com.sapportals.wcm.rendering.collection

Class ComponentValueMap

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          com.sapportals.wcm.rendering.collection.ComponentValueMap

All Implemented Interfaces:

Cloneable, Map, Serializable

public final class ComponentValueMap

extends HashMap

Since:

EP6, SP2_CP adds some special functionality to a standard HashMap to allow easier filling and retrieval of standard objects that are needed for IComponent instances. You can add other objects to this class just like in any ordinary Map. Note the restrictions described in the put(Object key, Object value) method.
For the standard objects, you can also retrieve them using the standard get method and the corresponding key - use the DATA_KEY*** constants of the ComponentFactory for this

See Also:

Serialized Form

Constructor Summary

ComponentValueMap()

Method Summary

PagerData	getPagerData()
ICollection	getParent()
IResourceList	getResourceList()
ISearchSession	getSearchSession()
SortDefinition	getSortDefinition()
Object	put(Object key, Object value) overwrites the inherited method from class HashMap.
void	setPagerData(PagerData pd)
void	setParent(ICollection coll)
void	setResourceList(IResourceList list)
void	setSearchSession(ISearchSession iss)
void	setSortData(SortDefinition sd)

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

ComponentValueMap

public ComponentValueMap()

Method Detail

setPagerData

public void setPagerData(PagerData pd)

Parameters:

pd - the pagerdata attribute - might be null, will overwrite existing entries

getPagerData

public PagerData getPagerData()

Returns:

the pagerdata attribute - might be null

setSortData

public void setSortData(SortDefinition sd)

getSortDefinition

public SortDefinition getSortDefinition()

Returns:

the SortDefinition attribute - might be null

setSearchSession

public void setSearchSession(ISearchSession iss)

getSearchSession

public ISearchSession getSearchSession()

Returns:

the ISearchSession attribute - might be null

setResourceList

public void setResourceList(IResourceList list)

getResourceList

public IResourceList getResourceList()

Returns:

the IResourceList attribute - might be null

setParent

public void setParent(ICollection coll)

getParent

public ICollection getParent()

Returns:

the ICollection attribute - might be null

put

public Object put(Object key,
                  Object value)

overwrites the inherited method from class HashMap. It checks, if the given key equals one of the constants defined in the ComponentFactory that start with DATA_KEY. If a key-value pair with that key is added, an error will be recorded in the tracing and the entry will not be added to the map.
Otherwise, the inherited method is called.