|
|||||||||
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 |
Constructor Summary | |
---|---|
protected |
ExposeRefinement()
|
|
ExposeRefinement(java.lang.String dimensionId)
|
|
ExposeRefinement(java.lang.String dimValId,
java.lang.String dimensionId)
|
|
ExposeRefinement(java.lang.String dimValId,
java.lang.String dimensionId,
java.lang.String groupKey)
|
Method Summary | |
---|---|
void |
applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
In this method we always use RefinementConfig elements to manage the exposure and closure of properties and dimensions. |
java.lang.String |
getDimensionId()
|
java.lang.String |
getDimValId()
|
boolean |
getExposeAll()
|
java.lang.String |
getGroupKey()
This property is required when using ExposeRefinement with Discovery Service-enabled datasources. |
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. |
boolean |
isDimExposed()
|
boolean |
isGroupExposed()
|
boolean |
isNavigableProp()
|
void |
parseMaxRefinements(java.lang.String maxRefinements)
String parser for the maximum number of refinements to return for dimensions and navigable properties for JSON init. |
void |
setDimensionId(java.lang.String dimensionId)
|
void |
setDimExposed(boolean dimExposed)
|
void |
setDimValId(java.lang.String dimValId)
|
void |
setExposeAll(boolean exposeAll)
|
void |
setGroupExposed(boolean groupExposed)
|
void |
setGroupKey(java.lang.String groupKey)
This property is required when using ExposeRefinement with Discovery Service-enabled datasources. |
void |
setMaxRefinements(java.math.BigInteger maxRefinements)
Sets the maximum number of refinements to return for dimensions and navigable properties. |
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 |
---|
beforeQueryStateAdd, clone, equals, equals, getName, hashCode, initializeFromJSON, setName |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected ExposeRefinement()
public ExposeRefinement(java.lang.String dimensionId)
public ExposeRefinement(java.lang.String dimValId, java.lang.String dimensionId)
public ExposeRefinement(java.lang.String dimValId, java.lang.String dimensionId, java.lang.String groupKey)
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 java.lang.String getGroupKey()
public void setGroupKey(java.lang.String groupKey)
groupKey
- public boolean isGroupExposed()
public void setGroupExposed(boolean groupExposed)
groupExposed
- public boolean isDimExposed()
public void setDimExposed(boolean dimExposed)
public boolean getExposeAll()
public void setExposeAll(boolean 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 parseMaxRefinements(java.lang.String maxRefinements)
maxRefinements
- public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query) throws QueryFunctionUnsupportedException
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 |