Package com.attivio.sdk.search.facet

Class FacetResponse

java.lang.Object

com.attivio.sdk.search.facet.FacetBuckets

com.attivio.sdk.search.facet.FacetResponse

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<FacetBucket>, java.util.function.Consumer<FacetBucket>

public class FacetResponse
extends FacetBuckets

A response to a FacetRequest.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.attivio.sdk.search.facet.FacetBuckets

COUNT_ATTR, DEFAULT_BUCKETS, MAX_ATTR, MEAN_ATTR, MIDPOINT_ATTR, MIN_ATTR, STDEV_ATTR, SUM_ATTR, SUM_OF_SQUARES_ATTR, VARIANCE_ATTR

Constructor Summary

Constructors

Constructor	Description
FacetResponse()
FacetResponse(java.lang.String name)
FacetResponse(java.lang.String name, java.lang.String displayName)

Method Summary

Modifier and Type	Method	Description
protected void	addAttributes(java.lang.StringBuilder buffer)
FacetResponse	clone()
boolean	equals(java.lang.Object other)
java.util.ArrayList<FacetBucket>	getBuckets()	Deprecated. use FacetBuckets.get(int)/FacetBuckets.iterator() instead.
FacetFilter	getFacetFilter(FacetBucket bucket)	Create a FacetFilter suitable for applying bucket to a QueryRequest.
FacetFilter	getFacetFilter(FacetBucket... buckets)	Create a FacetFilter suitable for applying buckets to a QueryRequest.
long	getFacetTime()	Get the facet generation time (in milliseconds).
FacetStatistics	getStatistics()	Get the statistics for this response.
long	getTotalCount()	Get the sum of the counts for all buckets (even those not returned).
int	hashCode()
void	readExternal(java.io.ObjectInput in)
void	setBuckets(java.util.Collection<FacetBucket> value)	Deprecated. use FacetBuckets.addAll(java.lang.Iterable<com.attivio.sdk.search.facet.FacetBucket>) instead
void	setFacetTime(long time)	Set the facet generation time (in milliseconds).
void	setTotalCount(long value)	Set the sum of the counts for all buckets (even those not returned).
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class com.attivio.sdk.search.facet.FacetBuckets

accept, add, addAll, addAttribute, addAttribute, addAttribute, addAttributes, attributes, clear, coerce, coerce, contains, containsBucket, ensureCapacity, forEach, get, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttributes, getBucket, getDisplayName, getField, getFilterField, getName, getStatistics, iterator, removeAttribute, removeLast, setAttribute, setAttributes, setDisplayName, setField, setName, setStatistics, size, sort, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface java.lang.Iterable

spliterator

Constructor Detail

FacetResponse

public FacetResponse()

FacetResponse

public FacetResponse(java.lang.String name)

FacetResponse

public FacetResponse(java.lang.String name,
                     java.lang.String displayName)

Method Detail

getBuckets

@Deprecated
public java.util.ArrayList<FacetBucket> getBuckets()

Deprecated.

use FacetBuckets.get(int)/FacetBuckets.iterator() instead.

Get the buckets as a list.

setBuckets

@Deprecated
public void setBuckets(java.util.Collection<FacetBucket> value)

Deprecated.

use FacetBuckets.addAll(java.lang.Iterable<com.attivio.sdk.search.facet.FacetBucket>) instead

Set the buckets.

getStatistics

public FacetStatistics getStatistics()

Get the statistics for this response.

Overrides:

getStatistics in class FacetBuckets

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.

getFacetFilter

public FacetFilter getFacetFilter(FacetBucket... buckets)

Create a FacetFilter suitable for applying buckets to a QueryRequest.

Assumes that each subsequent bucket is a child bucket of the preceeding bucket and that the first bucket is a child of this FacetResponse.

addAttributes

protected void addAttributes(java.lang.StringBuilder buffer)

Overrides:

addAttributes in class FacetBuckets

clone

public FacetResponse clone()

Overrides:

clone in class FacetBuckets

hashCode

public int hashCode()

Overrides:

hashCode in class FacetBuckets

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class FacetBuckets

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class FacetBuckets

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class FacetBuckets

Throws:

java.io.IOException

java.lang.ClassNotFoundException