Package org.opencms.xml.containerpage

Class CmsXmlGroupContainer

java.lang.Object

org.opencms.xml.A_CmsXmlDocument

org.opencms.xml.content.CmsXmlContent

org.opencms.xml.containerpage.CmsXmlGroupContainer

All Implemented Interfaces:

I_CmsXmlDocument

public class CmsXmlGroupContainer
extends CmsXmlContent

Implementation of a object used to access and manage the xml data of a group container.

In addition to the XML content interface. It also provides access to more comfortable beans.

Since:

8.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CmsXmlGroupContainer.XmlNode	XML node name constants.

Field Summary

Fields inherited from class org.opencms.xml.content.CmsXmlContent

A_VERSION, AUTO_CORRECTION_ATTRIBUTE, m_autoCorrectionEnabled, m_contentDefinition, m_hasInvalidatedBrokenLinks, XERCES_SCHEMA_PROPERTY

Fields inherited from class org.opencms.xml.A_CmsXmlDocument

m_conversion, m_document, m_elementLocales, m_elementNames, m_encoding, m_file, m_locales

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsXmlGroupContainer()	Hides the public constructor.
protected	CmsXmlGroupContainer(CmsObject cms, Locale locale, String modelUri)	Create a new group container based on the given default content, that will have all language nodes of the default content and ensures the presence of the given locale.
protected	CmsXmlGroupContainer(CmsObject cms, Locale locale, String encoding, CmsXmlContentDefinition contentDefinition)	Create a new container page based on the given content definition, that will have one language node for the given locale all initialized with default values.
protected	CmsXmlGroupContainer(CmsObject cms, org.dom4j.Document document, String encoding, EntityResolver resolver)	Creates a new group container based on the provided XML document.

Method Summary

Modifier and Type	Method	Description
void	clearLocales()	Removes all locales from the element group XML.
protected void	fillResource(CmsObject cms, org.dom4j.Element element, CmsResource res)	Fills a CmsXmlVfsFileValue with the resource identified by the given id.
CmsGroupContainerBean	getGroupContainer(CmsObject cms)	Returns the group container bean for the given locale.
protected void	initDocument(org.dom4j.Document document, String encoding, CmsXmlContentDefinition definition)	Initializes an XML document based on the provided document, encoding and content definition.
boolean	isAutoCorrectionEnabled()	Returns true if the auto correction feature is enabled for saving this XML content.
void	save(CmsObject cms, CmsGroupContainerBean groupContainer, Locale locale)	Saves given container page in the current locale, and not only in memory but also to VFS.
protected void	saveGroupContainer(CmsObject cms, org.dom4j.Element parent, CmsGroupContainerBean groupContainer)	Adds the given container page to the given element.
protected void	setFile(CmsFile file)	Sets the file this XML content is written to.

Methods inherited from class org.opencms.xml.content.CmsXmlContent

addBookmarkForElement, addBookmarkForValue, addLocale, addValue, addValue, clone, copyLocale, getAllSimpleSubValues, getBookmark, getBookmarks, getChoiceOptions, getContentDefinition, getContentDefinition, getHandler, getLinkProcessor, getLocaleNode, getSchemaVersion, getSimpleValuesBelowPath, getSubValues, getValuesByPath, getValueSequence, hasChoiceOptions, hasInvalidatedBrokenLinks, initDocument, isLocaleIndependent, isTransformedVersion, processSchemaNode, removeValue, resolveMappings, setAutoCorrectionEnabled, synchronizeLocaleIndependentValues, validate, visitAllValuesWith

Methods inherited from class org.opencms.xml.A_CmsXmlDocument

addBookmark, addLocale, clearBookmarks, copyLocale, copyLocale, correctXmlStructure, createDeepElementCopy, getBestMatchingLocale, getBookmark, getBookmarkName, getConversion, getEncoding, getFile, getIndexCount, getLocales, getLocales, getNames, getStringValue, getStringValue, getTempDataCache, getValue, getValue, getValueInternal, getValues, getValues, hasLocale, hasValue, hasValue, initDocument, isEnabled, isEnabled, marshal, marshal, moveLocale, removeBookmark, removeLocale, setConversion, toString, updateLocaleNodeSorting, validateXmlStructure

Methods inherited from class java.lang.Object

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

Constructor Details

CmsXmlGroupContainer

protected CmsXmlGroupContainer()

Hides the public constructor.

CmsXmlGroupContainer

protected CmsXmlGroupContainer(CmsObject cms,
 org.dom4j.Document document,
 String encoding,
 EntityResolver resolver)

Creates a new group container based on the provided XML document.

The given encoding is used when marshalling the XML again later.

Parameters:

cms - the cms context, if null no link validation is performed

document - the document to create the container page from

encoding - the encoding of the container page

resolver - the XML entity resolver to use

CmsXmlGroupContainer

protected CmsXmlGroupContainer(CmsObject cms,
 Locale locale,
 String modelUri)
                        throws CmsException

Create a new group container based on the given default content, that will have all language nodes of the default content and ensures the presence of the given locale.

The given encoding is used when marshalling the XML again later.

Parameters:

cms - the current users OpenCms content

locale - the locale to generate the default content for

modelUri - the absolute path to the container page file acting as model

Throws:

CmsException - in case the model file is not found or not valid

CmsXmlGroupContainer

protected CmsXmlGroupContainer(CmsObject cms,
 Locale locale,
 String encoding,
 CmsXmlContentDefinition contentDefinition)

Create a new container page based on the given content definition, that will have one language node for the given locale all initialized with default values.

The given encoding is used when marshalling the XML again later.

Parameters:

cms - the current users OpenCms content

locale - the locale to generate the default content for

encoding - the encoding to use when marshalling the container page later

contentDefinition - the content definition to create the content for

Method Details

clearLocales

public void clearLocales()
                  throws CmsXmlException

Removes all locales from the element group XML.

Throws:

CmsXmlException - if something goes wrong

getGroupContainer

public CmsGroupContainerBean getGroupContainer(CmsObject cms)

Returns the group container bean for the given locale.

Parameters:

cms - the cms context

Returns:

the group container bean

isAutoCorrectionEnabled

public boolean isAutoCorrectionEnabled()

Description copied from class: A_CmsXmlDocument

Returns true if the auto correction feature is enabled for saving this XML content.

Overrides:

isAutoCorrectionEnabled in class CmsXmlContent

Returns:

true if the auto correction feature is enabled for saving this XML content

See Also:

• CmsXmlContent.isAutoCorrectionEnabled()

save

public void save(CmsObject cms,
 CmsGroupContainerBean groupContainer,
 Locale locale)
          throws CmsException

Saves given container page in the current locale, and not only in memory but also to VFS.

Parameters:

cms - the current cms context

groupContainer - the group-container page to save

locale - the locale to save

Throws:

CmsException - if something goes wrong

fillResource

protected void fillResource(CmsObject cms,
 org.dom4j.Element element,
 CmsResource res)

Fills a CmsXmlVfsFileValue with the resource identified by the given id.

Parameters:

cms - the current CMS context

element - the XML element to fill

res - the resource to use

initDocument

protected void initDocument(org.dom4j.Document document,
 String encoding,
 CmsXmlContentDefinition definition)

Description copied from class: A_CmsXmlDocument

Initializes an XML document based on the provided document, encoding and content definition.

Overrides:

initDocument in class CmsXmlContent

Parameters:

document - the base XML document to use for initializing

encoding - the encoding to use when marshalling the document later

definition - the content definition to use

See Also:

• A_CmsXmlDocument.initDocument(org.dom4j.Document, java.lang.String, org.opencms.xml.CmsXmlContentDefinition)

saveGroupContainer

protected void saveGroupContainer(CmsObject cms,
 org.dom4j.Element parent,
 CmsGroupContainerBean groupContainer)
                           throws CmsException

Adds the given container page to the given element.

Parameters:

cms - the current CMS object

parent - the element to add it

groupContainer - the container page to add

Throws:

CmsException - if something goes wrong

setFile

protected void setFile(CmsFile file)

Description copied from class: CmsXmlContent

Sets the file this XML content is written to.

Overrides:

setFile in class CmsXmlContent

Parameters:

file - the file this XML content content is written to

See Also:

• CmsXmlContent.setFile(org.opencms.file.CmsFile)