Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.endeca.portal.data.functions
Class ExposeRefinement

    java.lang.Object
      com.endeca.portal.data.functions.QueryFunction
          com.endeca.portal.data.functions.QueryConfig
              com.endeca.portal.data.functions.ExposeRefinement

All Implemented Interfaces:
  java.io.Serializable, java.lang.Cloneable

    public class ExposeRefinement

extends QueryConfig

Expose a refinement in a query.

See Also:
  Serialized Form

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.
`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.lang.String` | `getGroupKey()` Only applies to 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.
`java.util.List<java.lang.reflect.Method>` | `getSetters()` Return the list of property setters on this function.
`boolean` | `isDimExposed()`
`boolean` | `isGroupExposed()` Only applies to Discovery Service enabled datasources.
`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` | `setGroupExposed(boolean groupExposed)` Only applies to Discovery Service enabled datasources.
`void` | `setGroupExposed(java.lang.String groupExposed)` Only applies to Discovery Service enabled datasources.
`void` | `setGroupKey(java.lang.String groupKey)` Only applies to Discovery Service enabled datasources.
`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, hashCode, init, setName, toJSON`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

### ExposeRefinement

    protected ExposeRefinement()

### ExposeRefinement

    public ExposeRefinement(java.lang.String dimensionId)

### ExposeRefinement

    public ExposeRefinement(java.lang.String dimValId,
                            java.lang.String dimensionId)

### ExposeRefinement

    public ExposeRefinement(java.lang.String dimValId,
                            java.lang.String dimensionId,
                            java.lang.String groupKey)

Method Detail

### getDimValId

    public java.lang.String getDimValId()

### setDimValId

    public void setDimValId(java.lang.String dimValId)

### getDimensionId

    public java.lang.String getDimensionId()

### setDimensionId

    public void setDimensionId(java.lang.String dimensionId)

### getGroupKey

    public java.lang.String getGroupKey()

  Only applies to Discovery Service enabled datasources. Will have no effect on ENEQuery datasources. This property is required when using ExposeRefinement with Discovery Service-enabled datasources.

  Returns:

### setGroupKey

    public void setGroupKey(java.lang.String groupKey)

  Only applies to Discovery Service enabled datasources. Will have no effect on ENEQuery datasources. This property is required when using ExposeRefinement with Discovery Service-enabled datasources.

  Parameters:
    `groupKey` -

### isGroupExposed

    public boolean isGroupExposed()

  Only applies to Discovery Service enabled datasources. Will have no effect on ENEQuery datasources.

  Returns:
    isGroupExposed

### setGroupExposed

    public void setGroupExposed(boolean groupExposed)

  Only applies to Discovery Service enabled datasources. Will have no effect on ENEQuery datasources.

  Parameters:
    `groupExposed` -

### setGroupExposed

    public void setGroupExposed(java.lang.String groupExposed)

  Only applies to Discovery Service enabled datasources. Will have no effect on ENEQuery datasources.

  Parameters:
    `groupExposed` -

### isDimExposed

    public boolean isDimExposed()

### setDimExposed

    public void setDimExposed(boolean dimExposed)

### setDimExposed

    public void setDimExposed(java.lang.String dimExposed)

### getExposeAll

    public boolean getExposeAll()

### setExposeAll

    public void setExposeAll(boolean exposeAll)

### setExposeAll

    public void setExposeAll(java.lang.String exposeAll)

### getOwnerId

    public java.lang.String getOwnerId()

  Only relevant to discovery service data sources.

  Returns:
    the owning NavConfig's id.

### setOwnerId

    public void setOwnerId(java.lang.String ownerId)

  Set the ownerID of this function. This property should be equal to the id property of a NavConfig instance that is on the same QueryState. Not required: if never set, this function, when applied to a request, will assume this expose should be applied to the default NavConfig. Only relevant to discovery service data sources.

  Parameters:
    `ownerId` -

### getMaxRefinements

    public java.math.BigInteger getMaxRefinements()

  Returns the maximum number of refinements to return for dimensions and navigable properties. Only relevant to discovery service data sources

  Returns:

### setMaxRefinements

    public void setMaxRefinements(java.math.BigInteger maxRefinements)

  Sets the maximum number of refinements to return for dimensions and navigable properties. Only relevant to discovery service data sources

  Parameters:
    `maxRefinements` -

### setMaxRefinements

    public void setMaxRefinements(int maxRefinements)

  Convenience method to set the maximum number of refinements to return for dimensions and navigable properties using an int. Only relevant to discovery service data sources.

  Parameters:
    `maxRefinements` -

### setMaxRefinements

    public void setMaxRefinements(java.lang.String maxRefinements)

  String setter for the maximum number of refinements to return for dimensions and navigable properties for JSON init. Only relevant to discovery service data sources.

  Parameters:
    `maxRefinements` -

### getSetters

    public java.util.List<java.lang.reflect.Method> getSetters()

  Description copied from class: `QueryFunction`
  Return the list of property setters on this function. Must be implemented by subclass. Required for correct JSON serialization/deserialization support. For most subclasses, implementing this method should be simple, as long as your setter methods follow standard Java naming conventions (e.g. "setPropertyName(PropertyType)"). All you should need to write is: `

       private static List setters = Reflection.getSetters(MyFunctionClass.class);
       \@Override
       public List getSetters() {
              return setters;
       }

  `

  Specified by:
    `getSetters` in class `QueryFunction`
  Returns:
    the list of setters

### getGetters

    public java.util.List<java.lang.reflect.Method> getGetters()

  Description copied from class: `QueryFunction`
  Return the list of property getters on this function. Must be implemented by subclass. Required for correct JSON serialization/deserialization support. For most subclasses, implementing this method should be simple, as long as your getter methods follow standard Java naming conventions (e.g. "getPropertyName()"). All you should need to write is: `

       private static List getters = Reflection.getGetters(MyFunctionClass.class);
       \@Override
       public List getGetters() {
              return getters;
       }

  `

  Specified by:
    `getGetters` in class `QueryFunction`
  Returns:
    the list of getters

### applyToENEQuery

    public void applyToENEQuery(com.endeca.navigation.ENEQuery query)

  Description copied from class: `QueryFunction`
  Apply this function to an ENEQuery. Must be implemented by subclass.

  Specified by:
    `applyToENEQuery` in class `QueryFunction`

### applyToDiscoveryServiceQuery

    public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
                                      throws QueryFunctionUnsupportedException

  In this method we always use RefinementConfig elements to manage the exposure and closure of properties and dimensions. The RefinementExposeOperator isn't used because a RefinementConfig element is required even when that operator is present (which makes the operator fairly useless).

  Specified by:
    `applyToDiscoveryServiceQuery` in class `QueryFunction`
  Throws:
    `QueryFunctionUnsupportedException`

### isNavigableProp

    public boolean isNavigableProp()

### 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`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD