|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.portal.data.functions.QueryFunction com.endeca.portal.data.functions.QueryFilter com.endeca.portal.data.functions.RecordAggregator
public class RecordAggregator
This class makes it possible to set the rollup key for aggregate record queries on MDEX 6. RecordAggregator is only supported on ENE presentation API data sources. Attempting to apply RecordAggregator to a discovery service data source will result in a QueryFunctionUnsupportedException.
Nested Class Summary | |
---|---|
static class |
RecordAggregator.AggregateCount
Enum that parallels and abstracts the same constants in ENEQuery. |
Field Summary |
---|
Fields inherited from class com.endeca.portal.data.functions.QueryFunction |
---|
CLASS_PROPERTY, operator |
Constructor Summary | |
---|---|
protected |
RecordAggregator()
|
|
RecordAggregator(org.json.JSONObject jsonObject)
initializes this query function from JSON. |
|
RecordAggregator(java.lang.String rollupKey)
Convenience constructor to create this query function given a rollup key. |
|
RecordAggregator(java.lang.String rollupKey,
RecordAggregator.AggregateCount aggCount)
Convenience constructor to create this query function given a rollup key and the number of base records per aggregate |
Method Summary | |
---|---|
void |
applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
Apply this function to a Request. |
void |
applyToENEQuery(com.endeca.navigation.ENEQuery query)
Apply this function to an ENEQuery. |
RecordAggregator.AggregateCount |
getAggCount()
Retrieves the number of base records per aggregate. |
java.util.List<java.lang.reflect.Method> |
getGetters()
Return the list of property getters on this function. |
java.lang.String |
getRollupKey()
retrieves the aggregate record query rollup key |
java.util.List<java.lang.reflect.Method> |
getSetters()
Return the list of property setters on this function. |
void |
setAggCount(RecordAggregator.AggregateCount aggCount)
Sets the number of base records per aggregate. |
void |
setAggCount(java.lang.String aggCount)
Sets the number of base records per aggregate. |
void |
setRollupKey(java.lang.String rollupKey)
sets the aggregate record query rollup key |
java.lang.String |
toString()
This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic. |
Methods inherited from class com.endeca.portal.data.functions.QueryFunction |
---|
clone, equals, equals, getInstance, getInstance, getName, getOperator, hashCode, init, setName, setOperator, setOperator, toJSON, toXML |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected RecordAggregator()
public RecordAggregator(org.json.JSONObject jsonObject) throws org.json.JSONException, java.lang.IllegalArgumentException, java.lang.ClassNotFoundException, java.lang.IllegalAccessException, java.lang.InstantiationException, java.lang.reflect.InvocationTargetException
jsonObject
- the JSON Object from which initialization occurs.
org.json.JSONException
java.lang.IllegalArgumentException
java.lang.ClassNotFoundException
java.lang.IllegalAccessException
java.lang.InstantiationException
java.lang.reflect.InvocationTargetException
public RecordAggregator(java.lang.String rollupKey)
rollupKey
- the aggregate record query rollup keypublic RecordAggregator(java.lang.String rollupKey, RecordAggregator.AggregateCount aggCount)
rollupKey
- the aggregate record query rollup keyaggCount
- the number of base records per aggregateMethod Detail |
---|
public java.lang.String getRollupKey()
public void setRollupKey(java.lang.String rollupKey)
rollupKey
- the aggregate record query rollup keypublic RecordAggregator.AggregateCount getAggCount()
public void setAggCount(RecordAggregator.AggregateCount aggCount)
aggCount
- the number of base records per aggregate.public void setAggCount(java.lang.String aggCount) throws java.lang.IllegalArgumentException
aggCount
- the number of base records per aggregate.
java.lang.IllegalArgumentException
- if the incoming String does not map to an AggregateCount valuepublic java.util.List<java.lang.reflect.Method> getSetters()
QueryFunction
private static List setters = Reflection.getSetters(MyFunctionClass.class);
\@Override
public List getSetters() {
return setters;
}
getSetters
in class QueryFunction
public java.util.List<java.lang.reflect.Method> getGetters()
QueryFunction
private static List getters = Reflection.getGetters(MyFunctionClass.class);
\@Override
public List getGetters() {
return getters;
}
getGetters
in class QueryFunction
public void applyToENEQuery(com.endeca.navigation.ENEQuery query)
QueryFunction
applyToENEQuery
in class QueryFunction
public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query) throws QueryFunctionUnsupportedException
QueryFunction
applyToDiscoveryServiceQuery
in class QueryFunction
QueryFunctionUnsupportedException
public java.lang.String toString()
QueryFunction
toString
in class QueryFunction
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |