FacetResponse (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.search.facet.FacetResponse

All Implemented Interfaces:

Serializable, Cloneable, Iterable<FacetBucket>
```
public class FacetResponse
extends Object
implements Serializable, Cloneable, Iterable<FacetBucket>
```
A response to a FacetRequest.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String TOKENIZED_ATTRIBUTE
Name of attribute that will identify if the buckets for this facet represet tokens.

Fields
Modifier and Type	Field and Description
`static String`	`TOKENIZED_ATTRIBUTE` Name of attribute that will identify if the buckets for this facet represet tokens.

Constructor Summary

Constructors
Constructor and Description

FacetResponse(String name)

FacetResponse(String name, String displayName)

Constructors
Constructor and Description
`FacetResponse(String name)`
`FacetResponse(String name, String displayName)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(FacetBucket bucket)` Add a `bucket` to this response.
`void`	`addAll(Iterable<FacetBucket> value)` Add all buckets in `value` to this response.
`void`	`clear()` Remove all buckets from this response.
`FacetResponse`	`clone()`
`boolean`	`containsBucket(String label)` Returns `true` if this FacetResponse contains a Bucket with the given `label`.
`boolean`	`equals(Object other)`
`FacetBucket`	`get(int index)` Get a facet bucket at `index`.
`Object`	`getAttribute(String name)` Get an attribute by `name`.
`boolean`	`getAttribute(String name, boolean defaultValue)` Get a `boolean` attribute by `name`, returning `defaultValue` if unset.
`Date`	`getAttribute(String name, Date defaultValue)` Get a `Date` attribute by `name`, returning `defaultValue` if unset.
`double`	`getAttribute(String name, double defaultValue)` Get a `double` attribute by `name`, returning `defaultValue` if unset.
`int`	`getAttribute(String name, int defaultValue)` Get an `int` attribute by `name`, returning `defaultValue` if unset.
`long`	`getAttribute(String name, long defaultValue)` Get a `long` attribute by `name`, returning `defaultValue` if unset.
`String`	`getAttribute(String name, String defaultValue)` Get a `String` attribute by `name`, returning `defaultValue` if unset.
`BaseTypesMap<String,Object>`	`getAttributes()` Get extended attributes.
`FacetBucket`	`getBucket(String label)` Gets a Bucket with the given `label`.
`ArrayList<FacetBucket>`	`getBuckets()` Get the buckets.
`String`	`getDisplayName()` Get the extended display name for this FacetResponse.
`static String`	`getDisplayName(FacetResponse response)` Get the raw display name for `response`.
`FacetFilter`	`getFacetFilter(FacetBucket bucket)` Create a `FacetFilter` suitable for applying `bucket` to a `QueryRequest`.
`long`	`getFacetTime()` Get the facet generation time (in milliseconds).
`String`	`getField()` Get the field used to generate this facet.
`String`	`getName()` Get the name for this FacetResponse.
`FacetStatistics`	`getStatistics()` Get the statistics for this response (if available).
`long`	`getTotalCount()` Get the sum of the counts for all buckets (even those not returned).
`int`	`hashCode()`
`Iterator<FacetBucket>`	`iterator()`
`void`	`setAttribute(String name, Boolean value)` Set a boolean attribute.
`void`	`setAttribute(String name, Date value)` Set a date attribute.
`void`	`setAttribute(String name, Number value)` Set a numeric attribute.
`void`	`setAttribute(String name, String value)` Set a string attribute.
`void`	`setAttributes(BaseTypesMap<String,Object> value)` Set extended attributes.
`void`	`setBuckets(Collection<FacetBucket> value)` Set the buckets.
`void`	`setDisplayName(String value)` Set the extended display name for this FacetResponse.
`void`	`setFacetTime(long time)` Set the facet generation time (in milliseconds).
`void`	`setField(String value)` Set the field used to generate this facet.
`void`	`setName(String value)` Set the name for this FacetResponse.
`void`	`setStatistics(FacetStatistics value)` Set the statistics for this response.
`void`	`setTotalCount(long value)` Set the sum of the counts for all buckets (even those not returned).
`int`	`size()` Get the number of buckets in this response.
`String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - TOKENIZED_ATTRIBUTE
```
public static final String TOKENIZED_ATTRIBUTE
```
    Name of attribute that will identify if the buckets for this facet represet tokens.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FacetResponse
```
public FacetResponse(String name)
```
  - FacetResponse
```
public FacetResponse(String name,
                     String displayName)
```
- Method Detail
  - getName
```
public String getName()
```
    Get the name for this FacetResponse.
  - setName
```
public void setName(String value)
```
    Set the name for this FacetResponse.
  - getField
```
public String getField()
```
    Get the field used to generate this facet.
    NOTE: may be null if this is not a field based facet.
  - setField
```
public void setField(String value)
```
    Set the field used to generate this facet.
  - getDisplayName
```
public String getDisplayName()
```
    Get the extended display name for this FacetResponse.
  - setDisplayName
```
public void setDisplayName(String value)
```
    Set the extended display name for this FacetResponse.
  - getBuckets
```
public ArrayList<FacetBucket> getBuckets()
```
    Get the buckets.
  - setBuckets
```
public void setBuckets(Collection<FacetBucket> value)
```
    Set the buckets.
  - getAttributes
```
public BaseTypesMap<String,Object> getAttributes()
```
    Get extended attributes.
  - getAttribute
```
public Object getAttribute(String name)
```
    Get an attribute by name.
  - getAttribute
```
public String getAttribute(String name,
                           String defaultValue)
```
    Get a String attribute by name, returning defaultValue if unset.
  - getAttribute
```
public boolean getAttribute(String name,
                            boolean defaultValue)
```
    Get a boolean attribute by name, returning defaultValue if unset.
  - getAttribute
```
public int getAttribute(String name,
                        int defaultValue)
```
    Get an int attribute by name, returning defaultValue if unset.
  - getAttribute
```
public long getAttribute(String name,
                         long defaultValue)
```
    Get a long attribute by name, returning defaultValue if unset.
  - getAttribute
```
public double getAttribute(String name,
                           double defaultValue)
```
    Get a double attribute by name, returning defaultValue if unset.
  - getAttribute
```
public Date getAttribute(String name,
                         Date defaultValue)
```
    Get a Date attribute by name, returning defaultValue if unset.
  - setAttributes
```
public void setAttributes(BaseTypesMap<String,Object> value)
```
    Set extended attributes.
  - setAttribute
```
public void setAttribute(String name,
                         String value)
```
    Set a string attribute.
  - setAttribute
```
public void setAttribute(String name,
                         Number value)
```
    Set a numeric attribute.
  - setAttribute
```
public void setAttribute(String name,
                         Date value)
```
    Set a date attribute.
  - setAttribute
```
public void setAttribute(String name,
                         Boolean value)
```
    Set a boolean attribute.
  - getStatistics
```
public FacetStatistics getStatistics()
```
    Get the statistics for this response (if available).
  - setStatistics
```
public void setStatistics(FacetStatistics value)
```
    Set the statistics for this response.
  - getTotalCount
```
public long getTotalCount()
```
    Get the sum of the counts for all buckets (even those not returned).
  - setTotalCount
```
public void setTotalCount(long value)
```
    Set the sum of the counts for all buckets (even those not returned).
  - getFacetTime
```
public long getFacetTime()
```
    Get the facet generation time (in milliseconds).
  - setFacetTime
```
public void setFacetTime(long time)
```
    Set the facet generation time (in milliseconds).
  - getFacetFilter
```
public FacetFilter getFacetFilter(FacetBucket bucket)
```
    Create a FacetFilter suitable for applying bucket to a QueryRequest.
  - containsBucket
```
public boolean containsBucket(String label)
```
    Returns true if this FacetResponse contains a Bucket with the given label.
    Warning: this method performs a linear scan of all buckets and may require generating display values for all buckets during scan.
  - getBucket
```
public FacetBucket getBucket(String label)
```
    Gets a Bucket with the given label.
    Warning: this method performs a linear scan of all buckets and may require generating display values for all buckets during scan.
  - get
```
public FacetBucket get(int index)
```
    Get a facet bucket at index.
  - iterator
```
public Iterator<FacetBucket> iterator()
```
    Specified by:
    
    iterator in interface Iterable<FacetBucket>
  - size
```
public int size()
```
    Get the number of buckets in this response.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - add
```
public void add(FacetBucket bucket)
```
    Add a bucket to this response.
  - addAll
```
public void addAll(Iterable<FacetBucket> value)
```
    Add all buckets in value to this response.
  - clear
```
public void clear()
```
    Remove all buckets from this response.
  - clone
```
public FacetResponse clone()
```
    Overrides:
    
    clone in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - getDisplayName
```
public static String getDisplayName(FacetResponse response)
```
    Get the raw display name for response.

Class FacetResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

TOKENIZED_ATTRIBUTE

Constructor Detail

FacetResponse

FacetResponse

Method Detail

getName

setName

getField

setField

getDisplayName

setDisplayName

getBuckets

setBuckets

getAttributes

getAttribute

getAttribute

getAttribute

getAttribute

getAttribute

getAttribute

getAttribute

setAttributes

setAttribute

setAttribute

setAttribute

setAttribute

getStatistics

setStatistics

getTotalCount

setTotalCount

getFacetTime

setFacetTime

getFacetFilter

containsBucket

getBucket

get

iterator

size

toString

add

addAll

clear

clone

hashCode

equals

getDisplayName