Class XSElementDecl

  • All Implemented Interfaces:
    XSElementDeclaration, XSObject, XSTerm

    public class XSElementDecl
    extends Object
    implements XSElementDeclaration
    The XML representation for an element declaration schema component is an <element> element information item
    Version:
    $Id$
    Author:
    Elena Litani, IBM, Sandy Gao, IBM
    • Constructor Detail

      • XSElementDecl

        public XSElementDecl()
    • Method Detail

      • setConstraintType

        public void setConstraintType​(short constraintType)
      • setIsNillable

        public void setIsNillable()
      • setIsAbstract

        public void setIsAbstract()
      • setIsGlobal

        public void setIsGlobal()
      • hashCode

        public int hashCode()
        get the hash code
        Overrides:
        hashCode in class Object
      • equals

        public boolean equals​(Object o)
        whether two decls are the same
        Overrides:
        equals in class Object
      • reset

        public void reset()
        Reset current element declaration
      • getType

        public short getType()
        Get the type of the object, i.e ELEMENT_DECLARATION.
        Specified by:
        getType in interface XSObject
      • getName

        public String getName()
        The name of this XSObject depending on the XSObject type.
        Specified by:
        getName in interface XSObject
      • getNamespace

        public String getNamespace()
        The namespace URI of this node, or null if it is unspecified. defines how a namespace URI is attached to schema components.
        Specified by:
        getNamespace in interface XSObject
      • getScope

        public short getScope()
        Optional. Either global or a complex type definition ( ctDefinition). This property is absent in the case of declarations within named model groups: their scope will be determined when they are used in the construction of complex type definitions.
        Specified by:
        getScope in interface XSElementDeclaration
      • getNillable

        public boolean getNillable()
        If {nillable} is true, then an element may also be valid if it carries the namespace qualified attribute with [local name] nil from namespace http://www.w3.org/2001/XMLSchema-instance and value true (see xsi:nil (2.6.2)) even if it has no text or element content despite a {content type} which would otherwise require content.
        Specified by:
        getNillable in interface XSElementDeclaration
      • isSubstitutionGroupExclusion

        public boolean isSubstitutionGroupExclusion​(short exclusion)
        Convenience method. Check if exclusion is a substitution group exclusion for this element declaration.
        Specified by:
        isSubstitutionGroupExclusion in interface XSElementDeclaration
        Parameters:
        exclusion - Extension, restriction or none. Represents final set for the element.
        Returns:
        True if exclusion is a part of the substitution group exclusion subset.
      • getSubstitutionGroupExclusions

        public short getSubstitutionGroupExclusions()
        Specifies if this declaration can be nominated as the {substitution group affiliation} of other element declarations having the same {type definition} or types derived therefrom.
        Specified by:
        getSubstitutionGroupExclusions in interface XSElementDeclaration
        Returns:
        A bit flag representing {extension, restriction} or NONE.
      • isDisallowedSubstitution

        public boolean isDisallowedSubstitution​(short disallowed)
        Convenience method. Check if disallowed is a disallowed substitution for this element declaration.
        Specified by:
        isDisallowedSubstitution in interface XSElementDeclaration
        Parameters:
        disallowed - Substitution, extension, restriction or none. Represents a block set for the element.
        Returns:
        True if disallowed is a part of the substitution group exclusion subset.
      • getDisallowedSubstitutions

        public short getDisallowedSubstitutions()
        The supplied values for {disallowed substitutions}
        Specified by:
        getDisallowedSubstitutions in interface XSElementDeclaration
        Returns:
        A bit flag representing {substitution, extension, restriction} or NONE.
      • getActualVC

        public Object getActualVC()
        Description copied from interface: XSElementDeclaration
        Value Constraint: Binding specific actual constraint value or null if the value is in error or there is no value constraint.
        Specified by:
        getActualVC in interface XSElementDeclaration
      • getActualVCType

        public short getActualVCType()
        Description copied from interface: XSElementDeclaration
        The actual constraint value built-in datatype, e.g. STRING_DT, SHORT_DT. If the type definition of this value is a list type definition, this method returns LIST_DT. If the type definition of this value is a list type definition whose item type is a union type definition, this method returns LISTOFUNION_DT. To query the actual constraint value of the list or list of union type definitions use itemValueTypes. If the actualNormalizedValue is null, this method returns UNAVAILABLE_DT.
        Specified by:
        getActualVCType in interface XSElementDeclaration
      • getItemValueTypes

        public ShortList getItemValueTypes()
        Description copied from interface: XSElementDeclaration
        In the case the actual constraint value represents a list, i.e. the actualValueType is LIST_DT, the returned array consists of one type kind which represents the itemType. If the actual constraint value represents a list type definition whose item type is a union type definition, i.e. LISTOFUNION_DT, for each actual constraint value in the list the array contains the corresponding memberType kind. For examples, see ItemPSVI.itemValueTypes.
        Specified by:
        getItemValueTypes in interface XSElementDeclaration