Package org.opencms.xml.content
Class CmsXmlContentValueLocation
- java.lang.Object
-
- org.opencms.xml.content.CmsXmlContentValueLocation
-
- All Implemented Interfaces:
I_CmsXmlContentLocation
,I_CmsXmlContentValueLocation
public class CmsXmlContentValueLocation extends java.lang.Object implements I_CmsXmlContentValueLocation
Represents the concrete location of an XML content value.- Since:
- 8.0.0
-
-
Constructor Summary
Constructors Constructor Description CmsXmlContentValueLocation(I_CmsXmlContentValue value)
Constructs a new XML content value location.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CmsUUID
asId(CmsObject cms)
Returns the structure id of the content value (only valid for VfsFile values!).java.lang.String
asString(CmsObject cms)
Returns the string value of the content value.I_CmsXmlDocument
getDocument()
Returns the XML document.java.util.Locale
getLocale()
Returns the locale.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.I_CmsXmlContentValue
getValue()
Returns the content value at the given location.
-
-
-
Constructor Detail
-
CmsXmlContentValueLocation
public CmsXmlContentValueLocation(I_CmsXmlContentValue value)
Constructs a new XML content value location.- Parameters:
value
- the XML content value
-
-
Method Detail
-
asId
public CmsUUID asId(CmsObject cms)
Description copied from interface:I_CmsXmlContentValueLocation
Returns the structure id of the content value (only valid for VfsFile values!).- Specified by:
asId
in interfaceI_CmsXmlContentValueLocation
- Parameters:
cms
- the CMS context- Returns:
- the structure id of the content value
- See Also:
I_CmsXmlContentValueLocation.asId(org.opencms.file.CmsObject)
-
asString
public java.lang.String asString(CmsObject cms)
Description copied from interface:I_CmsXmlContentValueLocation
Returns the string value of the content value.- Specified by:
asString
in interfaceI_CmsXmlContentValueLocation
- Parameters:
cms
- the CMS context- Returns:
- the string value of the content value
- See Also:
I_CmsXmlContentValueLocation.asString(org.opencms.file.CmsObject)
-
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 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)
-
getValue
public I_CmsXmlContentValue getValue()
Returns the content value at the given location.- Specified by:
getValue
in interfaceI_CmsXmlContentValueLocation
- Returns:
- the content value at the given location
-
-