Package opennlp.tools.namefind
Class TokenNameFinderFactory
java.lang.Object
opennlp.tools.util.BaseToolFactory
opennlp.tools.namefind.TokenNameFinderFactory
The factory that provides
TokenNameFinder default implementations and
resources. That only works if that's the central class used for training/runtime.-
Constructor Summary
ConstructorsConstructorDescriptionInitializes aTokenNameFinderFactorythat provides the default implementation of the resources.TokenNameFinderFactory(byte[] featureGeneratorBytes, Map<String, Object> resources, SequenceCodec<String> seqCodec) Initializes aTokenNameFinderFactoryinstance via given parameters. -
Method Summary
Modifier and TypeMethodDescriptionstatic TokenNameFinderFactorycreate(String subclassName, byte[] featureGeneratorBytes, Map<String, Object> resources, SequenceCodec<String> seqCodec) Initializes aTokenNameFinderFactoryinstance via given parameters.Creates and configures a newNameContextGeneratorin a default combination.Creates theAdaptiveFeatureGenerator.static SequenceCodec<String>instantiateSequenceCodec(String sequenceCodecImplName) Initializes aSequenceCodecinstance via given parameters.voidValidates the parsed artifacts.Methods inherited from class opennlp.tools.util.BaseToolFactory
create, create, createArtifactMap, createArtifactSerializersMap, createManifestEntries
-
Constructor Details
-
TokenNameFinderFactory
public TokenNameFinderFactory()Initializes aTokenNameFinderFactorythat provides the default implementation of the resources.BioCodecwill be used as defaultSequenceCodec. -
TokenNameFinderFactory
public TokenNameFinderFactory(byte[] featureGeneratorBytes, Map<String, Object> resources, SequenceCodec<String> seqCodec) Initializes aTokenNameFinderFactoryinstance via given parameters.- Parameters:
featureGeneratorBytes- Thebyte[]representing the feature generator descriptor.resources- Additional resources in a mapping.seqCodec- TheSequenceCodecto use.
-
-
Method Details
-
create
public static TokenNameFinderFactory create(String subclassName, byte[] featureGeneratorBytes, Map<String, Object> resources, SequenceCodec<String> seqCodec) throws InvalidFormatExceptionInitializes aTokenNameFinderFactoryinstance via given parameters.- Parameters:
subclassName- The class name used for instantiation. Ifnull, an instance ofTokenNameFinderFactorywill be returned per default. Otherwise, theExtensionLoadermechanism is applied to load the requestedsubclassName.featureGeneratorBytes- Thebyte[]representing the feature generator descriptor.resources- Additional resources in a mapping.seqCodec- TheSequenceCodecto use.- Returns:
- A valid
TokenNameFinderFactoryinstance. - Throws:
InvalidFormatException- Thrown if theExtensionLoadermechanism failed to create the factory associated withsubclassName.
-
validateArtifactMap
Description 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.
-
createSequenceCodec
- Returns:
- Initializes and returns a
SequenceCodecvia its class name configured in a manifest. If that initialization fails (e.g., if no matching class could be loaded for the configured class name at runtime), the currently loaded (default)SequenceCodecis returned. - See Also:
-
createContextGenerator
Creates and configures a newNameContextGeneratorin a default combination.- Returns:
- A
NameContextGeneratorinstance. - See Also:
-
createFeatureGenerators
Creates theAdaptiveFeatureGenerator. Usually this is a set of generators contained inAggregatedFeatureGenerator.Note: The generators are created on every call to this method.
- Returns:
- The
AdaptiveFeatureGeneratorornullif there is no descriptor in the model. - Throws:
TokenNameFinderModel.FeatureGeneratorCreationError- Thrown if configuration errors occurred.IllegalStateException- Thrown if inconsistencies occurred during creation.
-
instantiateSequenceCodec
public static SequenceCodec<String> instantiateSequenceCodec(String sequenceCodecImplName) throws InvalidFormatException Initializes aSequenceCodecinstance via given parameters.- Parameters:
sequenceCodecImplName- The class name used for instantiation. Ifnull, an instance ofBioCodecwill be returned per default. Otherwise, theExtensionLoadermechanism is applied to load the requestedsubclassName.- Returns:
- A valid
SequenceCodecinstance. - Throws:
InvalidFormatException- Thrown if theExtensionLoadermechanism failed to create the codec associated withsequenceCodecImplName.- See Also:
-