opennlp.tools.sentdetect

Class SentenceModel

java.lang.Object

opennlp.tools.util.model.BaseModel

opennlp.tools.sentdetect.SentenceModel

All Implemented Interfaces:

ArtifactProvider

public class SentenceModel
extends BaseModel

The SentenceModel is the model used by a learnable SentenceDetector.

See Also:

SentenceDetectorME

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
SentenceModel(File modelFile)
SentenceModel(InputStream in)
SentenceModel(String languageCode, AbstractModel sentModel, boolean useTokenEnd, Dictionary abbreviations)
SentenceModel(String languageCode, AbstractModel sentModel, boolean useTokenEnd, Dictionary abbreviations, char[] eosCharacters) Deprecated. Use SentenceModel(String, AbstractModel, Map, SentenceDetectorFactory) instead and pass in a SentenceDetectorFactory
SentenceModel(String languageCode, AbstractModel sentModel, boolean useTokenEnd, Dictionary abbreviations, char[] eosCharacters, Map<String,String> manifestInfoEntries) Deprecated. Use SentenceModel(String, AbstractModel, Map, SentenceDetectorFactory) instead and pass in a SentenceDetectorFactory
SentenceModel(String languageCode, AbstractModel sentModel, boolean useTokenEnd, Dictionary abbreviations, Map<String,String> manifestInfoEntries)
SentenceModel(String languageCode, AbstractModel sentModel, Map<String,String> manifestInfoEntries, SentenceDetectorFactory sdFactory)
SentenceModel(URL modelURL)

Method Summary

Modifier and Type	Method and Description
Dictionary	getAbbreviations()
protected Class<? extends BaseToolFactory>	getDefaultFactory() Sub-classes should override this method if their module has a default BaseToolFactory sub-class.
char[]	getEosCharacters()
SentenceDetectorFactory	getFactory()
AbstractModel	getMaxentModel()
static void	main(String[] args)
boolean	useTokenEnd()
protected void	validateArtifactMap() Validates the parsed artifacts.

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

checkArtifactMap, createArtifactSerializers, 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

Constructor Detail

SentenceModel

public SentenceModel(String languageCode,
                     AbstractModel sentModel,
                     Map<String,String> manifestInfoEntries,
                     SentenceDetectorFactory sdFactory)

SentenceModel

public SentenceModel(String languageCode,
                     AbstractModel sentModel,
                     boolean useTokenEnd,
                     Dictionary abbreviations,
                     char[] eosCharacters,
                     Map<String,String> manifestInfoEntries)

Deprecated. Use SentenceModel(String, AbstractModel, Map, SentenceDetectorFactory) instead and pass in a SentenceDetectorFactory

TODO: was added in 1.5.3 -> remove

SentenceModel

public SentenceModel(String languageCode,
                     AbstractModel sentModel,
                     boolean useTokenEnd,
                     Dictionary abbreviations,
                     char[] eosCharacters)

Deprecated. Use SentenceModel(String, AbstractModel, Map, SentenceDetectorFactory) instead and pass in a SentenceDetectorFactory

TODO: was added in 1.5.3 -> remove

SentenceModel

public SentenceModel(String languageCode,
                     AbstractModel sentModel,
                     boolean useTokenEnd,
                     Dictionary abbreviations,
                     Map<String,String> manifestInfoEntries)

SentenceModel

public SentenceModel(String languageCode,
                     AbstractModel sentModel,
                     boolean useTokenEnd,
                     Dictionary abbreviations)

SentenceModel

public SentenceModel(InputStream in)
              throws IOException,
                     InvalidFormatException

Throws:

IOException

InvalidFormatException

SentenceModel

public SentenceModel(File modelFile)
              throws IOException,
                     InvalidFormatException

Throws:

IOException

InvalidFormatException

SentenceModel

public SentenceModel(URL modelURL)
              throws IOException,
                     InvalidFormatException

Throws:

IOException

InvalidFormatException

Method Detail

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

getFactory

public SentenceDetectorFactory getFactory()

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.

getMaxentModel

public AbstractModel getMaxentModel()

getAbbreviations

public Dictionary getAbbreviations()

useTokenEnd

public boolean useTokenEnd()

getEosCharacters

public char[] getEosCharacters()

main

public static void main(String[] args)
                 throws FileNotFoundException,
                        IOException,
                        InvalidFormatException

Throws:

FileNotFoundException

IOException

InvalidFormatException