Class ListType

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

org.exolab.castor.xml.schema.simpletypes.ListType

All Implemented Interfaces:

Serializable, Referable

public class ListType
extends SimpleType

Represents a SimpleType that is a "list" of a given SimpleType.

Version:

$Revision: 7398 $ $Id: ListType.java 7398 2008-01-29 20:56:45Z wguttmn $

Author:

Arnaud Berry, Keith Visco

See Also:

• Serialized Form

Field Summary

Fields inherited from class SimpleType

FINAL_ALL, FINAL_LIST, FINAL_RESTRICTION, FINAL_UNION

Modifier and Type	Field	Description
static final String	FINAL_ALL	The value of the final attribute used for blocking all types of derivation.
static final String	FINAL_LIST	The value of the final attribute used for blocking list derivation.
static final String	FINAL_RESTRICTION	The value of the final attribute used for blocking restriction derivation.
static final String	FINAL_UNION	The value of the final attribute used for blocking union derivation.

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
ListType(Schema schema)	Creates a new ListType.

Method Summary

Modifier and Type	Method	Description
SimpleType	getItemType()	Returns the simpleType for the items of this ListType.
Annotation	getLocalAnnotation()	Returns the annotation which appears local to this Union, or null if no local annotation has been set.
short	getStructureType()	Returns the type of this Schema Structure
void	setItemType(String typeName)	Sets the SimpleType for this ListType (the type of item that instances of this list holds).
void	setItemType(SimpleType type)	Sets the SimpleType for this ListType (the type of item that instances of this list holds).
void	setLocalAnnotation(Annotation annotation)	Sets an annotation which is local to this Union.
void	setSchema(Schema schema)	Sets the Schema for this Union.

Methods inherited from class SimpleType

addFacet, copyFacets, createReference, getBuiltInBaseType, getEffectiveFacets, getFacet, getFacets, getFacets, getFinal, getLength, getLocalFacets, getMaxLength, getMinLength, getNumberOfFacets, getParent, getReferenceId, getTypeCode, hasFacet, isBuiltInType, isDateTimeType, isNumericType, isRedefined, removeFacet, removeFacet, resolveReference, setFinal, setParent, setRedefined, validate

Modifier and Type	Method	Description
void	addFacet(Facet facet)	Adds the given Facet to this Simpletype.
protected void	copyFacets(SimpleType target)	Copy this type's facets to the target type.
protected SimpleType	createReference(String name)	A helper method for classes which extend SimpleType.
SimpleType	getBuiltInBaseType()	Returns the built in type this type is derived from.
Enumeration<Facet>	getEffectiveFacets()	Returns an enumeration of the effective facets for this type.
Facet	getFacet(String name)	Returns the first facet associated with the given name.
Enumeration<Facet>	getFacets()	Returns an Enumeration of all the Facets (including inherited) facets for this type.
Enumeration<Facet>	getFacets(String name)	Returns the facets associated with the given name.
String	getFinal()	Returns the value of the 'final' property, indicating which types of derivation are not allowed, or null if the final property has not been set.
Long	getLength()	Returns the value of the length facet result can be null
Enumeration<Facet>	getLocalFacets()	Returns the facets of this type (without the parent's facets).
Long	getMaxLength()	Returns the value of the maxlength facet result can be null
Long	getMinLength()	Returns the value of the minlength facet result can be null
int	getNumberOfFacets(String name)	Returns the number of facets named 'name' within the list of facets of this simple type.
Structure	getParent()	Returns the parent Structure that contains this SimpleType.
String	getReferenceId()	Returns the Id used to Refer to this Object.
int	getTypeCode()	Gets the code for this simple type.
boolean	hasFacet(String name)	Returns true if this SimpleType has a specified Facet with the given name.
boolean	isBuiltInType()	Returns true if this SimpleType is a built in type.
boolean	isDateTimeType()	Indicates whether this SimpleType is a date/time type.
boolean	isNumericType()	Indicates whether this SimpleType is a numeric type.
boolean	isRedefined()	Returns true if this simpleType is a redefinition.
boolean	removeFacet(String name)	Removes the facet with the given name from this SimpleType.
boolean	removeFacet(Facet facet)	Removes the given Facet from this SimpleType.
protected static SimpleType	resolveReference(SimpleType simpleType)	A helper method for classes which extend SimpleType.
void	setFinal(String finalValue)	Sets the value of the 'final' property, indicating which types of derivation are not allowed.
protected void	setParent(Structure parent)	Sets the parent for this SimpleType
void	setRedefined()	Sets this Group has redefined.
void	validate()	Checks the validity of this SimpleType definition.

Methods inherited from class XMLType

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

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

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

ListType

public ListType(Schema schema)
         throws SchemaException

Creates a new ListType.

Parameters:

schema - the Schema for this ListType (Cannot be null)

Throws:

SchemaException

Method Details

getItemType

public SimpleType getItemType()

Returns the simpleType for the items of this ListType.

Returns:

the simpleType for the items of this ListType.

getLocalAnnotation

public Annotation getLocalAnnotation()

Returns the annotation which appears local to this Union, or null if no local annotation has been set.

Returns:

the annotation which is local to this Union.

getStructureType

public short getStructureType()

Returns the type of this Schema Structure

Overrides:

getStructureType in class SimpleType

Returns:

the type of this Schema Structure

setItemType

public void setItemType(SimpleType type)

Sets the SimpleType for this ListType (the type of item that instances of this list holds).

Parameters:

type - the SimpleType for this ListType.

setItemType

public void setItemType(String typeName)

Sets the SimpleType for this ListType (the type of item that instances of this list holds).

Parameters:

typeName - the name of the SimpleType for this ListType.

setLocalAnnotation

public void setLocalAnnotation(Annotation annotation)

Sets an annotation which is local to this Union.

Parameters:

annotation - the local annotation to set for this Union.

setSchema

public void setSchema(Schema schema)

Sets the Schema for this Union. This method overloads the SimpleType#setSchema method to prevent the Schema from being changed.

Overrides:

setSchema in class XMLType

Parameters:

schema - the schema that this Union belongs to.