Package org.exolab.castor.xml.schema

Class IdentityConstraint

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    Key, KeyRef, Unique
    public abstract class IdentityConstraint
extends Annotated
    The base class for the XML Schema Identity Constraints (key, keyref, unique).
    Version:
    $Revision: 6230 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
    Author:
    Keith Visco
    See Also:
    Serialized Form

    • Constructor Detail

      • IdentityConstraint

        protected IdentityConstraint​(java.lang.String name)
                      throws SchemaException
        Constructor used by sub-classes. Creates a new IdentityConstraint.
        Parameters:
        name - the name for the IdentityConstraint. Must not be null.
        Throws:
        SchemaException

    • Method Detail

      • addField

        public void addField​(IdentityField field)
        Adds the given IdentityField to this IdentityConstraint
        Parameters:
        field - the IdentityField to add.

      • getFields

        public java.util.Enumeration getFields()
        Returns an Enumeration of the IdentityFields contained within this IdentityConstraint.
        Returns:
        an Enumeration of the IdentityField objects contain within this IdentityConstraint.

      • getId

        public java.lang.String getId()
        Returns the Id of this IdentityConstraint, or null if no Id has been set.
        Returns:
        the Id of this IdentityConstraint, or null if no Id has been set.

      • getName

        public java.lang.String getName()
        Returns the name of this IdentityConstraint. This value will never be null.
        Returns:
        the name of this IdentityConstraint

      • getSelector

        public IdentitySelector getSelector()
        Returns the selector of this IdentityConstraint.
        Returns:
        the IdentitySelector of this IdentityConstraint

      • removeField

        public boolean removeField​(IdentityField field)
        Removes the given IdentityField from this IdentityConstraint.
        Returns:
        true if the IdentityField was contained within this IdentityConstraint, otherwise false.

      • setId

        public void setId​(java.lang.String id)
        Sets the Id for this IdentityConstraint.
        Parameters:
        id - the Id for this IdentityConstraint.

      • setName

        public void setName​(java.lang.String name)
             throws SchemaException
        Sets the name for this IdentityConstraint.
        Parameters:
        name - the name for this IdentityConstraint. Must not be null.
        Throws:
        SchemaException - if name is null.

      • setSelector

        public void setSelector​(IdentitySelector selector)
                 throws SchemaException
        Sets the selector for this IdentityConstraint.
        Parameters:
        selector - the Selector for this IdentityConstraint. Must not be null.
        Throws:
        SchemaException - if selector is null.

      • getStructureType

        public abstract short getStructureType()
        Returns the type of this Schema Structure
        Specified by:
        getStructureType in class Structure
        Returns:
        the type of this Schema Structure