org.exolab.castor.xml.schema

Class Annotation

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.Annotation

All Implemented Interfaces:

Serializable

public class Annotation
extends Structure

A class representing the XML Schema Annotation.

Version:

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

Author:

Keith Visco

See Also:

Serialized Form

Field Summary

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
Annotation()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAppInfo(AppInfo appInfo) Adds the given AppInfo to this annotation.
void	addDocumentation(Documentation documentation) Adds the given Documentation to this Annotation.
Enumeration<AppInfo>	getAppInfo() Returns an enumeration of all AppInfo elements for this Annotation.
Enumeration<Documentation>	getDocumentation() Returns an enumeration of all documentation elements for this Annotation.
short	getStructureType() Returns the type of this Schema Structure.
void	removeAppInfo(AppInfo appInfo) Removes the given AppInfo from this Annotation.
void	removeDocumentation(Documentation documentation) Removes the given Documentation from this Annotation.
void	validate() Checks the validity of this Schema definition.

Methods inherited from class org.exolab.castor.xml.schema.Structure

isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

Annotation

public Annotation()

Method Detail

addAppInfo

public void addAppInfo(AppInfo appInfo)

Adds the given AppInfo to this annotation.

Parameters:

appInfo - the AppInfo to add

addDocumentation

public void addDocumentation(Documentation documentation)

Adds the given Documentation to this Annotation.

Parameters:

documentation - the documentation to add to this Annotation

getAppInfo

public Enumeration<AppInfo> getAppInfo()

Returns an enumeration of all AppInfo elements for this Annotation.

Returns:

an enumeration of all AppInfo elements for this Annotation

getDocumentation

public Enumeration<Documentation> getDocumentation()

Returns an enumeration of all documentation elements for this Annotation.

Returns:

an enumeration of all documentation elements for this Annotation

removeAppInfo

public void removeAppInfo(AppInfo appInfo)

Removes the given AppInfo from this Annotation.

Parameters:

appInfo - the AppInfo to remove

removeDocumentation

public void removeDocumentation(Documentation documentation)

Removes the given Documentation from this Annotation.

Parameters:

documentation - the Documentation to remove

getStructureType

public short getStructureType()

Returns the type of this Schema Structure.

Specified by:

getStructureType in class Structure

Returns:

the type of this Schema Structure

validate

public void validate()
              throws ValidationException

Checks the validity of this Schema definition.

Specified by:

validate in class Structure

Throws:

ValidationException - when this Schema definition is invalid.