RelatedTermModule (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.search.v20.QueryExpansionModule
- - com.exalead.mercury.mami.search.v20.RelatedTermModule

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class RelatedTermModule
extends QueryExpansionModule
implements com.exalead.util.Checkable, java.io.Serializable
```
Expands the query using related terms.
Related terms are popular ngrams detected at indexing time. They allow to match popular concepts spanning several words.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule
  QueryExpansionModule.Transformer<T>, QueryExpansionModule.Visitor

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_KEEP_LONGEST_MATCH`
`static int`	`DEFAULT_MAX_SPAN`
`static int`	`DEFAULT_MIN_SPAN`
`static boolean`	`DEFAULT_WITH_PART_OF_SPEECH`
`boolean`	`keepLongestMatch`
`int`	`maxSpan`
`int`	`minSpan`
`boolean`	`withPartOfSpeech`

Fields inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule
name

Constructor Summary

Constructors
Constructor and Description

RelatedTermModule()

RelatedTermModule(RelatedTermModule o)
Copy constructor

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`accept(QueryExpansionModule.Transformer<T> transformer, T[] t)`
`void`	`accept(QueryExpansionModule.Visitor visitor)`
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this RelatedTermModule.
`static RelatedTermModule`	`fromString(java.lang.String s)` String representation of this RelatedTermModule.
`int`	`getMaxSpan()` Maximal number of words (excluding stop words) in a generated related term.
`int`	`getMinSpan()` Minimum number of words (excluding stop words) in a generated related term.
`boolean`	`isKeepLongestMatch()` Keeps only the longest match. 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'.
`boolean`	`isWithPartOfSpeech()` Automatically adds a PartOfSpeechTagger to the list of processors.
`RelatedTermModule`	`makeCopy()` Creates and returns a deep copy of this RelatedTermModule.
`static RelatedTermModule`	`readFrom(java.io.InputStream is)` Read this RelatedTermModule from an XML fragment.
`void`	`setKeepLongestMatch(boolean keepLongestMatch)` Keeps only the longest match. 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'.
`void`	`setMaxSpan(int maxSpan)` Maximal number of words (excluding stop words) in a generated related term.
`void`	`setMinSpan(int minSpan)` Minimum number of words (excluding stop words) in a generated related term.
`void`	`setWithPartOfSpeech(boolean withPartOfSpeech)` Automatically adds a PartOfSpeechTagger to the list of processors.
`java.lang.String`	`toString()` String representation of this RelatedTermModule.
`RelatedTermModule`	`withKeepLongestMatch(boolean keepLongestMatch)`
`RelatedTermModule`	`withKeepLongestMatch(java.lang.Boolean keepLongestMatch)`
`RelatedTermModule`	`withMaxSpan(int maxSpan)`
`RelatedTermModule`	`withMaxSpan(java.lang.Integer maxSpan)`
`RelatedTermModule`	`withMinSpan(int minSpan)`
`RelatedTermModule`	`withMinSpan(java.lang.Integer minSpan)`
`RelatedTermModule`	`withName(java.lang.String name)`
`RelatedTermModule`	`withWithPartOfSpeech(boolean withPartOfSpeech)`
`RelatedTermModule`	`withWithPartOfSpeech(java.lang.Boolean withPartOfSpeech)`
`void`	`writeTo(java.io.OutputStream os)` Write this RelatedTermModule as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule
getName, setName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - minSpan
```
public int minSpan
```
  - DEFAULT_MIN_SPAN
```
public static final int DEFAULT_MIN_SPAN
```
    See Also:
    
    Constant Field Values
  - maxSpan
```
public int maxSpan
```
  - DEFAULT_MAX_SPAN
```
public static final int DEFAULT_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
  - 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
  - RelatedTermModule
```
public RelatedTermModule()
```
  - RelatedTermModule
```
public RelatedTermModule(RelatedTermModule o)
```
    Copy constructor
- Method Detail
  - withName
```
public RelatedTermModule withName(java.lang.String name)
```
    Overrides:
    
    withName in class QueryExpansionModule
  - setMinSpan
```
public void setMinSpan(int minSpan)
```
    Minimum number of words (excluding stop words) in a generated related term.
  - getMinSpan
```
public int getMinSpan()
```
    Minimum number of words (excluding stop words) in a generated related term.
  - withMinSpan
```
public RelatedTermModule withMinSpan(int minSpan)
```
  - withMinSpan
```
public RelatedTermModule withMinSpan(java.lang.Integer minSpan)
```
  - setMaxSpan
```
public void setMaxSpan(int maxSpan)
```
    Maximal number of words (excluding stop words) in a generated related term.
  - getMaxSpan
```
public int getMaxSpan()
```
    Maximal number of words (excluding stop words) in a generated related term.
  - withMaxSpan
```
public RelatedTermModule withMaxSpan(int maxSpan)
```
  - withMaxSpan
```
public RelatedTermModule withMaxSpan(java.lang.Integer maxSpan)
```
  - setKeepLongestMatch
```
public void setKeepLongestMatch(boolean keepLongestMatch)
```
    Keeps only the longest match.
    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 will remove all other related terms.
  - isKeepLongestMatch
```
public boolean isKeepLongestMatch()
```
    Keeps only the longest match.
    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 will remove all other related terms.
  - withKeepLongestMatch
```
public RelatedTermModule withKeepLongestMatch(boolean keepLongestMatch)
```
  - withKeepLongestMatch
```
public RelatedTermModule withKeepLongestMatch(java.lang.Boolean keepLongestMatch)
```
  - setWithPartOfSpeech
```
public void setWithPartOfSpeech(boolean withPartOfSpeech)
```
    Automatically adds a PartOfSpeechTagger to the list of processors.
  - isWithPartOfSpeech
```
public boolean isWithPartOfSpeech()
```
    Automatically adds a PartOfSpeechTagger to the list of processors.
  - withWithPartOfSpeech
```
public RelatedTermModule withWithPartOfSpeech(boolean withPartOfSpeech)
```
  - withWithPartOfSpeech
```
public RelatedTermModule withWithPartOfSpeech(java.lang.Boolean withPartOfSpeech)
```
  - makeCopy
```
public RelatedTermModule makeCopy()
```
    Creates and returns a deep copy of this RelatedTermModule.
    
    Overrides:
    
    makeCopy in class QueryExpansionModule
  - readFrom
```
public static RelatedTermModule readFrom(java.io.InputStream is)
                                  throws javax.xml.bind.JAXBException
```
    Read this RelatedTermModule 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 RelatedTermModule as an XML fragment
    
    Overrides:
    
    writeTo in class QueryExpansionModule
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static RelatedTermModule fromString(java.lang.String s)
                                    throws javax.xml.bind.JAXBException,
                                           java.io.UnsupportedEncodingException
```
    String representation of this RelatedTermModule.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this RelatedTermModule.
    
    Overrides:
    
    toString in class QueryExpansionModule
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this RelatedTermModule.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Overrides:
    
    check in class QueryExpansionModule
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public void accept(QueryExpansionModule.Visitor visitor)
            throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class QueryExpansionModule
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public <T> T accept(QueryExpansionModule.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class QueryExpansionModule
    
    Throws:
    
    com.exalead.util.TypedException

Class RelatedTermModule

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

Field Summary

Fields inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

Constructor Summary

Method Summary

Methods inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

Methods inherited from class java.lang.Object

Field Detail

minSpan

DEFAULT_MIN_SPAN

maxSpan

DEFAULT_MAX_SPAN

keepLongestMatch

DEFAULT_KEEP_LONGEST_MATCH

withPartOfSpeech

DEFAULT_WITH_PART_OF_SPEECH

Constructor Detail

RelatedTermModule

RelatedTermModule

Method Detail

withName

setMinSpan

getMinSpan

withMinSpan

withMinSpan

setMaxSpan

getMaxSpan

withMaxSpan

withMaxSpan

setKeepLongestMatch

isKeepLongestMatch

withKeepLongestMatch

withKeepLongestMatch

setWithPartOfSpeech

isWithPartOfSpeech

withWithPartOfSpeech

withWithPartOfSpeech

makeCopy

readFrom

writeTo

fromString

toString

check

accept

accept