org.apache.xerces.dom

Class ProcessingInstructionImpl

Implemented Interfaces:
Cloneable, EventTarget, Node, NodeList, ProcessingInstruction, Serializable
Known Direct Subclasses:
DeferredProcessingInstructionImpl

public class ProcessingInstructionImpl
extends CharacterDataImpl
implements ProcessingInstruction

Processing Instructions (PIs) permit documents to carry processor-specific information alongside their actual content. PIs are most common in XML, but they are supported in HTML as well. This class inherits from CharacterDataImpl to reuse its setNodeValue method.
Version:
$Id: ProcessingInstructionImpl.java,v 1.15 2004/10/05 17:12:49 mrglavas Exp $
Since:
PR-DOM-Level-1-19980818.

Field Summary

protected String
target

Fields inherited from class org.apache.xerces.dom.CharacterDataImpl

data

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE, flags, ownerNode

Constructor Summary

ProcessingInstructionImpl(CoreDocumentImpl ownerDoc, String target, String data)
Factory constructor.

Method Summary

String
getBaseURI()
Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
String
getData()
A PI's data content tells the processor what we actually want it to do.
String
getNodeName()
Returns the target
short
getNodeType()
A short integer indicating what type of node this is.
String
getTarget()
A PI's "target" states what processor channel the PI's data should be directed to.
void
setData(String data)
Change the data content of this PI.

Methods inherited from class org.apache.xerces.dom.CharacterDataImpl

appendData, deleteData, getChildNodes, getData, getLength, getNodeValue, insertData, replaceData, setData, setNodeValue, setNodeValueInternal, setNodeValueInternal, substringData

Methods inherited from class org.apache.xerces.dom.ChildNode

cloneNode, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, appendChild, changed, changes, cloneNode, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getBaseURI, getChildNodes, getContainer, getFeature, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeNumber, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getReadOnly, getTextContent, getUserData, getUserData, getUserDataRecord, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, needsSyncChildren, normalize, removeChild, removeEventListener, replaceChild, setNodeValue, setPrefix, setReadOnly, setTextContent, setUserData, setUserData, synchronizeData, toString

Field Details

target

protected String target

Constructor Details

ProcessingInstructionImpl

public ProcessingInstructionImpl(CoreDocumentImpl ownerDoc,
                                 String target,
                                 String data)
Factory constructor.

Method Details

getBaseURI

public String getBaseURI()
Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. Note: If the URI is malformed, a null is returned.
Overrides:
getBaseURI in interface NodeImpl
Returns:
The absolute base URI of this node or null.
Since:
DOM Level 3

getData

public String getData()
A PI's data content tells the processor what we actually want it to do. It is defined slightly differently in HTML and XML.

In XML, the data begins with the non-whitespace character immediately after the target -- @see getTarget().

In HTML, the data begins with the character immediately after the "<?" token that begins the PI.

Note that getNodeValue is aliased to getData

Overrides:
getData in interface CharacterDataImpl

getNodeName

public String getNodeName()
Returns the target
Overrides:
getNodeName in interface NodeImpl

getNodeType

public short getNodeType()
A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface.
Overrides:
getNodeType in interface NodeImpl

getTarget

public String getTarget()
A PI's "target" states what processor channel the PI's data should be directed to. It is defined differently in HTML and XML.

In XML, a PI's "target" is the first (whitespace-delimited) token following the "<?" token that begins the PI.

In HTML, target is always null.

Note that getNodeName is aliased to getTarget.


setData

public void setData(String data)
Change the data content of this PI. Note that setData is aliased to setNodeValue.
Overrides:
setData in interface CharacterDataImpl
See Also:
getData().

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.