org.exolab.castor.xml.dtd

Class DTDdocument

java.lang.Object

org.exolab.castor.xml.dtd.DTDdocument

public class DTDdocument
extends Object

Implementation of DTD document specification.

Version:

$Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $

Author:

Alexander Totok

Constructor Summary

Constructors

Constructor and Description
DTDdocument()
DTDdocument(String name) Constructor, setting the name of the document.

Method Summary

Modifier and Type	Method and Description
void	addElement(Element element) Adds Element Declaration to the document.
void	addGeneralEntity(GeneralEntity generalEntity) Adds General Entity Declaration to the document.
void	addNotation(Notation notation) Adds a Notation Declaration to the document.
Element	getElement(String name) Returns requested Element Declaration.
Enumeration<Element>	getElements() Returns enumeration of the Element declarations in the DTD document.
Enumeration<GeneralEntity>	getGeneralEntities() Returns enumeration of the General Entity declarations in the DTD document.
GeneralEntity	getGeneralEntity(String name) Returns requested Genaral Entity Declaration.
String	getName() Returns the name of the document.
Notation	getNotation(String name) Returns requested Notation Declaration.
Enumeration<Notation>	getNotations() Returns enumeration of the Notation declarations in the DTD document.

Methods inherited from class java.lang.Object

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

Constructor Detail

DTDdocument

public DTDdocument()

DTDdocument

public DTDdocument(String name)

Constructor, setting the name of the document.

Method Detail

getName

public String getName()

Returns the name of the document.

addElement

public void addElement(Element element)
                throws DTDException

Adds Element Declaration to the document.

Throws:

DTDException - if an element has no name or there already exists element with the same name in the document.

getElement

public Element getElement(String name)

Returns requested Element Declaration.

Returns:

Element Declaration with the given name, null if there is no Element with this name in the document.

addNotation

public void addNotation(Notation notation)
                 throws DTDException

Adds a Notation Declaration to the document.

Throws:

DTDException - if a notation has no name or there already exists notation with the same name in the document.

getNotation

public Notation getNotation(String name)

Returns requested Notation Declaration.

Returns:

Notation Declaration with the given name, null if there is no Notation with this name in the document.

addGeneralEntity

public void addGeneralEntity(GeneralEntity generalEntity)

Adds General Entity Declaration to the document. If there already exists General Entity with the same name in the document, does nothing.

getGeneralEntity

public GeneralEntity getGeneralEntity(String name)

Returns requested Genaral Entity Declaration.

Returns:

General Entity Declaration with the given name, null if there is no General Entity with this name in the document.

getElements

public Enumeration<Element> getElements()

Returns enumeration of the Element declarations in the DTD document.

getGeneralEntities

public Enumeration<GeneralEntity> getGeneralEntities()

Returns enumeration of the General Entity declarations in the DTD document.

getNotations

public Enumeration<Notation> getNotations()

Returns enumeration of the Notation declarations in the DTD document.