RelatedTerms (EXALEAD CloudView Custom code SDK)

java.lang.Object
- com.exalead.linguistic.v10.SemanticProcessor
- - com.exalead.linguistic.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.linguistic.v10.SemanticProcessor
  SemanticProcessor.Transformer<T>, SemanticProcessor.Visitor

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_KEEP_LONGEST_MATCH`
`static int`	`DEFAULT_MAX_UNKNOWN_WORD_LEN`
`static int`	`DEFAULT_RELATED_TERMS_MAX_SPAN`
`static int`	`DEFAULT_RELATED_TERMS_MIN_SPAN`
`static boolean`	`DEFAULT_WITH_PART_OF_SPEECH`
`java.lang.String`	`dictionaryDirectory`
`boolean`	`keepLongestMatch`
`int`	`maxUnknownWordLen`
`java.lang.String`	`preprocResourceDir`
`int`	`relatedTermsMaxSpan`
`int`	`relatedTermsMinSpan`
`boolean`	`withPartOfSpeech`

Fields inherited from class com.exalead.linguistic.v10.SemanticProcessor
contexts, name, src

Constructor Summary

Constructors
Constructor and Description

RelatedTerms()

RelatedTerms(RelatedTerms o)
Copy constructor

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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`	`getDictionaryDirectory()` URL for the resource of the dictionary used to limit the set of terms (data://, file;// or resource://). If null, the set of extracted terms is not limited.
`int`	`getMaxUnknownWordLen()` Maximum length of unknown words used to build a RelatedTerm.
`java.lang.String`	`getPreprocResourceDir()` URL for the resource (data://, file;// or resource://) if null, uses standard resource of 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).
`boolean`	`isKeepLongestMatch()` Keeps only the longest term when several overlap.
`boolean`	`isWithPartOfSpeech()` If true, a PartOfSpeechTagger is automatically added to the list of processors.
`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`	`setDictionaryDirectory(java.lang.String dictionaryDirectory)` URL for the resource of the dictionary used to limit the set of terms (data://, file;// or resource://). If null, the set of extracted terms is not limited.
`void`	`setKeepLongestMatch(boolean keepLongestMatch)` Keeps only the longest term when several overlap.
`void`	`setMaxUnknownWordLen(int maxUnknownWordLen)` Maximum length of unknown words used to build a RelatedTerm.
`void`	`setPreprocResourceDir(java.lang.String preprocResourceDir)` URL for the resource (data://, file;// or resource://) if null, uses standard resource of 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`	`setWithPartOfSpeech(boolean withPartOfSpeech)` If true, a PartOfSpeechTagger is automatically added to the list of processors.
`java.lang.String`	`toString()` String representation of this RelatedTerms.
`RelatedTerms`	`withContexts(java.lang.String contexts)`
`RelatedTerms`	`withDictionaryDirectory(java.lang.String dictionaryDirectory)`
`RelatedTerms`	`withKeepLongestMatch(boolean keepLongestMatch)`
`RelatedTerms`	`withKeepLongestMatch(java.lang.Boolean keepLongestMatch)`
`RelatedTerms`	`withMaxUnknownWordLen(int maxUnknownWordLen)`
`RelatedTerms`	`withMaxUnknownWordLen(java.lang.Integer maxUnknownWordLen)`
`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`	`withSrc(java.lang.String src)` Deprecated.
`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.linguistic.v10.SemanticProcessor
getContexts, getName, getSrc, setContexts, setName, setSrc

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
  - keepLongestMatch
```
public boolean keepLongestMatch
```
  - DEFAULT_KEEP_LONGEST_MATCH
```
public static final boolean DEFAULT_KEEP_LONGEST_MATCH
```
    See Also:
    
    Constant Field Values
  - dictionaryDirectory
```
public java.lang.String dictionaryDirectory
```
  - preprocResourceDir
```
public java.lang.String preprocResourceDir
```
  - withPartOfSpeech
```
public boolean withPartOfSpeech
```
  - DEFAULT_WITH_PART_OF_SPEECH
```
public static final boolean DEFAULT_WITH_PART_OF_SPEECH
```
    See Also:
    
    Constant Field Values
  - maxUnknownWordLen
```
public int maxUnknownWordLen
```
  - DEFAULT_MAX_UNKNOWN_WORD_LEN
```
public static final int DEFAULT_MAX_UNKNOWN_WORD_LEN
```
    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
  - withSrc
```
@Deprecated
public RelatedTerms withSrc(java.lang.String src)
```
    Deprecated.
    
    Overrides:
    
    withSrc 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)
```
  - setKeepLongestMatch
```
public void setKeepLongestMatch(boolean keepLongestMatch)
```
    Keeps only the longest term when several overlap.
  - isKeepLongestMatch
```
public boolean isKeepLongestMatch()
```
    Keeps only the longest term when several overlap.
  - withKeepLongestMatch
```
public RelatedTerms withKeepLongestMatch(boolean keepLongestMatch)
```
  - withKeepLongestMatch
```
public RelatedTerms withKeepLongestMatch(java.lang.Boolean keepLongestMatch)
```
  - setDictionaryDirectory
```
public void setDictionaryDirectory(java.lang.String dictionaryDirectory)
```
    URL for the resource of the dictionary used to limit the set of terms (data://, file;// or resource://).
    If null, the set of extracted terms is not limited.
  - getDictionaryDirectory
```
public java.lang.String getDictionaryDirectory()
```
    URL for the resource of the dictionary used to limit the set of terms (data://, file;// or resource://).
    If null, the set of extracted terms is not limited.
  - withDictionaryDirectory
```
public RelatedTerms withDictionaryDirectory(java.lang.String dictionaryDirectory)
```
  - setPreprocResourceDir
```
public void setPreprocResourceDir(java.lang.String preprocResourceDir)
```
    URL for the resource (data://, file;// or resource://)
    if null, uses standard resource of product.
  - getPreprocResourceDir
```
public java.lang.String getPreprocResourceDir()
```
    URL for the resource (data://, file;// or resource://)
    if null, uses standard resource of product.
  - withPreprocResourceDir
```
public RelatedTerms withPreprocResourceDir(java.lang.String preprocResourceDir)
```
  - setWithPartOfSpeech
```
public void setWithPartOfSpeech(boolean withPartOfSpeech)
```
    If true, a PartOfSpeechTagger is automatically added to the list of processors.
  - isWithPartOfSpeech
```
public boolean isWithPartOfSpeech()
```
    If true, a PartOfSpeechTagger is automatically added to the list of processors.
  - withWithPartOfSpeech
```
public RelatedTerms withWithPartOfSpeech(boolean withPartOfSpeech)
```
  - withWithPartOfSpeech
```
public RelatedTerms withWithPartOfSpeech(java.lang.Boolean withPartOfSpeech)
```
  - setMaxUnknownWordLen
```
public void setMaxUnknownWordLen(int maxUnknownWordLen)
```
    Maximum length of unknown words used to build a RelatedTerm.
  - getMaxUnknownWordLen
```
public int getMaxUnknownWordLen()
```
    Maximum length of unknown words used to build a RelatedTerm.
  - withMaxUnknownWordLen
```
public RelatedTerms withMaxUnknownWordLen(int maxUnknownWordLen)
```
  - withMaxUnknownWordLen
```
public RelatedTerms withMaxUnknownWordLen(java.lang.Integer maxUnknownWordLen)
```
  - 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

Class RelatedTerms

Nested Class Summary

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

Field Summary

Fields inherited from class com.exalead.linguistic.v10.SemanticProcessor

Constructor Summary

Method Summary

Methods inherited from class com.exalead.linguistic.v10.SemanticProcessor

Methods inherited from class java.lang.Object

Field Detail

relatedTermsMinSpan

DEFAULT_RELATED_TERMS_MIN_SPAN

relatedTermsMaxSpan

DEFAULT_RELATED_TERMS_MAX_SPAN

keepLongestMatch

DEFAULT_KEEP_LONGEST_MATCH

dictionaryDirectory

preprocResourceDir

withPartOfSpeech

DEFAULT_WITH_PART_OF_SPEECH

maxUnknownWordLen

DEFAULT_MAX_UNKNOWN_WORD_LEN

Constructor Detail

RelatedTerms

RelatedTerms

Method Detail

withName

withContexts

withSrc

setRelatedTermsMinSpan

getRelatedTermsMinSpan

withRelatedTermsMinSpan

withRelatedTermsMinSpan

setRelatedTermsMaxSpan

getRelatedTermsMaxSpan

withRelatedTermsMaxSpan

withRelatedTermsMaxSpan

setKeepLongestMatch

isKeepLongestMatch

withKeepLongestMatch

withKeepLongestMatch

setDictionaryDirectory

getDictionaryDirectory

withDictionaryDirectory

setPreprocResourceDir

getPreprocResourceDir

withPreprocResourceDir

setWithPartOfSpeech

isWithPartOfSpeech

withWithPartOfSpeech

withWithPartOfSpeech

setMaxUnknownWordLen

getMaxUnknownWordLen

withMaxUnknownWordLen

withMaxUnknownWordLen

makeCopy

readFrom

writeTo

fromString

toString

check

accept

accept