Package com.gengoai.hermes.format
Class DocFormatParameters
- java.lang.Object
-
- com.gengoai.ParamMap<DocFormatParameters>
-
- com.gengoai.hermes.format.DocFormatParameters
-
- All Implemented Interfaces:
Copyable<DocFormatParameters>
,Serializable
- Direct Known Subclasses:
CoNLLFormat.CoNLLParameters
,CsvFormat.CSVParameters
,TaggedFormat.TaggedParameters
public class DocFormatParameters extends ParamMap<DocFormatParameters>
The type Doc format parameters.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.gengoai.ParamMap
ParamMap.Parameter<T extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static ParameterDef<Language>
DEFAULT_LANGUAGE
Defines the default language for new documentsParamMap.Parameter<Language>
defaultLanguage
The default language for new documents.ParamMap.Parameter<Boolean>
distributed
Creates a distributed document collection when the value is set to true (default false).static ParameterDef<Boolean>
DISTRIBUTED
Defines if a document collection should be distributed (true) or local (false)ParamMap.Parameter<List<TextNormalizer>>
normalizers
The class names of the text normalizes to use when constructing documents.static ParameterDef<List<TextNormalizer>>
NORMALIZERS
Defines the text normalization to use when constructing documentsstatic ParameterDef<SaveMode>
SAVE_MODE
Defines theSaveMode
when writing a CorpusParamMap.Parameter<SaveMode>
saveMode
Whether to overwrite, ignore, or throw an error when writing a corpus to an existing file/directory (default ERROR).
-
Constructor Summary
Constructors Constructor Description DocFormatParameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentFactory
getDocumentFactory()
-
Methods inherited from class com.gengoai.ParamMap
as, copy, get, get, getOrDefault, getOrDefault, getParam, parameter, parameterNames, set, set, setAll, toString, update
-
-
-
-
Field Detail
-
DEFAULT_LANGUAGE
public static final ParameterDef<Language> DEFAULT_LANGUAGE
Defines the default language for new documents
-
DISTRIBUTED
public static final ParameterDef<Boolean> DISTRIBUTED
Defines if a document collection should be distributed (true) or local (false)
-
NORMALIZERS
public static final ParameterDef<List<TextNormalizer>> NORMALIZERS
Defines the text normalization to use when constructing documents
-
SAVE_MODE
public static final ParameterDef<SaveMode> SAVE_MODE
Defines theSaveMode
when writing a Corpus
-
saveMode
public final ParamMap.Parameter<SaveMode> saveMode
Whether to overwrite, ignore, or throw an error when writing a corpus to an existing file/directory (default ERROR).
-
distributed
public final ParamMap.Parameter<Boolean> distributed
Creates a distributed document collection when the value is set to true (default false).
-
defaultLanguage
public final ParamMap.Parameter<Language> defaultLanguage
The default language for new documents. (default calls Hermes.defaultLanguage())
-
normalizers
public final ParamMap.Parameter<List<TextNormalizer>> normalizers
The class names of the text normalizes to use when constructing documents. (default calls TextNormalization.configuredInstance().getPreprocessors())
-
-
Method Detail
-
getDocumentFactory
public DocumentFactory getDocumentFactory()
- Returns:
- Creates a document factory based on the this set of parameters
-
-