org.exolab.castor.xml.schema
Class Documentation

java.lang.Object
  extended byorg.exolab.castor.xml.schema.Structure
      extended byorg.exolab.castor.xml.schema.Documentation
All Implemented Interfaces:
java.io.Serializable

public class Documentation
extends Structure

A class which represents the XML Schema Documentation element

Version:
$Revision: 1.3 $ $Date: 2000/12/13 03:39:48 $
Author:
Keith Visco
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.exolab.castor.xml.schema.Structure
ANNOTATION, 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
Documentation()
          Creates a new Documentation
 
Method Summary
 void add(java.lang.Object object)
          Adds the given Object to this Documentation
 java.lang.String getBase()
          Returns the base property of this Documentation
 java.lang.String getContent()
          Returns the String content of this Documentation
 java.util.Enumeration getObjects()
          Returns an Enumeration of all objects contained by this Documentation.
 short getStructureType()
          Returns the type of this Schema Structure
 void remove(java.lang.Object object)
          Removes the given Object from this Documentation
 void setBase(java.lang.String base)
          Sets the base property for this Documentation
 void setContent(java.lang.String content)
          Sets the String content for this Documentation
 void validate()
          Checks the validity of this Schema defintion.
 
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

Documentation

public Documentation()
Creates a new Documentation

Method Detail

add

public void add(java.lang.Object object)
Adds the given Object to this Documentation

Parameters:
object - the Object to add

getContent

public java.lang.String getContent()
Returns the String content of this Documentation

Returns:
the String content of this Documentation

getObjects

public java.util.Enumeration getObjects()
Returns an Enumeration of all objects contained by this Documentation.

Returns:
an Enumeration of all objects contained by this Documentation.

getBase

public java.lang.String getBase()
Returns the base property of this Documentation

Returns:
the base property of this Documentation

remove

public void remove(java.lang.Object object)
Removes the given Object from this Documentation

Parameters:
object - the Object to remove

setContent

public void setContent(java.lang.String content)
Sets the String content for this Documentation

Parameters:
content - the String content for this Documentation

setBase

public void setBase(java.lang.String base)
Sets the base property for this Documentation

Parameters:
base - the value of the base property

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

Specified by:
validate in class Structure
Throws:
ValidationException - when this Schema definition is invalid.


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