Attribute

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Attribute
extends BasePropertyContainer
implements java.lang.Cloneable
```
Represents an attribute object serializable via Jackson

Author:

Endeca Technologies, Inc

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPROX_CARDINALITY_PROPERTY`
`static java.lang.String`	`AVAILABLE_AGGREGATIONS_PROPERTY`
`static java.lang.String`	`AVAILABLE_DATETIME_PARTS_PROPERTY`
`static java.lang.String`	`AVG_LENGTH_PROPERTY`
`static java.lang.String`	`DATA_SOURCE_KEY_PROPERTY`
`static java.lang.String`	`DATA_TYPE_PROPERTY`
`static java.lang.String`	`DATETIME_COMBOS_ENABLED_PROPERTY`
`static java.lang.String`	`DEFAULT_AGGREGATION_PROPERTY`
`static java.lang.String`	`DEFAULT_CASCADE_DATETIME_PARTS_PROPERTY`
`static java.lang.String`	`DEFAULT_DATETIME_PARTS_PROPERTY`
`static java.lang.String`	`DEFAULT_DESCRIPTION_PROPERTY`
`static java.lang.String`	`DEFAULT_DISPLAY_NAME_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_INCLUDED_IN_AVAILABLE_REFINEMENTS_PROPERTY`
`static java.lang.String`	`IS_INDEXED_FOR_TEXT_SEARCH`
`static java.lang.String`	`IS_KEY_COLUMN_PROPERTY`
`static java.lang.String`	`IS_REFINEABLE_PROPERTY`
`static java.lang.String`	`IS_SINGLE_ASSIGN_PROPERTY`
`static java.lang.String`	`IS_VALUE_SEARCHABLE`
`static java.lang.String`	`LOCALIZED_DESCRIPTION_PROPERTY`
`static java.lang.String`	`LOCALIZED_DISPLAY_NAME_PROPERTY`
`static java.lang.String`	`MDEX_TYPE_PROPERTY`
`static java.lang.String`	`NAVIGATION_ORDERING_PROPERTY` Lexical/Dynamic
`static java.lang.String`	`NOTES`
`static java.lang.String`	`NOTES_LAST_MODIFIED_DATE`
`static java.lang.String`	`NOTES_LAST_MODIFIED_USERID`
`static java.lang.String`	`REFINEMENT_SELECTION_MODE` Single, Multi-AND, Multi-OR
`static java.lang.String`	`SEMANTIC_TYPE`
`static java.lang.String`	`SOURCE_ATTRIBUTE_KEY_PROPERTY`
`static java.lang.String`	`SOURCE_COLLECTION_KEY_PROPERTY`
`static java.lang.String`	`TAGS`
`static java.lang.String`	`VALUE_LANGUAGE`

Fields inherited from class com.endeca.portal.attributes.model.BasePropertyContainer
KEY_PROPERTY, properties

Constructor Summary

Constructors
Constructor and Description

Attribute()

Constructors
Constructor and Description
`Attribute()`

Method Summary

Methods
Modifier and Type	Method and Description
`Attribute`	`clone()`
`static java.lang.String`	`convertLocalizedMetadataMapToString(java.util.Map<java.lang.String,java.lang.String> localizedMetadataMap)` Utility function to get the string based representation of the locale metadata
`static java.util.Map<java.lang.String,java.lang.String>`	`convertLocalizedMetadataToMap(java.lang.String localizedMetadata)` Utility function to get the locale-attribute mappings in a Map object.
`com.oracle.endeca.pdi.concepts.ApproxCardinality`	`getApproxCardinality()`
`java.lang.String`	`getAvailableAggregations()`
`java.lang.String`	`getAvailableDateTimeParts()`
`long`	`getAverageLength()`
`java.lang.String`	`getDataSourceKey()`
`java.lang.String`	`getDatatype()`
`java.lang.String`	`getDatetimeCombosEnabled()`
`java.util.List<java.util.List<DatePart>>`	`getDatetimeCombosEnabledAsList()`
`java.lang.String`	`getDefaultAggregation()`
`java.lang.String`	`getDefaultCascadeDateTimeParts()`
`java.lang.String`	`getDefaultDateTimeParts()`
`java.lang.String`	`getDefaultDescription()` Get the default Description
`java.lang.String`	`getDefaultDisplayName()` Get the Display name for the system default
`java.lang.String`	`getDescription()`
`java.lang.String`	`getDescription(java.util.Locale locale)` Get description by locale settings
`java.lang.String`	`getDescription(javax.portlet.PortletRequest request)` Get description by request
`java.lang.String`	`getDescription(java.lang.String languageId)` Get description bu language id
`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 by language id
`java.lang.String`	`getFormatter()`
`java.lang.String`	`getLocalizedDescription()`
`java.lang.String`	`getLocalizedDisplayName()`
`java.lang.String`	`getNavigationOrder()`
`java.lang.String`	`getNotes()`
`java.util.Date`	`getNotesLastModifiedDate()`
`long`	`getNotesLastModifiedUserId()`
`RefinementSelectionMode`	`getRefinementSelectionMode()` Gets the refinement selection mode of this attribute.
`java.lang.String`	`getSemanticType()`
`java.lang.String`	`getSourceAttributeKey()`
`java.lang.String`	`getSourceCollectionKey()`
`java.util.List<java.lang.String>`	`getTags()`
`PropertyType`	`getType()` Gets the data type of this attribute.
`java.lang.String`	`getValueLanguage()` Indicates the language of this attribute's value space.
`boolean`	`isAttributeValueSearchEnabled()` Indicates if this attribute is enabled for and can be used in a value search.
`boolean`	`isDimension()`
`boolean`	`isIncludedInAvailableRefinements()`
`boolean`	`isIndexedForTextSearch()` Indicates if this attribute is enabled for and can be used in a text search filter.
`boolean`	`isKeyColumn()`
`boolean`	`isRefineable()`
`boolean`	`isSingleAssign()`
`void`	`setApproxCardinality(com.oracle.endeca.pdi.concepts.ApproxCardinality approxCardinality)` Set approx cardinality value
`void`	`setAttributeValueSearchEnabled(boolean isValueSearchable)`
`void`	`setAvailableAggregations(java.lang.String availableAggregations)` Sets the Available Aggregations
`void`	`setAvailableDateTimeParts(java.lang.String availableDateTimeParts)`
`void`	`setAverageLength(long avgLength)`
`void`	`setDataSourceKey(java.lang.String dataSourceKey)` Set the data source key
`void`	`setDatatype(java.lang.String dataType)` Sets the dataType
`void`	`setDatetimeCombosEnabled(java.lang.String dateTimeCombosEnabled)`
`void`	`setDefaultAggregation(java.lang.String defaultAggregation)` Sets the Default Aggregation
`void`	`setDefaultCascadeDateTimeParts(java.lang.String defaultCascadeDateTimeParts)`
`void`	`setDefaultDateTimeParts(java.lang.String defaultDateTimeParts)`
`void`	`setDefaultDescription(java.lang.String description)` Set the default description
`void`	`setDefaultDisplayName(java.lang.String displayName)` Set the Default Display Name
`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`	`setIncludedInAvailableRefinements(boolean isIncluded)` Sets whether or not this is included in available refinements
`void`	`setIndexedForTextSearch(boolean indexed)`
`void`	`setKeyColumn(boolean isKeyColumn)` Sets whether or not this is Key Column
`void`	`setLocalizedDescription(java.lang.String description)`
`void`	`setLocalizedDisplayName(java.lang.String displayName)`
`void`	`setNavigationOrder(java.lang.String order)` Sets the navigation order
`void`	`setNotes(java.lang.String notes)` Sets the NOTES
`void`	`setNotesLastModifiedDate(java.util.Date date)` Notes Last Modified Date
`void`	`setNotesLastModifiedUserId(long userId)` Notes Last Modified User
`void`	`setRefineable(boolean isRefineable)` Sets whether or not this is refineable
`void`	`setRefinementSelectionMode(RefinementSelectionMode mode)`
`void`	`setSemanticType(java.lang.String semanticType)` Sets the SEMANTIC TYPE
`void`	`setSingleAssign(boolean isSingleAssign)` Sets whether or not this is Single Assign
`void`	`setSourceAttributeKey(java.lang.String sourceAttributeKey)` Sets the source attribute key
`void`	`setSourceCollectionKey(java.lang.String sourceCollectionKey)` Sets the source collection key
`void`	`setTags(java.util.List<java.lang.String> tags)` Sets list of tags
`void`	`setValueLanguage(java.lang.String langCode)` Sets the language code of this attribute's value space.

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
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
  - DEFAULT_DISPLAY_NAME_PROPERTY
```
public static final java.lang.String DEFAULT_DISPLAY_NAME_PROPERTY
```
    See Also:
    Constant Field Values
  - DESCRIPTION_PROPERTY
```
public static final java.lang.String DESCRIPTION_PROPERTY
```
    See Also:
    Constant Field Values
  - LOCALIZED_DESCRIPTION_PROPERTY
```
public static final java.lang.String LOCALIZED_DESCRIPTION_PROPERTY
```
    See Also:
    Constant Field Values
  - DEFAULT_DESCRIPTION_PROPERTY
```
public static final java.lang.String DEFAULT_DESCRIPTION_PROPERTY
```
    See Also:
    Constant Field Values
  - DATA_TYPE_PROPERTY
```
public static final java.lang.String DATA_TYPE_PROPERTY
```
    See Also:
    Constant Field Values
  - AVG_LENGTH_PROPERTY
```
public static final java.lang.String AVG_LENGTH_PROPERTY
```
    See Also:
    Constant Field Values
  - IS_DIMENSION_PROPERTY
```
public static final java.lang.String IS_DIMENSION_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_INCLUDED_IN_AVAILABLE_REFINEMENTS_PROPERTY
```
public static final java.lang.String IS_INCLUDED_IN_AVAILABLE_REFINEMENTS_PROPERTY
```
    See Also:
    Constant Field Values
  - IS_VALUE_SEARCHABLE
```
public static final java.lang.String IS_VALUE_SEARCHABLE
```
    See Also:
    Constant Field Values
  - IS_INDEXED_FOR_TEXT_SEARCH
```
public static final java.lang.String IS_INDEXED_FOR_TEXT_SEARCH
```
    See Also:
    Constant Field Values
  - MDEX_TYPE_PROPERTY
```
public static final java.lang.String MDEX_TYPE_PROPERTY
```
    See Also:
    Constant Field Values
  - SEMANTIC_TYPE
```
public static final java.lang.String SEMANTIC_TYPE
```
    See Also:
    Constant Field Values
  - TAGS
```
public static final java.lang.String TAGS
```
    See Also:
    Constant Field Values
  - NOTES
```
public static final java.lang.String NOTES
```
    See Also:
    Constant Field Values
  - NOTES_LAST_MODIFIED_DATE
```
public static final java.lang.String NOTES_LAST_MODIFIED_DATE
```
    See Also:
    Constant Field Values
  - NOTES_LAST_MODIFIED_USERID
```
public static final java.lang.String NOTES_LAST_MODIFIED_USERID
```
    See Also:
    Constant Field Values
  - REFINEMENT_SELECTION_MODE
```
public static final java.lang.String REFINEMENT_SELECTION_MODE
```
    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
  - AVAILABLE_DATETIME_PARTS_PROPERTY
```
public static final java.lang.String AVAILABLE_DATETIME_PARTS_PROPERTY
```
    See Also:
    Constant Field Values
  - DEFAULT_DATETIME_PARTS_PROPERTY
```
public static final java.lang.String DEFAULT_DATETIME_PARTS_PROPERTY
```
    See Also:
    Constant Field Values
  - DEFAULT_CASCADE_DATETIME_PARTS_PROPERTY
```
public static final java.lang.String DEFAULT_CASCADE_DATETIME_PARTS_PROPERTY
```
    See Also:
    Constant Field Values
  - DATETIME_COMBOS_ENABLED_PROPERTY
```
public static final java.lang.String DATETIME_COMBOS_ENABLED_PROPERTY
```
    See Also:
    Constant Field Values
  - FORMATTER_PROPERTY
```
public static final java.lang.String FORMATTER_PROPERTY
```
    See Also:
    Constant Field Values
  - SOURCE_ATTRIBUTE_KEY_PROPERTY
```
public static final java.lang.String SOURCE_ATTRIBUTE_KEY_PROPERTY
```
    See Also:
    Constant Field Values
  - SOURCE_COLLECTION_KEY_PROPERTY
```
public static final java.lang.String SOURCE_COLLECTION_KEY_PROPERTY
```
    See Also:
    Constant Field Values
  - APPROX_CARDINALITY_PROPERTY
```
public static final java.lang.String APPROX_CARDINALITY_PROPERTY
```
    See Also:
    Constant Field Values
  - VALUE_LANGUAGE
```
public static final java.lang.String VALUE_LANGUAGE
```
    See Also:
    Constant Field Values
  - DATA_SOURCE_KEY_PROPERTY
```
public static final java.lang.String DATA_SOURCE_KEY_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(java.lang.String languageId)
```
    Get display name by 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:
  - getDefaultDisplayName
```
public java.lang.String getDefaultDisplayName()
```
    Get the Display name for the system default
    
    Returns:
  - setDefaultDisplayName
```
public void setDefaultDisplayName(java.lang.String displayName)
```
    Set the Default Display Name
    
    Parameters:
    displayName -
  - setLocalizedDisplayName
```
public void setLocalizedDisplayName(java.lang.String displayName)
```
    Parameters:
    LocalizedDisplayName - the LocalizedDisplayName to set
  - getLocalizedDisplayName
```
public java.lang.String getLocalizedDisplayName()
```
    Returns:
    the LocalizedDisplayName
  - setSemanticType
```
public void setSemanticType(java.lang.String semanticType)
```
    Sets the SEMANTIC TYPE
    
    Parameters:
    sourceCollectionKey - the source collection key to set
  - getSemanticType
```
public java.lang.String getSemanticType()
```
    Returns:
    the SEMANTIC TYPE
  - getTags
```
public java.util.List<java.lang.String> getTags()
```
    Returns:
    list of tags
  - setTags
```
public void setTags(java.util.List<java.lang.String> tags)
```
    Sets list of tags
    
    Parameters:
    isDimension -
  - setNotes
```
public void setNotes(java.lang.String notes)
```
    Sets the NOTES
    
    Parameters:
    sourceCollectionKey - the source collection key to set
  - getNotes
```
public java.lang.String getNotes()
```
    Returns:
    the NOTES
  - getNotesLastModifiedDate
```
public java.util.Date getNotesLastModifiedDate()
```
    Returns:
    Notes Last Modified Date
  - setNotesLastModifiedDate
```
public void setNotesLastModifiedDate(java.util.Date date)
```
    Notes Last Modified Date
    
    Parameters:
    date -
  - getNotesLastModifiedUserId
```
public long getNotesLastModifiedUserId()
```
    Returns:
    Notes Last Modified User
  - setNotesLastModifiedUserId
```
public void setNotesLastModifiedUserId(long userId)
```
    Notes Last Modified User
    
    Parameters:
    date -
  - 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
  - getValueLanguage
```
public java.lang.String getValueLanguage()
```
    Indicates the language of this attribute's value space. This primarily impacts search indexing for the attribute.
    
    Returns:
    mdex language code or null if language is unknown
  - setValueLanguage
```
public void setValueLanguage(java.lang.String langCode)
```
    Sets the language code of this attribute's value space.
    
    See Also:
    getValueLanguage()
  - 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 -
  - convertLocalizedMetadataToMap
```
public static java.util.Map<java.lang.String,java.lang.String> convertLocalizedMetadataToMap(java.lang.String localizedMetadata)
```
    Utility function to get the locale-attribute mappings in a Map object.
    
    Returns:
  - convertLocalizedMetadataMapToString
```
public static java.lang.String convertLocalizedMetadataMapToString(java.util.Map<java.lang.String,java.lang.String> localizedMetadataMap)
```
    Utility function to get the string based representation of the locale metadata
    
    Returns:
  - 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
  - getDescription
```
public java.lang.String getDescription(java.lang.String languageId)
```
    Get description bu language id
    
    Parameters:
    languageId -
    
    Returns:
  - getDescription
```
public java.lang.String getDescription(java.util.Locale locale)
```
    Get description by locale settings
    
    Parameters:
    locale -
    
    Returns:
  - getDescription
```
public java.lang.String getDescription(javax.portlet.PortletRequest request)
```
    Get description by request
    
    Parameters:
    locale -
    
    Returns:
  - getDefaultDescription
```
public java.lang.String getDefaultDescription()
```
    Get the default Description
    
    Returns:
  - setDefaultDescription
```
public void setDefaultDescription(java.lang.String description)
```
    Set the default description
    
    Parameters:
    description -
  - setLocalizedDescription
```
public void setLocalizedDescription(java.lang.String description)
```
    Parameters:
    LocalizedDescription - the LocalizedDescription to set
  - getLocalizedDescription
```
public java.lang.String getLocalizedDescription()
```
    Returns:
    the LocalizedDescription
  - 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
  - setApproxCardinality
```
public void setApproxCardinality(com.oracle.endeca.pdi.concepts.ApproxCardinality approxCardinality)
```
    Set approx cardinality value
    
    Parameters:
    approxCardinality - the approx cardinality value to set
  - getApproxCardinality
```
public com.oracle.endeca.pdi.concepts.ApproxCardinality getApproxCardinality()
```
    Returns:
    the approx cardinality value
  - setDataSourceKey
```
public void setDataSourceKey(java.lang.String dataSourceKey)
```
    Set the data source key
    
    Parameters:
    dataSourceKey - the data source key
  - getDataSourceKey
```
public java.lang.String getDataSourceKey()
```
    Returns:
    dataSourceKey the data source key
  - 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
  - setAvailableDateTimeParts
```
public void setAvailableDateTimeParts(java.lang.String availableDateTimeParts)
```
  - getAvailableDateTimeParts
```
public java.lang.String getAvailableDateTimeParts()
```
  - setDefaultDateTimeParts
```
public void setDefaultDateTimeParts(java.lang.String defaultDateTimeParts)
```
  - setDefaultCascadeDateTimeParts
```
public void setDefaultCascadeDateTimeParts(java.lang.String defaultCascadeDateTimeParts)
```
  - getDefaultDateTimeParts
```
public java.lang.String getDefaultDateTimeParts()
```
  - getDefaultCascadeDateTimeParts
```
public java.lang.String getDefaultCascadeDateTimeParts()
```
  - setDatetimeCombosEnabled
```
public void setDatetimeCombosEnabled(java.lang.String dateTimeCombosEnabled)
```
  - getDatetimeCombosEnabled
```
public java.lang.String getDatetimeCombosEnabled()
```
  - getDatetimeCombosEnabledAsList
```
public java.util.List<java.util.List<DatePart>> getDatetimeCombosEnabledAsList()
                                                                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - 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
  - setSourceAttributeKey
```
public void setSourceAttributeKey(java.lang.String sourceAttributeKey)
```
    Sets the source attribute key
    
    Parameters:
    sourceAttributeKey - the source attribute key to set
  - getSourceAttributeKey
```
public java.lang.String getSourceAttributeKey()
```
    Returns:
    the source attribute key
  - setSourceCollectionKey
```
public void setSourceCollectionKey(java.lang.String sourceCollectionKey)
```
    Sets the source collection key
    
    Parameters:
    sourceCollectionKey - the source collection key to set
  - getSourceCollectionKey
```
public java.lang.String getSourceCollectionKey()
```
    Returns:
    the source colection key
  - isSingleAssign
```
public boolean isSingleAssign()
```
    Returns:
    true if this is Single Assign(not multi-value)
  - setSingleAssign
```
public void setSingleAssign(boolean isSingleAssign)
```
    Sets whether or not this is Single Assign
    
    Parameters:
    isRefineable -
  - isIncludedInAvailableRefinements
```
public boolean isIncludedInAvailableRefinements()
```
    Returns:
    true if this is included in available refinements
  - setIncludedInAvailableRefinements
```
public void setIncludedInAvailableRefinements(boolean isIncluded)
```
    Sets whether or not this is included in available refinements
    
    Parameters:
    isIncluded -
  - isAttributeValueSearchEnabled
```
public boolean isAttributeValueSearchEnabled()
```
    Indicates if this attribute is enabled for and can be used in a value search.
    
    Returns:
    true if the attribute is value searchable
  - setAttributeValueSearchEnabled
```
public void setAttributeValueSearchEnabled(boolean isValueSearchable)
```
  - isIndexedForTextSearch
```
public boolean isIndexedForTextSearch()
```
    Indicates if this attribute is enabled for and can be used in a text search filter.
    
    Returns:
    true if the attribute is indexed for text search
  - setIndexedForTextSearch
```
public void setIndexedForTextSearch(boolean indexed)
```
  - getRefinementSelectionMode
```
public RefinementSelectionMode getRefinementSelectionMode()
```
    Gets the refinement selection mode of this attribute.
    
    Returns:
    RefinementSelectionMode indicating mode. If unknown, single-select is returned.
  - setRefinementSelectionMode
```
public void setRefinementSelectionMode(RefinementSelectionMode mode)
```
  - getType
```
public PropertyType getType()
```
    Gets the data type of this attribute.
    
    Returns:
    PropertyType indicating the attribute's data type. It could be PropertyType.UNKNOWN if no type information is available.
  - setAverageLength
```
public void setAverageLength(long avgLength)
```
  - getAverageLength
```
public long getAverageLength()
```
  - clone
```
public Attribute clone()
```
    Overrides:
    
    clone in class java.lang.Object
    
    See Also:
    Object.clone()

Class Attribute

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DISPLAY_NAME_PROPERTY

LOCALIZED_DISPLAY_NAME_PROPERTY

DEFAULT_DISPLAY_NAME_PROPERTY

DESCRIPTION_PROPERTY

LOCALIZED_DESCRIPTION_PROPERTY

DEFAULT_DESCRIPTION_PROPERTY

DATA_TYPE_PROPERTY

AVG_LENGTH_PROPERTY

IS_DIMENSION_PROPERTY

IS_SINGLE_ASSIGN_PROPERTY

IS_INCLUDED_IN_AVAILABLE_REFINEMENTS_PROPERTY

IS_VALUE_SEARCHABLE

IS_INDEXED_FOR_TEXT_SEARCH

MDEX_TYPE_PROPERTY

SEMANTIC_TYPE

TAGS

NOTES

NOTES_LAST_MODIFIED_DATE

NOTES_LAST_MODIFIED_USERID

REFINEMENT_SELECTION_MODE

NAVIGATION_ORDERING_PROPERTY

IS_KEY_COLUMN_PROPERTY

IS_REFINEABLE_PROPERTY

AVAILABLE_AGGREGATIONS_PROPERTY

DEFAULT_AGGREGATION_PROPERTY

AVAILABLE_DATETIME_PARTS_PROPERTY

DEFAULT_DATETIME_PARTS_PROPERTY

DEFAULT_CASCADE_DATETIME_PARTS_PROPERTY

DATETIME_COMBOS_ENABLED_PROPERTY

FORMATTER_PROPERTY

SOURCE_ATTRIBUTE_KEY_PROPERTY

SOURCE_COLLECTION_KEY_PROPERTY

APPROX_CARDINALITY_PROPERTY

VALUE_LANGUAGE

DATA_SOURCE_KEY_PROPERTY

Constructor Detail

Attribute

Method Detail

setDisplayName

getDisplayName

getDisplayName

getDisplayName

getDefaultDisplayName

setDefaultDisplayName

setLocalizedDisplayName

getLocalizedDisplayName

setSemanticType

getSemanticType

getTags

setTags

setNotes

getNotes

getNotesLastModifiedDate

setNotesLastModifiedDate

getNotesLastModifiedUserId

setNotesLastModifiedUserId

setDatatype

getDatatype

getValueLanguage

setValueLanguage

isDimension

setDimension

convertLocalizedMetadataToMap

convertLocalizedMetadataMapToString

setDescription

getDescription

getDescription

getDescription

getDescription

getDefaultDescription

setDefaultDescription

setLocalizedDescription