org.exolab.castor.xml.schema

Class XMLType

public abstract class XMLType extends Annotated

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

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

Author: Keith Visco

Field Summary
protected static StringNULL_ARGUMENT
Error message for a null argument
Constructor Summary
XMLType()
Default constructor
Method Summary
XMLTypegetBaseType()
Returns the base type that this type inherits from.
StringgetDerivationMethod()
Gets the name of the derivation method used to derive this type from its parent. null for primitive types.
StringgetId()
Returns the Id for this ComplexType, or null if no Id has been set.
StringgetName()
Returns the name of this type (null if none was defined)
SchemagetSchema()
Returns the schema to which this type belongs
XMLTypegetType()
Returns the type this type "really" represents ("this" in most cases), provides the indirection needed by references and forward declarations.
booleanisAnyType()
Returns true if this XMLType is an AnyType
booleanisComplexType()
Returns true if this XMLType is a ComplexType
booleanisSimpleType()
Returns true if this XMLType is a SimpleType
voidsetBaseType(XMLType baseType)
Sets the base type for this datatype
voidsetDerivationMethod(String derivationMethod)
Sets the derivation method name
voidsetId(String id)
Sets the Id for this XMLType.
voidsetName(String name)
Sets the name of this type
protected abstract voidsetParent(Structure parent)
Sets the parent for this XMLType
voidsetSchema(Schema schema)
Sets the name of this SimpleType

Field Detail

NULL_ARGUMENT

protected static String NULL_ARGUMENT
Error message for a null argument

Constructor Detail

XMLType

public XMLType()
Default constructor

Method Detail

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.

getDerivationMethod

public String getDerivationMethod()
Gets the name of the derivation method used to derive this type from its parent. null for primitive types.

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)

getSchema

public Schema getSchema()
Returns the schema to which this type belongs

Returns: the Schema to which this type belongs

getType

XMLType getType()
Returns the type this type "really" represents ("this" in most cases), provides the indirection needed by references and forward declarations.

Returns: the type this type "really" represents

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

setBaseType

public void setBaseType(XMLType baseType)
Sets the base type for this datatype

Parameters: baseType the base type which this datatype inherits from

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

setName

public void setName(String name)
Sets the name of this type

Parameters: name of the type

setParent

protected abstract void setParent(Structure parent)
Sets the parent for this XMLType

Parameters: parent the parent Structure for this XMLType

setSchema

public void setSchema(Schema schema)
Sets the name of this SimpleType

Parameters: schema the Schema to which this Simpletype belongs

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