com.endeca.portal.data.functions
Class AnalyticsQueryConfig
java.lang.Object
com.endeca.portal.data.functions.QueryFunction
com.endeca.portal.data.functions.QueryConfig
com.endeca.portal.data.functions.AnalyticsQueryConfig
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable
public class AnalyticsQueryConfig
- extends QueryConfig
Allow an analytics query to be added to the QueryState.
- See Also:
- Serialized Form
Fields inherited from class com.endeca.portal.data.functions.QueryConfig |
id |
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. |
java.lang.String |
getAnalyticsQuery()
|
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 java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
DEFAULT_ID
public static final java.lang.String DEFAULT_ID
- See Also:
- Constant Field Values
HANDLER_FUNCTION
public static final java.lang.String HANDLER_FUNCTION
- See Also:
- Constant Field Values
AnalyticsQueryConfig
protected AnalyticsQueryConfig()
AnalyticsQueryConfig
public AnalyticsQueryConfig(java.lang.String analyticsQuery)
- Construct a new AnalyticsQueryConfig with a specified query.
- Parameters:
analyticsQuery
-
AnalyticsQueryConfig
public AnalyticsQueryConfig(java.lang.String id,
java.lang.String analyticsQuery)
- Construct a new AnalyticsQueryConfig with a specified query.
- Parameters:
id
- A string id used to distinguish this function from othersanalyticsQuery
-
getAnalyticsQuery
public java.lang.String getAnalyticsQuery()
setAnalyticsQuery
public void setAnalyticsQuery(java.lang.String analyticsQuery)
applyToDiscoveryServiceQuery
public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
throws QueryFunctionUnsupportedException
- Description copied from class:
QueryFunction
- Apply this function to a Request. Must be implemented by subclass.
- Specified by:
applyToDiscoveryServiceQuery
in class QueryFunction
- Throws:
QueryFunctionUnsupportedException
toString
public java.lang.String toString()
- Description copied from class:
QueryFunction
- 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.
- Specified by:
toString
in class QueryFunction