| |
|
| java.lang.Object org.exolab.castor.xml.schema.Structure org.exolab.castor.xml.schema.Annotated org.exolab.castor.xml.schema.IdentityConstraint
All known Subclasses: org.exolab.castor.xml.schema.Unique, org.exolab.castor.xml.schema.Key, org.exolab.castor.xml.schema.KeyRef,
IdentityConstraint | abstract public class IdentityConstraint extends Annotated (Code) | | The base class for the XML Schema Identity Constraints
(key, keyref, unique).
author: Keith Visco version: $Revision: 6230 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $ |
Method Summary | |
public void | addField(IdentityField field) | public Enumeration | getFields() Returns an Enumeration of the IdentityFields contained within this
IdentityConstraint. | public String | getId() Returns the Id of this IdentityConstraint, or null if no
Id has been set. | public String | getName() Returns the name of this IdentityConstraint. | public IdentitySelector | getSelector() Returns the selector of this IdentityConstraint. | abstract public short | getStructureType() | public boolean | removeField(IdentityField field) Removes the given IdentityField from this IdentityConstraint. | public void | setId(String id) Sets the Id for this IdentityConstraint.
Parameters: id - the Id for this IdentityConstraint. | public void | setName(String name) Sets the name for this IdentityConstraint.
Parameters: name - the name for this IdentityConstraint. | public void | setSelector(IdentitySelector selector) Sets the selector for this IdentityConstraint.
Parameters: selector - the Selector for this IdentityConstraint. | public void | validate() Checks the validity of this Schema defintion. |
IdentityConstraint | protected IdentityConstraint(String name) throws SchemaException(Code) | | Constructor used by sub-classes. Creates a new IdentityConstraint.
Parameters: name - the name for the IdentityConstraint. Must not be null. |
addField | public void addField(IdentityField field)(Code) | | Adds the given IdentityField to this IdentityConstraint
Parameters: field - the IdentityField to add. |
getFields | public Enumeration getFields()(Code) | | Returns an Enumeration of the IdentityFields contained within this
IdentityConstraint.
an Enumeration of the IdentityField objects contain withinthis IdentityConstraint. |
getId | public String getId()(Code) | | Returns the Id of this IdentityConstraint, or null if no
Id has been set.
the Id of this IdentityConstraint, or null if noId has been set. |
getName | public String getName()(Code) | | Returns the name of this IdentityConstraint. This value will
never be null.
the name of this IdentityConstraint |
getSelector | public IdentitySelector getSelector()(Code) | | Returns the selector of this IdentityConstraint.
the IdentitySelector of this IdentityConstraint |
getStructureType | abstract public short getStructureType()(Code) | | Returns the type of this Schema Structure
the type of this Schema Structure |
removeField | public boolean removeField(IdentityField field)(Code) | | Removes the given IdentityField from this IdentityConstraint.
true if the IdentityField was contained within this IdentityConstraint, otherwise false. |
setId | public void setId(String id)(Code) | | Sets the Id for this IdentityConstraint.
Parameters: id - the Id for this IdentityConstraint. |
setName | public void setName(String name) throws SchemaException(Code) | | Sets the name for this IdentityConstraint.
Parameters: name - the name for this IdentityConstraint. Must not be null. exception: SchemaException - if name is null. |
setSelector | public void setSelector(IdentitySelector selector) throws SchemaException(Code) | | Sets the selector for this IdentityConstraint.
Parameters: selector - the Selector for this IdentityConstraint. Must not be null. exception: SchemaException - if selector is null. |
|
|
|