PhraseQuery (pipeline-javadocs 5.10 API)

java.lang.Object
- com.lucidworks.search.dsl.DslBase
- - com.lucidworks.search.dsl.request.DslCloneable
  - - com.lucidworks.search.dsl.request.query.Query
    - - com.lucidworks.search.dsl.request.query.AbstractLeafQuery
      - com.lucidworks.search.dsl.request.query.ChangableValueQuery
        
        com.lucidworks.search.dsl.request.query.AbstractTermQuery
        
        com.lucidworks.search.dsl.request.query.PhraseQuery

```
public class PhraseQuery
extends AbstractTermQuery
```
A query that matches documents on phrase.
AbstractTermQuery.getValue() is a phrase

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static java.lang.String TYPE
- Constructor Summary
  
  Constructors
  Constructor Description
  
  PhraseQuery(java.lang.String field, java.lang.String value, java.lang.Integer proximity)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  PhraseQuery clone()
  
  java.lang.Integer getProximity()
  - Methods inherited from class com.lucidworks.search.dsl.request.query.AbstractTermQuery
    getField, getValue, setValue
  - Methods inherited from class com.lucidworks.search.dsl.request.query.ChangableValueQuery
    isEmptyQuery
  - Methods inherited from class com.lucidworks.search.dsl.request.query.AbstractLeafQuery
    getChildQueries, removeChildQuery, replaceChildQuery
  - Methods inherited from class com.lucidworks.search.dsl.request.DslCloneable
    clone, deepClone
  - Methods inherited from class com.lucidworks.search.dsl.DslBase
    equals, hashCode, toString
  - Methods inherited from class java.lang.Object
    getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE
```
public static final java.lang.String TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PhraseQuery
```
public PhraseQuery(java.lang.String field,
                   java.lang.String value,
                   java.lang.Integer proximity)
```
- Method Detail
  - getProximity
```
public java.lang.Integer getProximity()
```
    Returns:
    
    the amount of slop permitted on phrase queries. Slop refers to the number of positions one token needs to be moved in relation to another token in order to match a phrase specified in a query.
  - clone
```
public PhraseQuery clone()
```
    Specified by:
    
    clone in class ChangableValueQuery