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

Modifier and Type	Method	Description
CmsUUID	asId(CmsObject cms)	Returns the structure id of the content value (only valid for VfsFile values!).
String	asString(CmsObject cms)	Returns the string value of the content value.
I_CmsXmlDocument	getDocument()	Returns the XML document.
Locale	getLocale()	Returns the locale.
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.
I_CmsXmlContentValue	getValue()	Returns the content value at the given location.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsXmlContentValueLocation

public CmsXmlContentValueLocation(I_CmsXmlContentValue value)

Constructs a new XML content value location.

Parameters:

value - the XML content value

Method Details

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 interface I_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 String asString(CmsObject cms)

Description copied from interface: I_CmsXmlContentValueLocation

Returns the string value of the content value.

Specified by:

asString in interface I_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 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 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)

getValue

public I_CmsXmlContentValue getValue()

Returns the content value at the given location.

Specified by:

getValue in interface I_CmsXmlContentValueLocation

Returns:

the content value at the given location