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_CmsWidgetParameter, I_CmsXmlContentValue, I_CmsXmlSchemaType

public class CmsXmlVfsFileValue
extends A_CmsXmlContentValue

Describes the XML content type "OpenCmsVfsFile".

Since:

6.0.0

Version:

$Revision: 1.18 $

Author:

Andreas Zahner

Field Summary

static String	NO_LINK Value to mark that no link is defined, "none".
static String	TYPE_NAME The name of this type as used in the XML schema.

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

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

CmsXmlVfsFileValue(I_CmsXmlDocument document, Element element, Locale locale, I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsVfsFile".

CmsXmlVfsFileValue(String name, String minOccurs, String maxOccurs)
Creates a new schema type descriptor for the type "OpenCmsVfsFile".

Method Summary

I_CmsXmlContentValue	createValue(I_CmsXmlDocument document, Element element, Locale locale) Creates a XML content value object for this type.
CmsLinkTable	getLinkTable() Returns the link table of this XML page element.
String	getSchemaDefinition() Returns a String representation of the XML definition for this schema type.
String	getStringValue(CmsObject cms) Returns the value of this parameter.
String	getTypeName() Returns the schema type name.
I_CmsXmlSchemaType	newInstance(String name, String minOccurs, String maxOccurs) Creates a new instance of this XML schema type initialized with the given values.
void	setStringValue(CmsObject cms, String value) Sets the value of this parameter.

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

appendXmlSchema, compareTo, equals, generateXml, getContentDefinition, getDefault, getDefault, getDocument, getElement, getId, getIndex, getKey, getLocale, getMaxOccurs, getMinOccurs, getName, getPath, getPlainText, hasError, hashCode, isSimpleType, readSchemaDefinition, setContentDefinition, setDefault, setKeyPrefix, toString, validateValue

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

CmsXmlVfsFileValue

public CmsXmlVfsFileValue()

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

CmsXmlVfsFileValue

public CmsXmlVfsFileValue(I_CmsXmlDocument document,
                          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 occurences of this type according to the XML schema

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

Method Detail

createValue

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

Description copied from interface: I_CmsXmlSchemaType

Creates a XML content value object for this type.

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)

getLinkTable

public CmsLinkTable getLinkTable()

Returns the link table of this XML page element.

Returns:

the link table of this XML page element

getSchemaDefinition

public String getSchemaDefinition()

Description copied from interface: I_CmsXmlSchemaType

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

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_CmsWidgetParameter

Returns the value of this parameter.

Parameters:

cms - an initialized instance of an OpenCms user context

Returns:

the value of this parameter

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.

Returns:

the schema type name

See Also:

I_CmsXmlSchemaType.getTypeName()

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.

Parameters:

name - the name to use in the xml document

minOccurs - minimum number of occurences

maxOccurs - maximum number of occurences

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)

setStringValue

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

Description copied from interface: I_CmsWidgetParameter

Sets the value of this parameter.

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 an OpenCms user context

value - the value to set

Throws:

CmsIllegalArgumentException

See Also:

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