Class Facet
- java.lang.Object
-
- com.google.appengine.api.search.Facet
-
- All Implemented Interfaces:
- java.io.Serializable
public final class Facet extends java.lang.Object implements java.io.Serializable
AFacet
can be used to categorize aDocument
. It is not aField
.Search results can contain facets for the extended result set and their value frequency. For example, if a search query is related to "wine", then facets could be "color" with values of "red" and "white", and "year" with values of "2000" and "2005".
Each facet has a name and exactly one value: atom or number. Facet name lengths are between 1 and
SearchApiLimits.MAXIMUM_NAME_LENGTH
characters, and atoms are limited toSearchApiLimits.MAXIMUM_ATOM_LENGTH
characters. Numbers must be betweenSearchApiLimits.MINIMUM_NUMBER_VALUE
andSearchApiLimits.MAXIMUM_NUMBER_VALUE
.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description boolean
equals(java.lang.Object object)
java.lang.String
getAtom()
Returns the atomic value of the facet.java.lang.String
getName()
Returns the name of the facet.java.lang.Double
getNumber()
Returns the numeric value of the facet.int
hashCode()
java.lang.String
toString()
static Facet
withAtom(java.lang.String name, java.lang.String value)
Creates and returns an atom facet with the givenname
andvalue
.static Facet
withNumber(java.lang.String name, java.lang.Double value)
Creates and returns a number facet with the givenname
andvalue
.
-
-
-
Method Detail
-
withAtom
public static Facet withAtom(java.lang.String name, java.lang.String value)
Creates and returns an atom facet with the givenname
andvalue
.- Returns:
- an instance of
Facet
. - Throws:
java.lang.IllegalArgumentException
- if the facet name or value are invalid.
-
withNumber
public static Facet withNumber(java.lang.String name, java.lang.Double value)
Creates and returns a number facet with the givenname
andvalue
.- Returns:
- an instance of
Facet
. - Throws:
java.lang.IllegalArgumentException
- if the facet name or value are invalid.
-
getName
public java.lang.String getName()
Returns the name of the facet.
-
getAtom
public java.lang.String getAtom()
Returns the atomic value of the facet. Returns null if the value is not atomic.
-
getNumber
public java.lang.Double getNumber()
Returns the numeric value of the facet. Returns null if the value is not numeric.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object object)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-