morfologik.stemming
Class WordData

java.lang.Object
  morfologik.stemming.WordData

All Implemented Interfaces:

Cloneable

public final class WordData
extends Object
implements Cloneable

Stem and tag data associated with a given word.

Important notes:

• Objects of this class are volatile (their content changes on subsequent calls to DictionaryLookup class. If you need a copy of the stem or tag data for a given word, you have to create a custom buffer yourself and copy the associated data, perform clone() or create strings (they are immutable) using getStem() and then CharSequence.toString().
• Objects of this class must not be used in any Java collections. In fact both equals and hashCode methods are overridden and throw exceptions to prevent accidental damage.

Method Summary

protected WordData	clone() Declare a covariant of Object.clone() that returns a deep copy of this object.
boolean	equals(Object obj)
CharSequence	getStem()
ByteBuffer	getStemBytes(ByteBuffer target) Copy the stem's binary data (no charset decoding) to a custom byte buffer.
CharSequence	getTag()
ByteBuffer	getTagBytes(ByteBuffer target) Copy the tag's binary data (no charset decoding) to a custom byte buffer.
CharSequence	getWord()
ByteBuffer	getWordBytes(ByteBuffer target) Copy the inflected word's binary data (no charset decoding) to a custom byte buffer.
int	hashCode()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getStemBytes

public ByteBuffer getStemBytes(ByteBuffer target)

Copy the stem's binary data (no charset decoding) to a custom byte buffer. If the buffer is null or not large enough to hold the result, a new buffer is allocated.

Parameters:

target - Target byte buffer to copy the stem buffer to or null if a new buffer should be allocated.

Returns:

Returns target or the new reallocated buffer.

getTagBytes

public ByteBuffer getTagBytes(ByteBuffer target)

Copy the tag's binary data (no charset decoding) to a custom byte buffer. If the buffer is null or not large enough to hold the result, a new buffer is allocated.

Parameters:

target - Target byte buffer to copy the tag buffer to or null if a new buffer should be allocated.

Returns:

Returns target or the new reallocated buffer.

getWordBytes

public ByteBuffer getWordBytes(ByteBuffer target)

Copy the inflected word's binary data (no charset decoding) to a custom byte buffer. If the buffer is null or not large enough to hold the result, a new buffer is allocated.

Parameters:

target - Target byte buffer to copy the word buffer to or null if a new buffer should be allocated.

Returns:

Returns target or the new reallocated buffer.

getTag

public CharSequence getTag()

Returns:

Return tag data decoded to a character sequence or null if no associated tag data exists.

getStem

public CharSequence getStem()

Returns:

Return stem data decoded to a character sequence or null if no associated stem data exists.

getWord

public CharSequence getWord()

Returns:

Return inflected word form data. Usually the parameter passed to DictionaryLookup.lookup(CharSequence).

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

protected WordData clone()

Declare a covariant of Object.clone() that returns a deep copy of this object. The content of all internal buffers is copied.

Overrides:

clone in class Object