Package org.opencms.xml.types

Class CmsXmlVfsFileValue

java.lang.Object

org.opencms.xml.types.A_CmsXmlContentValue

org.opencms.xml.types.CmsXmlVfsFileValue

All Implemented Interfaces:

Comparable<I_CmsXmlSchemaType>, I_CmsWidgetParameter, I_CmsXmlContentValue, I_CmsXmlSchemaType, I_CmsJsonFormattableValue

Direct Known Subclasses:

CmsXmlVfsImageValue

public class CmsXmlVfsFileValue
extends A_CmsXmlContentValue
implements I_CmsJsonFormattableValue

Describes the XML content type "OpenCmsVfsFile".

This type allows links to internal VFS resources only.

Since:

7.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.xml.types.I_CmsXmlContentValue

I_CmsXmlContentValue.CmsSearchContentConfig, I_CmsXmlContentValue.SearchContentType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NO_LINK	Value to mark that no link is defined, "none".
static final String	TYPE_NAME	The name of this type as used in the XML schema.
static final String	TYPE_VFS_LINK	The vfs link type constant.

Fields inherited from class org.opencms.xml.types.A_CmsXmlContentValue

m_defaultValue, m_document, m_element, m_locale, m_maxOccurs, m_minOccurs, m_name

Fields inherited from interface org.opencms.xml.types.I_CmsXmlSchemaType

XSI_NAMESPACE, XSI_NAMESPACE_ATTRIBUTE_NO_SCHEMA_LOCATION

Constructor Summary

Constructors

Constructor	Description
CmsXmlVfsFileValue()	Creates a new, empty schema type descriptor of type "OpenCmsVfsFile".
CmsXmlVfsFileValue(String name, String minOccurs, String maxOccurs)	Creates a new schema type descriptor for the type "OpenCmsVfsFile".
CmsXmlVfsFileValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsVfsFile".

Method Summary

Modifier and Type	Method	Description
I_CmsXmlContentValue	createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)	Creates a XML content value object for this type.
static void	fillEntry(org.dom4j.Element element, CmsUUID id, String rootPath, CmsRelationType type)	Fills the given element with a CmsXmlVfsFileValue for the given data.
org.dom4j.Element	generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale)	Appends an XML for a new, empty node of this schema type to the given root element.
CmsLink	getLink(CmsObject cms)	Returns the link object represented by this XML content value.
String	getPlainText(CmsObject cms)	Returns the value of this XML content node as a plain text String.
String	getSchemaDefinition()	Returns a String representation of the XML definition for this schema type.
String	getStringValue(CmsObject cms)	Returns the value of this XML content node as a String.
String	getTypeName()	Returns the schema type name.
CmsLink	getUncheckedLink()	Returns the raw data from the XML value as a CmsLink, without any consistency checks.
boolean	isSearchable()	The default implementation always returns true.
I_CmsXmlSchemaType	newInstance(String name, String minOccurs, String maxOccurs)	Creates a new instance of this XML schema type initialized with the given values.
void	setIdValue(CmsObject cms, CmsUUID id)	Sets the value as a structure id.
void	setStringValue(CmsObject cms, String value)	Sets the provided String as value of this XML content node.
Object	toJson(CmsObject cms)	Gets the JSON representation of the value.

Methods inherited from class org.opencms.xml.types.A_CmsXmlContentValue

appendXmlSchema, compareTo, equals, getChoiceMaxOccurs, getContentDefinition, getDefault, getDefault, getDocument, getElement, getId, getIndex, getKey, getLocale, getMaxIndex, getMaxOccurs, getMinOccurs, getName, getPath, getRelationType, getXmlIndex, hasError, hashCode, isChoiceOption, isChoiceType, isSimpleType, moveDown, moveUp, moveValue, readSchemaDefinition, setContentDefinition, setDefault, setKeyPrefix, toString, validateValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opencms.xml.types.I_CmsXmlContentValue

getSearchContentConfig

Field Details

NO_LINK

public static final String NO_LINK

Value to mark that no link is defined, "none".

See Also:

• Constant Field Values

TYPE_NAME

public static final String TYPE_NAME

The name of this type as used in the XML schema.

See Also:

• Constant Field Values

TYPE_VFS_LINK

public static final String TYPE_VFS_LINK

The vfs link type constant.

See Also:

• Constant Field Values

Constructor Details

CmsXmlVfsFileValue

public CmsXmlVfsFileValue()

Creates a new, empty schema type descriptor of type "OpenCmsVfsFile".

CmsXmlVfsFileValue

public CmsXmlVfsFileValue(I_CmsXmlDocument document,
 org.dom4j.Element element,
 Locale locale,
 I_CmsXmlSchemaType type)

Creates a new XML content value of type "OpenCmsVfsFile".

Parameters:

document - the XML content instance this value belongs to

element - the XML element that contains this value

locale - the locale this value is created for

type - the type instance to create the value for

CmsXmlVfsFileValue

public CmsXmlVfsFileValue(String name,
 String minOccurs,
 String maxOccurs)

Creates a new schema type descriptor for the type "OpenCmsVfsFile".

Parameters:

name - the name of the XML node containing the value according to the XML schema

minOccurs - minimum number of occurrences of this type according to the XML schema

maxOccurs - maximum number of occurrences of this type according to the XML schema

Method Details

fillEntry

public static void fillEntry(org.dom4j.Element element,
 CmsUUID id,
 String rootPath,
 CmsRelationType type)

Fills the given element with a CmsXmlVfsFileValue for the given data.

Parameters:

element - the element to fill

id - the id to use

rootPath - the path to use

type - the relation type to use

createValue

public I_CmsXmlContentValue createValue(I_CmsXmlDocument document,
 org.dom4j.Element element,
 Locale locale)

Description copied from interface: I_CmsXmlSchemaType

Creates a XML content value object for this type.

Specified by:

createValue in interface I_CmsXmlSchemaType

Parameters:

document - the XML content instance this value belongs to

element - the XML element to create the value from

locale - the locale to create the value for

Returns:

the created XML content value object

See Also:

• I_CmsXmlSchemaType.createValue(I_CmsXmlDocument, org.dom4j.Element, Locale)

generateXml

public org.dom4j.Element generateXml(CmsObject cms,
 I_CmsXmlDocument document,
 org.dom4j.Element root,
 Locale locale)

Description copied from interface: I_CmsXmlSchemaType

Appends an XML for a new, empty node of this schema type to the given root element.

This is used to dynamically build a vaild XML content object from an initialized CmsXmlContentDefinition class.

Important: This method can only be used during initialization of a XML content object, not to add values to an already initialized XML content. To add values after initialization, use CmsXmlContent.addValue(CmsObject, String, Locale, int).

Specified by:

generateXml in interface I_CmsXmlSchemaType

Overrides:

generateXml in class A_CmsXmlContentValue

Parameters:

cms - the current users OpenCms context

document - the document the XML is generated for

root - the element to append the XML to

locale - the locale to generate the element default content for

Returns:

the generated XML element

See Also:

• I_CmsXmlSchemaType.generateXml(org.opencms.file.CmsObject, org.opencms.xml.I_CmsXmlDocument, org.dom4j.Element, java.util.Locale)

getLink

public CmsLink getLink(CmsObject cms)

Returns the link object represented by this XML content value.

Parameters:

cms - the cms context, can be null but in this case no link check is performed

Returns:

the link object represented by this XML content value (will return null for an empty link)

getPlainText

public String getPlainText(CmsObject cms)

Description copied from interface: I_CmsXmlContentValue

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

Specified by:

getPlainText in interface I_CmsXmlContentValue

Overrides:

getPlainText in class A_CmsXmlContentValue

Parameters:

cms - an initialized instance of a CmsObject

Returns:

the value of this XML content node as a plain text String

See Also:

• I_CmsXmlContentValue.getPlainText(org.opencms.file.CmsObject)

getSchemaDefinition

public String getSchemaDefinition()

Description copied from interface: I_CmsXmlSchemaType

Returns a String representation of the XML definition for this schema type.

Specified by:

getSchemaDefinition in interface I_CmsXmlSchemaType

Returns:

a String representation of the XML definition for this schema type

See Also:

• I_CmsXmlSchemaType.getSchemaDefinition()

getStringValue

public String getStringValue(CmsObject cms)
                      throws CmsRuntimeException

Description copied from interface: I_CmsXmlContentValue

Returns the value of this XML content node as a String.

Specified by:

getStringValue in interface I_CmsWidgetParameter

Specified by:

getStringValue in interface I_CmsXmlContentValue

Parameters:

cms - an initialized instance of a CmsObject

Returns:

the value of this XML content node as a String

Throws:

CmsRuntimeException

See Also:

• I_CmsXmlContentValue.getStringValue(CmsObject)

getTypeName

public String getTypeName()

Description copied from interface: I_CmsXmlSchemaType

Returns the schema type name.

By convention, a XML schema type name has the form "OpenCms + ${name}". Examples are "OpenCmsString" or "OpenCmsBoolean".

The schema type name is fixed by the implementation.

Specified by:

getTypeName in interface I_CmsXmlSchemaType

Returns:

the schema type name

See Also:

• I_CmsXmlSchemaType.getTypeName()

getUncheckedLink

public CmsLink getUncheckedLink()

Returns the raw data from the XML value as a CmsLink, without any consistency checks.

Returns:

the unchecked data from the XML as a CmsLink

isSearchable

public boolean isSearchable()

Description copied from class: A_CmsXmlContentValue

The default implementation always returns true.

Specified by:

isSearchable in interface I_CmsXmlContentValue

Overrides:

isSearchable in class A_CmsXmlContentValue

Returns:

true in case this value is searchable by default

See Also:

• A_CmsXmlContentValue.isSearchable()

newInstance

public I_CmsXmlSchemaType newInstance(String name,
 String minOccurs,
 String maxOccurs)

Description copied from interface: I_CmsXmlSchemaType

Creates a new instance of this XML schema type initialized with the given values.

Specified by:

newInstance in interface I_CmsXmlSchemaType

Parameters:

name - the name to use in the xml document

minOccurs - minimum number of occurrences

maxOccurs - maximum number of occurrences

Returns:

a new instance of this XML content type initialized with the given values

See Also:

• I_CmsXmlSchemaType.newInstance(java.lang.String, java.lang.String, java.lang.String)

setIdValue

public void setIdValue(CmsObject cms,
 CmsUUID id)

Sets the value as a structure id.

Parameters:

cms - the current CMS context

id - the structure id which should be stored in the file value

setStringValue

public void setStringValue(CmsObject cms,
 String value)
                    throws CmsIllegalArgumentException

Description copied from interface: I_CmsXmlContentValue

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.

Specified by:

setStringValue in interface I_CmsWidgetParameter

Specified by:

setStringValue in interface I_CmsXmlContentValue

Parameters:

cms - an initialized instance of a CmsObject

value - the value to set

Throws:

CmsIllegalArgumentException

See Also:

• I_CmsXmlContentValue.setStringValue(org.opencms.file.CmsObject, java.lang.String)

toJson

public Object toJson(CmsObject cms)

Description copied from interface: I_CmsJsonFormattableValue

Gets the JSON representation of the value.

Specified by:

toJson in interface I_CmsJsonFormattableValue

Parameters:

cms - the CMS context

Returns:

the JSON representation of the value

See Also:

• I_CmsJsonFormattableValue.toJson(org.opencms.file.CmsObject)