Package com.google.appengine.api.search

Class FacetRequest

java.lang.Object

com.google.appengine.api.search.FacetRequest

public final class FacetRequest
extends Object

A facet request representing parameters for requesting specific facets to be returned with a query result.

For example, to request a facet with a name and specific values:

   FacetRequest request = FacetRequest.newBuilder().setName("wine_type")
       .addValueConstraint("white").addValueConstraint("red").build();
  

and to request ranges:

 FacetRequest request = FacetRequest.newBuilder().setName("year")
     .addRange(null, 2000.0)           // year < 2000.0
     .addRange(1980.0, 2000.0)         // 1980.0 <= year < 2000.0
     .addRange(2000.0, null).build();  // year >= 2000.0
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FacetRequest.Builder	A facet request builder.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the name of the face in this request.
List<FacetRange>	getRanges()	Returns an unmodifiable list of FacetRanges.
List<String>	getValueConstraints()	Returns an unmodifiable list of value constraints.
Integer	getValueLimit()	Returns the maximum number of values this facet should have.
static FacetRequest.Builder	newBuilder()	Creates and returns a FacetRequest builder.
static FacetRequest.Builder	newBuilder(FacetRequest request)	Creates a builder from the given FacetRequest.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public static FacetRequest.Builder newBuilder()

Creates and returns a FacetRequest builder. Set the facet request parameters and use the FacetRequest.Builder.build() method to create a concrete instance of FacetRequest.

Returns:

a FacetRequest.Builder which can construct a facet request

newBuilder

public static FacetRequest.Builder newBuilder(FacetRequest request)

Creates a builder from the given FacetRequest.

Parameters:

request - the facet request for the builder to use to build another request.

Returns:

a new builder with values set from the given request

getName

public String getName()

Returns the name of the face in this request.

getValueLimit

public Integer getValueLimit()

Returns the maximum number of values this facet should have. Null if the value limit is not set.

getRanges

public List<FacetRange> getRanges()

Returns an unmodifiable list of FacetRanges.

getValueConstraints

public List<String> getValueConstraints()

Returns an unmodifiable list of value constraints.

toString

public String toString()

Overrides:

toString in class Object