Package opennlp.tools.postag
Class POSTaggerFactory
- java.lang.Object
-
- opennlp.tools.util.BaseToolFactory
-
- opennlp.tools.postag.POSTaggerFactory
-
public class POSTaggerFactory extends BaseToolFactory
The factory that providesPOSTaggerdefault implementations and resources.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPOSTaggerFactory.POSDictionarySerializer
-
Constructor Summary
Constructors Constructor Description POSTaggerFactory()Initializes aPOSTaggerFactorythat provides the default implementation of the resources.POSTaggerFactory(byte[] featureGeneratorBytes, Map<String,Object> resources, TagDictionary posDictionary)Initializes aPOSTaggerFactoryfrom a given set of the resources.
-
Method Summary
-
Methods inherited from class opennlp.tools.util.BaseToolFactory
create, create, createManifestEntries
-
-
-
-
Constructor Detail
-
POSTaggerFactory
public POSTaggerFactory()
Initializes aPOSTaggerFactorythat provides the default implementation of the resources.
-
POSTaggerFactory
public POSTaggerFactory(byte[] featureGeneratorBytes, Map<String,Object> resources, TagDictionary posDictionary)Initializes aPOSTaggerFactoryfrom a given set of the resources.- Parameters:
featureGeneratorBytes- The bytes for feature generation.resources- Additional resources as key-value map.posDictionary- ATagDictionaryused for the new instance.
-
-
Method Detail
-
createFeatureGenerators
public AdaptiveFeatureGenerator createFeatureGenerators()
Creates theAdaptiveFeatureGenerator. Usually this is a set of generators contained in theAggregatedFeatureGenerator.Note: The generators are created on every call to this method.
- Returns:
- the feature generator or
nullif there is no descriptor in the model - Throws:
IllegalStateException- Thrown if inconsistencies occurred during creation.
-
createArtifactSerializersMap
public Map<String,ArtifactSerializer> createArtifactSerializersMap()
Description copied from class:BaseToolFactoryCreates aMapwith pairs of keys andArtifactSerializer. The models implementation should call this method fromBaseModel#createArtifactSerializersMap.The base implementation will return a
HashMapthat should be populated by subclasses.- Overrides:
createArtifactSerializersMapin classBaseToolFactory
-
createArtifactMap
public Map<String,Object> createArtifactMap()
Description copied from class:BaseToolFactoryA model's implementation should call this constructor that creates a model programmatically.The base implementation will return a
HashMapthat should be populated by subclasses.- Overrides:
createArtifactMapin classBaseToolFactory- Returns:
- Retrieves a
Mapwith pairs of keys and objects.
-
createTagDictionary
public TagDictionary createTagDictionary(File dictionary) throws IOException
Initializes aTagDictionaryfrom adictionary file.- Parameters:
dictionary- TheFileused for creating the dictionary.- Returns:
- A valid
TagDictionaryready for use. - Throws:
IOException- Thrown if IO errors occurred during creation.
-
createTagDictionary
public TagDictionary createTagDictionary(InputStream in) throws IOException
Initializes aTagDictionaryfrom adictionary stream.- Parameters:
in- TheInputStreamused for creating the dictionary.- Returns:
- A valid
TagDictionaryready for use. - Throws:
IOException- Thrown if IO errors occurred during creation.
-
setTagDictionary
public void setTagDictionary(TagDictionary dictionary)
-
getTagDictionary
public TagDictionary getTagDictionary()
- Returns:
- The
TagDictionaryused.
-
getPOSContextGenerator
public POSContextGenerator getPOSContextGenerator()
- Returns:
- The
POSContextGeneratorwith a default cache size of0.
-
getPOSContextGenerator
public POSContextGenerator getPOSContextGenerator(int cacheSize)
- Parameters:
cacheSize- Must be greater than or equal to0.- Returns:
- The
POSContextGeneratorconfigured with the givencacheSize.
-
getSequenceValidator
public SequenceValidator<String> getSequenceValidator()
- Returns:
- The
SequenceValidatorused.
-
validateArtifactMap
public void validateArtifactMap() throws InvalidFormatExceptionDescription copied from class:BaseToolFactoryValidates the parsed artifacts.Note: Subclasses should generally invoke
super.validateArtifactMapat the beginning of this method.- Specified by:
validateArtifactMapin classBaseToolFactory- Throws:
InvalidFormatException- Thrown if validation found invalid states.
-
create
public static POSTaggerFactory create(String subclassName, byte[] featureGeneratorBytes, Map<String,Object> resources, TagDictionary posDictionary) throws InvalidFormatException
Instantiates aPOSTaggerFactoryvia a givensubclassName.- Parameters:
subclassName- The class name used for instantiation. Ifnull, an instance ofPOSTaggerFactorywill be returned per default. Otherwise, theExtensionLoadermechanism is applied to load the requestedsubclassName.featureGeneratorBytes- The bytes for feature generation.resources- Additional resources as key-value map.posDictionary- ATagDictionaryused for the new instance.- Returns:
- Throws:
InvalidFormatException- Thrown if theExtensionLoadermechanism failed to load the factory via thesubclassName.
-
createEmptyTagDictionary
public TagDictionary createEmptyTagDictionary()
- Returns:
- An empty, case-sensitive
TagDictionary.
-
-