opennlp.tools.namefind

Class TokenNameFinderModel

java.lang.Object

opennlp.tools.util.model.BaseModel

opennlp.tools.namefind.TokenNameFinderModel

All Implemented Interfaces:

ArtifactProvider

public class TokenNameFinderModel
extends BaseModel

The TokenNameFinderModel is the model used by a learnable TokenNameFinder.

See Also:

NameFinderME

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenNameFinderModel.FeatureGeneratorCreationError

Field Summary

Fields inherited from class opennlp.tools.util.model.BaseModel

artifactMap, FACTORY_NAME, MANIFEST_ENTRY, toolFactory, TRAINING_CUTOFF_PROPERTY, TRAINING_EVENTHASH_PROPERTY, TRAINING_ITERATIONS_PROPERTY

Constructor Summary

Constructors

Constructor and Description
TokenNameFinderModel(File modelFile)
TokenNameFinderModel(InputStream in)
TokenNameFinderModel(String languageCode, AbstractModel nameFinderModel, byte[] generatorDescriptor, Map<String,Object> resources, Map<String,String> manifestInfoEntries)
TokenNameFinderModel(String languageCode, AbstractModel nameFinderModel, Map<String,Object> resources, Map<String,String> manifestInfoEntries)
TokenNameFinderModel(URL modelURL)

Method Summary

Modifier and Type	Method and Description
static Map<String,ArtifactSerializer>	createArtifactSerializers()
protected void	createArtifactSerializers(Map<String,ArtifactSerializer> serializers) Registers all ArtifactSerializer for their artifact file name extensions.
AdaptiveFeatureGenerator	createFeatureGenerators() Creates the AdaptiveFeatureGenerator.
AbstractModel	getNameFinderModel() Retrieves the TokenNameFinder model.
static boolean	isModelValid(MaxentModel model)
TokenNameFinderModel	updateFeatureGenerator(byte[] descriptor)
protected void	validateArtifactMap() Validates the parsed artifacts.

Methods inherited from class opennlp.tools.util.model.BaseModel

checkArtifactMap, getArtifact, getArtifactSerializer, getDefaultFactory, getLanguage, getManifestProperty, getVersion, isLoadedFromSerialized, serialize, setManifestProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TokenNameFinderModel

public TokenNameFinderModel(String languageCode,
                            AbstractModel nameFinderModel,
                            byte[] generatorDescriptor,
                            Map<String,Object> resources,
                            Map<String,String> manifestInfoEntries)

TokenNameFinderModel

public TokenNameFinderModel(String languageCode,
                            AbstractModel nameFinderModel,
                            Map<String,Object> resources,
                            Map<String,String> manifestInfoEntries)

TokenNameFinderModel

public TokenNameFinderModel(InputStream in)
                     throws IOException,
                            InvalidFormatException

Throws:

IOException

InvalidFormatException

TokenNameFinderModel

public TokenNameFinderModel(File modelFile)
                     throws IOException,
                            InvalidFormatException

Throws:

IOException

InvalidFormatException

TokenNameFinderModel

public TokenNameFinderModel(URL modelURL)
                     throws IOException,
                            InvalidFormatException

Throws:

IOException

InvalidFormatException

Method Detail

getNameFinderModel

public AbstractModel getNameFinderModel()

Retrieves the TokenNameFinder model.

Returns:

the classification model

createFeatureGenerators

public AdaptiveFeatureGenerator createFeatureGenerators()

Creates the AdaptiveFeatureGenerator. Usually this is a set of generators contained in the AggregatedFeatureGenerator. Note: The generators are created on every call to this method.

Returns:

the feature generator or null if there is no descriptor in the model

updateFeatureGenerator

public TokenNameFinderModel updateFeatureGenerator(byte[] descriptor)

createArtifactSerializers

protected void createArtifactSerializers(Map<String,ArtifactSerializer> serializers)

Description copied from class: BaseModel

Registers all ArtifactSerializer for their artifact file name extensions. The registered ArtifactSerializer are used to create and serialize resources in the model package. Override this method to register custom ArtifactSerializers. Note: Subclasses should generally invoke super.createArtifactSerializers at the beginning of this method. This method is called during construction.

Overrides:

createArtifactSerializers in class BaseModel

Parameters:

serializers - the key of the map is the file extension used to lookup the ArtifactSerializer.

createArtifactSerializers

public static Map<String,ArtifactSerializer> createArtifactSerializers()

isModelValid

public static boolean isModelValid(MaxentModel model)

validateArtifactMap

protected void validateArtifactMap()
                            throws InvalidFormatException

Description copied from class: BaseModel

Validates the parsed artifacts. If something is not valid subclasses should throw an InvalidFormatException. Note: Subclasses should generally invoke super.validateArtifactMap at the beginning of this method.

Overrides:

validateArtifactMap in class BaseModel

Throws:

InvalidFormatException