Interface ComplexType

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean cache​(Element element, Map<String,​Object> hints)
      This method is a directive to the parser whether to keep the data around in memory for post processing.
      String getAnyAttributeNameSpace()
      This methos represents the potential 'anyAttribute' declaration's namespace attribute which may occur within a complex type definition.
      Attribute[] getAttributes()
      The set of attributes required by this complex type declaration.
      int getBlock()
      Specifies a mask which denotes which substitution mechanisms may be used for this complex type definition.
      ElementGrouping getChild()
      Returns the child element representing the structure of nested child nodes (if any are allowed).
      Element[] getChildElements()  
      int getFinal()
      Specifies a mask which denotes which substitution mechanisms prohibited for use by child definitions of this complex type.
      String getId()
      Returns the xml schema id of this complexType if one exists, null otherwise.
      Type getParent()
      This is used to represent the heirarchy represented within an xml schema document(s).
      boolean isAbstract()
      Returns true when the complexType should be considered abstract, as defined by the XML schema of which this complex type definition is a part.
      boolean isDerived()
      This method is used to publish whether this complexType is at the root of an inheritance tree, or a leaf within an inheritance tree.
      boolean isMixed()
      Returns true if this complexType allows mixed content (Child elements and a String value).
    • Method Detail

      • getParent

        Type getParent()
        This is used to represent the heirarchy represented within an xml schema document(s). This is particularily useful, as the parent will have the first attempt to create a real (non Object[]) value of the element. For more information see getValue.
        See Also:
        Type#getValue(Element, ElementValue[], Attributes)
      • isAbstract

        boolean isAbstract()
        Returns true when the complexType should be considered abstract, as defined by the XML schema of which this complex type definition is a part.
      • getAnyAttributeNameSpace

        String getAnyAttributeNameSpace()
        This methos represents the potential 'anyAttribute' declaration's namespace attribute which may occur within a complex type definition.
      • getAttributes

        Attribute[] getAttributes()
        The set of attributes required by this complex type declaration. As per the xml schema definition, there is not an implied order to the attributes. For performance reasons an implementor may wich to order the attributes from most common to least commonly used attributes.
      • getChild

        ElementGrouping getChild()
        Returns the child element representing the structure of nested child nodes (if any are allowed).
        See Also:
        ElementGrouping
      • getChildElements

        Element[] getChildElements()
      • getId

        String getId()
        Returns the xml schema id of this complexType if one exists, null otherwise.
      • isMixed

        boolean isMixed()
        Returns true if this complexType allows mixed content (Child elements and a String value).
      • isDerived

        boolean isDerived()
        This method is used to publish whether this complexType is at the root of an inheritance tree, or a leaf within an inheritance tree. This method should return true when the complexType is not a root of an inheritance tree.
      • cache

        boolean cache​(Element element,
                      Map<String,​Object> hints)
        This method is a directive to the parser whether to keep the data around in memory for post processing. Generally this should return True, except when streaming.
        Returns:
        True, except when streaming the element.