| 
 | |||||||||||
| 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.AbstractProcessingInstruction
 AbstractProcessingInstruction is an abstract base class for
 tree implementors to use for implementation inheritence.
 
| Field Summary | 
| 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 | |
| AbstractProcessingInstruction() | |
| Method Summary | |
|  void | accept(Visitor visitor)acceptis the method used in the Visitor Pattern. | 
|  String | asXML()asXMLreturns the textual XML representation of this node. | 
|  String | getName()getNamereturns the name of this node. | 
|  short | getNodeType()Returns the code according to the type of node. | 
|  String | getPath(Element context)Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c. | 
|  String | getUniquePath(Element context)Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node. | 
| protected  Map | parseValues(String text)Parses the raw data of PI as a Map. | 
|  boolean | removeValue(String name) | 
|  void | setName(String name)Sets the text data of this node or this method will throw an UnsupportedOperationExceptionif it is read-only. | 
|  void | setValue(String name,
         String value) | 
|  void | setValues(Map data) | 
|  String | toString() | 
| protected  String | toString(Map values)This will convert the Map to a string representation. | 
|  void | write(Writer writer)writewrites this node as the default XML notation for
 this node. | 
| Methods inherited from class org.dom4j.tree.AbstractNode | 
| asXPathResult, clone, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getDocument, getDocumentFactory, getNodeTypeName, getParent, getPath, getStringValue, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setParent, setText, supportsParent, valueOf | 
| Methods inherited from class java.lang.Object | 
| equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Methods inherited from interface org.dom4j.ProcessingInstruction | 
| getTarget, getText, getValue, getValues, setTarget | 
| Methods inherited from interface org.dom4j.Node | 
| asXPathResult, clone, createXPath, detach, getDocument, getNodeTypeName, getParent, getPath, getStringValue, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setParent, setText, supportsParent, valueOf | 
| Constructor Detail | 
public AbstractProcessingInstruction()
| Method Detail | 
public short getNodeType()
Node
getNodeType in interface NodegetNodeType in class AbstractNodepublic String getPath(Element context)
Node
getPath in interface Nodecontext - is the parent context from which the relative path should
            start. If the context is null or the context is not an
            ancestor of this node then the path will be absolute and start
            from the document and so begin with the '/' character.
public String getUniquePath(Element context)
NodeReturns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node. This method will use the XPath index operator to restrict the path if multiple elements with the same name occur on the path.
getUniquePath in interface Nodecontext - is the parent context from which the path should start. If the
            context is null or the context is not an ancestor of this node
            then the path will start from the document and so begin with
            the '/' character.
public String toString()
public String asXML()
Node
 asXML returns the textual XML representation of this node.
 
asXML in interface Node
public void write(Writer writer)
           throws IOException
Node
 write writes this node as the default XML notation for
 this node. If you wish to control the XML output (such as for pretty
 printing, changing the indentation policy etc.) then please use XMLWriter or its derivations.
 
write in interface Nodewrite in class AbstractNodeIOExceptionpublic void accept(Visitor visitor)
Node
 accept is the method used in the Visitor Pattern.
 
accept in interface Nodevisitor - is the visitor in the Visitor Pattern
public void setValue(String name,
                     String value)
setValue in interface ProcessingInstructionpublic void setValues(Map data)
setValues in interface ProcessingInstructionpublic String getName()
Node
 getName returns the name of this node. This is the XML
 local name of the element, attribute, entity or processing instruction.
 For CDATA and Text nodes this method will return null.
 
getName in interface NodegetName in class AbstractNodepublic 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 boolean removeValue(String name)
removeValue in interface ProcessingInstructionprotected String toString(Map values)
This will convert the Map to a string representation.
values - is a Map of PI data to convert
protected Map parseValues(String text)
 Parses the raw data of PI as a Map.
 
text - String PI data to parse
| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||