Class AnyType

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

All Implemented Interfaces:

Serializable

public final class AnyType
extends XMLType

A Class which represents the XML Schema AnyType.

Version:

$Revision: 6230 $ $Date: 2005-12-13 14:58:48 -0700 (Tue, 13 Dec 2005) $

Author:

Keith Visco

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
AnyType(Schema schema)	Creates a new AnyType for the given Schema.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the name of this type.
short	getStructureType()	Returns the type of this Schema Structure.
void	setBaseType(XMLType baseType)	Overrides XMLType#setBaseType(), anyType cannot have a Base type.
void	setDerivationMethod(String derivationMethod)	Overrides XMLType#setDerivationMethod, anyType cannot be derived from any other type.
void	setId(String id)	Sets the Id for this XMLType.
void	setName(String name)	Overrides XMLType#setName.
protected void	setParent(Structure parent)	Sets the parent for this XMLType
void	validate()	Checks the validity of this Schema defintion.

Methods inherited from class XMLType

getBaseType, getBaseTypeName, getDerivationMethod, getId, getSchema, isAnyType, isComplexType, isSimpleType, 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.
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	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

AnyType

public AnyType(Schema schema)

Creates a new AnyType for the given Schema.

Method Details

getName

public String getName()

Returns the name of this type. This method always returns 'anyType'.

Overrides:

getName in class XMLType

Returns:

the name of this type.

getStructureType

public short getStructureType()

Returns the type of this Schema Structure. This method returns Structure.ANYTYPE.

Specified by:

getStructureType in class Structure

Returns:

the type of this Schema Structure.

setName

public void setName(String name)

Overrides XMLType#setName. The Name of anyType cannot be changed.

Overrides:

setName in class XMLType

Parameters:

name - of the type

setBaseType

public void setBaseType(XMLType baseType)

Overrides XMLType#setBaseType(), anyType cannot have a Base type.

Overrides:

setBaseType in class XMLType

Parameters:

baseType - the base type which this datatype inherits from

setDerivationMethod

public void setDerivationMethod(String derivationMethod)

Overrides XMLType#setDerivationMethod, anyType cannot be derived from any other type.

Overrides:

setDerivationMethod in class XMLType

Parameters:

derivationMethod - the derivation method.

setId

public void setId(String id)

Sets the Id for this XMLType. The Id must be globally unique within the Schema. Use a null value to remove the Id.

Overrides:

setId in class XMLType

Parameters:

id - the unique Id for this XMLType

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.

setParent

protected void setParent(Structure parent)

Sets the parent for this XMLType

Specified by:

setParent in class XMLType

Parameters:

parent - the parent Structure for this XMLType