com.exalead.indexing.analysis.v10

Class RelatedTerms

java.lang.Object

com.exalead.indexing.analysis.v10.SemanticProcessor

com.exalead.indexing.analysis.v10.RelatedTerms

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class RelatedTerms
extends SemanticProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Extracts all possible related terms.
Only one instance of this processor may exist per input context. Annotations generated:

• "relatedTerm": RelatedTerm identifier (stored in the dictionary and in the index)
• "relatedTermDisplay": display form of the RelatedTerm (stored in the dictionary)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

SemanticProcessor.FromDataModel, SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	blacklistResource
static boolean	DEFAULT_KEEP_LONGEST_MATCH
static int	DEFAULT_MAX_RELATED_TERMS_PER_DOC
static int	DEFAULT_RELATED_TERMS_MAX_SPAN
static int	DEFAULT_RELATED_TERMS_MIN_SPAN
static boolean	DEFAULT_WITH_PART_OF_SPEECH
java.lang.String	dictionaryName
boolean	keepLongestMatch
int	maxRelatedTermsPerDoc
java.lang.String	preprocResourceDir
int	relatedTermsMaxSpan
int	relatedTermsMinSpan
java.lang.String	whitelistResource
boolean	withPartOfSpeech

Fields inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

contexts, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
RelatedTerms()
RelatedTerms(RelatedTerms o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(SemanticProcessor.Transformer<T> transformer, T[] t)
void	accept(SemanticProcessor.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this RelatedTerms.
static RelatedTerms	fromString(java.lang.String s) String representation of this RelatedTerms.
java.lang.String	getBlacklistResource() Path to a related terms blocklist resource.
java.lang.String	getDictionaryName() Name of the dictionary populated by terms extracted by this processor. If null, use the default dictionary.
int	getMaxRelatedTermsPerDoc() The maximum number of related terms per document.
java.lang.String	getPreprocResourceDir() URL for the resource of the related terms preprocessor (data://, file;// or resource://). If null, we use the standard preprocessor of the product.
int	getRelatedTermsMaxSpan() Maximum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list).
int	getRelatedTermsMinSpan() Minimum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list).
java.lang.String	getWhitelistResource() Path to a related terms allow list resource.
boolean	isKeepLongestMatch() Keeps only the longest term when several overlap. For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e', this option will only keep 'b-c-d' and remove all other related terms.
boolean	isWithPartOfSpeech() Adds a PartOfSpeechTagger to the list of processors automatically.
RelatedTerms	makeCopy() Creates and returns a deep copy of this RelatedTerms.
static RelatedTerms	readFrom(java.io.InputStream is) Read this RelatedTerms from an XML fragment.
void	setBlacklistResource(java.lang.String blacklistResource) Path to a related terms blocklist resource.
void	setDictionaryName(java.lang.String dictionaryName) Name of the dictionary populated by terms extracted by this processor. If null, use the default dictionary.
void	setKeepLongestMatch(boolean keepLongestMatch) Keeps only the longest term when several overlap. For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e', this option will only keep 'b-c-d' and remove all other related terms.
void	setMaxRelatedTermsPerDoc(int maxRelatedTermsPerDoc) The maximum number of related terms per document.
void	setPreprocResourceDir(java.lang.String preprocResourceDir) URL for the resource of the related terms preprocessor (data://, file;// or resource://). If null, we use the standard preprocessor of the product.
void	setRelatedTermsMaxSpan(int relatedTermsMaxSpan) Maximum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list).
void	setRelatedTermsMinSpan(int relatedTermsMinSpan) Minimum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list).
void	setWhitelistResource(java.lang.String whitelistResource) Path to a related terms allow list resource.
void	setWithPartOfSpeech(boolean withPartOfSpeech) Adds a PartOfSpeechTagger to the list of processors automatically.
java.lang.String	toString() String representation of this RelatedTerms.
RelatedTerms	withBlacklistResource(java.lang.String blacklistResource)
RelatedTerms	withContexts(java.lang.String contexts)
RelatedTerms	withDataModelClass(java.lang.String dataModelClass)
RelatedTerms	withDataModelProperty(java.lang.String dataModelProperty)
RelatedTerms	withDataModelState(java.lang.String dataModelState)
RelatedTerms	withDictionaryName(java.lang.String dictionaryName)
RelatedTerms	withDisabled(boolean disabled)
RelatedTerms	withDisabled(java.lang.Boolean disabled)
RelatedTerms	withFromDataModel(SemanticProcessor fromDataModel)
RelatedTerms	withKeepLongestMatch(boolean keepLongestMatch)
RelatedTerms	withKeepLongestMatch(java.lang.Boolean keepLongestMatch)
RelatedTerms	withMaxRelatedTermsPerDoc(int maxRelatedTermsPerDoc)
RelatedTerms	withMaxRelatedTermsPerDoc(java.lang.Integer maxRelatedTermsPerDoc)
RelatedTerms	withName(java.lang.String name)
RelatedTerms	withPreprocResourceDir(java.lang.String preprocResourceDir)
RelatedTerms	withRelatedTermsMaxSpan(int relatedTermsMaxSpan)
RelatedTerms	withRelatedTermsMaxSpan(java.lang.Integer relatedTermsMaxSpan)
RelatedTerms	withRelatedTermsMinSpan(int relatedTermsMinSpan)
RelatedTerms	withRelatedTermsMinSpan(java.lang.Integer relatedTermsMinSpan)
RelatedTerms	withWhitelistResource(java.lang.String whitelistResource)
RelatedTerms	withWithPartOfSpeech(boolean withPartOfSpeech)
RelatedTerms	withWithPartOfSpeech(java.lang.Boolean withPartOfSpeech)
void	writeTo(java.io.OutputStream os) Write this RelatedTerms as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.SemanticProcessor

getContexts, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setContexts, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

relatedTermsMinSpan

public int relatedTermsMinSpan

DEFAULT_RELATED_TERMS_MIN_SPAN

public static final int DEFAULT_RELATED_TERMS_MIN_SPAN

See Also:

Constant Field Values

relatedTermsMaxSpan

public int relatedTermsMaxSpan

DEFAULT_RELATED_TERMS_MAX_SPAN

public static final int DEFAULT_RELATED_TERMS_MAX_SPAN

See Also:

Constant Field Values

maxRelatedTermsPerDoc

public int maxRelatedTermsPerDoc

DEFAULT_MAX_RELATED_TERMS_PER_DOC

public static final int DEFAULT_MAX_RELATED_TERMS_PER_DOC

See Also:

Constant Field Values

keepLongestMatch

public boolean keepLongestMatch

DEFAULT_KEEP_LONGEST_MATCH

public static final boolean DEFAULT_KEEP_LONGEST_MATCH

See Also:

Constant Field Values

dictionaryName

public java.lang.String dictionaryName

preprocResourceDir

public java.lang.String preprocResourceDir

whitelistResource

public java.lang.String whitelistResource

blacklistResource

public java.lang.String blacklistResource

withPartOfSpeech

public boolean withPartOfSpeech

DEFAULT_WITH_PART_OF_SPEECH

public static final boolean DEFAULT_WITH_PART_OF_SPEECH

See Also:

Constant Field Values

Constructor Detail

RelatedTerms

public RelatedTerms()

RelatedTerms

public RelatedTerms(RelatedTerms o)

Copy constructor

Method Detail

withName

public RelatedTerms withName(java.lang.String name)

Overrides:

withName in class SemanticProcessor

withContexts

public RelatedTerms withContexts(java.lang.String contexts)

Overrides:

withContexts in class SemanticProcessor

withFromDataModel

public RelatedTerms withFromDataModel(SemanticProcessor fromDataModel)

withDataModelState

public RelatedTerms withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SemanticProcessor

withDataModelClass

public RelatedTerms withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SemanticProcessor

withDataModelProperty

public RelatedTerms withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SemanticProcessor

withDisabled

public RelatedTerms withDisabled(boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

withDisabled

public RelatedTerms withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SemanticProcessor

setRelatedTermsMinSpan

public void setRelatedTermsMinSpan(int relatedTermsMinSpan)

Minimum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list).

getRelatedTermsMinSpan

public int getRelatedTermsMinSpan()

Minimum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list).

withRelatedTermsMinSpan

public RelatedTerms withRelatedTermsMinSpan(int relatedTermsMinSpan)

withRelatedTermsMinSpan

public RelatedTerms withRelatedTermsMinSpan(java.lang.Integer relatedTermsMinSpan)

setRelatedTermsMaxSpan

public void setRelatedTermsMaxSpan(int relatedTermsMaxSpan)

Maximum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list).

getRelatedTermsMaxSpan

public int getRelatedTermsMaxSpan()

Maximum number of words (excluding stop words) in an automatically extracted term (not applicable to allow list).

withRelatedTermsMaxSpan

public RelatedTerms withRelatedTermsMaxSpan(int relatedTermsMaxSpan)

withRelatedTermsMaxSpan

public RelatedTerms withRelatedTermsMaxSpan(java.lang.Integer relatedTermsMaxSpan)

setMaxRelatedTermsPerDoc

public void setMaxRelatedTermsPerDoc(int maxRelatedTermsPerDoc)

The maximum number of related terms per document.

getMaxRelatedTermsPerDoc

public int getMaxRelatedTermsPerDoc()

The maximum number of related terms per document.

withMaxRelatedTermsPerDoc

public RelatedTerms withMaxRelatedTermsPerDoc(int maxRelatedTermsPerDoc)

withMaxRelatedTermsPerDoc

public RelatedTerms withMaxRelatedTermsPerDoc(java.lang.Integer maxRelatedTermsPerDoc)

setKeepLongestMatch

public void setKeepLongestMatch(boolean keepLongestMatch)

Keeps only the longest term when several overlap.
For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e', this option will only keep 'b-c-d' and remove all other related terms.

isKeepLongestMatch

public boolean isKeepLongestMatch()

Keeps only the longest term when several overlap.
For example, if you have 5 tokens ('a', 'b', 'c', 'd', 'e') and 4 related terms 'a', 'a-c', 'b-c-d' and 'd-e', this option will only keep 'b-c-d' and remove all other related terms.

withKeepLongestMatch

public RelatedTerms withKeepLongestMatch(boolean keepLongestMatch)

withKeepLongestMatch

public RelatedTerms withKeepLongestMatch(java.lang.Boolean keepLongestMatch)

setDictionaryName

public void setDictionaryName(java.lang.String dictionaryName)

Name of the dictionary populated by terms extracted by this processor.
If null, use the default dictionary.

getDictionaryName

public java.lang.String getDictionaryName()

Name of the dictionary populated by terms extracted by this processor.
If null, use the default dictionary.

withDictionaryName

public RelatedTerms withDictionaryName(java.lang.String dictionaryName)

setPreprocResourceDir

public void setPreprocResourceDir(java.lang.String preprocResourceDir)

URL for the resource of the related terms preprocessor (data://, file;// or resource://).
If null, we use the standard preprocessor of the product.

getPreprocResourceDir

public java.lang.String getPreprocResourceDir()

URL for the resource of the related terms preprocessor (data://, file;// or resource://).
If null, we use the standard preprocessor of the product.

withPreprocResourceDir

public RelatedTerms withPreprocResourceDir(java.lang.String preprocResourceDir)

setWhitelistResource

public void setWhitelistResource(java.lang.String whitelistResource)

Path to a related terms allow list resource.

getWhitelistResource

public java.lang.String getWhitelistResource()

Path to a related terms allow list resource.

withWhitelistResource

public RelatedTerms withWhitelistResource(java.lang.String whitelistResource)

setBlacklistResource

public void setBlacklistResource(java.lang.String blacklistResource)

Path to a related terms blocklist resource.

getBlacklistResource

public java.lang.String getBlacklistResource()

Path to a related terms blocklist resource.

withBlacklistResource

public RelatedTerms withBlacklistResource(java.lang.String blacklistResource)

setWithPartOfSpeech

public void setWithPartOfSpeech(boolean withPartOfSpeech)

Adds a PartOfSpeechTagger to the list of processors automatically. Improves quality of automatically extracted terms.

isWithPartOfSpeech

public boolean isWithPartOfSpeech()

Adds a PartOfSpeechTagger to the list of processors automatically. Improves quality of automatically extracted terms.

withWithPartOfSpeech

public RelatedTerms withWithPartOfSpeech(boolean withPartOfSpeech)

withWithPartOfSpeech

public RelatedTerms withWithPartOfSpeech(java.lang.Boolean withPartOfSpeech)

makeCopy

public RelatedTerms makeCopy()

Creates and returns a deep copy of this RelatedTerms.

Overrides:

makeCopy in class SemanticProcessor

readFrom

public static RelatedTerms readFrom(java.io.InputStream is)
                             throws javax.xml.bind.JAXBException

Read this RelatedTerms from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this RelatedTerms as an XML fragment

Overrides:

writeTo in class SemanticProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static RelatedTerms fromString(java.lang.String s)
                               throws javax.xml.bind.JAXBException,
                                      java.io.UnsupportedEncodingException

String representation of this RelatedTerms.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RelatedTerms.

Overrides:

toString in class SemanticProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this RelatedTerms.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public void accept(SemanticProcessor.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(SemanticProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class SemanticProcessor

Throws:

com.exalead.util.TypedException