Package org.exolab.castor.xml.schema

Class IdentityField

java.lang.Object
org.exolab.castor.xml.schema.Structure
org.exolab.castor.xml.schema.Annotated
org.exolab.castor.xml.schema.IdentityField
All Implemented Interfaces:
Serializable
public class IdentityField extends Annotated
A class which represents the field selector for an IdentityConstraint
Version:
$Revision: 6230 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
Author:
Keith Visco
See Also:

  • Constructor Details

    • IdentityField

      public IdentityField(String xpath) throws SchemaException
      Creates a new IdentityField.
      Parameters:
      xpath - the xpath for the IdentityField. Must not be null.
      Throws:
      SchemaException - if xpath is null.

  • Method Details

    • getId

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

    • getXPath

      public String getXPath()
      Returns the XPath of this IdentityField. This value will never be null.
      Returns:
      the XPath of this IdentityField.

    • setId

      public void setId(String id)
      Sets the Id for this IdentityField.
      Parameters:
      id - the Id for this IdentityField.

    • setXPath

      public void setXPath(String xpath) throws SchemaException
      Sets the XPath expression for this Field.
      Parameters:
      xpath - the XPath expression for this IdentityField. Must not be null.
      Throws:
      SchemaException - if xpath is null.

    • getStructureType

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

    • validate

      public void validate() throws ValidationException
      Checks the validity of this Schema defintion.
      Specified by:
      validate in class Structure
      Throws:
      ValidationException - when this Schema definition is invalid.