uPortal 2.4.1
API Documentation

org.jasig.portal.utils
Interface IPortalDocument

All Superinterfaces:
org.w3c.dom.Document, org.w3c.dom.Node
All Known Implementing Classes:
PortalDocumentImpl

public interface IPortalDocument
extends org.w3c.dom.Document

An interface that allows a Document to cache elements by known keys. This is used to locally store and manager the ID element mappings regardless of the actual DOM implementation.

Version:
$Revision: 1.2 $
Author:
Nick Bolton

Field Summary
 
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
 
Method Summary
 void copyCache(IPortalDocument sourceDoc)
          Copies the element cache from the source document.
 void putIdentifier(java.lang.String idName, org.w3c.dom.Element element)
          Registers an identifier name with a specified element node.
 
Methods inherited from interface org.w3c.dom.Document
createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, importNode
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

Method Detail

putIdentifier

public void putIdentifier(java.lang.String idName,
                          org.w3c.dom.Element element)
Registers an identifier name with a specified element node.

Parameters:
idName - a key used to store an Element object.
element - an Element object to map. document.

copyCache

public void copyCache(IPortalDocument sourceDoc)
Copies the element cache from the source document. This will provide equivalent mappings from IDs to elements in this document provided the elements exist in the source document.

Parameters:
sourceDoc - The source doc to copy from.

uPortal 2.4.1
API Documentation