org.opencms.ade.containerpage.inherited
Class CmsContainerConfiguration

java.lang.Object
  org.opencms.ade.containerpage.inherited.CmsContainerConfiguration

public class CmsContainerConfiguration
extends java.lang.Object

A bean representing a single configuration entry for the inherited container configuration.

Field Summary

static java.lang.String	N_CONFIGURATION Node name.
static java.lang.String	N_ELEMENT Node name.
static java.lang.String	N_HIDDEN Node name.
static java.lang.String	N_KEY Node name.
static java.lang.String	N_NAME Node name.
static java.lang.String	N_NEWELEMENT Node name.
static java.lang.String	N_ORDERKEY Node name.
static java.lang.String	N_URI Node name.
static java.lang.String	N_VISIBLE Node name.

Constructor Summary

CmsContainerConfiguration(java.util.List<java.lang.String> ordering, java.util.Map<java.lang.String,java.lang.Boolean> visibility, java.util.Map<java.lang.String,CmsContainerElementBean> newElements)
Creates a new instance.

Method Summary

static CmsContainerConfiguration	emptyConfiguration() Generates an empty configuration object.
java.util.Map<java.lang.String,CmsContainerElementBean>	getNewElements() Gets the map of new elements.
java.util.LinkedHashMap<java.lang.String,CmsContainerElementBean>	getNewElementsInOrder() Gets the new elements in the order in which they appear in the 'ordering' list.
java.util.List<java.lang.String>	getOrdering() Gets the ordering list.
java.lang.String	getPath() Gets the path from which this configuration was read.
java.util.Map<java.lang.String,java.lang.Boolean>	getVisibility() Gets the visibility map for this configuration.
void	setPath(java.lang.String path) Sets the path for this configuration.

Methods inherited from class java.lang.Object

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

Field Detail

N_CONFIGURATION

public static final java.lang.String N_CONFIGURATION

Node name.

See Also:

Constant Field Values

N_ELEMENT

public static final java.lang.String N_ELEMENT

Node name.

See Also:

Constant Field Values

N_HIDDEN

public static final java.lang.String N_HIDDEN

Node name.

See Also:

Constant Field Values

N_KEY

public static final java.lang.String N_KEY

Node name.

See Also:

Constant Field Values

N_NAME

public static final java.lang.String N_NAME

Node name.

See Also:

Constant Field Values

N_NEWELEMENT

public static final java.lang.String N_NEWELEMENT

Node name.

See Also:

Constant Field Values

N_ORDERKEY

public static final java.lang.String N_ORDERKEY

Node name.

See Also:

Constant Field Values

N_URI

public static final java.lang.String N_URI

Node name.

See Also:

Constant Field Values

N_VISIBLE

public static final java.lang.String N_VISIBLE

Node name.

See Also:

Constant Field Values

Constructor Detail

CmsContainerConfiguration

public CmsContainerConfiguration(java.util.List<java.lang.String> ordering,
                                 java.util.Map<java.lang.String,java.lang.Boolean> visibility,
                                 java.util.Map<java.lang.String,CmsContainerElementBean> newElements)

Creates a new instance.

Parameters:

ordering - the new ordering list

visibility - the visibility map

newElements - the new elements

Method Detail

emptyConfiguration

public static CmsContainerConfiguration emptyConfiguration()

Generates an empty configuration object.

Returns:

an empty configuration object

getNewElements

public java.util.Map<java.lang.String,CmsContainerElementBean> getNewElements()

Gets the map of new elements.

Returns:

the map of new elements

getNewElementsInOrder

public java.util.LinkedHashMap<java.lang.String,CmsContainerElementBean> getNewElementsInOrder()

Gets the new elements in the order in which they appear in the 'ordering' list.

Returns:

an ordered map containing the new elements in the correct order

getOrdering

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

Gets the ordering list.

Returns:

the ordering list

getPath

public java.lang.String getPath()

Gets the path from which this configuration was read.

Returns:

the path from which this configuration was read

getVisibility

public java.util.Map<java.lang.String,java.lang.Boolean> getVisibility()

Gets the visibility map for this configuration.

Returns:

the visibility map

setPath

public void setPath(java.lang.String path)

Sets the path for this configuration.

Parameters:

path - the new path value