org.opencms.xml.types
Interface I_CmsXmlContentValue

All Superinterfaces:
java.lang.Comparable, I_CmsXmlSchemaType
All Known Implementing Classes:
A_CmsXmlContentValue, A_CmsXmlValueCdataBase, A_CmsXmlValueTextBase, CmsXmlBooleanValue, CmsXmlColorValue, CmsXmlDateTimeValue, CmsXmlHtmlValue, CmsXmlLocaleValue, CmsXmlNestedContentDefinition, CmsXmlStringValue, CmsXmlVarLinkValue, CmsXmlVfsFileValue

public interface I_CmsXmlContentValue
extends I_CmsXmlSchemaType

Provides access to the value of a specific XML content node.

Since:
6.0.0
Version:
$Revision: 1.16 $
Author:
Alexander Kandzior

Field Summary
 
Fields inherited from interface org.opencms.xml.types.I_CmsXmlSchemaType
XSI_NAMESPACE, XSI_NAMESPACE_ATTRIBUTE_NO_SCHEMA_LOCATION
 
Method Summary
 I_CmsXmlDocument getDocument()
          Returns the XML content instance this value belongs to.
 org.dom4j.Element getElement()
          Returns the original XML element of this XML content value.
 int getIndex()
          Returns the node index of this XML content value in the source XML document, starting with 0.
 java.util.Locale getLocale()
          Returns the locale of this XML content value was generated for.
 int getMaxIndex()
          Returns the total number of XML elements of this type that currently exist in the source document.
 java.lang.String getPath()
          Returns the path of this XML content value in the source document.
 java.lang.String getPlainText(CmsObject cms)
          Returns the value of this XML content node as a plain text String.
 java.lang.String getStringValue(CmsObject cms)
          Returns the value of this XML content node as a String.
 void moveDown()
          Moves this XML content value one position down in the source document, if possible.
 void moveUp()
          Moves this XML content value one position up in the source document, if possible.
 void setStringValue(CmsObject cms, java.lang.String value)
          Sets the provided String as value of this XML content node.
 
Methods inherited from interface org.opencms.xml.types.I_CmsXmlSchemaType
appendXmlSchema, createValue, generateXml, getContentDefinition, getDefault, getMaxOccurs, getMinOccurs, getName, getSchemaDefinition, getTypeName, isSimpleType, newInstance, setContentDefinition, setDefault, validateValue
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getDocument

I_CmsXmlDocument getDocument()
Returns the XML content instance this value belongs to.

Returns:
the XML content instance this value belongs to

getElement

org.dom4j.Element getElement()
Returns the original XML element of this XML content value.

Returns:
the original XML element of this XML content value

getIndex

int getIndex()
Returns the node index of this XML content value in the source XML document, starting with 0.

This is usefull in case there are more then one elements with the same XML node name in the source XML document.

Returns:
the index of this XML content node in the source document

getLocale

java.util.Locale getLocale()
Returns the locale of this XML content value was generated for.

Returns:
the locale of this XML content value was generated for

getMaxIndex

int getMaxIndex()
Returns the total number of XML elements of this type that currently exist in the source document.

Returns:
the total number of XML elements of this type that currently exist in the source document

getPath

java.lang.String getPath()
Returns the path of this XML content value in the source document.

Returns:
the path of this XML content value in the source document

getPlainText

java.lang.String getPlainText(CmsObject cms)
Returns the value of this XML content node as a plain text String.

Plain text in this context means a pure textual representation of the content (i.e. without html tags). The plain text may be null, too, if there is no sound or useful textual representation (i.e. color values).

Parameters:
cms - an initialized instance of a CmsObject
Returns:
the value of this XML content node as a plain text String

getStringValue

java.lang.String getStringValue(CmsObject cms)
Returns the value of this XML content node as a String.

Parameters:
cms - an initialized instance of a CmsObject
Returns:
the value of this XML content node as a String

moveDown

void moveDown()
Moves this XML content value one position down in the source document, if possible.

If the XML content value is already the first in it's sequence, it is not moved.


moveUp

void moveUp()
Moves this XML content value one position up in the source document, if possible.

If the XML content value is already the last in it's sequence, it is not moved.


setStringValue

void setStringValue(CmsObject cms,
                    java.lang.String value)
Sets the provided String as value of this XML content node.

This method does provide processing of the content based on the users current OpenCms context. This can be used e.g. for link extraction and replacement in the content.

Parameters:
cms - an initialized instance of a CmsObject
value - the value to set