|
|||||||||
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
public abstract class QueryFunction
The base class of all QueryFunctions. Wraps functionality for serializing and deserializing, cloning, and comparing. Refer to subclasses for specific types of functions.
QueryFilter
or QueryConfig
, not this class directly.
Other than that, simply pay attention to the abstract methods in this class
and your toString()
implementation.
QueryFilter
,
QueryConfig
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
CLASS_PROPERTY
|
Constructor Summary | |
---|---|
protected |
QueryFunction()
|
Method Summary | |
---|---|
abstract void |
applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
Apply this function to a Request. |
void |
beforeQueryStateAdd(QueryState state)
Function to check for any additional conditions when adding to the query state. |
QueryFunction |
clone()
|
boolean |
equals(java.lang.Object other)
|
boolean |
equals(QueryFunction other)
Compares two QueryFunction instances by checking class types and using the object's toString() method |
java.lang.String |
getName()
Retrieve the name. |
int |
hashCode()
|
void |
initializeFromJSON(MDEXState mdexState)
This method is called when constructing a MDEXState's initialQueryState from a json object. |
void |
setName(java.lang.String name)
Set the name. |
abstract 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 |
Field Detail |
---|
public static final java.lang.String CLASS_PROPERTY
Constructor Detail |
---|
protected QueryFunction()
Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the name to setpublic abstract void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query) throws QueryFunctionUnsupportedException
query
-
QueryFunctionUnsupportedException
public abstract java.lang.String toString()
toString
in class java.lang.Object
public QueryFunction clone()
clone
in class java.lang.Object
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public boolean equals(QueryFunction other)
other
-
QueryFunction
equals the otherpublic int hashCode()
hashCode
in class java.lang.Object
public void beforeQueryStateAdd(QueryState state)
public void initializeFromJSON(MDEXState mdexState) throws QueryFunctionInitializationException
ArbitraryLQLASTFilter
classes use this technique to allow different params/member vars for initialization
from json vs. initialization programmatically from within Java.
mdexState
- the MDEXState object on which this QueryFunction exists
QueryFunctionInitializationException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |