Package org.carrot2.language

Class EphemeralDictionaries

java.lang.Object

org.carrot2.attrs.AttrComposite

org.carrot2.language.EphemeralDictionaries

All Implemented Interfaces:

AcceptingVisitor

public class EphemeralDictionaries
extends AttrComposite

Ephemeral per-request overrides for the default LanguageComponents passed to the algorithm.

Since:

4.1.0

See Also:

override(LanguageComponents)

Field Summary

Fields

Modifier and Type	Field	Description
AttrObjectArray<LabelFilterDictionary>	labelFilters	Additional label filtering dictionaries (supplying cluster label filters that should be discarded from the output).
AttrObjectArray<StopwordFilterDictionary>	wordFilters	Additional stop word filtering dictionaries (supplying word filters that should be discarded from the input).

Fields inherited from class org.carrot2.attrs.AttrComposite

attributes

Constructor Summary

Constructors

Constructor	Description
EphemeralDictionaries()

Method Summary

Modifier and Type	Method	Description
LanguageComponents	override(LanguageComponents languageComponents)	Override components of the existing LanguageComponents instance with this object's dictionaries.

Methods inherited from class org.carrot2.attrs.AttrComposite

accept

Methods inherited from class java.lang.Object

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

Field Detail

wordFilters

public AttrObjectArray<StopwordFilterDictionary> wordFilters

Additional stop word filtering dictionaries (supplying word filters that should be discarded from the input).

One or more dictionaries can be supplied. The default implementation in DefaultDictionaryImpl supports exact string matching and regular expression patterns.

REST-style example using the default implementation:

"wordFilters": [{
   "exact": ["word1", "word2"],
   "regexp": [
     "(?).+pattern1.+",
     "(?).+[0-9]{2}.+"
   ]
 }]

See Also:

DefaultDictionaryImpl, StopwordFilterDictionary, StopwordFilter

labelFilters

public AttrObjectArray<LabelFilterDictionary> labelFilters

Additional label filtering dictionaries (supplying cluster label filters that should be discarded from the output).

One or more dictionaries can be supplied. The default implementation in DefaultDictionaryImpl supports exact string matching and regular expression patterns.

REST-style example using the default implementation:

"labelFilters": [{
   "exact": ["Cluster Label 1", "Foo Bar"],
   "regexp": [
     "(?).+pattern1.+",
     "(?).+[0-9]{2}.+"
   ]
 }]

See Also:

DefaultDictionaryImpl, LabelFilterDictionary, LabelFilter

Constructor Detail

EphemeralDictionaries

public EphemeralDictionaries()

Method Detail

override

public LanguageComponents override(LanguageComponents languageComponents)

Override components of the existing LanguageComponents instance with this object's dictionaries.