Package org.opencms.xml.content

Class CmsXmlContentRootLocation

java.lang.Object

org.opencms.xml.content.CmsXmlContentRootLocation

All Implemented Interfaces:

I_CmsXmlContentLocation

public class CmsXmlContentRootLocation
extends Object
implements I_CmsXmlContentLocation

Represents the root of an XML content for a given locale.

Since:

8.0.0

Constructor Summary

Constructors

Constructor	Description
CmsXmlContentRootLocation(I_CmsXmlDocument doc, Locale locale)	Creates a new root location for a given locale.

Method Summary

Modifier and Type	Method	Description
I_CmsXmlDocument	getDocument()	Returns the XML document.
Locale	getLocale()	Returns the locale.
I_CmsXmlContentValueLocation	getSubValue(String subPath)	Returns the location for an xpath relative to the current location.
List<I_CmsXmlContentValueLocation>	getSubValues(String subPath)	Returns the locations for an xpath relative to the current location.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsXmlContentRootLocation

public CmsXmlContentRootLocation(I_CmsXmlDocument doc,
 Locale locale)

Creates a new root location for a given locale.

Parameters:

doc - the XML document

locale - the locale

Method Details

getDocument

public I_CmsXmlDocument getDocument()

Description copied from interface: I_CmsXmlContentLocation

Returns the XML document.

Specified by:

getDocument in interface I_CmsXmlContentLocation

Returns:

the XML document

See Also:

• I_CmsXmlContentLocation.getDocument()

getLocale

public Locale getLocale()

Description copied from interface: I_CmsXmlContentLocation

Returns the locale.

Specified by:

getLocale in interface I_CmsXmlContentLocation

Returns:

the locale

See Also:

• I_CmsXmlContentLocation.getLocale()

getSubValue

public I_CmsXmlContentValueLocation getSubValue(String subPath)

Description copied from interface: I_CmsXmlContentLocation

Returns the location for an xpath relative to the current location.

Specified by:

getSubValue in interface I_CmsXmlContentLocation

Parameters:

subPath - the relative path

Returns:

the location which the relative path points to

See Also:

• I_CmsXmlContentLocation.getSubValue(java.lang.String)

getSubValues

public List<I_CmsXmlContentValueLocation> getSubValues(String subPath)

Description copied from interface: I_CmsXmlContentLocation

Returns the locations for an xpath relative to the current location.

Specified by:

getSubValues in interface I_CmsXmlContentLocation

Parameters:

subPath - the relative path

Returns:

the locations which the relative path points to

See Also:

• I_CmsXmlContentLocation.getSubValues(java.lang.String)