opennlp.tools.sentiment

Class SentimentModel

java.lang.Object

opennlp.tools.util.model.BaseModel

opennlp.tools.sentiment.SentimentModel

All Implemented Interfaces:

opennlp.tools.util.model.ArtifactProvider

public class SentimentModel
extends opennlp.tools.util.model.BaseModel

Class for the basis of the Sentiment Analysis model.

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
SentimentModel(File file) Initializes the Sentiment Analysis model.
SentimentModel(String languageCode, opennlp.tools.ml.model.MaxentModel sentimentModel, Map<String,String> manifestInfoEntries, SentimentFactory factory) Initializes the Sentiment Analysis model.
SentimentModel(URL modelURL) Initializes the Sentiment Analysis model.

Method Summary

Methods

Modifier and Type	Method and Description
SentimentFactory	getFactory() Returns the sentiment factory
opennlp.tools.ml.model.MaxentModel	getMaxentModel() Returns the MaxEntropy model
opennlp.tools.ml.model.SequenceClassificationModel<String>	getSentimentModel() Deprecated.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SentimentModel

public SentimentModel(String languageCode,
              opennlp.tools.ml.model.MaxentModel sentimentModel,
              Map<String,String> manifestInfoEntries,
              SentimentFactory factory)

Initializes the Sentiment Analysis model.

Parameters:

languageCode - the code for the language of the text, e.g. "en"

sentimentModel - a MaxEnt sentiment model

manifestInfoEntries - additional information in the manifest

factory - a Sentiment Analysis factory

SentimentModel

public SentimentModel(URL modelURL)
               throws IOException,
                      opennlp.tools.util.InvalidFormatException

Initializes the Sentiment Analysis model.

Parameters:

modelURL - the URL to a file required for the model

Throws:

IOException

opennlp.tools.util.InvalidFormatException

SentimentModel

public SentimentModel(File file)
               throws opennlp.tools.util.InvalidFormatException,
                      IOException

Initializes the Sentiment Analysis model.

Parameters:

file - the file required for the model

Throws:

opennlp.tools.util.InvalidFormatException

IOException

Method Detail

getSentimentModel

@Deprecated
public opennlp.tools.ml.model.SequenceClassificationModel<String> getSentimentModel()

Deprecated.

Return the model

Returns:

the model

getFactory

public SentimentFactory getFactory()

Returns the sentiment factory

Returns:

the sentiment factory for the model

getMaxentModel

public opennlp.tools.ml.model.MaxentModel getMaxentModel()

Returns the MaxEntropy model

Returns:

the MaxEnt model