org.apache.batik.dom
Class AbstractDocument

java.lang.Object
  org.apache.batik.dom.AbstractNode
      org.apache.batik.dom.AbstractParentNode
          org.apache.batik.dom.AbstractDocument

All Implemented Interfaces:

Document, DocumentEvent, DocumentTraversal, EventTarget, ExtendedNode, Localizable, Node, NodeEventTarget, Serializable

Direct Known Subclasses:

AbstractStylableDocument, GenericDocument

public abstract class AbstractDocument

extends AbstractParentNode

implements Document, DocumentEvent, DocumentTraversal, Localizable

This class implements the Document interface.

See Also:

Serialized Form

Nested Class Summary

protected class

AbstractDocument.IdSoftRef

Nested classes inherited from class org.apache.batik.dom.AbstractParentNode

AbstractParentNode.ChildNodes, AbstractParentNode.ElementsByTagName, AbstractParentNode.ElementsByTagNameNS

Field Summary

protected DocumentEventSupport	documentEventSupport The DocumentEventSupport.
protected Map	elementsById The elementsById lists.
protected WeakHashMap	elementsByTagNames The ElementsByTagName lists.
protected WeakHashMap	elementsByTagNamesNS The ElementsByTagNameNS lists.
protected boolean	eventsEnabled Whether the event dispatching must be done.
protected DOMImplementation	implementation The DOM implementation.
protected LocalizableSupport	localizableSupport The localizable support for the error messages.
protected static String	RESOURCES The error messages bundle class name.
protected TraversalSupport	traversalSupport The traversal support.

Fields inherited from class org.apache.batik.dom.AbstractParentNode

childNodes

Fields inherited from class org.apache.batik.dom.AbstractNode

EMPTY_NODE_LIST, eventSupport, ownerDocument

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

protected	AbstractDocument() Creates a new document.
	AbstractDocument(DocumentType dt, DOMImplementation impl) Creates a new document.

Method Summary

void	addIdEntry(Element e, String id)
protected void	checkChildType(Node n, boolean replace) Checks the validity of a node to be inserted.
Node	cloneNode(boolean deep) DOM: Implements Node.cloneNode(boolean).
protected Node	copyInto(Node n) Copy the fields of the current node into the given node.
Event	createEvent(String eventType) DOM: Implements DocumentEvent.createEvent(String).
NodeIterator	createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) DOM: Implements DocumentTraversal.createNodeIterator(Node,int,NodeFilter,boolean).
TreeWalker	createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) DOM: Implements DocumentTraversal.createTreeWalker(Node,int,NodeFilter,boolean).
protected Node	deepCopyInto(Node n) Deeply copy the fields of the current node into the given node.
protected Node	deepExport(Node n, Document d) Deeply exports this node to the given document.
void	detachNodeIterator(NodeIterator it) Detaches the given node iterator from this document.
protected Node	export(Node n, Document d) Exports this node to the given document.
String	formatMessage(String key, Object[] args) Implements Localizable.formatMessage(String,Object[]).
Element	getChildElementById(Node requestor, String id) Finds an element that is in the same document fragment as 'requestor' that has 'id'.
protected AbstractDocument	getCurrentDocument() Returns the current document.
DocumentType	getDoctype() DOM: Implements Document.getDoctype().
Element	getDocumentElement() DOM: Implements Document.getDocumentElement().
Element	getElementById(String id) DOM: Implements Document.getElementById(String).
AbstractParentNode.ElementsByTagName	getElementsByTagName(Node n, String ln) Returns an ElementsByTagName object from the cache, if any.
AbstractParentNode.ElementsByTagNameNS	getElementsByTagNameNS(Node n, String ns, String ln) Returns an ElementsByTagNameNS object from the cache, if any.
boolean	getEventsEnabled() Tests whether the event dispatching must be done.
DOMImplementation	getImplementation() DOM: Implements Document.getImplementation().
Locale	getLocale() Implements Localizable.getLocale().
String	getNodeName() DOM: Implements Node.getNodeName().
short	getNodeType() DOM: Implements Node.getNodeType().
protected Node	getRoot(Node n)
Node	importNode(Node importedNode, boolean deep) DOM: Implements Document.importNode(Node,boolean).
Node	importNode(Node importedNode, boolean deep, boolean trimId) Imports the given node 'importNode' to this document.
abstract boolean	isId(Attr node)
void	nodeToBeRemoved(Node node) Notifies this document that a node will be removed.
void	putElementsByTagName(Node n, String ln, AbstractParentNode.ElementsByTagName l) Puts an ElementsByTagName object in the cache.
void	putElementsByTagNameNS(Node n, String ns, String ln, AbstractParentNode.ElementsByTagNameNS l) Puts an ElementsByTagNameNS object in the cache.
void	removeIdEntry(Element e, String id) Remove the mapping for element to id
void	setDoctype(DocumentType dt) Sets the document type node.
void	setEventsEnabled(boolean b) Sets the eventsEnabled property.
void	setLocale(Locale l) Implements Localizable.setLocale(Locale).
void	updateIdEntry(Element e, String oldId, String newId)

Methods inherited from class org.apache.batik.dom.AbstractParentNode

appendChild, checkAndRemove, deepExport, fireDOMNodeInsertedEvent, fireDOMNodeInsertedIntoDocumentEvent, fireDOMNodeRemovedEvent, fireDOMNodeRemovedFromDocumentEvent, fireDOMSubtreeModifiedEvent, getChildNodes, getElementsByTagName, getElementsByTagNameNS, getFirstChild, getLastChild, hasChildNodes, insertBefore, nodeAdded, normalize, removeChild, replaceChild

Methods inherited from class org.apache.batik.dom.AbstractNode

addEventListener, createDOMException, dispatchEvent, export, fireDOMCharacterDataModifiedEvent, getAttributes, getEventSupport, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getParentNodeEventTarget, getPrefix, getPreviousSibling, hasAttributes, isSupported, newNode, removeEventListener, setNextSibling, setNodeName, setNodeValue, setOwnerDocument, setParentNode, setPrefix, setPreviousSibling, setSpecified

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Document

createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getElementsByTagName, getElementsByTagNameNS

Methods inherited from interface org.w3c.dom.Node

appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Methods inherited from interface org.apache.batik.dom.ExtendedNode

isReadonly, setReadonly

Field Detail

RESOURCES

protected static final String RESOURCES

The error messages bundle class name.

See Also:

Constant Field Values

localizableSupport

protected transient LocalizableSupport localizableSupport

The localizable support for the error messages.

implementation

protected transient DOMImplementation implementation

The DOM implementation.

traversalSupport

protected transient TraversalSupport traversalSupport

The traversal support.

documentEventSupport

protected transient DocumentEventSupport documentEventSupport

The DocumentEventSupport.

eventsEnabled

protected transient boolean eventsEnabled

Whether the event dispatching must be done.

elementsByTagNames

protected transient WeakHashMap elementsByTagNames

The ElementsByTagName lists.

elementsByTagNamesNS

protected transient WeakHashMap elementsByTagNamesNS

The ElementsByTagNameNS lists.

elementsById

protected transient Map elementsById

The elementsById lists. This is keyed on 'id'. the entry is either a IdSoftReference to the element or a List of IdSoftReferences (if there is more than one element owned by this document with a particular 'id').

Constructor Detail

AbstractDocument

protected AbstractDocument()

Creates a new document.

AbstractDocument

public AbstractDocument(DocumentType dt,
                        DOMImplementation impl)

Creates a new document.

Method Detail

setLocale

public void setLocale(Locale l)

Implements Localizable.setLocale(Locale).

Specified by:

setLocale in interface Localizable

Parameters:

l - The locale to set.

getLocale

public Locale getLocale()

Implements Localizable.getLocale().

Specified by:

getLocale in interface Localizable

formatMessage

public String formatMessage(String key,
                            Object[] args)
                     throws MissingResourceException

Implements Localizable.formatMessage(String,Object[]).

Specified by:

formatMessage in interface Localizable

Parameters:

key - The key used to retreive the message from the resource bundle.

args - The objects that compose the message.

Throws:

MissingResourceException - if the key is not in the bundle.

getEventsEnabled

public boolean getEventsEnabled()

Tests whether the event dispatching must be done.

setEventsEnabled

public void setEventsEnabled(boolean b)

Sets the eventsEnabled property.

getNodeName

public String getNodeName()

DOM: Implements Node.getNodeName().

Specified by:

getNodeName in interface Node

Returns:

"#document".

getNodeType

public short getNodeType()

DOM: Implements Node.getNodeType().

Specified by:

getNodeType in interface Node

Returns:

Node.DOCUMENT_NODE

getDoctype

public DocumentType getDoctype()

DOM: Implements Document.getDoctype().

Specified by:

getDoctype in interface Document

setDoctype

public void setDoctype(DocumentType dt)

Sets the document type node.

getImplementation

public DOMImplementation getImplementation()

DOM: Implements Document.getImplementation().

Specified by:

getImplementation in interface Document

Returns:

implementation

getDocumentElement

public Element getDocumentElement()

DOM: Implements Document.getDocumentElement().

Specified by:

getDocumentElement in interface Document

importNode

public Node importNode(Node importedNode,
                       boolean deep)
                throws DOMException

DOM: Implements Document.importNode(Node,boolean).

Specified by:

importNode in interface Document

Throws:

DOMException

importNode

public Node importNode(Node importedNode,
                       boolean deep,
                       boolean trimId)

Imports the given node 'importNode' to this document. It does so deeply if 'deep' is set to true. It will not mark id attributes as id's if 'trimId' is set false. this is used primarily for the clone trees of the 'use' element so they don't clutter the hashtable.

cloneNode

public Node cloneNode(boolean deep)

DOM: Implements Node.cloneNode(boolean).

Specified by:

cloneNode in interface Node

Overrides:

cloneNode in class AbstractNode

isId

public abstract boolean isId(Attr node)

getElementById

public Element getElementById(String id)

DOM: Implements Document.getElementById(String).

Specified by:

getElementById in interface Document

getChildElementById

public Element getChildElementById(Node requestor,
                                   String id)

Finds an element that is in the same document fragment as 'requestor' that has 'id'.

getRoot

protected Node getRoot(Node n)

removeIdEntry

public void removeIdEntry(Element e,
                          String id)

Remove the mapping for element to id

addIdEntry

public void addIdEntry(Element e,
                       String id)

updateIdEntry

public void updateIdEntry(Element e,
                          String oldId,
                          String newId)

getElementsByTagName

public AbstractParentNode.ElementsByTagName getElementsByTagName(Node n,
                                                                 String ln)

Returns an ElementsByTagName object from the cache, if any.

putElementsByTagName

public void putElementsByTagName(Node n,
                                 String ln,
                                 AbstractParentNode.ElementsByTagName l)

Puts an ElementsByTagName object in the cache.

getElementsByTagNameNS

public AbstractParentNode.ElementsByTagNameNS getElementsByTagNameNS(Node n,
                                                                     String ns,
                                                                     String ln)

Returns an ElementsByTagNameNS object from the cache, if any.

putElementsByTagNameNS

public void putElementsByTagNameNS(Node n,
                                   String ns,
                                   String ln,
                                   AbstractParentNode.ElementsByTagNameNS l)

Puts an ElementsByTagNameNS object in the cache.

createEvent

public Event createEvent(String eventType)
                                     throws DOMException

DOM: Implements DocumentEvent.createEvent(String).

Specified by:

createEvent in interface DocumentEvent

Throws:

DOMException

createNodeIterator

public NodeIterator createNodeIterator(Node root,
                                       int whatToShow,
                                       NodeFilter filter,
                                       boolean entityReferenceExpansion)
                                                      throws DOMException

DOM: Implements DocumentTraversal.createNodeIterator(Node,int,NodeFilter,boolean).

Specified by:

createNodeIterator in interface DocumentTraversal

Throws:

DOMException

createTreeWalker

public TreeWalker createTreeWalker(Node root,
                                   int whatToShow,
                                   NodeFilter filter,
                                   boolean entityReferenceExpansion)
                                                  throws DOMException

DOM: Implements DocumentTraversal.createTreeWalker(Node,int,NodeFilter,boolean).

Specified by:

createTreeWalker in interface DocumentTraversal

Throws:

DOMException

detachNodeIterator

public void detachNodeIterator(NodeIterator it)

Detaches the given node iterator from this document.

nodeToBeRemoved

public void nodeToBeRemoved(Node node)

Notifies this document that a node will be removed.

Overrides:

nodeToBeRemoved in class AbstractParentNode

getCurrentDocument

protected AbstractDocument getCurrentDocument()

Returns the current document.

Overrides:

getCurrentDocument in class AbstractNode

export

protected Node export(Node n,
                      Document d)

Exports this node to the given document.

Parameters:

n - The clone node.

d - The destination document.

deepExport

protected Node deepExport(Node n,
                          Document d)

Deeply exports this node to the given document.

Parameters:

n - The clone node.

d - The destination document.

copyInto

protected Node copyInto(Node n)

Copy the fields of the current node into the given node.

Overrides:

copyInto in class AbstractNode

Parameters:

n - a node of the type of this.

deepCopyInto

protected Node deepCopyInto(Node n)

Deeply copy the fields of the current node into the given node.

Overrides:

deepCopyInto in class AbstractParentNode

Parameters:

n - a node of the type of this.

checkChildType

protected void checkChildType(Node n,
                              boolean replace)

Checks the validity of a node to be inserted.

Overrides:

checkChildType in class AbstractNode