org.exolab.castor.xml.schema

Class IdentityField

Implemented Interfaces:
java.io.Serializable

public class IdentityField
extends Annotated

A class which represents the field selector for an IdentityConstraint
Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:32 $
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

IdentityField(String xpath)
Creates a new IdentityField.

Method Summary

String
getId()
Returns the Id of this IdentityField, or null if no Id has been set.
short
getStructureType()
Returns the type of this Schema Structure
String
getXPath()
Returns the XPath of this IdentityField.
void
setId(String id)
Sets the Id for this IdentityField.
void
setXPath(String xpath)
Sets the XPath expression for this Field.
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

getStructureType, isValid, validate

Constructor Details

IdentityField

public IdentityField(String xpath)
            throws SchemaException
Creates a new IdentityField.
Parameters:
Throws:
SchemaException - if xpath is null.

Method Details

getId

public String getId()
Returns the Id of this IdentityField, or null if no Id has been set.
Returns:
the Id of this IdentityField, or null if no Id has been set.

getStructureType

public short getStructureType()
Returns the type of this Schema Structure
Overrides:
getStructureType in interface Structure
Returns:
the type of this Schema Structure

getXPath

public String getXPath()
Returns the XPath of this IdentityField. This value will never be null.
Returns:
the XPath of this IdentityField.

setId

public void setId(String id)
Sets the Id for this IdentityField.
Parameters:
id - the Id for this IdentityField.

setXPath

public void setXPath(String xpath)
            throws SchemaException
Sets the XPath expression for this Field.
Parameters:
xpath - the XPath expression for this IdentityField. Must not be null.
Throws:
SchemaException - if xpath is null.

validate

public void validate()
            throws ValidationException
Checks the validity of this Schema defintion.
Overrides:
validate in interface Structure
Throws:
ValidationException - when this Schema definition is invalid.

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