| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.dom4j.tree.AbstractNode
org.dom4j.tree.AbstractEntity
org.dom4j.tree.FlyweightEntity
org.dom4j.tree.DefaultEntity
 DefaultEntity is the default Entity implementation. It is a
 doubly linked node which supports the parent relationship and can be modified
 in place.
 
| Field Summary | 
| Fields inherited from class org.dom4j.tree.FlyweightEntity | 
| name, text | 
| Fields inherited from class org.dom4j.tree.AbstractNode | 
| NODE_TYPE_NAMES | 
| 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 | 
| Constructor Summary | |
| DefaultEntity(Element parent,
              String name,
              String text)Creates the Entitywith the specified name and text. | |
| DefaultEntity(String name)Creates the Entitywith the specified name | |
| DefaultEntity(String name,
              String text)Creates the Entitywith the specified name and text. | |
| Method Summary | |
|  Element | getParent()getParentreturns the parentElementif
 this node supports the parent relationship or null if it is the root
 element or does not support the parent relationship. | 
|  boolean | isReadOnly()isReadOnlyreturns true if this node is read only and
 cannot be modified. | 
|  void | setName(String name)Sets the text data of this node or this method will throw an UnsupportedOperationExceptionif it is read-only. | 
|  void | setParent(Element parent)setParentsets the parent relationship of this node if the
 parent relationship is supported or does nothing if the parent
 relationship is not supported. | 
|  void | setText(String text)sets the value of the entity if it is not defined yet otherwise an UnsupportedOperationExceptionis thrown as this class is
 read only. | 
|  boolean | supportsParent()supportsParentreturns true if this node supports the
 parent relationship. | 
| Methods inherited from class org.dom4j.tree.FlyweightEntity | 
| createXPathResult, getName, getText | 
| Methods inherited from class org.dom4j.tree.AbstractEntity | 
| accept, asXML, getNodeType, getPath, getStringValue, getUniquePath, toString, write | 
| Methods inherited from class org.dom4j.tree.AbstractNode | 
| asXPathResult, clone, createPattern, createXPath, createXPathFilter, detach, getDocument, getDocumentFactory, getNodeTypeName, getPath, getUniquePath, hasContent, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, valueOf | 
| Methods inherited from class java.lang.Object | 
| equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Methods inherited from interface org.dom4j.Node | 
| asXPathResult, clone, createXPath, detach, getDocument, getNodeTypeName, getPath, getUniquePath, hasContent, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, valueOf | 
| Constructor Detail | 
public DefaultEntity(String name)
Entity with the specified name
name - is the name of the entity
public DefaultEntity(String name,
                     String text)
Entity with the specified name and text.
name - is the name of the entitytext - is the text of the entity
public DefaultEntity(Element parent,
                     String name,
                     String text)
Entity with the specified name and text.
parent - is the parent elementname - is the name of the entitytext - is the text of the entity| Method Detail | 
public void setName(String name)
Node
 Sets the text data of this node or this method will throw an
 UnsupportedOperationException if it is read-only.
 
setName in interface NodesetName in class AbstractNodepublic void setText(String text)
FlyweightEntityUnsupportedOperationException is thrown as this class is
 read only.
setText in interface NodesetText in class FlyweightEntitytext - DOCUMENT ME!public Element getParent()
Node
 getParent returns the parent Element if
 this node supports the parent relationship or null if it is the root
 element or does not support the parent relationship.
 
 This method is an optional feature and may not be supported for all
 Node implementations.
 
getParent in interface NodegetParent in class AbstractNodepublic void setParent(Element parent)
Node
 setParent sets the parent relationship of this node if the
 parent relationship is supported or does nothing if the parent
 relationship is not supported.
 
 This method should only be called from inside an Element
 implementation method and is not intended for general use.
 
setParent in interface NodesetParent in class AbstractNodepublic boolean supportsParent()
Node
 supportsParent returns true if this node supports the
 parent relationship.
 
Some XML tree implementations are singly linked and only support downward navigation through children relationships. The default case is that both parent and children relationships are supported though for memory and performance reasons the parent relationship may not be supported.
supportsParent in interface NodesupportsParent in class AbstractNodepublic boolean isReadOnly()
Node
 isReadOnly returns true if this node is read only and
 cannot be modified. Any attempt to modify a read-only Node
 will result in an UnsupportedOperationException being
 thrown.
 
isReadOnly in interface NodeisReadOnly in class AbstractNode| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||