org.exolab.castor.xml.schema

Class IdentityField

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

Constructor Summary
IdentityField(String xpath)
Creates a new IdentityField.
Method Summary
StringgetId()
Returns the Id of this IdentityField, or null if no Id has been set.
shortgetStructureType()
Returns the type of this Schema Structure
StringgetXPath()
Returns the XPath of this IdentityField.
voidsetId(String id)
Sets the Id for this IdentityField.
voidsetXPath(String xpath)
Sets the XPath expression for this Field.
voidvalidate()
Checks the validity of this Schema defintion.

Constructor Detail

IdentityField

public IdentityField(String xpath)
Creates a new IdentityField.

Parameters: xpath, the xpath for the IdentityField. Must not be null.

Throws: SchemaException if xpath is null.

Method Detail

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

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)
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()
Checks the validity of this Schema defintion.

Throws: ValidationException when this Schema definition is invalid.

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