Package org.opencms.xml.containerpage

Class CmsXmlContainerPage

java.lang.Object

org.opencms.xml.A_CmsXmlDocument

org.opencms.xml.content.CmsXmlContent

org.opencms.xml.containerpage.CmsXmlContainerPage

All Implemented Interfaces:

I_CmsXmlDocument

public class CmsXmlContainerPage
extends CmsXmlContent

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

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

Since:

7.5.2

See Also:

• getContainerPage(CmsObject)

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	LEGACY_SYSTEM_SETTING_NAMES	Name for old internal setting names that are not used with the SYSTEM:: prefix in code.
static final String	SYSTEM_SETTING_PREFIX	Prefix for system element settings.

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	CmsXmlContainerPage()	Hides the public constructor.
protected	CmsXmlContainerPage(CmsObject cms, Locale locale, String modelUri)	Create a new container page 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	CmsXmlContainerPage(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	CmsXmlContainerPage(CmsObject cms, org.dom4j.Document document, String encoding, EntityResolver resolver)	Creates a new container page based on the provided XML document.

Method Summary

Modifier and Type	Method	Description
protected void	checkLinkConcistency(CmsObject cms)	Checks the link consistency for a given locale and reinitializes the document afterwards.
protected CmsContainerPageBean	cleanupContainersContainers(CmsObject cms, CmsContainerPageBean cntPage)	Removes all empty containers and merges the containers of the current document that are not used in the given container page with it.
byte[]	createContainerPageXml(CmsObject cms, CmsContainerPageBean cntPage)	Saves a container page bean to the in-memory XML structure and returns the changed content.
protected CmsResource	fillResource(CmsObject cms, org.dom4j.Element element, CmsUUID resourceId)	Fills a CmsXmlVfsFileValue with the resource identified by the given id.
CmsContainerPageBean	getContainerPage(CmsObject cms)	Gets the container page content as a bean.
protected void	initDocument(org.dom4j.Document document, String encoding, CmsXmlContentDefinition definition)	Initializes an XML document based on the provided document, encoding and content definition.
void	initDocument(CmsObject cms)	Calls initDocument, but with a different CmsObject
protected void	initDocument(CmsObject cms, 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.
protected CmsContainerPageBean	removeEmptyContainers(CmsContainerPageBean cntPage)	Removes all empty containers to clean up container page XML.
void	save(CmsObject cms, CmsContainerPageBean cntPage)	Saves given container page in the current locale, and not only in memory but also to VFS.
void	save(CmsObject cms, CmsContainerPageBean cntPage, boolean ifChangedOnly)	Saves given container page in the current locale, and not only in memory but also to VFS.
protected void	saveContainerPage(CmsObject cms, org.dom4j.Element parent, CmsContainerPageBean cntPage)	Adds the given container page to the given element.
protected void	setFile(CmsFile file)	Sets the file this XML content is written to.
void	writeContainerPage(CmsObject cms, CmsContainerPageBean cntPage)	Saves a container page in in-memory XML structure.

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, 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

Field Details

LEGACY_SYSTEM_SETTING_NAMES

public static final Set<String> LEGACY_SYSTEM_SETTING_NAMES

Name for old internal setting names that are not used with the SYSTEM:: prefix in code.

SYSTEM_SETTING_PREFIX

public static final String SYSTEM_SETTING_PREFIX

Prefix for system element settings.

See Also:

• Constant Field Values

Constructor Details

CmsXmlContainerPage

protected CmsXmlContainerPage()

Hides the public constructor.

CmsXmlContainerPage

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

Creates a new container page 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

CmsXmlContainerPage

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

Create a new container page 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

CmsXmlContainerPage

protected CmsXmlContainerPage(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

createContainerPageXml

public byte[] createContainerPageXml(CmsObject cms,
 CmsContainerPageBean cntPage)
                              throws CmsException

Saves a container page bean to the in-memory XML structure and returns the changed content.

Parameters:

cms - the current CMS context

cntPage - the container page bean

Returns:

the new content for the container page

Throws:

CmsException - if something goes wrong

getContainerPage

public CmsContainerPageBean getContainerPage(CmsObject cms)

Gets the container page content as a bean.

Parameters:

cms - the current CMS context

Returns:

the bean containing the container page data

initDocument

public void initDocument(CmsObject cms)

Calls initDocument, but with a different CmsObject

Parameters:

cms - the CmsObject to use

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,
 CmsContainerPageBean cntPage)
          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

cntPage - the container page to save

Throws:

CmsException - if something goes wrong

save

public void save(CmsObject cms,
 CmsContainerPageBean cntPage,
 boolean ifChangedOnly)
          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

cntPage - the container page to save

ifChangedOnly - true to only write the file if the content has changed

Throws:

CmsException - if something goes wrong

writeContainerPage

public void writeContainerPage(CmsObject cms,
 CmsContainerPageBean cntPage)
                        throws CmsException

Saves a container page in in-memory XML structure.

Parameters:

cms - the current CMS context

cntPage - the container page bean to save

Throws:

CmsException - if something goes wrong

checkLinkConcistency

protected void checkLinkConcistency(CmsObject cms)

Checks the link consistency for a given locale and reinitializes the document afterwards.

Parameters:

cms - the cms context

cleanupContainersContainers

protected CmsContainerPageBean cleanupContainersContainers(CmsObject cms,
 CmsContainerPageBean cntPage)

Removes all empty containers and merges the containers of the current document that are not used in the given container page with it.

Parameters:

cms - the current CMS context

cntPage - the container page to merge

Returns:

a new container page with the additional unused containers

fillResource

protected CmsResource fillResource(CmsObject cms,
 org.dom4j.Element element,
 CmsUUID resourceId)
                            throws CmsException

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

Parameters:

cms - the current CMS context

element - the XML element to fill

resourceId - the ID identifying the resource to use

Returns:

the resource

Throws:

CmsException - if the resource can not be read

initDocument

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

Description copied from class: CmsXmlContent

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

Checks the links and removes invalid ones in the initialized document.

Overrides:

initDocument in class CmsXmlContent

Parameters:

cms - the current users OpenCms content

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:

• CmsXmlContent.initDocument(org.opencms.file.CmsObject, org.dom4j.Document, java.lang.String, org.opencms.xml.CmsXmlContentDefinition)

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)

removeEmptyContainers

protected CmsContainerPageBean removeEmptyContainers(CmsContainerPageBean cntPage)

Removes all empty containers to clean up container page XML.

Parameters:

cntPage - the container page bean

Returns:

the newly generated result

saveContainerPage

protected void saveContainerPage(CmsObject cms,
 org.dom4j.Element parent,
 CmsContainerPageBean cntPage)
                          throws CmsException

Adds the given container page to the given element.

Parameters:

cms - the current CMS object

parent - the element to add it

cntPage - 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)