com.endeca.portal.attributes.model
Class Attribute

java.lang.Object
  com.endeca.portal.attributes.model.BasePropertyContainer
      com.endeca.portal.attributes.model.Attribute

public class Attribute
extends BasePropertyContainer

Represents an attribute object serializable via Jackson

Author:

Endeca Technologies, Inc

Field Summary

static java.lang.String	DISPLAY_NAME_PROPERTY
static java.lang.String	IS_PROPERTY_VALUE_SEARCHABLE_PROPERTY
static java.lang.String	IS_SHOW_RECORD_COUNTS
static java.lang.String	IS_SINGLE_ASSIGN_PROPERTY
static java.lang.String	IS_TEXT_SEARCH_ALLOWS_WILDCARDS_PROPERTY
static java.lang.String	IS_TEXT_SEARCHABLE_PROPERTY
static java.lang.String	IS_UNIQUE_PROPERTY
static java.lang.String	LOCALIZED_DISPLAY_NAME_PROPERTY
static java.lang.String	MDEX_TYPE_PROPERTY
static java.lang.String	MULTI_SELECT_TYPE_PROPERTY
static java.lang.String	SORT_ORDER_PROPERTY
static java.lang.String	SYSTEM_IS_DIMENSION
static java.lang.String	SYSTEM_LOCALIZED_DN_SETTINGS

Fields inherited from class com.endeca.portal.attributes.model.BasePropertyContainer

KEY_PROPERTY, properties

Constructor Summary

Attribute()

Method Summary

java.lang.String	getDisplayName()
java.lang.String	getDisplayName(java.util.Locale locale) Get display name by locale settings
java.lang.String	getDisplayName(javax.portlet.PortletRequest request) Get display name by request
java.lang.String	getDisplayName(java.lang.String languageId) Get display name bu language id
java.lang.String	getLocalizedDisplayName()
java.lang.String	getRefinementSortOrder()
java.lang.String	getSelectionModel()
boolean	isDimension(boolean defaultValue)
void	setDisplayName(java.lang.String displayName)
void	setLocalizedDisplayName(java.lang.String displayName)
void	setRefinementSortOrder(java.lang.String sortOrder) Sets the refinement sort order (e.g. lexical, record count).
void	setSelectionModel(java.lang.String selectionModel) Sets the refinement selection model (e.g. single, multi-or, multi-and).

Methods inherited from class com.endeca.portal.attributes.model.BasePropertyContainer

addProperty, getKey, getProperties, getProperty, getProperty, isEmpty, isValid, setKey, setProperties, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DISPLAY_NAME_PROPERTY

public static final java.lang.String DISPLAY_NAME_PROPERTY

See Also:

Constant Field Values

LOCALIZED_DISPLAY_NAME_PROPERTY

public static final java.lang.String LOCALIZED_DISPLAY_NAME_PROPERTY

See Also:

Constant Field Values

IS_SINGLE_ASSIGN_PROPERTY

public static final java.lang.String IS_SINGLE_ASSIGN_PROPERTY

See Also:

Constant Field Values

IS_SHOW_RECORD_COUNTS

public static final java.lang.String IS_SHOW_RECORD_COUNTS

See Also:

Constant Field Values

IS_TEXT_SEARCH_ALLOWS_WILDCARDS_PROPERTY

public static final java.lang.String IS_TEXT_SEARCH_ALLOWS_WILDCARDS_PROPERTY

See Also:

Constant Field Values

IS_TEXT_SEARCHABLE_PROPERTY

public static final java.lang.String IS_TEXT_SEARCHABLE_PROPERTY

See Also:

Constant Field Values

IS_PROPERTY_VALUE_SEARCHABLE_PROPERTY

public static final java.lang.String IS_PROPERTY_VALUE_SEARCHABLE_PROPERTY

See Also:

Constant Field Values

IS_UNIQUE_PROPERTY

public static final java.lang.String IS_UNIQUE_PROPERTY

See Also:

Constant Field Values

MDEX_TYPE_PROPERTY

public static final java.lang.String MDEX_TYPE_PROPERTY

See Also:

Constant Field Values

MULTI_SELECT_TYPE_PROPERTY

public static final java.lang.String MULTI_SELECT_TYPE_PROPERTY

See Also:

Constant Field Values

SORT_ORDER_PROPERTY

public static final java.lang.String SORT_ORDER_PROPERTY

See Also:

Constant Field Values

SYSTEM_LOCALIZED_DN_SETTINGS

public static final java.lang.String SYSTEM_LOCALIZED_DN_SETTINGS

See Also:

Constant Field Values

SYSTEM_IS_DIMENSION

public static final java.lang.String SYSTEM_IS_DIMENSION

See Also:

Constant Field Values

Constructor Detail

Attribute

public Attribute()

Method Detail

setDisplayName

public void setDisplayName(java.lang.String displayName)

Parameters:

displayName - the displayName to set

getDisplayName

public java.lang.String getDisplayName()

Returns:

the displayName

getDisplayName

public java.lang.String getDisplayName(java.lang.String languageId)

Get display name bu language id

Parameters:

languageId -

Returns:

getDisplayName

public java.lang.String getDisplayName(java.util.Locale locale)

Get display name by locale settings

Parameters:

locale -

Returns:

getDisplayName

public java.lang.String getDisplayName(javax.portlet.PortletRequest request)

Get display name by request

Parameters:

locale -

Returns:

setLocalizedDisplayName

public void setLocalizedDisplayName(java.lang.String displayName)

Parameters:

LocalizedDisplayName - the LocalizedDisplayName to set

getLocalizedDisplayName

public java.lang.String getLocalizedDisplayName()

Returns:

the LocalizedDisplayName

setRefinementSortOrder

public void setRefinementSortOrder(java.lang.String sortOrder)

Sets the refinement sort order (e.g. lexical, record count). Note that this method does NOT validate the input against the Sort enum in the config service; since this is a model, we leave that to higher-level logic to deal with.

Parameters:

sortOrder - the refinement sort order to set

getRefinementSortOrder

public java.lang.String getRefinementSortOrder()

Returns:

the sort order for refinements

setSelectionModel

public void setSelectionModel(java.lang.String selectionModel)

Sets the refinement selection model (e.g. single, multi-or, multi-and). Note that this method does NOT validate the input against the Select enum in the config service; since this is a model, we leave that to higher-level logic to deal with.

Parameters:

selectionModel - the selection model for refinements

getSelectionModel

public java.lang.String getSelectionModel()

Returns:

the selection model for refinements

isDimension

public boolean isDimension(boolean defaultValue)