com.attivio.sdk.search.facet

Class DateFacetRequest

java.lang.Object

com.attivio.sdk.search.facet.FacetRequest

com.attivio.sdk.search.facet.DateFacetRequest

All Implemented Interfaces:

Serializable, Cloneable

public class DateFacetRequest
extends FacetRequest

Calendar based date facet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DateFacetRequest.DateFacetInterval An interval for date faceting.
static class	DateFacetRequest.DateFacetResolution

Nested classes/interfaces inherited from class com.attivio.sdk.search.facet.FacetRequest

FacetRequest.SortBy

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_SCALE_ATTRIBUTE Name of attribute that will contain the scale used for date faceting.
static String	DATE_STEP_ATTRIBUTE Name of attribute that will contain the step used for date faceting.
static String	TIME_ZONE_ATTRIBUTE Name of attribute that will contain the time zone for date faceting.

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

DEFAULT_MAX_MEMORY_USAGE, DEFAULT_PRIMARY_SORT, DEFAULT_SAMPLE_MODE, DEFAULT_SECONDARY_SORT, DEFAULT_SORT_BY

Constructor Summary

Constructors

Constructor and Description
DateFacetRequest()
DateFacetRequest(FieldExpression field)
DateFacetRequest(FieldExpression field, List<DateFacetRequest.DateFacetInterval> intervals)
DateFacetRequest(String field)
DateFacetRequest(String field, List<DateFacetRequest.DateFacetInterval> intervals)

Method Summary

Modifier and Type	Method and Description
void	addInterval(DateFacetRequest.DateFacetResolution resolution)
void	addInterval(DateFacetRequest.DateFacetResolution resolution, int step)
protected int	addParameters(StringBuilder buffer, int index)
boolean	equals(Object other)
List<DateFacetRequest.DateFacetInterval>	getIntervals()
int	hashCode()
boolean	isFacetFinder() true if the facet finder can replace this FacetRequest with a suggested FacetRequest.
void	setFacetFinder(boolean value) Set if FacetFinder is allowed to provide a suggestion for this FacetRequest.
void	setIntervals(DateFacetRequest.DateFacetInterval... value)
void	setIntervals(List<DateFacetRequest.DateFacetInterval> value)

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

addName, addParameter, clone, getBucketComparator, getDistributedMaxBuckets, getDistributedMinBucketCount, getField, getFieldExpression, getMaxBuckets, getMaxMemoryUsage, getMinBucketCount, getName, getPrimarySortOrder, getRawDistributedMaxBuckets, getRawDistributedMinBucketCount, getRawMaxBuckets, getRawMinBucketCount, getSecondarySortOrder, getShallowMode, getSortBy, isCalculateStatistics, isFacetTokens, setCalculateStatistics, setDefaults, setDistributedMaxBuckets, setDistributedMaxBuckets, setDistributedMinBucketCount, setDistributedMinBucketCount, setFacetTokens, setField, setFieldExpression, setMaxBuckets, setMaxBuckets, setMaxMemoryUsage, setMinBucketCount, setMinBucketCount, setName, setPrimarySortOrder, setSecondarySortOrder, setShallowMode, setSortOrder, setSortOrder, setSortOrder, toString, valueOf

Methods inherited from class java.lang.Object

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

Field Detail

TIME_ZONE_ATTRIBUTE

public static final String TIME_ZONE_ATTRIBUTE

Name of attribute that will contain the time zone for date faceting.

See Also:

Constant Field Values

DATE_SCALE_ATTRIBUTE

public static final String DATE_SCALE_ATTRIBUTE

Name of attribute that will contain the scale used for date faceting.

See Also:

Constant Field Values

DATE_STEP_ATTRIBUTE

public static final String DATE_STEP_ATTRIBUTE

Name of attribute that will contain the step used for date faceting.

See Also:

Constant Field Values

Constructor Detail

DateFacetRequest

public DateFacetRequest()

DateFacetRequest

public DateFacetRequest(String field)

DateFacetRequest

public DateFacetRequest(String field,
                        List<DateFacetRequest.DateFacetInterval> intervals)

DateFacetRequest

public DateFacetRequest(FieldExpression field)

DateFacetRequest

public DateFacetRequest(FieldExpression field,
                        List<DateFacetRequest.DateFacetInterval> intervals)

Method Detail

isFacetFinder

public final boolean isFacetFinder()

true if the facet finder can replace this FacetRequest with a suggested FacetRequest.

This will replace a FacetRequest for a numeric field with a RangeFacetRequest when facet finder runs.

Overrides:

isFacetFinder in class FacetRequest

setFacetFinder

public final void setFacetFinder(boolean value)

Set if FacetFinder is allowed to provide a suggestion for this FacetRequest.

Overrides:

setFacetFinder in class FacetRequest

getIntervals

public List<DateFacetRequest.DateFacetInterval> getIntervals()

setIntervals

public void setIntervals(DateFacetRequest.DateFacetInterval... value)

setIntervals

public void setIntervals(List<DateFacetRequest.DateFacetInterval> value)

addInterval

public void addInterval(DateFacetRequest.DateFacetResolution resolution)

addInterval

public void addInterval(DateFacetRequest.DateFacetResolution resolution,
                        int step)

hashCode

public int hashCode()

Description copied from class: FacetRequest

Overrides:

hashCode in class FacetRequest

equals

public boolean equals(Object other)

Description copied from class: FacetRequest

Overrides:

equals in class FacetRequest

addParameters

protected int addParameters(StringBuilder buffer,
                            int index)

Overrides:

addParameters in class FacetRequest