org.exolab.castor.xml.schema
Class IdentityField

java.lang.Object
  extended by org.exolab.castor.xml.schema.Structure
      extended by org.exolab.castor.xml.schema.Annotated
          extended by org.exolab.castor.xml.schema.IdentityField
All Implemented Interfaces:
java.io.Serializable

public class IdentityField
extends Annotated

A class which represents the field selector for an IdentityConstraint

Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:32 $
Author:
Keith Visco
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.exolab.castor.xml.schema.Structure
ANNOTATION, ANYTYPE, APPINFO, ATTRIBUTE, ATTRIBUTE_GROUP, COMPLEX_CONTENT, COMPLEX_TYPE, DOCUMENTATION, ELEMENT, FACET, GROUP, IDENTITY_FIELD, IDENTITY_SELECTOR, KEY, KEYREF, LIST, MODELGROUP, MODELGROUP_REF, REDEFINE, SCHEMA, SIMPLE_CONTENT, SIMPLE_TYPE, UNION, UNIQUE, UNKNOWN, WILDCARD
 
Constructor Summary
IdentityField(java.lang.String xpath)
          Creates a new IdentityField.
 
Method Summary
 java.lang.String getId()
          Returns the Id of this IdentityField, or null if no Id has been set.
 short getStructureType()
          Returns the type of this Schema Structure
 java.lang.String getXPath()
          Returns the XPath of this IdentityField.
 void setId(java.lang.String id)
          Sets the Id for this IdentityField.
 void setXPath(java.lang.String xpath)
          Sets the XPath expression for this Field.
 void validate()
          Checks the validity of this Schema defintion.
 
Methods inherited from class org.exolab.castor.xml.schema.Annotated
addAnnotation, getAnnotations, removeAnnotation
 
Methods inherited from class org.exolab.castor.xml.schema.Structure
isValid
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdentityField

public IdentityField(java.lang.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 Detail

getId

public java.lang.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 java.lang.String getXPath()
Returns the XPath of this IdentityField. This value will never be null.

Returns:
the XPath of this IdentityField.

setId

public void setId(java.lang.String id)
Sets the Id for this IdentityField.

Parameters:
id - the Id for this IdentityField.

setXPath

public void setXPath(java.lang.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.


Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com