Package 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:
java.io.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 Description protected static java.lang.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 Description XMLType()
Default constructor
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description XMLType
getBaseType()
Returns the base type that this type inherits from.java.lang.String
getBaseTypeName()
If this type has a base type, this returns its name.
Returns null otherwise.java.lang.String
getDerivationMethod()
Gets the name of the derivation method used to derive this type from its parent.java.lang.String
getId()
Returns the Id for this ComplexType, or null if no Id has been set.java.lang.String
getName()
Returns the name of this type (null if none was defined)Schema
getSchema()
Returns the schema to which this type belongs(package private) XMLType
getType()
Returns the type this type "really" represents ("this" in most cases), provides the indirection needed by references and forward declarations.boolean
isAnyType()
Returns true if this XMLType is an AnyTypeboolean
isComplexType()
Returns true if this XMLType is a ComplexTypeboolean
isSimpleType()
Returns true if this XMLType is a SimpleTypevoid
setBaseType(XMLType baseType)
Sets the base type for this datatypevoid
setDerivationMethod(java.lang.String derivationMethod)
Sets the derivation method namevoid
setId(java.lang.String id)
Sets the Id for this XMLType.void
setName(java.lang.String name)
Sets the name of this typeprotected abstract void
setParent(Structure parent)
Sets the parent for this XMLTypevoid
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
-
-
-
-
Method Detail
-
getId
public java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.String derivationMethod)
Sets the derivation method name
-
setId
public void setId(java.lang.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
-
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
-
getBaseTypeName
public java.lang.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.
-
-