com.japisoft.fastparser.dom
Class CharacterDataImpl

java.lang.Object
  |
  +--com.japisoft.fastparser.node.SimpleNode
        |
        +--com.japisoft.fastparser.dom.NodeImpl
              |
              +--com.japisoft.fastparser.dom.CharacterDataImpl
All Implemented Interfaces:
CharacterData, MutableNode, Node, ViewableNode
Direct Known Subclasses:
CommentImpl, TextImpl

public class CharacterDataImpl
extends NodeImpl
implements CharacterData

CharacterData

Version:
1.0
Author:
(c) 2002-2003 JAPISOFT

Field Summary
 
Fields inherited from class com.japisoft.fastparser.dom.NodeImpl
nameSpaceURI
 
Fields inherited from class com.japisoft.fastparser.node.SimpleNode
COMMENT_NODE, TAG_NODE, TEXT_NODE
 
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
 
Constructor Summary
CharacterDataImpl()
           
CharacterDataImpl(int type)
           
CharacterDataImpl(int type, java.lang.String content)
           
 
Method Summary
 void appendData(java.lang.String arg)
          Append the string to the end of the character data of the node.
 void deleteData(int offset, int count)
          Remove a range of characters from the node.
 java.lang.String getData()
          The character data of the node that implements this interface.
 int getLength()
          The number of characters that are available through data and the substringData method below.
 void insertData(int offset, java.lang.String arg)
          Insert a string at the specified character offset.
 void replaceData(int offset, int count, java.lang.String arg)
          Replace the characters starting at the specified character offset with the specified string.
 void setData(java.lang.String data)
           
 java.lang.String substringData(int offset, int count)
          Extracts a range of data from the node.
 
Methods inherited from class com.japisoft.fastparser.dom.NodeImpl
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNamespaceURI, setNodeValue, setOwnerDocument, setPrefix
 
Methods inherited from class com.japisoft.fastparser.node.SimpleNode
addChildNode, addNameSpaceDeclaration, addNode, childAt, childCount, childNodeIndex, clone, getAllChild, getAttribute, getAttribute, getContent, getDefaultNamespace, getDocument, getLine, getNameSpaceDeclaration, getNameSpaceDeclarationURI, getNamespaceDeclared, getNameSpacePrefix, getNameSpaceURI, getNodeByCriteria, getNodeByName, getNodeContent, getNodeForXPathLocation, getSimpleParent, getType, getViewAttribute, getViewAttributes, getViewChildAt, getViewChildCount, getViewContent, getXPathLocation, getXPathLocation, hasAttribute, insertChildNode, isComment, isLeaf, isNamespaceDeclared, isRoot, isTag, isText, isViewComment, isViewLeaf, isViewText, removeChildNode, removeNameSpaceDeclaration, setAttribute, setContent, setDefaultNamespace, setDocument, setLine, setNameSpace, setNodeAttribute, setNodeContent, setNodeParent, setSimpleParent, setType, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, removeChild, replaceChild, setNodeValue
 

Constructor Detail

CharacterDataImpl

public CharacterDataImpl()

CharacterDataImpl

public CharacterDataImpl(int type)

CharacterDataImpl

public CharacterDataImpl(int type,
                         java.lang.String content)
Method Detail

getData

public java.lang.String getData()
                         throws DOMException
The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Specified by:
getData in interface CharacterData
Throws:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setData

public void setData(java.lang.String data)
             throws DOMException
Specified by:
setData in interface CharacterData
DOMException

getLength

public int getLength()
The number of characters that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.

Specified by:
getLength in interface CharacterData

substringData

public java.lang.String substringData(int offset,
                                      int count)
                               throws DOMException
Extracts a range of data from the node.

Specified by:
substringData in interface CharacterData
Parameters:
offset - Start offset of substring to extract.
count - The number of characters to extract.
Returns:
The specified substring. If the sum of offset and count exceeds the length, then all characters to the end of the data are returned.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data, or if the specified count is negative.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString.

appendData

public void appendData(java.lang.String arg)
                throws DOMException
Append the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the DOMString specified.

Specified by:
appendData in interface CharacterData
Parameters:
arg - The DOMString to append.
Throws:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

insertData

public void insertData(int offset,
                       java.lang.String arg)
                throws DOMException
Insert a string at the specified character offset.

Specified by:
insertData in interface CharacterData
Parameters:
offset - The character offset at which to insert.
arg - The DOMString to insert.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

deleteData

public void deleteData(int offset,
                       int count)
                throws DOMException
Remove a range of characters from the node. Upon success, data and length reflect the change.

Specified by:
deleteData in interface CharacterData
Parameters:
offset - The offset from which to remove characters.
count - The number of characters to delete. If the sum of offset and count exceeds length then all characters from offset to the end of the data are deleted.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

replaceData

public void replaceData(int offset,
                        int count,
                        java.lang.String arg)
                 throws DOMException
Replace the characters starting at the specified character offset with the specified string.

Specified by:
replaceData in interface CharacterData
Parameters:
offset - The offset from which to start replacing.
count - The number of characters to replace. If the sum of offset and count exceeds length , then all characters to the end of the data are replaced (i.e., the effect is the same as a remove method call with the same range, followed by an append method invocation).
arg - The DOMString with which the range must be replaced.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.