com.endeca.portal.attributes.viewmodel
Class Attribute

java.lang.Object
  extended by com.endeca.portal.attributes.model.BasePropertyContainer
      extended by com.endeca.portal.attributes.viewmodel.Attribute

public class Attribute
extends BasePropertyContainer

Represents an attribute object serializable via Jackson

Author:
Endeca Technologies, Inc

Field Summary
static java.lang.String AVAILABLE_AGGREGATIONS_PROPERTY
           
static java.lang.String DATA_TYPE_PROPERTY
           
static java.lang.String DEFAULT_AGGREGATION_PROPERTY
           
static java.lang.String DESCRIPTION_PROPERTY
           
static java.lang.String DISPLAY_NAME_PROPERTY
           
static java.lang.String FORMATTER_PROPERTY
           
static java.lang.String IS_DIMENSION_PROPERTY
           
static java.lang.String IS_KEY_COLUMN_PROPERTY
           
static java.lang.String IS_REFINEABLE_PROPERTY
           
static java.lang.String LOCALIZED_DISPLAY_NAME_PROPERTY
           
static java.lang.String NAVIGATION_ORDERING_PROPERTY
          Lexical/Dynamic
static java.lang.String REFINEMENT_BEHAVIOR_PROPERTY
          Single, Multi-AND, Multi-OR
 
Fields inherited from class com.endeca.portal.attributes.model.BasePropertyContainer
KEY_PROPERTY, properties
 
Constructor Summary
Attribute()
           
 
Method Summary
 java.lang.String getAvailableAggregations()
           
 java.lang.String getDatatype()
           
 java.lang.String getDefaultAggregation()
           
 java.lang.String getDescription()
           
 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 getFormatter()
           
 java.lang.String getLocalizedDisplayName()
           
 java.lang.String getNavigationOrder()
           
 java.lang.String getRefinement()
           
 boolean isDimension()
           
 boolean isKeyColumn()
           
 boolean isRefineable()
           
 void setAvailableAggregations(java.lang.String availableAggregations)
          Sets the Available Aggregations
 void setDatatype(java.lang.String dataType)
          Sets the dataType
 void setDefaultAggregation(java.lang.String defaultAggregation)
          Sets the Default Aggregation
 void setDescription(java.lang.String description)
          Sets the description
 void setDimension(boolean isDimension)
          Sets whether or not this is a dimension
 void setDisplayName(java.lang.String displayName)
           
 void setFormatter(java.lang.String formatter)
          Sets the Formatter
 void setKeyColumn(boolean isKeyColumn)
          Sets whether or not this is Key Column
 void setLocalizedDisplayName(java.lang.String displayName)
           
 void setNavigationOrder(java.lang.String order)
          Sets the navigation order
 void setRefineable(boolean isRefineable)
          Sets whether or not this is refineable
 void setRefinement(java.lang.String refinement)
          Sets the refinement behavior
 
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

DATA_TYPE_PROPERTY

public static final java.lang.String DATA_TYPE_PROPERTY
See Also:
Constant Field Values

IS_DIMENSION_PROPERTY

public static final java.lang.String IS_DIMENSION_PROPERTY
See Also:
Constant Field Values

DESCRIPTION_PROPERTY

public static final java.lang.String DESCRIPTION_PROPERTY
See Also:
Constant Field Values

REFINEMENT_BEHAVIOR_PROPERTY

public static final java.lang.String REFINEMENT_BEHAVIOR_PROPERTY
Single, Multi-AND, Multi-OR

See Also:
Constant Field Values

NAVIGATION_ORDERING_PROPERTY

public static final java.lang.String NAVIGATION_ORDERING_PROPERTY
Lexical/Dynamic

See Also:
Constant Field Values

IS_KEY_COLUMN_PROPERTY

public static final java.lang.String IS_KEY_COLUMN_PROPERTY
See Also:
Constant Field Values

IS_REFINEABLE_PROPERTY

public static final java.lang.String IS_REFINEABLE_PROPERTY
See Also:
Constant Field Values

AVAILABLE_AGGREGATIONS_PROPERTY

public static final java.lang.String AVAILABLE_AGGREGATIONS_PROPERTY
See Also:
Constant Field Values

DEFAULT_AGGREGATION_PROPERTY

public static final java.lang.String DEFAULT_AGGREGATION_PROPERTY
See Also:
Constant Field Values

FORMATTER_PROPERTY

public static final java.lang.String FORMATTER_PROPERTY
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

setDatatype

public void setDatatype(java.lang.String dataType)
Sets the dataType

Parameters:
dataType - the dataType to set

getDatatype

public java.lang.String getDatatype()
Returns:
the dataType

isDimension

public boolean isDimension()
Returns:
true if this is a dimension

setDimension

public void setDimension(boolean isDimension)
Sets whether or not this is a dimension

Parameters:
isDimension -

setDescription

public void setDescription(java.lang.String description)
Sets the description

Parameters:
description - the description to set

getDescription

public java.lang.String getDescription()
Returns:
the description

setRefinement

public void setRefinement(java.lang.String refinement)
Sets the refinement behavior

Parameters:
refinement - the refinement behavior to set

getRefinement

public java.lang.String getRefinement()
Returns:
the refinement

setNavigationOrder

public void setNavigationOrder(java.lang.String order)
Sets the navigation order

Parameters:
order - the navigation order to set

getNavigationOrder

public java.lang.String getNavigationOrder()
Returns:
the navigation order

isRefineable

public boolean isRefineable()
Returns:
true if this is refineable

setRefineable

public void setRefineable(boolean isRefineable)
Sets whether or not this is refineable

Parameters:
isRefineable -

isKeyColumn

public boolean isKeyColumn()
Returns:
true if this is key column

setKeyColumn

public void setKeyColumn(boolean isKeyColumn)
Sets whether or not this is Key Column

Parameters:
isKeyColumn -

setAvailableAggregations

public void setAvailableAggregations(java.lang.String availableAggregations)
Sets the Available Aggregations

Parameters:
availableAggregations - the Available Aggregations to set

getAvailableAggregations

public java.lang.String getAvailableAggregations()
Returns:
the Available Aggregations

setDefaultAggregation

public void setDefaultAggregation(java.lang.String defaultAggregation)
Sets the Default Aggregation

Parameters:
defaultAggregation - the Default Aggregation to set

getDefaultAggregation

public java.lang.String getDefaultAggregation()
Returns:
the Default Aggregation

setFormatter

public void setFormatter(java.lang.String formatter)
Sets the Formatter

Parameters:
formatter - the description to set

getFormatter

public java.lang.String getFormatter()
Returns:
the Formatter