org.opencms.jsp.decorator
Class CmsDecorationMap

java.lang.Object
  org.opencms.jsp.decorator.CmsDecorationMap

All Implemented Interfaces:

Comparable

public class CmsDecorationMap
extends Object
implements Comparable

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

Version:

$Revision: 1.2 $

Author:

Michael Emmerich

Field Summary

static String

CSV_SEPERATOR The seperator for the CSV file.

Constructor Summary

CmsDecorationMap(CmsObject cms, CmsResource res, CmsDecorationDefintion decDef)
Constructor, creates a new CmsDecorationMap.

Method Summary

int	compareTo(Object o)
Map	getDecorationMap() Returns the decorationMap.
Locale	getLocale() Returns the locale.
String	getName() Returns the name.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CSV_SEPERATOR

public static final String CSV_SEPERATOR

The seperator for the CSV file.

See Also:

Constant Field Values

Constructor Detail

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 Detail

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

See Also:

Comparable.compareTo(java.lang.Object)

getDecorationMap

public Map 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

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()