org.ozoneDB.xml.dom4j
Interface OzoneBranch

All Superinterfaces:
Branch, java.lang.Cloneable, Node, org.ozoneDB.OzoneCompatibleOrProxy, org.ozoneDB.OzoneRemote
All Known Subinterfaces:
OzoneDocument, OzoneElement
All Known Implementing Classes:
OzoneDocumentImpl, OzoneElementImpl

public interface OzoneBranch
extends Branch, org.ozoneDB.OzoneRemote

$Id: OzoneBranch.java,v 1.1 2003/07/07 10:30:29 per_nyfelt Exp $


Field Summary
 
Fields inherited from interface org.dom4j.Node
ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE
 
Method Summary
 void addNode(int index, Node node)
           
 void addNode(Node node)
           
 void childAdded(Node node)
          Called when a new child node has been added to me to allow any parent relationships to be created or events to be fired.
 void childRemoved(Node node)
          Called when a child node has been removed to allow any parent relationships to be deleted or events to be fired.
 java.util.List contentList()
           
 void contentRemoved()
          Called when the given List content has been removed so each node should have its parent and document relationships cleared
 java.util.List createContentList()
          A Factory Method pattern which creates a List implementation used to store content
 java.util.List createContentList(int size)
          A Factory Method pattern which creates a List implementation used to store content
 java.util.List createEmptyList()
          A Factory Method pattern which creates an empty a BackedList implementation
 BackedList createResultList()
          A Factory Method pattern which creates a BackedList implementation used to store results of a filtered content query.
 java.util.List createSingleResultList(java.lang.Object result)
          A Factory Method pattern which creates a BackedList implementation which contains a single result
 java.lang.String elementID(Element element)
           
 java.lang.String getContentAsStringValue(java.lang.Object content)
           
 java.lang.String getContentAsText(java.lang.Object content)
           
 java.lang.String getTextTrim()
           
 void invalidNodeTypeAddException(Node node)
          Called when an invalid node has been added.
 boolean removeNode(Node node)
           
 
Methods inherited from interface org.dom4j.Branch
add, add, add, add, addElement, addElement, addElement, appendContent, clearContent, content, elementByID, indexOf, node, nodeCount, nodeIterator, normalize, processingInstruction, processingInstructions, processingInstructions, remove, remove, remove, remove, removeProcessingInstruction, setContent, setProcessingInstructions
 
Methods inherited from interface org.dom4j.Node
accept, asXML, asXPathResult, clone, createXPath, detach, getDocument, getName, getNodeType, getNodeTypeName, getParent, getPath, getPath, getStringValue, getText, getUniquePath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf, write
 
Methods inherited from interface org.ozoneDB.OzoneCompatibleOrProxy
getObjectID
 

Method Detail

getContentAsText

public java.lang.String getContentAsText(java.lang.Object content)
Returns:
the text value of the given content object as text which returns the text value of CDATA, Entity or Text nodes

getContentAsStringValue

public java.lang.String getContentAsStringValue(java.lang.Object content)
Returns:
the XPath defined string-value of the given content object

getTextTrim

public java.lang.String getTextTrim()

elementID

public java.lang.String elementID(Element element)
Returns:
the ID of the given Element

contentList

public java.util.List contentList()
Returns:
the internal List used to manage the content

createContentList

public java.util.List createContentList()
A Factory Method pattern which creates a List implementation used to store content


createContentList

public java.util.List createContentList(int size)
A Factory Method pattern which creates a List implementation used to store content


createResultList

public BackedList createResultList()
A Factory Method pattern which creates a BackedList implementation used to store results of a filtered content query.


createSingleResultList

public java.util.List createSingleResultList(java.lang.Object result)
A Factory Method pattern which creates a BackedList implementation which contains a single result


createEmptyList

public java.util.List createEmptyList()
A Factory Method pattern which creates an empty a BackedList implementation


addNode

public void addNode(Node node)

addNode

public void addNode(int index,
                    Node node)

removeNode

public boolean removeNode(Node node)

childAdded

public void childAdded(Node node)
Called when a new child node has been added to me to allow any parent relationships to be created or events to be fired.


childRemoved

public void childRemoved(Node node)
Called when a child node has been removed to allow any parent relationships to be deleted or events to be fired.


contentRemoved

public void contentRemoved()
Called when the given List content has been removed so each node should have its parent and document relationships cleared


invalidNodeTypeAddException

public void invalidNodeTypeAddException(Node node)
Called when an invalid node has been added. Throws an IllegalAddException.



Copyright © 2004 The Ozone Database Project - www.ozone-db.org. All Rights Reserved.