Package org.nuxeo.ecm.platform.query.api

Interface AggregateDefinition

All Known Implementing Classes:

AggregateDescriptor

public interface AggregateDefinition

Since:

6.0

Method Summary

Modifier and Type	Method	Description
AggregateDefinition	clone()
Map<String,Integer>	getAggregateDateRangeDefinitionOrderMap()
Map<String,Integer>	getAggregateRangeDefinitionOrderMap()
List<AggregateRangeDateDefinition>	getDateRanges()
String	getDocumentField()	Get the document aggregator field
String	getId()
Map<String,String>	getProperties()
List<AggregateRangeDefinition>	getRanges()
PredicateFieldDefinition	getSearchField()	Get the ref of the search input, the type of the field must be nxs:stringList
String	getType()
void	setDateRanges(List<AggregateRangeDateDefinition> ranges)
void	setDocumentField(String parameter)
void	setId(String id)
void	setProperty(String name, String value)
void	setRanges(List<AggregateRangeDefinition> ranges)
void	setSearchField(PredicateFieldDefinition field)
void	setType(String type)

Method Details

getId

String getId()

setId

void setId(String id)

getType

String getType()

setType

void setType(String type)

setProperty

void setProperty(String name,
 String value)

getProperties

Map<String,String> getProperties()

getRanges

List<AggregateRangeDefinition> getRanges()

setRanges

void setRanges(List<AggregateRangeDefinition> ranges)

getDateRanges

List<AggregateRangeDateDefinition> getDateRanges()

setDateRanges

void setDateRanges(List<AggregateRangeDateDefinition> ranges)

getDocumentField

String getDocumentField()

Get the document aggregator field

setDocumentField

void setDocumentField(String parameter)

getSearchField

PredicateFieldDefinition getSearchField()

Get the ref of the search input, the type of the field must be nxs:stringList

setSearchField

void setSearchField(PredicateFieldDefinition field)

clone

AggregateDefinition clone()

getAggregateDateRangeDefinitionOrderMap

Map<String,Integer> getAggregateDateRangeDefinitionOrderMap()

Returns:

a map associating the key of the date range to its position in the definition.

getAggregateRangeDefinitionOrderMap

Map<String,Integer> getAggregateRangeDefinitionOrderMap()

Returns:

a map associating the key of the range to its position in the definition.