hnscnvt
Class HNSSign

java.lang.Object
  hnscnvt.HNSSign

public class HNSSign
extends java.lang.Object

The data defining a single HamNoSys 4 sign. The main constituents are strings, one for each of the following features of the sign:

• Manual component
  Note that this is composed of 8-bit HNS characters, as defined by the encoding associated with the old HamNoSys 3 font;
• Non-manual component, a space-separated list of HNST non-manual tags; each tag is one of the non-manual HamNoSys 4 primitives, as defined in ViSiCAST D5.1, Ch. 4, possibly prefixed with a letter indicating the main articulator associated with that primitive.
• Gloss name.
• Input error text

In addition, in the case where the sign is created from an HNS-SiGML (<hns_sign> element, either the text of this element or its DOM Element representation may be held with the sign.

Constructor Summary

HNSSign()
Constructs a sign with null components.

HNSSign(java.lang.String man, java.lang.String nm, java.lang.String glss, java.lang.String err)
Constructor forming the sign from the given manual, non-manual, gloss and input error text componenents, any of which may be null; there is no associated element or element text at this stage.

Method Summary

org.w3c.dom.Element	element() Assuming it is available (as indicated by elementIsAvailable()), this method returns the text of the <hns_sign> element defining this sign.
boolean	elementIsAvailable() Returns a boolean indicating whether this sign has an associated <hns_sign> DOM Element.
java.lang.String	elementText() Assuming it is available (as indicated by elementTextIsAvailable()), this method returns the text of the <hns_sign> element defining this sign.
boolean	elementTextIsAvailable() Returns a boolean indicating whether this sign has an associated <hns_sign> element text.
boolean	equals(java.lang.Object other) Equality test, requiring matching manual, non-manual and gloss components.
java.lang.String	error() Returns the sign's input error text.
java.lang.String	gloss() Returns the sign's gloss string.
java.lang.String	man() Returns the sign's HNS manual component.
java.lang.String	nonMan() Returns the sign's HNS non-manual component.
void	setElement(org.w3c.dom.Element el) Sets the <hns_sign> DOM Element from which this sign has been generated.
void	setElementText(java.lang.String el) Sets the <hns_sign> element text from which this sign has been generated.
void	setError(java.lang.String err) Sets the sign's input error text.
void	setGloss(java.lang.String glss) Sets the sign's gloss string.
void	setMan(java.lang.String man) Sets the sign's HNS manual component.
void	setNonMan(java.lang.String nm) Sets the sign's HNS non-manual component.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HNSSign

public HNSSign()

Constructs a sign with null components.

HNSSign

public HNSSign(java.lang.String man,
               java.lang.String nm,
               java.lang.String glss,
               java.lang.String err)

Constructor forming the sign from the given manual, non-manual, gloss and input error text componenents, any of which may be null; there is no associated element or element text at this stage.

Method Detail

setMan

public void setMan(java.lang.String man)

Sets the sign's HNS manual component.

setNonMan

public void setNonMan(java.lang.String nm)

Sets the sign's HNS non-manual component.

setGloss

public void setGloss(java.lang.String glss)

Sets the sign's gloss string.

setError

public void setError(java.lang.String err)

Sets the sign's input error text.

setElementText

public void setElementText(java.lang.String el)

Sets the <hns_sign> element text from which this sign has been generated.

setElement

public void setElement(org.w3c.dom.Element el)

Sets the <hns_sign> DOM Element from which this sign has been generated.

man

public java.lang.String man()

Returns the sign's HNS manual component.

nonMan

public java.lang.String nonMan()

Returns the sign's HNS non-manual component.

gloss

public java.lang.String gloss()

Returns the sign's gloss string.

error

public java.lang.String error()

Returns the sign's input error text.

elementTextIsAvailable

public boolean elementTextIsAvailable()

Returns a boolean indicating whether this sign has an associated <hns_sign> element text.

elementText

public java.lang.String elementText()

Assuming it is available (as indicated by elementTextIsAvailable()), this method returns the text of the <hns_sign> element defining this sign.

elementIsAvailable

public boolean elementIsAvailable()

Returns a boolean indicating whether this sign has an associated <hns_sign> DOM Element.

element

public org.w3c.dom.Element element()

Assuming it is available (as indicated by elementIsAvailable()), this method returns the text of the <hns_sign> element defining this sign.

equals

public boolean equals(java.lang.Object other)

Equality test, requiring matching manual, non-manual and gloss components.

Overrides:

equals in class java.lang.Object