Package org.opencms.ade.containerpage.inherited

Class CmsContainerConfigurationParser

java.lang.Object

org.opencms.ade.containerpage.inherited.CmsContainerConfigurationParser

public class CmsContainerConfigurationParser
extends Object

A parser class which reads data from inherited container configuration files.

Constructor Summary

Constructors

Constructor	Description
CmsContainerConfigurationParser(CmsObject cms)	Creates a new configuration parser.

Method Summary

Modifier and Type	Method	Description
Map<Locale,Map<String,CmsContainerConfiguration>>	getParsedResults()	Gets the parsed results as a map.
void	parse(CmsFile file)	Parses the contents of a file.
void	parse(CmsResource resource)	Parses the contents of a resource.
protected void	parseConfigurationGroup(I_CmsXmlContentLocation location)	Parses a group of named configurations from a given XML content location.
protected void	parseSingleConfiguration(I_CmsXmlContentValueLocation location)	Parses a single inheritance configuration from an XML content node.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsContainerConfigurationParser

public CmsContainerConfigurationParser(CmsObject cms)

Creates a new configuration parser.

Parameters:

cms - the current CMS context

Method Details

getParsedResults

public Map<Locale,Map<String,CmsContainerConfiguration>> getParsedResults()

Gets the parsed results as a map.

Returns:

the parse results

parse

public void parse(CmsFile file)
           throws CmsException

Parses the contents of a file.

Parameters:

file - the file to parse

Throws:

CmsException - if something goes wrong

parse

public void parse(CmsResource resource)
           throws CmsException

Parses the contents of a resource.

Parameters:

resource - the resource which should be parsed

Throws:

CmsException - if something goes wrong

parseConfigurationGroup

protected void parseConfigurationGroup(I_CmsXmlContentLocation location)

Parses a group of named configurations from a given XML content location.

Parameters:

location - the location from which to read the configuration group

parseSingleConfiguration

protected void parseSingleConfiguration(I_CmsXmlContentValueLocation location)

Parses a single inheritance configuration from an XML content node.

Parameters:

location - the node from which to read the single configuration