org.exolab.castor.xml.schema

Class XMLType

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.Annotated

org.exolab.castor.xml.schema.XMLType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AnyType, ComplexType, SimpleType, TypeReference

public abstract class XMLType
extends Annotated

The base type for XML Schema types, such as complex types and simple types.

Version:

$Revision: 8602 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $

Author:

Keith Visco

See Also:

Serialized Form

Field Summary

Fields

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

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

Constructors

Constructor and Description
XMLType() Default constructor

Method Summary

Methods

Modifier and Type	Method and 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
boolean	isAnyType() Returns true if this XMLType is an AnyType
boolean	isComplexType() Returns true if this XMLType is a ComplexType
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
protected abstract void	setParent(Structure parent) Sets the parent for this XMLType
void	setSchema(Schema schema) Sets the name of this SimpleType

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

Methods inherited from class java.lang.Object

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

Field Detail

NULL_ARGUMENT

protected static String NULL_ARGUMENT

Error message for a null argument

Constructor Detail

XMLType

public XMLType()

Default constructor

Method Detail

getId

public String getId()

Returns the Id for this ComplexType, or null if no Id has been set.

Returns:

the Id for this ComplexType, or null if no Id has been set.

getName

public String getName()

Returns the name of this type (null if none was defined)

Returns:

the name of this type (null if none was defined)

setName

public void setName(String name)

Sets the name of this type

Parameters:

name - of the type

isAnyType

public final boolean isAnyType()

Returns true if this XMLType is an AnyType

Returns:

true if this XMLType is an AnyType

isComplexType

public final boolean isComplexType()

Returns true if this XMLType is a ComplexType

Returns:

true if this XMLType is a ComplexType

isSimpleType

public final boolean isSimpleType()

Returns true if this XMLType is a SimpleType

Returns:

true if this XMLType is a SimpleType

getSchema

public Schema getSchema()

Returns the schema to which this type belongs

Returns:

the Schema to which this type belongs

setSchema

public void setSchema(Schema schema)

Sets the name of this SimpleType

Parameters:

schema - the Schema to which this Simpletype belongs

getBaseType

public XMLType getBaseType()

Returns the base type that this type inherits from. If this type is a Simpletype that is a built in primitive type then null is returned.

Returns:

the parent type.

setBaseType

public void setBaseType(XMLType baseType)

Sets the base type for this datatype

Parameters:

baseType - the base type which this datatype inherits from

getDerivationMethod

public String getDerivationMethod()

Gets the name of the derivation method used to derive this type from its parent. null for primitive types.

setDerivationMethod

public void setDerivationMethod(String derivationMethod)

Sets the derivation method name

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.

Parameters:

id - the unique Id for this XMLType

setParent

protected abstract void setParent(Structure parent)

Sets the parent for this XMLType

Parameters:

parent - the parent Structure for this XMLType

getBaseTypeName

public String getBaseTypeName()

If this type has a base type, this returns its name.
Returns null otherwise.

Returns:

Base type's name if available, null otherwise.