Package org.opencms.xml.content
Class CmsXmlContentRootLocation
- java.lang.Object
-
- org.opencms.xml.content.CmsXmlContentRootLocation
-
- All Implemented Interfaces:
I_CmsXmlContentLocation
public class CmsXmlContentRootLocation extends java.lang.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, java.util.Locale locale)
Creates a new root location for a given locale.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description I_CmsXmlDocument
getDocument()
Returns the XML document.java.util.Locale
getLocale()
Returns the locale.I_CmsXmlContentValueLocation
getSubValue(java.lang.String subPath)
Returns the location for an xpath relative to the current location.java.util.List<I_CmsXmlContentValueLocation>
getSubValues(java.lang.String subPath)
Returns the locations for an xpath relative to the current location.
-
-
-
Constructor Detail
-
CmsXmlContentRootLocation
public CmsXmlContentRootLocation(I_CmsXmlDocument doc, java.util.Locale locale)
Creates a new root location for a given locale.- Parameters:
doc
- the XML documentlocale
- the locale
-
-
Method Detail
-
getDocument
public I_CmsXmlDocument getDocument()
Description copied from interface:I_CmsXmlContentLocation
Returns the XML document.- Specified by:
getDocument
in interfaceI_CmsXmlContentLocation
- Returns:
- the XML document
- See Also:
I_CmsXmlContentLocation.getDocument()
-
getLocale
public java.util.Locale getLocale()
Description copied from interface:I_CmsXmlContentLocation
Returns the locale.- Specified by:
getLocale
in interfaceI_CmsXmlContentLocation
- Returns:
- the locale
- See Also:
I_CmsXmlContentLocation.getLocale()
-
getSubValue
public I_CmsXmlContentValueLocation getSubValue(java.lang.String subPath)
Description copied from interface:I_CmsXmlContentLocation
Returns the location for an xpath relative to the current location.- Specified by:
getSubValue
in interfaceI_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 java.util.List<I_CmsXmlContentValueLocation> getSubValues(java.lang.String subPath)
Description copied from interface:I_CmsXmlContentLocation
Returns the locations for an xpath relative to the current location.- Specified by:
getSubValues
in interfaceI_CmsXmlContentLocation
- Parameters:
subPath
- the relative path- Returns:
- the locations which the relative path points to
- See Also:
I_CmsXmlContentLocation.getSubValues(java.lang.String)
-
-