PhraseNear (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.search.query.phrase.Phrase
- - com.attivio.sdk.search.query.phrase.PhraseNear

All Implemented Interfaces:

Serializable, Cloneable
```
public final class PhraseNear
extends Phrase
```
Phrase for matching terms that are proximal to each other.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.attivio.sdk.search.query.phrase.Phrase
  Phrase.Parameter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MINIMUM` Default minimum.
`static int`	`DEFAULT_NEAR_DISTANCE` Default distance for near/onear phrases.
`static int`	`MAX_DISTANCE` Maximum distance allowed.
`static int`	`MIN_DISTANCE` Minimum distance allowed.
`static int`	`REQUIRE_ALL_DISTANCE` Distance for require all phrases.
`protected List<Phrase>`	`terms` List of terms for matching.

Fields inherited from class com.attivio.sdk.search.query.phrase.Phrase
parameters

Constructor Summary

Constructors
Constructor and Description
`PhraseNear()` Constructor
`PhraseNear(boolean ordered, int distance)` Constructor
`PhraseNear(List<Phrase> terms)` Constructor
`PhraseNear(Phrase... terms)` Constructor
`PhraseNear(Phrase[] terms, int offset, int length)` Constructor
`PhraseNear(String... terms)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTerm(Phrase term)` Add `term` to this phrase.
`void`	`addTerm(String term)` Add a `SearchTerm` to this phrase.
`void`	`addTerms(List<Phrase> terms)` Add `terms` to this phrase.
`void`	`addTerms(Phrase[] terms)` Add `terms` to this phrase.
`void`	`addTerms(Phrase[] terms, int offset, int length)` Add
`PhraseNear`	`append(Phrase... terms)`
`PhraseNear`	`append(Phrase term)`
`PhraseNear`	`append(String... terms)`
`PhraseNear`	`append(String term)`
`PhraseNear`	`clone()`
`protected Phrase`	`clone(Phrase[] terms, int length)` Clone to facilitate rewrite().
`boolean`	`equals(Object other)`
`int`	`getDistance()` Get the maximum amount of distance allowed between the first and last matching term.
`int`	`getEndOffset()` Get the end offset (0 indexed, exclusive) for this term in the original query string.
`int`	`getMinimum()` Get the minimum number of sub phrases that are required to produce a match.
`int`	`getStartOffset()` Get the start offset (0 indexed, inclusive) for this term in the original query string.
`List<Phrase>`	`getTerms()` Get the terms for this phrase.
`int`	`hashCode()`
`boolean`	`isExactPhrase()` Returns true if this phrase requires all terms to be adjacent and in order.
`boolean`	`isOrdered()` Get if terms in phrase must be in order.
`boolean`	`isRequireAll()` Returns true if this phrase is a "require all" phrase.
`static PhraseNear`	`near()` Create a near (with default distance).
`static PhraseNear`	`near(Phrase... terms)` Create a near (with default distance).
`static PhraseNear`	`near(Phrase[] terms, int offset, int length)` Create a near (with default distance).
`static PhraseNear`	`near(Phrase a, Phrase b, int distance)` Create a near between 2 terms with specified distance.
`static PhraseNear`	`near(String... terms)` Create a near (with default distance).
`static PhraseNear`	`onear()` Create an onear (with default distance).
`static PhraseNear`	`onear(Phrase... terms)` Create an onear (with default distance).
`static PhraseNear`	`onear(Phrase[] terms, int offset, int length)` Create an onear (with default distance).
`static PhraseNear`	`onear(Phrase a, Phrase b, int distance)` Create an onear between 2 terms with specified distance.
`static PhraseNear`	`onear(String... terms)` Create an onear (with default distance).
`static PhraseNear`	`phrase()` Create an exact phrase.
`static PhraseNear`	`phrase(Phrase... terms)` Create an exact phrase.
`static PhraseNear`	`phrase(Phrase[] terms, int offset, int length)` Create an exact phrase.
`static PhraseNear`	`phrase(String... terms)` Create an exact phrase.
`static PhraseNear`	`requireAll()` Create a require all.
`static PhraseNear`	`requireAll(Phrase... terms)` Create a require all.
`static PhraseNear`	`requireAll(String... terms)` Create a require all.
`Phrase`	`rewrite(PhraseHandler handler)` Recursively rewrite this phrase using `handler`.
`Phrase`	`rewriteChildren(PhraseHandler handler)` Rewrite any children of this phrase using `handler`.
`void`	`setDistance(int value)` Set the maximum amount of distance allowed between the first and last matching term.
`void`	`setMinimum(int value)` Set the minimum number of sub phrases that are required to produce a match.
`void`	`setOrdered(boolean value)` Set if terms in phrase must be in order.
`void`	`setParameter(String name, Object value)` Set parameter `name` to `value`.
`void`	`setTerms(List<Phrase> value)` Set the terms for this phrase.
`void`	`setTerms(Phrase... args)` Set the terms for this phrase.
`void`	`setTerms(String... args)` Set the terms for this phrase.
`int`	`size()` Get the number of terms in this phrase.
`void`	`toString(StringBuilder buffer, boolean compact)` Appends the string representation of this query to `buffer`.

Methods inherited from class com.attivio.sdk.search.query.phrase.Phrase
containsParameters, containsParameters, copyParameters, getBoost, getParameter, getParameter, getParameter, getParameter, getParameterInternal, isMatchAll, parameters, parseIntParameter, removeParameter, setBoost, setParameters, toArray, toString, toString

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

- Field Detail
  - DEFAULT_MINIMUM
```
public static final int DEFAULT_MINIMUM
```
    Default minimum.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NEAR_DISTANCE
```
public static final int DEFAULT_NEAR_DISTANCE
```
    Default distance for near/onear phrases.
    
    See Also:
    
    Constant Field Values
  - REQUIRE_ALL_DISTANCE
```
public static final int REQUIRE_ALL_DISTANCE
```
    Distance for require all phrases.
    Require all phrases place no restriction on distance between terms in phrase.
    
    See Also:
    
    Constant Field Values
  - MAX_DISTANCE
```
public static final int MAX_DISTANCE
```
    Maximum distance allowed.
    Distances equal to are larger than this will be treated as a require all phrase.
    
    See Also:
    
    Constant Field Values
  - MIN_DISTANCE
```
public static final int MIN_DISTANCE
```
    Minimum distance allowed.
    Distances equal to or less than this will be treated as a require all phrase.
    
    See Also:
    
    Constant Field Values
  - terms
```
protected List<Phrase> terms
```
    List of terms for matching.
- Constructor Detail
  - PhraseNear
```
public PhraseNear()
```
    Constructor
  - PhraseNear
```
public PhraseNear(boolean ordered,
                  int distance)
```
    Constructor
  - PhraseNear
```
public PhraseNear(String... terms)
```
    Constructor
  - PhraseNear
```
public PhraseNear(Phrase... terms)
```
    Constructor
  - PhraseNear
```
public PhraseNear(Phrase[] terms,
                  int offset,
                  int length)
```
    Constructor
  - PhraseNear
```
public PhraseNear(List<Phrase> terms)
```
    Constructor
- Method Detail
  - setParameter
```
public void setParameter(String name,
                         Object value)
```
    Set parameter name to value.
    NOTE: name is case insensitive.
    
    Overrides:
    
    setParameter in class Phrase
  - isOrdered
```
public boolean isOrdered()
```
    Get if terms in phrase must be in order.
  - setOrdered
```
public void setOrdered(boolean value)
```
    Set if terms in phrase must be in order.
  - getDistance
```
public int getDistance()
```
    Get the maximum amount of distance allowed between the first and last matching term.
    If this is 0, then all terms in this phrase must be adjacent to each other.
  - setDistance
```
public void setDistance(int value)
```
    Set the maximum amount of distance allowed between the first and last matching term.
  - getMinimum
```
public int getMinimum()
```
    Get the minimum number of sub phrases that are required to produce a match.
    If this is 0, then all sub phrases are required for a match.
    
    NOTE: minimum is not supported for ordered phrases.
  - setMinimum
```
public void setMinimum(int value)
```
    Set the minimum number of sub phrases that are required to produce a match.
    If this is 0, then all sub phrases are required for a match.
    
    NOTE: minimum is not supported for ordered phrases.
  - isExactPhrase
```
public boolean isExactPhrase()
```
    Returns true if this phrase requires all terms to be adjacent and in order.
  - isRequireAll
```
public boolean isRequireAll()
```
    Returns true if this phrase is a "require all" phrase.
    Require all phrases place no restriction on ordering of terms or distance between terms.
  - append
```
public PhraseNear append(String term)
```
  - append
```
public PhraseNear append(String... terms)
```
  - append
```
public PhraseNear append(Phrase term)
```
  - append
```
public PhraseNear append(Phrase... terms)
```
  - hashCode
```
public int hashCode()
```
  - equals
```
public boolean equals(Object other)
```
  - clone
```
public PhraseNear clone()
```
  - clone
```
protected Phrase clone(Phrase[] terms,
                       int length)
```
    Clone to facilitate rewrite().
  - toString
```
public void toString(StringBuilder buffer,
                     boolean compact)
```
    Appends the string representation of this query to buffer.
    
    Specified by:
    
    toString in class Phrase
  - requireAll
```
public static PhraseNear requireAll()
```
    Create a require all.
  - requireAll
```
public static PhraseNear requireAll(Phrase... terms)
```
    Create a require all.
  - requireAll
```
public static PhraseNear requireAll(String... terms)
```
    Create a require all.
  - phrase
```
public static PhraseNear phrase()
```
    Create an exact phrase.
  - phrase
```
public static PhraseNear phrase(Phrase... terms)
```
    Create an exact phrase.
  - phrase
```
public static PhraseNear phrase(Phrase[] terms,
                                int offset,
                                int length)
```
    Create an exact phrase.
  - phrase
```
public static PhraseNear phrase(String... terms)
```
    Create an exact phrase.
  - near
```
public static PhraseNear near()
```
    Create a near (with default distance).
  - near
```
public static PhraseNear near(Phrase... terms)
```
    Create a near (with default distance).
  - near
```
public static PhraseNear near(Phrase[] terms,
                              int offset,
                              int length)
```
    Create a near (with default distance).
  - near
```
public static PhraseNear near(Phrase a,
                              Phrase b,
                              int distance)
```
    Create a near between 2 terms with specified distance.
  - near
```
public static PhraseNear near(String... terms)
```
    Create a near (with default distance).
  - onear
```
public static PhraseNear onear()
```
    Create an onear (with default distance).
  - onear
```
public static PhraseNear onear(Phrase... terms)
```
    Create an onear (with default distance).
  - onear
```
public static PhraseNear onear(Phrase[] terms,
                               int offset,
                               int length)
```
    Create an onear (with default distance).
  - onear
```
public static PhraseNear onear(Phrase a,
                               Phrase b,
                               int distance)
```
    Create an onear between 2 terms with specified distance.
  - onear
```
public static PhraseNear onear(String... terms)
```
    Create an onear (with default distance).
  - getStartOffset
```
public int getStartOffset()
```
    Description copied from class: Phrase
    
    Get the start offset (0 indexed, inclusive) for this term in the original query string.
    This value is set during parsing and indicates the start offset into the original query string that this term represents. In general, offsets should not be set/modified by query transformers and it is recommended that start and end offsets are set to zero when cloning.
    
    NOTE: if Phrase.getStartOffset() == Phrase.getEndOffset(), this indicates that the term did not come from a parsed query string.
    
    Specified by:
    
    getStartOffset in class Phrase
  - getEndOffset
```
public int getEndOffset()
```
    Description copied from class: Phrase
    
    Get the end offset (0 indexed, exclusive) for this term in the original query string.
    This value is set during parsing and indicates the end offset of the original query string that this term represents. In general, offsets should not be set/modified by query transformers and it is recommended that start and end offsets are set to zero when cloning.
    
    NOTE: if Phrase.getStartOffset() == Phrase.getEndOffset(), this indicates that the term did not come from a parsed query string.
    
    Specified by:
    
    getEndOffset in class Phrase
  - size
```
public int size()
```
    Get the number of terms in this phrase.
  - getTerms
```
public List<Phrase> getTerms()
```
    Get the terms for this phrase.
  - setTerms
```
public void setTerms(List<Phrase> value)
```
    Set the terms for this phrase.
  - setTerms
```
public void setTerms(String... args)
```
    Set the terms for this phrase.
  - setTerms
```
public void setTerms(Phrase... args)
```
    Set the terms for this phrase.
  - addTerm
```
public void addTerm(String term)
```
    Add a SearchTerm to this phrase.
  - addTerm
```
public void addTerm(Phrase term)
```
    Add term to this phrase.
  - addTerms
```
public void addTerms(Phrase[] terms)
```
    Add terms to this phrase.
  - addTerms
```
public void addTerms(Phrase[] terms,
                     int offset,
                     int length)
```
    Add
    length terms from terms starting at offset.
  - addTerms
```
public void addTerms(List<Phrase> terms)
```
    Add terms to this phrase.
  - rewrite
```
public Phrase rewrite(PhraseHandler handler)
```
    Recursively rewrite this phrase using handler.
    NOTE: If a phrase has any children, the phrase itself will be passed to handler first, prior to its children. If handler returns a new phrase, its children will not be traversed automatically.
    
    Overrides:
    
    rewrite in class Phrase
  - rewriteChildren
```
public Phrase rewriteChildren(PhraseHandler handler)
```
    Description copied from class: Phrase
    
    Rewrite any children of this phrase using handler.
    Returns the modified phrase, which may be null if all children were removed by handler.
    
    This method may have no effect if this Phrase represents a leaf in the tree.
    
    NOTE: child phrases are not recursively traversed.
    
    Specified by:
    
    rewriteChildren in class Phrase

Class PhraseNear

Nested Class Summary

Nested classes/interfaces inherited from class com.attivio.sdk.search.query.phrase.Phrase

Field Summary

Fields inherited from class com.attivio.sdk.search.query.phrase.Phrase

Constructor Summary

Method Summary

Methods inherited from class com.attivio.sdk.search.query.phrase.Phrase

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MINIMUM

DEFAULT_NEAR_DISTANCE

REQUIRE_ALL_DISTANCE

MAX_DISTANCE

MIN_DISTANCE

terms

Constructor Detail

PhraseNear

PhraseNear

PhraseNear

PhraseNear

PhraseNear

PhraseNear

Method Detail

setParameter

isOrdered

setOrdered

getDistance

setDistance

getMinimum

setMinimum

isExactPhrase

isRequireAll

append

append

append

append

hashCode

equals

clone

clone

toString

requireAll

requireAll

requireAll

phrase

phrase

phrase

phrase

near

near

near

near

near

onear

onear

onear

onear

onear

getStartOffset

getEndOffset

size

getTerms

setTerms

setTerms

setTerms

addTerm

addTerm

addTerms

addTerms

addTerms

rewrite

rewriteChildren