Public Member Functions

org.exolab.castor.xml.schema.IdentityField Class Reference

Inheritance diagram for org.exolab.castor.xml.schema.IdentityField:
org.exolab.castor.xml.schema.Annotated org.exolab.castor.xml.schema.Structure

List of all members.

Public Member Functions

 IdentityField (String xpath) throws SchemaException
String getId ()
String getXPath ()
void setId (String id)
void setXPath (String xpath) throws SchemaException
short getStructureType ()
void validate () throws ValidationException

Detailed Description

A class which represents the field selector for an IdentityConstraint

Author:
Keith Visco
Version:
Revision:
1.1.1.1
Date:
2003/03/03 07:09:32

Constructor & Destructor Documentation

org.exolab.castor.xml.schema.IdentityField.IdentityField ( String  xpath  )  throws SchemaException

Creates a new IdentityField.

Parameters:
xpath,the xpath for the IdentityField. Must not be null.
Exceptions:
SchemaException if xpath is null.

References org.exolab.castor.xml.schema.IdentityField.setXPath().

Member Function Documentation

String org.exolab.castor.xml.schema.IdentityField.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.
short org.exolab.castor.xml.schema.IdentityField.getStructureType (  )  [virtual]

Returns the type of this Schema Structure

Returns:
the type of this Schema Structure

Implements org.exolab.castor.xml.schema.Structure.

String org.exolab.castor.xml.schema.IdentityField.getXPath (  ) 

Returns the XPath of this IdentityField. This value will never be null.

Returns:
the XPath of this IdentityField.
void org.exolab.castor.xml.schema.IdentityField.setId ( String  id  ) 

Sets the Id for this IdentityField.

Parameters:
id the Id for this IdentityField.
void org.exolab.castor.xml.schema.IdentityField.setXPath ( String  xpath  )  throws SchemaException

Sets the XPath expression for this Field.

Parameters:
xpath the XPath expression for this IdentityField. Must not be null.
Exceptions:
SchemaException if xpath is null.

Referenced by org.exolab.castor.xml.schema.IdentityField.IdentityField().

void org.exolab.castor.xml.schema.IdentityField.validate (  )  throws ValidationException [virtual]

Checks the validity of this Schema defintion.

Exceptions:
ValidationException when this Schema definition is invalid.

Implements org.exolab.castor.xml.schema.Structure.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties
Generated on Thu Jan 12 2012 23:15:56 for ACS-10.0 Java API by  doxygen 1.7.0