org.apache.uima.annotator.dict_annot.dictionary.impl
Class DictionaryEntry

java.lang.Object
  extended by org.apache.uima.annotator.dict_annot.dictionary.impl.DictionaryEntry

public class DictionaryEntry
extends java.lang.Object

The DictionaryEntry contains the entry meta data object and the information if an entry is complete or just a part of a multi-word entry. If the entry is part of a multi-word entry it also contains the branch of multi-word tokens that are followed by the current entry.


Constructor Summary
DictionaryEntry(boolean isComplete, EntryMetaData metaData)
          Creates a new DictionaryEntry object
 
Method Summary
 EntryMetaData getEntryMetaData()
          Returns the current entry meta data object.
 java.util.HashMap<java.lang.String,DictionaryEntry> getSubBranch()
          Returns the sub branch for a dictionary entry.
 boolean isComplete()
          Returns for the current entry if it is complete or not.
 void setComplete()
          marks the current entry as a valid entry
 void setEntryMetaData(EntryMetaData metaData)
          Sets the metaData for this entry.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DictionaryEntry

public DictionaryEntry(boolean isComplete,
                       EntryMetaData metaData)
Creates a new DictionaryEntry object

Parameters:
isComplete - should be true if the current entry is complete. An entry is complete if it is a single word or the last token of a multi word entry
metaData - meta data for the current entry
Method Detail

getSubBranch

public java.util.HashMap<java.lang.String,DictionaryEntry> getSubBranch()
Returns the sub branch for a dictionary entry. If no sub branch exist, a new branch is created.

Returns:
returns the sub branch HashMap for this entry

isComplete

public boolean isComplete()
Returns for the current entry if it is complete or not. An entry is complete if it is a single word or the last token of a multi word entry.

Returns:
returns true if the entry is complete, otherwise false.

setComplete

public void setComplete()
marks the current entry as a valid entry


getEntryMetaData

public EntryMetaData getEntryMetaData()
Returns the current entry meta data object.

Returns:
EntryMetaData object for the current entry.

setEntryMetaData

public void setEntryMetaData(EntryMetaData metaData)
Sets the metaData for this entry.

Parameters:
metaData - entry meta data


Copyright © 2011. All Rights Reserved.