opennlp.tools.postag

Class POSModel

java.lang.Object

opennlp.tools.util.model.BaseModel

opennlp.tools.postag.POSModel

All Implemented Interfaces:

ArtifactProvider

public final class POSModel
extends BaseModel

The POSModel is the model used by a learnable POSTagger.

See Also:

POSTaggerME

Field Summary

Fields

Modifier and Type	Field and Description
static String	POS_MODEL_ENTRY_NAME

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
POSModel(File modelFile)
POSModel(InputStream in)
POSModel(String languageCode, AbstractModel posModel, Map<String,String> manifestInfoEntries, POSTaggerFactory posFactory)
POSModel(String languageCode, AbstractModel posModel, POSDictionary tagDictionary, Dictionary ngramDict) Deprecated. Use POSModel(String, AbstractModel, Map, POSTaggerFactory) instead.
POSModel(String languageCode, AbstractModel posModel, POSDictionary tagDictionary, Dictionary ngramDict, Map<String,String> manifestInfoEntries) Deprecated. Use POSModel(String, AbstractModel, Map, POSTaggerFactory) instead.
POSModel(URL modelURL)

Method Summary

Modifier and Type	Method and Description
protected void	createArtifactSerializers(Map<String,ArtifactSerializer> serializers) Registers all ArtifactSerializer for their artifact file name extensions.
protected Class<? extends BaseToolFactory>	getDefaultFactory() Sub-classes should override this method if their module has a default BaseToolFactory sub-class.
POSTaggerFactory	getFactory()
Dictionary	getNgramDictionary() Retrieves the ngram dictionary.
AbstractModel	getPosModel()
POSDictionary	getTagDictionary() Deprecated. Use getFactory() to get a POSTaggerFactory and POSTaggerFactory.getTagDictionary() to get a TagDictionary.
protected void	validateArtifactMap() Validates the parsed artifacts.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

POS_MODEL_ENTRY_NAME

public static final String POS_MODEL_ENTRY_NAME

See Also:

Constant Field Values

Constructor Detail

POSModel

public POSModel(String languageCode,
                AbstractModel posModel,
                POSDictionary tagDictionary,
                Dictionary ngramDict,
                Map<String,String> manifestInfoEntries)

Deprecated. Use POSModel(String, AbstractModel, Map, POSTaggerFactory) instead.

POSModel

public POSModel(String languageCode,
                AbstractModel posModel,
                POSDictionary tagDictionary,
                Dictionary ngramDict)

Deprecated. Use POSModel(String, AbstractModel, Map, POSTaggerFactory) instead.

POSModel

public POSModel(String languageCode,
                AbstractModel posModel,
                Map<String,String> manifestInfoEntries,
                POSTaggerFactory posFactory)

POSModel

public POSModel(InputStream in)
         throws IOException,
                InvalidFormatException

Throws:

IOException

InvalidFormatException

POSModel

public POSModel(File modelFile)
         throws IOException,
                InvalidFormatException

Throws:

IOException

InvalidFormatException

POSModel

public POSModel(URL modelURL)
         throws IOException,
                InvalidFormatException

Throws:

IOException

InvalidFormatException

Method Detail

getDefaultFactory

protected Class<? extends BaseToolFactory> getDefaultFactory()

Description copied from class: BaseModel

Sub-classes should override this method if their module has a default BaseToolFactory sub-class.

Overrides:

getDefaultFactory in class BaseModel

Returns:

the default BaseToolFactory for the module, or null if none.

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.

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

getPosModel

public AbstractModel getPosModel()

getTagDictionary

public POSDictionary getTagDictionary()

Deprecated. Use getFactory() to get a POSTaggerFactory and POSTaggerFactory.getTagDictionary() to get a TagDictionary.

Retrieves the tag dictionary.

Returns:

tag dictionary or null if not used

Throws:

IllegalStateException - if the TagDictionary is not an instance of POSDictionary

getFactory

public POSTaggerFactory getFactory()

getNgramDictionary

public Dictionary getNgramDictionary()

Retrieves the ngram dictionary.

Returns:

ngram dictionary or null if not used