com.endeca.portal.attributes.model
Enum RefinementSelectionMode

java.lang.Object
  java.lang.Enum<RefinementSelectionMode>
      com.endeca.portal.attributes.model.RefinementSelectionMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RefinementSelectionMode>

public enum RefinementSelectionMode
extends java.lang.Enum<RefinementSelectionMode>

Represents all the supported selection modes for a refinement attribute.

Enum Constant Summary

MULTI_AND

MULTI_OR

SINGLE

Method Summary

boolean	equalsMdexValue(java.lang.String mdexValue)
com.endeca.mdex.xquery._2009._09.Select	getMdexMode()
static RefinementSelectionMode	parseSelectionMode(java.lang.String mdexMode) Find the RefinementSelectionMode corresponding to the specified system-navigation_Select value obtained from the Endeca Server metadata.
static RefinementSelectionMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RefinementSelectionMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MULTI_AND

public static final RefinementSelectionMode MULTI_AND

MULTI_OR

public static final RefinementSelectionMode MULTI_OR

SINGLE

public static final RefinementSelectionMode SINGLE

Method Detail

values

public static RefinementSelectionMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RefinementSelectionMode c : RefinementSelectionMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RefinementSelectionMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

parseSelectionMode

public static RefinementSelectionMode parseSelectionMode(java.lang.String mdexMode)

Find the RefinementSelectionMode corresponding to the specified system-navigation_Select value obtained from the Endeca Server metadata.

Parameters:

mdexMode - the mode value from the Endeca Server system-navigation_Select metadata attribute

Returns:

the corresponding RefinementSelectionMode or null if the value was not understood

getMdexMode

public com.endeca.mdex.xquery._2009._09.Select getMdexMode()

Returns:

Endeca Server's system-navigation_Select value for this mode

equalsMdexValue

public boolean equalsMdexValue(java.lang.String mdexValue)

Returns:

true if this mode matches the specified String value (e.g. "multi-and", "multi-or" or "single")