Package org.opencms.jsp.decorator

Class CmsDecorationMap

java.lang.Object

org.opencms.jsp.decorator.CmsDecorationMap

All Implemented Interfaces:

Comparable<CmsDecorationMap>

public class CmsDecorationMap
extends Object
implements Comparable<CmsDecorationMap>

The CmsDecorationMap is the object representation of a single decoartion file.

The semicolon seperated elements of the decoartion file are stored in a map.

The map uses the decoration as keys and CmsDecorationObjects as values.

Multiple CmsDecorationMaps form a CmsDecorationBundle.

Since:

6.1.3

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CSV_SEPERATOR	The seperator for the CSV file.

Constructor Summary

Constructors

Constructor	Description
CmsDecorationMap(CmsObject cms, CmsResource res, CmsDecorationDefintion decDef)	Constructor, creates a new CmsDecorationMap.
CmsDecorationMap(CmsDecorationDefintion decDef, String name, Locale locale)	Constructor, creates a new, empty CmsDecorationMap.

Method Summary

Modifier and Type	Method	Description
int	compareTo(CmsDecorationMap o)
boolean	equals(Object obj)
Map<String,CmsDecorationObject>	getDecorationMap()	Returns the decorationMap.
Locale	getLocale()	Returns the locale.
String	getName()	Returns the name.
int	hashCode()
void	setDecorationMap(Map<String,CmsDecorationObject> decorationMap)	Sets the decorationMap.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

CSV_SEPERATOR

public static final String CSV_SEPERATOR

The seperator for the CSV file.

See Also:

• Constant Field Values

Constructor Details

CmsDecorationMap

public CmsDecorationMap(CmsDecorationDefintion decDef,
 String name,
 Locale locale)

Constructor, creates a new, empty CmsDecorationMap.

Parameters:

decDef - the CmsDecorationDefintion to be used in this decoration map

name - The name of the decoration map

locale - the locale for this decoration map

CmsDecorationMap

public CmsDecorationMap(CmsObject cms,
 CmsResource res,
 CmsDecorationDefintion decDef)
                 throws CmsException

Constructor, creates a new CmsDecorationMap.

Parameters:

cms - the CmsObject

res - the resource to extrace the decorations from

decDef - the CmsDecorationDefintion to be used in this decoration map

Throws:

CmsException - if something goes wrong

Method Details

compareTo

public int compareTo(CmsDecorationMap o)

Specified by:

compareTo in interface Comparable<CmsDecorationMap>

See Also:

• Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

getDecorationMap

public Map<String,CmsDecorationObject> getDecorationMap()

Returns the decorationMap.

Returns:

the decorationMap

getLocale

public Locale getLocale()

Returns the locale.

Returns:

the locale

getName

public String getName()

Returns the name.

Returns:

the name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

setDecorationMap

public void setDecorationMap(Map<String,CmsDecorationObject> decorationMap)

Sets the decorationMap.

Parameters:

decorationMap - the decorationMap to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()