Package org.opencms.xml.content

Interface I_CmsXmlContentLocation

All Known Subinterfaces:

I_CmsXmlContentValueLocation

All Known Implementing Classes:

CmsXmlContentRootLocation, CmsXmlContentValueLocation

public interface I_CmsXmlContentLocation

This class represents a location in an XML content for a specific locale.

It is used for conveniently retrieving configuration values from an XML content without manually concatenating xpath strings.

Since:

8.0.0

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.

Method Details

getDocument

I_CmsXmlDocument getDocument()

Returns the XML document.

Returns:

the XML document

getLocale

Locale getLocale()

Returns the locale.

Returns:

the locale

getSubValue

I_CmsXmlContentValueLocation getSubValue(String subPath)

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

Parameters:

subPath - the relative path

Returns:

the location which the relative path points to

getSubValues

List<I_CmsXmlContentValueLocation> getSubValues(String subPath)

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

Parameters:

subPath - the relative path

Returns:

the locations which the relative path points to