org.exolab.castor.xml.schema

Class IdentityConstraint

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

Constructor Summary
protected IdentityConstraint(String name)
Constructor used by sub-classes.
Method Summary
voidaddField(IdentityField field)
Adds the given IdentityField to this IdentityConstraint
EnumerationgetFields()
Returns an Enumeration of the IdentityFields contained within this IdentityConstraint.
StringgetId()
Returns the Id of this IdentityConstraint, or null if no Id has been set.
StringgetName()
Returns the name of this IdentityConstraint.
IdentitySelectorgetSelector()
Returns the selector of this IdentityConstraint.
abstract shortgetStructureType()
Returns the type of this Schema Structure
booleanremoveField(IdentityField field)
Removes the given IdentityField from this IdentityConstraint.
voidsetId(String id)
Sets the Id for this IdentityConstraint.
voidsetName(String name)
Sets the name for this IdentityConstraint.
voidsetSelector(IdentitySelector selector)
Sets the selector for this IdentityConstraint.
voidvalidate()
Checks the validity of this Schema defintion.

Constructor Detail

IdentityConstraint

protected IdentityConstraint(String name)
Constructor used by sub-classes. Creates a new IdentityConstraint.

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

Method Detail

addField

public void addField(IdentityField field)
Adds the given IdentityField to this IdentityConstraint

Parameters: field the IdentityField to add.

getFields

public 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 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 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

getStructureType

public abstract short getStructureType()
Returns the type of this Schema Structure

Returns: the type of this Schema Structure

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(String id)
Sets the Id for this IdentityConstraint.

Parameters: id the Id for this IdentityConstraint.

setName

public void setName(String name)
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)
Sets the selector for this IdentityConstraint.

Parameters: selector the Selector for this IdentityConstraint. Must not be null.

Throws: SchemaException if selector is null.

validate

public void validate()
Checks the validity of this Schema defintion.

Throws: ValidationException when this Schema definition is invalid.

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