Package org.nuxeo.ecm.platform.query.core

Class AggregateDescriptor

java.lang.Object

org.nuxeo.ecm.platform.query.core.AggregateDescriptor

All Implemented Interfaces:

AggregateDefinition

public class AggregateDescriptor
extends Object
implements AggregateDefinition

Since:

6.0

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Integer>	aggregateDateRangeDefinitionOrderMap
protected List<AggregateRangeDateDescriptor>	aggregateDateRanges
protected PropertiesDescriptor	aggregateProperties
protected List<AggregateRangeDescriptor>	aggregateRanges
protected FieldDescriptor	field
protected String	id
protected String	parameter
protected String	type

Constructor Summary

Constructors

Constructor	Description
AggregateDescriptor()

Method Summary

Modifier and Type	Method	Description
AggregateDescriptor	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)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

aggregateDateRanges

protected List<AggregateRangeDateDescriptor> aggregateDateRanges

aggregateProperties

protected PropertiesDescriptor aggregateProperties

aggregateDateRangeDefinitionOrderMap

protected Map<String,Integer> aggregateDateRangeDefinitionOrderMap

aggregateRanges

protected List<AggregateRangeDescriptor> aggregateRanges

field

protected FieldDescriptor field

id

protected String id

parameter

protected String parameter

type

protected String type

Constructor Details

AggregateDescriptor

public AggregateDescriptor()

Method Details

clone

public AggregateDescriptor clone()

Specified by:

clone in interface AggregateDefinition

Overrides:

clone in class Object

getAggregateDateRangeDefinitionOrderMap

public Map<String,Integer> getAggregateDateRangeDefinitionOrderMap()

Specified by:

getAggregateDateRangeDefinitionOrderMap in interface AggregateDefinition

Returns:

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

getAggregateRangeDefinitionOrderMap

public Map<String,Integer> getAggregateRangeDefinitionOrderMap()

Specified by:

getAggregateRangeDefinitionOrderMap in interface AggregateDefinition

Returns:

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

getDateRanges

public List<AggregateRangeDateDefinition> getDateRanges()

Specified by:

getDateRanges in interface AggregateDefinition

getDocumentField

public String getDocumentField()

Description copied from interface: AggregateDefinition

Get the document aggregator field

Specified by:

getDocumentField in interface AggregateDefinition

getId

public String getId()

Specified by:

getId in interface AggregateDefinition

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface AggregateDefinition

getRanges

public List<AggregateRangeDefinition> getRanges()

Specified by:

getRanges in interface AggregateDefinition

getSearchField

public PredicateFieldDefinition getSearchField()

Description copied from interface: AggregateDefinition

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

Specified by:

getSearchField in interface AggregateDefinition

getType

public String getType()

Specified by:

getType in interface AggregateDefinition

setDateRanges

public void setDateRanges(List<AggregateRangeDateDefinition> ranges)

Specified by:

setDateRanges in interface AggregateDefinition

setDocumentField

public void setDocumentField(String parameter)

Specified by:

setDocumentField in interface AggregateDefinition

setId

public void setId(String id)

Specified by:

setId in interface AggregateDefinition

setProperty

public void setProperty(String name,
 String value)

Specified by:

setProperty in interface AggregateDefinition

setRanges

public void setRanges(List<AggregateRangeDefinition> ranges)

Specified by:

setRanges in interface AggregateDefinition

setSearchField

public void setSearchField(PredicateFieldDefinition field)

Specified by:

setSearchField in interface AggregateDefinition

setType

public void setType(String type)

Specified by:

setType in interface AggregateDefinition