org.exolab.jmscts.requirements
Class Document

java.lang.Object
  |
  +--org.exolab.jmscts.requirements.Document

All Implemented Interfaces:

java.io.Serializable

public class Document

extends java.lang.Object

implements java.io.Serializable

The document element is the root element of all requirements documents.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Document()

Method Summary

void	addInclude(Include vInclude) Method addInclude
void	addInclude(int index, Include vInclude) Method addInclude
void	addReference(int index, Reference vReference) Method addReference
void	addReference(Reference vReference) Method addReference
void	addRequirement(int index, Requirement vRequirement) Method addRequirement
void	addRequirement(Requirement vRequirement) Method addRequirement
void	clearInclude() Method clearInclude
void	clearReference() Method clearReference
void	clearRequirement() Method clearRequirement
java.util.Enumeration	enumerateInclude() Method enumerateInclude
java.util.Enumeration	enumerateReference() Method enumerateReference
java.util.Enumeration	enumerateRequirement() Method enumerateRequirement
boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
Description	getDescription() Returns the value of field 'description'.
Include[]	getInclude() Method getInclude
Include	getInclude(int index) Method getInclude
int	getIncludeCount() Method getIncludeCount
Reference[]	getReference() Method getReference
Reference	getReference(int index) Method getReference
int	getReferenceCount() Method getReferenceCount
Requirement[]	getRequirement() Method getRequirement
Requirement	getRequirement(int index) Method getRequirement
int	getRequirementCount() Method getRequirementCount
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
boolean	removeInclude(Include vInclude) Method removeInclude
boolean	removeReference(Reference vReference) Method removeReference
boolean	removeRequirement(Requirement vRequirement) Method removeRequirement
void	setDescription(Description description) Sets the value of field 'description'.
void	setInclude(Include[] includeArray) Method setInclude
void	setInclude(int index, Include vInclude) Method setInclude
void	setReference(int index, Reference vReference) Method setReference
void	setReference(Reference[] referenceArray) Method setReference
void	setRequirement(int index, Requirement vRequirement) Method setRequirement
void	setRequirement(Requirement[] requirementArray) Method setRequirement
static Document	unmarshal(java.io.Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document()

Method Detail

addInclude

public void addInclude(Include vInclude)
                throws java.lang.IndexOutOfBoundsException

Method addInclude

Parameters:

vInclude -

addInclude

public void addInclude(int index,
                       Include vInclude)
                throws java.lang.IndexOutOfBoundsException

Method addInclude

Parameters:

index -

vInclude -

addReference

public void addReference(Reference vReference)
                  throws java.lang.IndexOutOfBoundsException

Method addReference

Parameters:

vReference -

addReference

public void addReference(int index,
                         Reference vReference)
                  throws java.lang.IndexOutOfBoundsException

Method addReference

Parameters:

index -

vReference -

addRequirement

public void addRequirement(Requirement vRequirement)
                    throws java.lang.IndexOutOfBoundsException

Method addRequirement

Parameters:

vRequirement -

addRequirement

public void addRequirement(int index,
                           Requirement vRequirement)
                    throws java.lang.IndexOutOfBoundsException

Method addRequirement

Parameters:

index -

vRequirement -

clearInclude

public void clearInclude()

Method clearInclude

clearReference

public void clearReference()

Method clearReference

clearRequirement

public void clearRequirement()

Method clearRequirement

enumerateInclude

public java.util.Enumeration enumerateInclude()

Method enumerateInclude

enumerateReference

public java.util.Enumeration enumerateReference()

Method enumerateReference

enumerateRequirement

public java.util.Enumeration enumerateRequirement()

Method enumerateRequirement

equals

public boolean equals(java.lang.Object obj)

Note: hashCode() has not been overriden

Overrides:

equals in class java.lang.Object

Parameters:

obj -

getDescription

public Description getDescription()

Returns the value of field 'description'.

Returns:

the value of field 'description'.

getInclude

public Include getInclude(int index)
                   throws java.lang.IndexOutOfBoundsException

Method getInclude

Parameters:

index -

getInclude

public Include[] getInclude()

Method getInclude

getIncludeCount

public int getIncludeCount()

Method getIncludeCount

getReference

public Reference getReference(int index)
                       throws java.lang.IndexOutOfBoundsException

Method getReference

Parameters:

index -

getReference

public Reference[] getReference()

Method getReference

getReferenceCount

public int getReferenceCount()

Method getReferenceCount

getRequirement

public Requirement getRequirement(int index)
                           throws java.lang.IndexOutOfBoundsException

Method getRequirement

Parameters:

index -

getRequirement

public Requirement[] getRequirement()

Method getRequirement

getRequirementCount

public int getRequirementCount()

Method getRequirementCount

isValid

public boolean isValid()

Method isValid

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

removeInclude

public boolean removeInclude(Include vInclude)

Method removeInclude

Parameters:

vInclude -

removeReference

public boolean removeReference(Reference vReference)

Method removeReference

Parameters:

vReference -

removeRequirement

public boolean removeRequirement(Requirement vRequirement)

Method removeRequirement

Parameters:

vRequirement -

setDescription

public void setDescription(Description description)

Sets the value of field 'description'.

Parameters:

description - the value of field 'description'.

setInclude

public void setInclude(int index,
                       Include vInclude)
                throws java.lang.IndexOutOfBoundsException

Method setInclude

Parameters:

index -

vInclude -

setInclude

public void setInclude(Include[] includeArray)

Method setInclude

Parameters:

includeArray -

setReference

public void setReference(int index,
                         Reference vReference)
                  throws java.lang.IndexOutOfBoundsException

Method setReference

Parameters:

index -

vReference -

setReference

public void setReference(Reference[] referenceArray)

Method setReference

Parameters:

referenceArray -

setRequirement

public void setRequirement(int index,
                           Requirement vRequirement)
                    throws java.lang.IndexOutOfBoundsException

Method setRequirement

Parameters:

index -

vRequirement -

setRequirement

public void setRequirement(Requirement[] requirementArray)

Method setRequirement

Parameters:

requirementArray -

unmarshal

public static Document unmarshal(java.io.Reader reader)
                          throws org.exolab.castor.xml.MarshalException,
                                 org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate