Public Member Functions | Protected Member Functions

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

Inheritance diagram for org.exolab.castor.xml.schema.IdentityConstraint:
org.exolab.castor.xml.schema.Annotated org.exolab.castor.xml.schema.Structure org.exolab.castor.xml.schema.Key org.exolab.castor.xml.schema.KeyRef org.exolab.castor.xml.schema.Unique

List of all members.

Public Member Functions

void addField (IdentityField field)
Enumeration getFields ()
String getId ()
String getName ()
IdentitySelector getSelector ()
boolean removeField (IdentityField field)
void setId (String id)
void setName (String name) throws SchemaException
void setSelector (IdentitySelector selector) throws SchemaException
abstract short getStructureType ()
void validate () throws ValidationException

Protected Member Functions

 IdentityConstraint (String name) throws SchemaException

Detailed Description

The base class for the XML Schema Identity Constraints (key, keyref, unique).

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

Constructor & Destructor Documentation

org.exolab.castor.xml.schema.IdentityConstraint.IdentityConstraint ( String  name  )  throws SchemaException [protected]

Constructor used by sub-classes. Creates a new IdentityConstraint.

Parameters:
name,the name for the IdentityConstraint. Must not be null.

References org.exolab.castor.xml.schema.IdentityConstraint.setName().


Member Function Documentation

void org.exolab.castor.xml.schema.IdentityConstraint.addField ( IdentityField  field  ) 
Enumeration org.exolab.castor.xml.schema.IdentityConstraint.getFields (  ) 

Returns an Enumeration of the IdentityFields contained within this IdentityConstraint.

Returns:
an Enumeration of the IdentityField objects contain within this IdentityConstraint.
String org.exolab.castor.xml.schema.IdentityConstraint.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.
String org.exolab.castor.xml.schema.IdentityConstraint.getName (  ) 

Returns the name of this IdentityConstraint. This value will never be null.

Returns:
the name of this IdentityConstraint
IdentitySelector org.exolab.castor.xml.schema.IdentityConstraint.getSelector (  ) 

Returns the selector of this IdentityConstraint.

Returns:
the IdentitySelector of this IdentityConstraint
abstract short org.exolab.castor.xml.schema.IdentityConstraint.getStructureType (  )  [pure virtual]
boolean org.exolab.castor.xml.schema.IdentityConstraint.removeField ( IdentityField  field  ) 

Removes the given IdentityField from this IdentityConstraint.

Returns:
true if the IdentityField was contained within this IdentityConstraint, otherwise false.
void org.exolab.castor.xml.schema.IdentityConstraint.setId ( String  id  ) 

Sets the Id for this IdentityConstraint.

Parameters:
id the Id for this IdentityConstraint.
void org.exolab.castor.xml.schema.IdentityConstraint.setName ( String  name  )  throws SchemaException

Sets the name for this IdentityConstraint.

Parameters:
name the name for this IdentityConstraint. Must not be null.
Exceptions:
SchemaException if name is null.

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

void org.exolab.castor.xml.schema.IdentityConstraint.setSelector ( IdentitySelector  selector  )  throws SchemaException

Sets the selector for this IdentityConstraint.

Parameters:
selector the Selector for this IdentityConstraint. Must not be null.
Exceptions:
SchemaException if selector is null.

Referenced by org.exolab.castor.xml.schema.reader.IdentityConstraintUnmarshaller.endElement().

void org.exolab.castor.xml.schema.IdentityConstraint.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