Class Documentation

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.AnnotationItem

org.exolab.castor.xml.schema.Documentation

All Implemented Interfaces:

Serializable

public class Documentation
extends AnnotationItem

A class which represents the XML Schema Documentation element

Version:

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

Author:

Keith Visco

See Also:

• AnnotationItem
• Serialized Form

Field Summary

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
Documentation()	Creates a new Documentation

Method Summary

Modifier and Type	Method	Description
short	getStructureType()	Returns the type of this Schema Structure

Methods inherited from class AnnotationItem

add, getContent, getObjects, getSource, remove, setSource, validate

Modifier and Type	Method	Description
void	add(Object object)	Adds the given Object to this Annotation item.
String	getContent()	Returns the String content of this Annotation item.
Enumeration	getObjects()	Returns an Enumeration of all objects contained by this Annotation item.
String	getSource()	Returns the source property of this Annotaion item.
void	remove(Object object)	Removes the given Object from this Annotation item.
void	setSource(String source)	Sets the source property for this Annotaion item.
void	validate()	Checks the validity of this Schema defintion.

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

Documentation

public Documentation()

Creates a new Documentation

Method Details

getStructureType

public short getStructureType()

Returns the type of this Schema Structure

Specified by:

getStructureType in class AnnotationItem

Returns:

the type of this Schema Structure