Class CmsXmlContentValueSequence


  • public class CmsXmlContentValueSequence
    extends java.lang.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​(java.lang.String path, java.util.Locale locale, CmsXmlContent content)
      Generates a new content sequence element from the given type, content and content definition.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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, java.lang.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.
      java.util.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.
      java.lang.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.
      java.util.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 Detail

      • CmsXmlContentValueSequence

        public CmsXmlContentValueSequence​(java.lang.String path,
                                          java.util.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