Facet (AppEngine :: appengine-apis 2.0.17 API)

java.lang.Object
- com.google.appengine.api.search.Facet

All Implemented Interfaces:

Serializable
```
public final class Facet
extends Object
implements Serializable
```
A Facet can be used to categorize a Document. It is not a Field.
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 to SearchApiLimits.MAXIMUM_ATOM_LENGTH characters. Numbers must be between SearchApiLimits.MINIMUM_NUMBER_VALUE and SearchApiLimits.MAXIMUM_NUMBER_VALUE.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object object)`
`String`	`getAtom()`	Returns the atomic value of the facet.
`String`	`getName()`	Returns the name of the facet.
`Double`	`getNumber()`	Returns the numeric value of the facet.
`int`	`hashCode()`
`String`	`toString()`
`static Facet`	`withAtom(String name, String value)`	Creates and returns an atom facet with the given `name` and `value`.
`static Facet`	`withNumber(String name, Double value)`	Creates and returns a number facet with the given `name` and `value`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - withAtom
```
public static Facet withAtom(String name,
                             String value)
```
    Creates and returns an atom facet with the given name and value.
    
    Returns:
    
    an instance of Facet.
    
    Throws:
    
    IllegalArgumentException - if the facet name or value are invalid.
  - withNumber
```
public static Facet withNumber(String name,
                               Double value)
```
    Creates and returns a number facet with the given name and value.
    
    Returns:
    
    an instance of Facet.
    
    Throws:
    
    IllegalArgumentException - if the facet name or value are invalid.
  - getName
```
public String getName()
```
    Returns the name of the facet.
  - getAtom
```
public String getAtom()
```
    Returns the atomic value of the facet. Returns null if the value is not atomic.
  - getNumber
```
public Double getNumber()
```
    Returns the numeric value of the facet. Returns null if the value is not numeric.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object