Package opennlp.tools.namefind
Class NameSample
- java.lang.Object
-
- opennlp.tools.namefind.NameSample
-
- All Implemented Interfaces:
Serializable,Sample
public class NameSample extends Object implements Sample
Encapsulates names for a single unit of text.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_TYPEThe default type value when there is no type in training data.
-
Constructor Summary
Constructors Constructor Description NameSample(String[] sentence, Span[] names, boolean clearAdaptiveData)Initializes aNameSampleinstance with given parameters.NameSample(String[] sentence, Span[] names, String[][] additionalContext, boolean clearAdaptiveData)Initializes aNameSampleinstance with given parameters.NameSample(String id, String[] sentence, Span[] names, String[][] additionalContext, boolean clearAdaptiveData)Initializes aNameSampleinstance with given parameters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)String[][]getAdditionalContext()StringgetId()Span[]getNames()String[]getSentence()inthashCode()booleanisClearAdaptiveDataSet()static NameSampleparse(String taggedTokens, boolean clearAdaptiveData)Parses given input into aNameSample.static NameSampleparse(String taggedTokens, String defaultType, boolean clearAdaptiveData)Parses given input into aNameSample.StringtoString()
-
-
-
Field Detail
-
DEFAULT_TYPE
public static final String DEFAULT_TYPE
The default type value when there is no type in training data.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NameSample
public NameSample(String id, String[] sentence, Span[] names, String[][] additionalContext, boolean clearAdaptiveData)
Initializes aNameSampleinstance with given parameters.- Parameters:
id- The identifier to use.sentence- The tokens representing a training sentence. Must not benull.names- Thenamesto use.additionalContext- Additional context in a 2-dimensional array.clearAdaptiveData- Iftruethe adaptive data of the feature generators is cleared.- Throws:
RuntimeException- Thrown if name spans are overlapping.
-
NameSample
public NameSample(String[] sentence, Span[] names, String[][] additionalContext, boolean clearAdaptiveData)
Initializes aNameSampleinstance with given parameters.- Parameters:
sentence- The tokens representing a sentence. Must not benull.names- Thenamesto use.additionalContext- Additional context in a 2-dimensional array.clearAdaptiveData- Iftruethe adaptive data of the feature generators is cleared.- Throws:
RuntimeException- Thrown if name spans are overlapping.
-
NameSample
public NameSample(String[] sentence, Span[] names, boolean clearAdaptiveData)
Initializes aNameSampleinstance with given parameters.- Parameters:
sentence- The tokens representing a sentence. Must not benull.names- Thenamesto use.clearAdaptiveData- Iftruethe adaptive data of the feature generators is cleared.- Throws:
RuntimeException- Thrown if name spans are overlapping.
-
-
Method Detail
-
getId
public String getId()
- Returns:
- Retrieves the current identifier. May be
null.
-
getSentence
public String[] getSentence()
- Returns:
- Retrieves the sentence in tokenized form.
-
getAdditionalContext
public String[][] getAdditionalContext()
- Returns:
- Retrieves additional context. May be
null.
-
isClearAdaptiveDataSet
public boolean isClearAdaptiveDataSet()
- Returns:
trueif the adaptive data of the feature generators are cleared,falseotherwise.
-
parse
public static NameSample parse(String taggedTokens, boolean clearAdaptiveData) throws IOException
Parses given input into aNameSample.- Parameters:
taggedTokens- The input data to parse.clearAdaptiveData-trueif the adaptive data of the feature generators should be cleared,falseotherwise.- Returns:
- A
NameSampleinstance resulting from the parsing. - Throws:
IOException- Thrown if IO errors occurred during parsing.
-
parse
public static NameSample parse(String taggedTokens, String defaultType, boolean clearAdaptiveData) throws IOException
Parses given input into aNameSample.- Parameters:
taggedTokens- The input data to parse.defaultType- The type to set by default.clearAdaptiveData-trueif the adaptive data of the feature generators should be cleared,falseotherwise.- Returns:
- A
NameSampleinstance resulting from the parsing. - Throws:
IOException- Thrown if IO errors occurred during parsing.
-
-