Class KeyRef

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.Annotated

org.exolab.castor.xml.schema.IdentityConstraint

org.exolab.castor.xml.schema.KeyRef

All Implemented Interfaces:

Serializable

public class KeyRef
extends IdentityConstraint

A class that represents the XML Schema Identity Constraint: KeyRef.

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 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

Modifier and Type	Field	Description
static final short	ANNOTATION
static final short	ANYTYPE
static final short	APPINFO
static final short	ATTRIBUTE
static final short	ATTRIBUTE_GROUP
static final short	COMPLEX_CONTENT
static final short	COMPLEX_TYPE
static final short	DOCUMENTATION
static final short	ELEMENT
static final short	FACET
static final short	GROUP
static final short	IDENTITY_FIELD
static final short	IDENTITY_SELECTOR
static final short	KEY
static final short	KEYREF
static final short	LIST
static final short	MODELGROUP
static final short	MODELGROUP_REF
static final short	REDEFINE
static final short	SCHEMA
static final short	SIMPLE_CONTENT
static final short	SIMPLE_TYPE
static final short	UNION
static final short	UNIQUE
static final short	UNKNOWN
static final short	WILDCARD

Constructor Summary

Constructors

Constructor	Description
KeyRef(String name, String refer)	Creates a new KeyRef Identity-Constraint.

Method Summary

Modifier and Type	Method	Description
String	getRefer()	Returns the refer field (the name of the key being referenced).
short	getStructureType()	Returns the type of this Schema Structure.
void	setRefer(String refer)	Sets the refer field (the name of the key being referenced).

Methods inherited from class IdentityConstraint

addField, getFields, getId, getName, getSelector, removeField, setId, setName, setSelector, validate

Modifier and Type	Method	Description
void	addField(IdentityField field)	Adds the given IdentityField to this IdentityConstraint
Enumeration	getFields()	Returns an Enumeration of the IdentityFields contained within this IdentityConstraint.
String	getId()	Returns the Id of this IdentityConstraint, or null if no Id has been set.
String	getName()	Returns the name of this IdentityConstraint.
IdentitySelector	getSelector()	Returns the selector of this IdentityConstraint.
boolean	removeField(IdentityField field)	Removes the given IdentityField from this IdentityConstraint.
void	setId(String id)	Sets the Id for this IdentityConstraint.
void	setName(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 Annotated

addAnnotation, getAnnotations, removeAnnotation

Modifier and Type	Method	Description
void	addAnnotation(Annotation annotation)	Adds the given Annotation to this Annotated Structure.
Enumeration<Annotation>	getAnnotations()	Returns an Enumeration of the Annotations contained within this Annotated type.
void	removeAnnotation(Annotation annotation)	Removes the given Annotation from this Annotated Structure.

Methods inherited from class Structure

isValid

Modifier and Type	Method	Description
boolean	isValid()	Calls validate() to determine if this Schema Definition is valid.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KeyRef

public KeyRef(String name,
 String refer)
       throws SchemaException

Creates a new KeyRef Identity-Constraint.

Parameters:

name - the name for the IdentityConstraint. Must not be null.

Throws:

SchemaException - when name or refer are null.

Method Details

getRefer

public String getRefer()

Returns the refer field (the name of the key being referenced).

Returns:

the refer field (the name of the key being referenced).

setRefer

public void setRefer(String refer)
              throws SchemaException

Sets the refer field (the name of the key being referenced).

Parameters:

refer - the name of the key to reference. Must not be null.

Throws:

SchemaException - when refer is null.

getStructureType

public short getStructureType()

Returns the type of this Schema Structure.

Specified by:

getStructureType in class IdentityConstraint

Returns:

the type of this Schema Structure.