org.elasticsearch.index.query.xcontent
Class PrefixFilterBuilder

java.lang.Object
  extended by org.elasticsearch.index.query.xcontent.BaseFilterBuilder
      extended by org.elasticsearch.index.query.xcontent.PrefixFilterBuilder
All Implemented Interfaces:
XContentFilterBuilder, ToXContent

public class PrefixFilterBuilder
extends BaseFilterBuilder

A filter that restricts search results to values that have a matching prefix in a given field.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.elasticsearch.util.xcontent.ToXContent
ToXContent.MapParams, ToXContent.Params
 
Field Summary
 
Fields inherited from interface org.elasticsearch.util.xcontent.ToXContent
EMPTY_PARAMS
 
Constructor Summary
PrefixFilterBuilder(java.lang.String name, java.lang.String prefix)
          A filter that restricts search results to values that have a matching prefix in a given field.
 
Method Summary
 void doXContent(XContentBuilder builder, ToXContent.Params params)
           
 
Methods inherited from class org.elasticsearch.index.query.xcontent.BaseFilterBuilder
toXContent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrefixFilterBuilder

public PrefixFilterBuilder(java.lang.String name,
                           java.lang.String prefix)
A filter that restricts search results to values that have a matching prefix in a given field.

Parameters:
name - The field name
prefix - The prefix
Method Detail

doXContent

public void doXContent(XContentBuilder builder,
                       ToXContent.Params params)
                throws java.io.IOException
Specified by:
doXContent in class BaseFilterBuilder
Throws:
java.io.IOException