|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.endeca.portal.data.functions.QueryFunction
com.endeca.portal.data.functions.QueryConfig
com.endeca.portal.data.functions.AnalyticsQueryConfig
public class AnalyticsQueryConfig
Allow an analytics query to be added to the QueryState. Note that if you have more than one AnalyticsQueryConfig instance in a QueryState, behavior is undefined on an ENE presentation API data source. Whichever AnalyticsQueryConfig happens to be applied to the ENEQuery last before actual querying occurs will "win", and any other AnalyticsQueryConfig instances will be overridden.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_ID
|
static java.lang.String |
HANDLER_FUNCTION
|
Fields inherited from class com.endeca.portal.data.functions.QueryConfig |
---|
id |
Fields inherited from class com.endeca.portal.data.functions.QueryFunction |
---|
CLASS_PROPERTY, operator |
Constructor Summary | |
---|---|
protected |
AnalyticsQueryConfig()
|
|
AnalyticsQueryConfig(java.lang.String analyticsQuery)
Construct a new AnalyticsQueryConfig with a specified query. |
|
AnalyticsQueryConfig(java.lang.String id,
java.lang.String analyticsQuery)
Construct a new AnalyticsQueryConfig with a specified query. |
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. |
java.lang.String |
getAnalyticsQuery()
|
java.util.List<java.lang.reflect.Method> |
getGetters()
Return the list of property getters on this function. |
java.util.List<java.lang.reflect.Method> |
getSetters()
Return the list of property setters on this function. |
void |
setAnalyticsQuery(java.lang.String analyticsQuery)
|
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.QueryConfig |
---|
getId, setId |
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 |
Field Detail |
---|
public static final java.lang.String DEFAULT_ID
public static final java.lang.String HANDLER_FUNCTION
Constructor Detail |
---|
protected AnalyticsQueryConfig()
public AnalyticsQueryConfig(java.lang.String analyticsQuery)
analyticsQuery
- public AnalyticsQueryConfig(java.lang.String id, java.lang.String analyticsQuery)
id
- A string id used to distinguish this function from othersanalyticsQuery
- Method Detail |
---|
public java.lang.String getAnalyticsQuery()
public void setAnalyticsQuery(java.lang.String analyticsQuery)
public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query) throws QueryFunctionUnsupportedException
QueryFunction
applyToDiscoveryServiceQuery
in class QueryFunction
QueryFunctionUnsupportedException
public void applyToENEQuery(com.endeca.navigation.ENEQuery query) throws QueryFunctionUnsupportedException
QueryFunction
applyToENEQuery
in class QueryFunction
QueryFunctionUnsupportedException
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 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.lang.String toString()
QueryFunction
toString
in class QueryFunction
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |