opennlp.tools.namefind
Class TokenNameFinderModel

java.lang.Object
  extended by opennlp.tools.util.model.BaseModel
      extended by 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
static class TokenNameFinderModel.FeatureGeneratorCreationError
           
 
Field Summary
 
Fields inherited from class opennlp.tools.util.model.BaseModel
TRAINING_CUTOFF_PROPERTY, TRAINING_EVENTHASH_PROPERTY, TRAINING_ITERATIONS_PROPERTY
 
Constructor Summary
TokenNameFinderModel(File modelFile)
           
TokenNameFinderModel(InputStream in)
           
TokenNameFinderModel(String languageCode, opennlp.model.AbstractModel nameFinderModel, byte[] generatorDescriptor, Map<String,Object> resources, Map<String,String> manifestInfoEntries)
           
TokenNameFinderModel(String languageCode, opennlp.model.AbstractModel nameFinderModel, Map<String,Object> resources, Map<String,String> manifestInfoEntries)
           
TokenNameFinderModel(URL modelURL)
           
 
Method Summary
static Map<String,ArtifactSerializer> createArtifactSerializers()
           
 AdaptiveFeatureGenerator createFeatureGenerators()
          Creates the AdaptiveFeatureGenerator.
 opennlp.model.AbstractModel getNameFinderModel()
          Retrieves the TokenNameFinder model.
static boolean isModelValid(opennlp.model.MaxentModel model)
           
 TokenNameFinderModel updateFeatureGenerator(byte[] descriptor)
           
 
Methods inherited from class opennlp.tools.util.model.BaseModel
getArtifact, getLanguage, getManifestProperty, getVersion, isLoadedFromSerialized, serialize
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TokenNameFinderModel

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

TokenNameFinderModel

public TokenNameFinderModel(String languageCode,
                            opennlp.model.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 opennlp.model.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

public static Map<String,ArtifactSerializer> createArtifactSerializers()

isModelValid

public static boolean isModelValid(opennlp.model.MaxentModel model)


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.