Package org.opencms.xml.content

Class CmsXmlContentValueSequence

java.lang.Object

org.opencms.xml.content.CmsXmlContentValueSequence

public class CmsXmlContentValueSequence
extends Object

Describes the sequence of XML content values of a specific type in an XML content instance.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsXmlContentValueSequence(String path, Locale locale, CmsXmlContent content)	Generates a new content sequence element from the given type, content and content definition.

Method Summary

Modifier and Type	Method	Description
I_CmsXmlContentValue	addValue(CmsObject cms, int index)	Adds a value element of the type the original xpath indicates at the selected index to the XML content document.
I_CmsXmlContentValue	addValue(CmsObject cms, String xpath, int index)	Adds a value element of the type indicated by the given xpath at the selected index to the XML content document.
I_CmsXmlContentValue	addValue(CmsObject cms, I_CmsXmlSchemaType type, int index)	Adds a value element of the given type at the selected index to the XML content document.
int	getElementCount()	Returns the count of XML content values for the selected schema type and locale in the XML content.
Locale	getLocale()	Returns the locale this sequence is based on.
int	getMaxOccurs()	Returns the maximum occurrences of this type in the XML content schema.
int	getMinOccurs()	Returns the minimum occurrences of this type in the XML content schema.
String	getPath()	Returns the (simplified) Xpath expression that identifies the root node of this content value sequence.
I_CmsXmlContentValue	getValue(int index)	Returns the XML content values from the index position of this sequence.
List<I_CmsXmlContentValue>	getValues()	Returns the list of XML content values for the selected schema type and locale in the XML content.
boolean	isChoiceSequence()	Returns true if this sequence represents a choice sequence.
void	removeValue(int index)	Removes the value element of the sequence type at the selected index from XML content document.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsXmlContentValueSequence

public CmsXmlContentValueSequence(String path,
 Locale locale,
 CmsXmlContent content)

Generates a new content sequence element from the given type, content and content definition.

Parameters:

path - the path in the document to generate the value sequence for

locale - the locale to get the content values from

content - the XML content to generate the sequence element out of

Method Details

addValue

public I_CmsXmlContentValue addValue(CmsObject cms,
 I_CmsXmlSchemaType type,
 int index)

Adds a value element of the given type at the selected index to the XML content document.

Parameters:

cms - the current users OpenCms context

type - the type to add

index - the index where to add the new value element

Returns:

the added XML content value element

See Also:

• CmsXmlContent.addValue(CmsObject, String, Locale, int)
• addValue(CmsObject, String, int)
• addValue(CmsObject, int)

addValue

public I_CmsXmlContentValue addValue(CmsObject cms,
 int index)

Adds a value element of the type the original xpath indicates at the selected index to the XML content document.

The "original xpath" is the path used in the constructor when creating this value sequence.

Parameters:

cms - the current users OpenCms context

index - the index where to add the new value element

Returns:

the added XML content value element

See Also:

• CmsXmlContent.addValue(CmsObject, String, Locale, int)
• addValue(CmsObject, String, int)
• addValue(CmsObject, I_CmsXmlSchemaType, int)

addValue

public I_CmsXmlContentValue addValue(CmsObject cms,
 String xpath,
 int index)

Adds a value element of the type indicated by the given xpath at the selected index to the XML content document.

Parameters:

cms - the current users OpenCms context

xpath - the path that indicates the element type in the content definition

index - the index where to add the new value element

Returns:

the added XML content value element

See Also:

• CmsXmlContent.addValue(CmsObject, String, Locale, int)
• addValue(CmsObject, I_CmsXmlSchemaType, int)
• addValue(CmsObject, int)

getElementCount

public int getElementCount()

Returns the count of XML content values for the selected schema type and locale in the XML content.

Returns:

the count of XML content values for the selected schema type and locale in the XML content

getLocale

public Locale getLocale()

Returns the locale this sequence is based on.

Returns:

the locale this sequence is based on

getMaxOccurs

public int getMaxOccurs()

Returns the maximum occurrences of this type in the XML content schema.

Returns:

the maximum occurrences of this type in the XML content schema

See Also:

• I_CmsXmlSchemaType.getMaxOccurs()

getMinOccurs

public int getMinOccurs()

Returns the minimum occurrences of this type in the XML content schema.

Returns:

the minimum occurrences of this type in the XML content schema

See Also:

• I_CmsXmlSchemaType.getMinOccurs()

getPath

public String getPath()

Returns the (simplified) Xpath expression that identifies the root node of this content value sequence.

Returns:

the (simplified) Xpath expression that identifies the root node of this content value sequence

getValue

public I_CmsXmlContentValue getValue(int index)

Returns the XML content values from the index position of this sequence.

Parameters:

index - the index position to get the value from

Returns:

the XML content values from the index position of this sequence

getValues

public List<I_CmsXmlContentValue> getValues()

Returns the list of XML content values for the selected schema type and locale in the XML content.

Returns:

the list of XML content values for the selected schema type and locale in the XML content

See Also:

• getValue(int)

isChoiceSequence

public boolean isChoiceSequence()

Returns true if this sequence represents a choice sequence.

Returns:

true if this sequence represents a choice sequence

removeValue

public void removeValue(int index)

Removes the value element of the sequence type at the selected index from XML content document.

Parameters:

index - the index where to remove the value element

See Also:

• CmsXmlContent.removeValue(String, Locale, int)