com.endeca.portal.attributes.model
Class AttributeSettings

java.lang.Object
  com.endeca.portal.attributes.model.AttributeSettings

public class AttributeSettings
extends java.lang.Object

This class represents the top-level container for the Unified Attribute Model (UAM). It contains attribute and group hash map collections, as well as an ordered list representing the order of groups. Instances of this class can be converted to JSON using Jackson.

Author:

Endeca Technologies,, Inc

Constructor Summary

AttributeSettings()

Method Summary

AttributeSettings	copyBPCs() This method creates a shallow copy of AttributeSettings by cloning it's containers (attributes, groups and GroupOrder).
Attribute	getAttribute(java.lang.String key) Looks up an attribute by its name (key).
Attribute	getAttribute(java.lang.String key, java.util.Locale locale) Looks up an attribute by its name (key) and Locale.
BPCFilter	getAttributeFilter() An AttributeSettings instance can contain pre-constructed BPC filters for attributes and groups.
java.util.HashMap<java.lang.String,Attribute>	getAttributes()
BPCFilter	getGroupFilter() An AttributeSettings instance can contain pre-constructed BPC filters for attributes and groups.
java.util.List<java.lang.String>	getGroupOrder()
java.util.HashMap<java.lang.String,Group>	getGroups()
java.util.Set<java.lang.String>	getLanguageCodes()
void	setAttributeFilter(BPCFilter attributeFilter)
void	setAttributes(java.util.HashMap<java.lang.String,Attribute> attributes)
void	setGroupFilter(BPCFilter groupFilter)
void	setGroupOrder(java.util.List<java.lang.String> groupOrder)
void	setGroups(java.util.HashMap<java.lang.String,Group> groups)
void	setLanguageCodes(java.util.Set<java.lang.String> languageCodes)

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeSettings

public AttributeSettings()

Method Detail

setAttributes

public void setAttributes(java.util.HashMap<java.lang.String,Attribute> attributes)

Parameters:

attributes - the attributes to set

getAttributes

public java.util.HashMap<java.lang.String,Attribute> getAttributes()

Returns:

the attributes

getAttribute

public Attribute getAttribute(java.lang.String key)

Looks up an attribute by its name (key).

Parameters:

key - name of attribute

Returns:

an Attribute or null if not found

getAttribute

public Attribute getAttribute(java.lang.String key,
                              java.util.Locale locale)

Looks up an attribute by its name (key) and Locale. If a localized variant of the specified attribute exists, it will be returned. Otherwise the attribute corresponding the the specified key is returned, or null if that doesn't exist.

Parameters:

key - name of attribute

locale - local variant to seek

Returns:

an Attribute or null if not found

setGroups

public void setGroups(java.util.HashMap<java.lang.String,Group> groups)

Parameters:

groups - the groups to set

getGroups

public java.util.HashMap<java.lang.String,Group> getGroups()

Returns:

the groups

setGroupOrder

public void setGroupOrder(java.util.List<java.lang.String> groupOrder)

Parameters:

groupOrder - the groupOrder to set

getGroupOrder

public java.util.List<java.lang.String> getGroupOrder()

Returns:

the groupOrder

setLanguageCodes

public void setLanguageCodes(java.util.Set<java.lang.String> languageCodes)

Parameters:

attributes - the attributes to set

getLanguageCodes

public java.util.Set<java.lang.String> getLanguageCodes()

Returns:

the attributes

setAttributeFilter

public void setAttributeFilter(BPCFilter attributeFilter)

Parameters:

attributeFilter - the attributeFilter to set

getAttributeFilter

public BPCFilter getAttributeFilter()

An AttributeSettings instance can contain pre-constructed BPC filters for attributes and groups. These filter objects can be used as a convenience mechanism for storing a filter constructed based on the information contained in the global settings. These filter objects will be cached along with this AttributeSettings instance and can be reused by various portlets during merging.

Returns:

the attribute filter or null if it has not been set

setGroupFilter

public void setGroupFilter(BPCFilter groupFilter)

Parameters:

groupFilter - the groupFilter to set

getGroupFilter

public BPCFilter getGroupFilter()

An AttributeSettings instance can contain pre-constructed BPC filters for attributes and groups. These filter objects can be used as a convenience mechanism for storing a filter constructed based on the information contained in the global settings. These filter objects will be cached along with this AttributeSettings instance and can be reused by various portlets during merging.

Returns:

the group filter or null if it has not been set

copyBPCs

public AttributeSettings copyBPCs()

This method creates a shallow copy of AttributeSettings by cloning it's containers (attributes, groups and GroupOrder). The members of these containers are added by reference, so any change to these will be changed in both the new copy and the existing version. However, this method will allow you to add/delete members of these containers without effecting the original version.

Returns:

AttributeSettings