|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.xml.schema.Structure
org.exolab.castor.xml.schema.Annotated
org.exolab.castor.xml.schema.IdentityConstraint
public abstract class IdentityConstraint
The base class for the XML Schema Identity Constraints (key, keyref, unique).
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 | |
---|---|
protected |
IdentityConstraint(java.lang.String name)
Constructor used by sub-classes. |
Method Summary | |
---|---|
void |
addField(IdentityField field)
Adds the given IdentityField to this IdentityConstraint |
java.util.Enumeration |
getFields()
Returns an Enumeration of the IdentityFields contained within this IdentityConstraint. |
java.lang.String |
getId()
Returns the Id of this IdentityConstraint, or null if no Id has been set. |
java.lang.String |
getName()
Returns the name of this IdentityConstraint. |
IdentitySelector |
getSelector()
Returns the selector of this IdentityConstraint. |
abstract short |
getStructureType()
Returns the type of this Schema Structure |
boolean |
removeField(IdentityField field)
Removes the given IdentityField from this IdentityConstraint. |
void |
setId(java.lang.String id)
Sets the Id for this IdentityConstraint. |
void |
setName(java.lang.String name)
Sets the name for this IdentityConstraint. |
void |
setSelector(IdentitySelector selector)
Sets the selector for this IdentityConstraint. |
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 |
---|
protected IdentityConstraint(java.lang.String name) throws SchemaException
name,
- the name for the IdentityConstraint. Must not be null.
SchemaException
Method Detail |
---|
public void addField(IdentityField field)
field
- the IdentityField to add.public java.util.Enumeration getFields()
public java.lang.String getId()
public java.lang.String getName()
public IdentitySelector getSelector()
public boolean removeField(IdentityField field)
public void setId(java.lang.String id)
id
- the Id for this IdentityConstraint.public void setName(java.lang.String name) throws SchemaException
name
- the name for this IdentityConstraint. Must not be null.
SchemaException
- if name is null.public void setSelector(IdentitySelector selector) throws SchemaException
selector
- the Selector for this IdentityConstraint. Must not be
null.
SchemaException
- if selector is null.public abstract short getStructureType()
getStructureType
in class Structure
public void validate() throws ValidationException
validate
in class Structure
ValidationException
- when this Schema definition
is invalid.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |