org.exolab.castor.xml.schema

Class IdentitySelector

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.Annotated

org.exolab.castor.xml.schema.IdentitySelector

All Implemented Interfaces:

java.io.Serializable

public class IdentitySelector
extends Annotated

A class which represents the selector for an IdentityConstraint

Version:

$Revision: 6230 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $

Author:

Keith Visco

See Also:

Serialized Form

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

Constructors

Constructor and Description
IdentitySelector(java.lang.String xpath) Creates a new IdentitySelector.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId() Returns the Id of this IdentitySelector, or null if no Id has been set.
short	getStructureType() Returns the type of this Schema Structure
java.lang.String	getXPath() Returns the XPath of this IdentitySelector.
void	setId(java.lang.String id) Sets the Id for this IdentitySelector.
void	setXPath(java.lang.String xpath) Sets the XPath expression for this Selector.
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

IdentitySelector

public IdentitySelector(java.lang.String xpath)
                 throws SchemaException

Creates a new IdentitySelector.

Parameters:

xpath - the xpath for the IdentitySelector. Must not be null.

Throws:

SchemaException - if xpath is null.

Method Detail

getId

public java.lang.String getId()

Returns the Id of this IdentitySelector, or null if no Id has been set.

Returns:

the Id of this IdentitySelector, or null if no Id has been set.

getXPath

public java.lang.String getXPath()

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

Returns:

the XPath of this IdentitySelector.

setId

public void setId(java.lang.String id)

Sets the Id for this IdentitySelector.

Parameters:

id - the Id for this IdentitySelector.

setXPath

public void setXPath(java.lang.String xpath)
              throws SchemaException

Sets the XPath expression for this Selector.

Parameters:

xpath - the XPath expression for this IdentitySelector. Must not be null.

Throws:

SchemaException - if xpath is null.

getStructureType

public short getStructureType()

Returns the type of this Schema Structure

Specified by:

getStructureType in class Structure

Returns:

the type of this Schema Structure

validate

public void validate()
              throws ValidationException

Checks the validity of this Schema defintion.

Specified by:

validate in class Structure

Throws:

ValidationException - when this Schema definition is invalid.