de.bensoft.acis.core.language

Class Word

java.lang.Object

de.bensoft.acis.core.language.Word

public class Word
extends java.lang.Object

Represents a word of a sentence including information such as the normal form, type or synonyms.
Note that the type is language-dependent and defined in the respective Language interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Word.WordType Contains the standard word types.

Constructor Summary

Constructors

Constructor and Description
Word(java.lang.String typedForm, java.lang.String normalForm, int type, java.lang.String[] synonyms) The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Word word, boolean caseSensitive) Checks whether the word equals another in any way.
boolean	equalsExact(Word word) Checks whether the typed form of the word equals the typed form of another.
boolean	equalsNormalForm(Word word, boolean caseSensitive) Checks whether the normal form of the word equals the normal form of another.
boolean	equalsSynonym(Word word, boolean caseSensitive) Checks whether the word is the synonym of another or the other way around.
java.lang.String	getNormalForm() Returns the normal/base form of a word.
java.lang.String[]	getSynonyms() Returns the synonyms of the word.
int	getType() Returns the type of the word.
java.lang.String	getTypedForm() Returns the form the word occurred in the input.
void	setNormalForm(java.lang.String normalForm) Sets the normal/base form if a word.
void	setSynonyms(java.lang.String[] synonyms) Sets the synonyms of the word.
void	setType(int type) Sets the type of the word.
void	setTypedForm(java.lang.String typedForm) Sets the form the word occurred in the input.

Methods inherited from class java.lang.Object

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

Constructor Detail

Word

public Word(java.lang.String typedForm,
            java.lang.String normalForm,
            int type,
            java.lang.String[] synonyms)

The constructor.

Parameters:

typedForm - The form the word occurs in the input.

normalForm - The normal/base form of a word.

type - The type.

synonyms - An array of synonyms. If there are no synonyms, pass an empty array. Must not be null.

Method Detail

getTypedForm

public java.lang.String getTypedForm()

Returns the form the word occurred in the input.

Returns:

The typed form of the word.

setTypedForm

public void setTypedForm(java.lang.String typedForm)

Sets the form the word occurred in the input.

Parameters:

typedForm - The typed form of the word.

getNormalForm

public java.lang.String getNormalForm()

Returns the normal/base form of a word.

Returns:

The normal form.

setNormalForm

public void setNormalForm(java.lang.String normalForm)

Sets the normal/base form if a word.

Parameters:

normalForm - The normal form.

getType

public int getType()

Returns the type of the word.

Returns:

An int representing the type of the word.

setType

public void setType(int type)

Sets the type of the word.

Parameters:

type - An int representing the type of the word. Note: This is language-dependent, so the word types defined in the respective Language interface should be used.

getSynonyms

public java.lang.String[] getSynonyms()

Returns the synonyms of the word.

Returns:

An array containing Strings of synonyms in normal form.

setSynonyms

public void setSynonyms(java.lang.String[] synonyms)

Sets the synonyms of the word.

Parameters:

synonyms - The synonyms array to set. Must not be null.

equalsSynonym

public boolean equalsSynonym(Word word,
                             boolean caseSensitive)

Checks whether the word is the synonym of another or the other way around. The NormalForm of the word is used for checking.

Parameters:

word - The word to check with.

caseSensitive - Whether the comparison should be case sensitive.

Returns:

true when they are synonyms, false when not.

equalsNormalForm

public boolean equalsNormalForm(Word word,
                                boolean caseSensitive)

Checks whether the normal form of the word equals the normal form of another.

Parameters:

word - The word to check with.

caseSensitive - Whether the comparison should be case sensitive.

Returns:

true when they have the same normal form, false when not.

equalsExact

public boolean equalsExact(Word word)

Checks whether the typed form of the word equals the typed form of another.

Parameters:

word - The word to check with.

Returns:

true when they have the same typed form, false when not.

equals

public boolean equals(Word word,
                      boolean caseSensitive)

Checks whether the word equals another in any way.

Parameters:

word - The word to check with.

caseSensitive - Whether the comparison should be case sensitive.

Returns:

true when they have the same typed form, normal form or share synonyms. false when not.