|
|||||||||
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.QueryConfig com.endeca.portal.data.functions.ExposeRefinement
public class ExposeRefinement
Expose a refinement in a query.
Field Summary |
---|
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 |
ExposeRefinement()
|
|
ExposeRefinement(com.endeca.mdex.conversation.RefinementExposeOperator operator)
|
|
ExposeRefinement(java.lang.String dimValId)
|
|
ExposeRefinement(java.lang.String dimValId,
java.lang.String dimensionId)
|
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 |
getDimensionId()
|
java.lang.String |
getDimValId()
|
boolean |
getExposeAll()
|
java.util.List<java.lang.reflect.Method> |
getGetters()
Return the list of property getters on this function. |
java.math.BigInteger |
getMaxRefinements()
Returns the maximum number of refinements to return for dimensions and navigable properties. |
java.lang.String |
getOwnerId()
Only relevant to discovery service data sources. |
java.util.List<java.lang.reflect.Method> |
getSetters()
Return the list of property setters on this function. |
boolean |
isDimExposed()
|
boolean |
isNavigableProp()
|
void |
setDimensionId(java.lang.String dimensionId)
|
void |
setDimExposed(boolean dimExposed)
|
void |
setDimExposed(java.lang.String dimExposed)
|
void |
setDimValId(java.lang.String dimValId)
|
void |
setExposeAll(boolean exposeAll)
|
void |
setExposeAll(java.lang.String exposeAll)
|
void |
setMaxRefinements(java.math.BigInteger maxRefinements)
Sets the maximum number of refinements to return for dimensions and navigable properties. |
void |
setMaxRefinements(int maxRefinements)
Convenience method to set the maximum number of refinements to return for dimensions and navigable properties using an int. |
void |
setMaxRefinements(java.lang.String maxRefinements)
String setter for the maximum number of refinements to return for dimensions and navigable properties for JSON init. |
void |
setOwnerId(java.lang.String ownerId)
Set the ownerID of this function. |
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 |
Constructor Detail |
---|
protected ExposeRefinement()
public ExposeRefinement(java.lang.String dimValId)
public ExposeRefinement(java.lang.String dimValId, java.lang.String dimensionId)
public ExposeRefinement(com.endeca.mdex.conversation.RefinementExposeOperator operator)
Method Detail |
---|
public java.lang.String getDimValId()
public void setDimValId(java.lang.String dimValId)
public java.lang.String getDimensionId()
public void setDimensionId(java.lang.String dimensionId)
public boolean isDimExposed()
public void setDimExposed(boolean dimExposed)
public void setDimExposed(java.lang.String dimExposed)
public boolean getExposeAll()
public void setExposeAll(boolean exposeAll)
public void setExposeAll(java.lang.String exposeAll)
public java.lang.String getOwnerId()
public void setOwnerId(java.lang.String ownerId)
ownerId
- public java.math.BigInteger getMaxRefinements()
public void setMaxRefinements(java.math.BigInteger maxRefinements)
maxRefinements
- public void setMaxRefinements(int maxRefinements)
maxRefinements
- public void setMaxRefinements(java.lang.String maxRefinements)
maxRefinements
- 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.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 boolean isNavigableProp()
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 |