Class TypeReference

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.Annotated

org.exolab.castor.xml.schema.XMLType

org.exolab.castor.xml.schema.TypeReference

All Implemented Interfaces:

Serializable

public class TypeReference
extends XMLType

Package private class to handles type references.

Version:

$Revision:

Author:

Arnaud Berry

See Also:

• Serialized Form

Field Summary

Fields inherited from class XMLType

NULL_ARGUMENT

Modifier and Type	Field	Description
protected static String	NULL_ARGUMENT	Error message for a null argument

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
TypeReference()

Method Summary

Modifier and Type	Method	Description
short	getStructureType()	Returns Structure.UNKNOWN (This class should not be seen outside ElementDecl anyway)
protected void	setParent(Structure parent)	Sets the parent for this Schema type
void	validate()	Checks the validity of this type defintion.

Methods inherited from class XMLType

getBaseType, getBaseTypeName, getDerivationMethod, getId, getName, getSchema, isAnyType, isComplexType, isSimpleType, setBaseType, setDerivationMethod, setId, setName, setSchema

Modifier and Type	Method	Description
XMLType	getBaseType()	Returns the base type that this type inherits from.
String	getBaseTypeName()	If this type has a base type, this returns its name. Returns null otherwise.
String	getDerivationMethod()	Gets the name of the derivation method used to derive this type from its parent.
String	getId()	Returns the Id for this ComplexType, or null if no Id has been set.
String	getName()	Returns the name of this type (null if none was defined)
Schema	getSchema()	Returns the schema to which this type belongs
final boolean	isAnyType()	Returns true if this XMLType is an AnyType
final boolean	isComplexType()	Returns true if this XMLType is a ComplexType
final boolean	isSimpleType()	Returns true if this XMLType is a SimpleType
void	setBaseType(XMLType baseType)	Sets the base type for this datatype
void	setDerivationMethod(String derivationMethod)	Sets the derivation method name
void	setId(String id)	Sets the Id for this XMLType.
void	setName(String name)	Sets the name of this type
void	setSchema(Schema schema)	Sets the name of this SimpleType

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

TypeReference

public TypeReference()

Method Details

setParent

protected void setParent(Structure parent)

Sets the parent for this Schema type

Specified by:

setParent in class XMLType

Parameters:

parent - the parent Structure for SchemaType

getStructureType

public short getStructureType()

Returns Structure.UNKNOWN (This class should not be seen outside ElementDecl anyway)

Specified by:

getStructureType in class Structure

Returns:

the type of this Schema Structure.

validate

public void validate()
              throws ValidationException

Checks the validity of this type defintion.

Specified by:

validate in class Structure

Throws:

ValidationException - when this type definition is invalid.