charger.gloss

Class AbstractTypeDescriptor

Object

charger.gloss.AbstractTypeDescriptor

Direct Known Subclasses:

GenericTypeDescriptor, WordnetTypeDescriptor

public abstract class AbstractTypeDescriptor
extends Object

Abstract interface for a type descriptor. A descriptor is CharGer's way of storing a dictionary-style definition. The type descriptor contains the term being described (called its label), a definition string, and a part of speech string. Subclasses may add additional features (such as Wordnet's dictionary pointers). Any GNode in CharGer may have one ore more descriptors associated with it. In order to be parsed, any concrete class's tag name needs to be added to the CGXMLParser. In order to be queried, any concrete class must be handled by the SenseQueryDialog class.

See Also:

SenseQueryDialog, charger.xml.CGXParser, charger.wn.WordnetTypeDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected String	definition A text definition, possibly including examples, variants, etc.
protected String	eol Convenience for the toXML methods
protected String	label The actual term to which this descriptor applies
static String[]	legalPartsOfSpeech the list of available parts of speech.
protected String	partofspeech The part of speech.
protected static String	tagName
protected boolean	validated Whether this type descriptor has been tested or analyzed with respect to some dictionary, etc.

Constructor Summary

Constructors

Constructor and Description
AbstractTypeDescriptor()

Method Summary

Modifier and Type	Method and Description
boolean	equals(AbstractTypeDescriptor d) Compares two type descriptors for equality.
String	getDefinition() Gets the definition string that is being represented by this descriptor.
static AbstractTypeDescriptor	getInstanceFromXML(org.xml.sax.Attributes attrs) Parses the XML parms that go along with the tag in getTagName().
String	getLabel() Gets the type descriptor's term label.
String	getPOS() Gets the part of speech string that is being represented by this descriptor.
static String	getTagName() Gives the tag name that will be used by XML to represent this descriptor
String	getTrimmedString() Shorten the definition so it won't overrun windows and dialogs.
boolean	isValidated() Whether this type descriptor has been validated or not.
void	setDefinition(String def) Sets the definition of this type descriptor, without validation.
void	setLabel(String lab) Sets the type descriptor's term label.
boolean	setValidated(boolean b) Sets whether this type descriptor is validated or not.
abstract String	toXML(String indent) Translates the descriptor into its self-contained XML version.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tagName

protected static String tagName

eol

protected String eol

Convenience for the toXML methods

label

protected String label

The actual term to which this descriptor applies

definition

protected String definition

A text definition, possibly including examples, variants, etc.

partofspeech

protected String partofspeech

The part of speech.

See Also:

TypeDescriptor#legalPartsOfSpeech

legalPartsOfSpeech

public static String[] legalPartsOfSpeech

the list of available parts of speech. Not really relevant for Wordnet, which has its own reserved four types: "noun", "verb", "adjective", and "adverb". The legal labels are: "noun", "verb", "adjective", "adverb", "preposition", "other";

validated

protected boolean validated

Whether this type descriptor has been tested or analyzed with respect to some dictionary, etc.

Constructor Detail

AbstractTypeDescriptor

public AbstractTypeDescriptor()

Method Detail

setDefinition

public void setDefinition(String def)

Sets the definition of this type descriptor, without validation.

getDefinition

public String getDefinition()

Gets the definition string that is being represented by this descriptor.

getPOS

public String getPOS()

Gets the part of speech string that is being represented by this descriptor.

isValidated

public boolean isValidated()

Whether this type descriptor has been validated or not.

setLabel

public void setLabel(String lab)

Sets the type descriptor's term label.

Parameters:

lab - the term label to be assigned to this descriptor.

getLabel

public String getLabel()

Gets the type descriptor's term label.

Returns:

the term label that was assigned to this descriptor.

setValidated

public boolean setValidated(boolean b)

Sets whether this type descriptor is validated or not. Sub-classes can override and provide a real validation procedure if the argument is true. Default is to return the value passed in by the caller

Parameters:

b - if true, then perform whatever validation procedure will be required; otherwise just invalidate the descriptor.

getTagName

public static String getTagName()

Gives the tag name that will be used by XML to represent this descriptor

toXML

public abstract String toXML(String indent)

Translates the descriptor into its self-contained XML version.

Parameters:

indent - For convenience, what is the current indentation prefix?

Returns:

a self-contained XML tag, including nested parts if necessary.

getInstanceFromXML

public static AbstractTypeDescriptor getInstanceFromXML(org.xml.sax.Attributes attrs)

Parses the XML parms that go along with the tag in getTagName(). Does not handle the tag itself; it assumes we've already determined that this is the right class to invoke.

Parameters:

attrs - the Attributes passed to org.xml.sax.startElement

Returns:

an instance of the descriptor, or null if it can't be formed.

See Also:

charger.xml.CGXParser

getTrimmedString

public String getTrimmedString()

Shorten the definition so it won't overrun windows and dialogs. If there's a ";" or ":" symbol in the string, it and everything after it is deleted. Then if the string is still longer than 80 characters, it is truncated.

Returns:

a possibly shortened form of the definition.

equals

public boolean equals(AbstractTypeDescriptor d)

Compares two type descriptors for equality. They are considered equal if the part of speech is equal and the labels agree (ignored upper/lower case).

Parameters:

d - Descriptor to be compared.

Returns:

true if the POS and label are equal.