public final class FacetRequest
extends java.lang.Object
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
Modifier and Type | Class and Description |
---|---|
static class |
FacetRequest.Builder
A facet request builder.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName()
Returns the name of the face in this request.
|
java.util.List<FacetRange> |
getRanges()
Returns an unmodifiable list of
FacetRange s. |
java.util.List<java.lang.String> |
getValueConstraints()
Returns an unmodifiable list of value constraints.
|
java.lang.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.
|
java.lang.String |
toString() |
public static FacetRequest.Builder newBuilder()
FacetRequest
builder. Set the facet request
parameters and use the FacetRequest.Builder.build()
method to create a concrete
instance of FacetRequest.FacetRequest.Builder
which can construct a facet requestpublic static FacetRequest.Builder newBuilder(FacetRequest request)
request
- the facet request for the builder to use
to build another request.public java.lang.String getName()
public java.lang.Integer getValueLimit()
public java.util.List<FacetRange> getRanges()
FacetRange
s.public java.util.List<java.lang.String> getValueConstraints()
public java.lang.String toString()
toString
in class java.lang.Object