Package opennlp.tools.sentdetect
Class SentenceDetectorFactory
java.lang.Object
opennlp.tools.util.BaseToolFactory
opennlp.tools.sentdetect.SentenceDetectorFactory
The factory that provides
SentenceDetector default implementations and
resources-
Constructor Summary
ConstructorsConstructorDescriptionCreates aSentenceDetectorFactorythat provides the default implementation of the resources.SentenceDetectorFactory(String languageCode, boolean useTokenEnd, Dictionary abbreviationDictionary, char[] eosCharacters) Creates aSentenceDetectorFactory. -
Method Summary
Modifier and TypeMethodDescriptionstatic SentenceDetectorFactorycreate(String subclassName, String languageCode, boolean useTokenEnd, Dictionary abbrDictionary, char[] eosChars) Instantiates aSentenceDetectorFactoryvia a givensubclassName.A model's implementation should call this constructor that creates a model programmatically.char[]booleanvoidValidates the parsed artifacts.Methods inherited from class opennlp.tools.util.BaseToolFactory
create, create, createArtifactSerializersMap
-
Constructor Details
-
SentenceDetectorFactory
public SentenceDetectorFactory()Creates aSentenceDetectorFactorythat provides the default implementation of the resources. -
SentenceDetectorFactory
public SentenceDetectorFactory(String languageCode, boolean useTokenEnd, Dictionary abbreviationDictionary, char[] eosCharacters) Creates aSentenceDetectorFactory. Use this constructor to programmatically create a factory.- Parameters:
languageCode- The ISO language code to be used for this factory.useTokenEnd-trueifTOKEN_END_PROPERTYshall be used,falseotherwise.abbreviationDictionary- TheDictionarywhich holds abbreviations.eosCharacters- The characters to be used to detect sentence endings.
-
-
Method Details
-
validateArtifactMap
Description copied from class:BaseToolFactoryValidates the parsed artifacts.Note: Subclasses should generally invoke
super.validateArtifactMapat the beginning of this method.- Specified by:
validateArtifactMapin classBaseToolFactory- Throws:
InvalidFormatException- Thrown if validation found invalid states.
-
createArtifactMap
Description copied from class:BaseToolFactoryA model's implementation should call this constructor that creates a model programmatically.The base implementation will return a
HashMapthat should be populated by subclasses.- Overrides:
createArtifactMapin classBaseToolFactory- Returns:
- Retrieves a
Mapwith pairs of keys and objects.
-
createManifestEntries
- Overrides:
createManifestEntriesin classBaseToolFactory- Returns:
- Retrieves the manifest entries to be added to the model manifest.
-
create
public static SentenceDetectorFactory create(String subclassName, String languageCode, boolean useTokenEnd, Dictionary abbrDictionary, char[] eosChars) throws InvalidFormatException Instantiates aSentenceDetectorFactoryvia a givensubclassName.- Parameters:
subclassName- The class name used for instantiation. Ifnull, an instance ofSentenceDetectorFactorywill be returned per default. Otherwise, theExtensionLoadermechanism is applied to load the requestedsubclassName.languageCode- The ISO language code to be used. Must not benull.useTokenEnd-trueifTOKEN_END_PROPERTYshall be set,falseotherwise.abbrDictionary- TheDictionaryof abbreviations if available; may benull.eosChars- An array of characters representing end of sentence symbols / characters.- Returns:
- A valid
SentenceDetectorFactoryinstance. - Throws:
InvalidFormatException- Thrown if theExtensionLoadermechanism failed to create the factory associated withsubclassName.
-
getEOSCharacters
public char[] getEOSCharacters() -
isUseTokenEnd
public boolean isUseTokenEnd() -
getAbbreviationDictionary
- Returns:
- An abbreviation
Dictionaryornullif unset.
-
getLanguageCode
-
getEndOfSentenceScanner
- Returns:
- An
EndOfSentenceScannerinstance, guaranteed to be notnull.
-
getSDContextGenerator
- Returns:
- A
SDContextGeneratorinstance, guaranteed to be notnull.
-