il.co.iter.dbdom
Class DBCharacterData
java.lang.Object
|
+--il.co.iter.dbdom.DBNode
|
+--il.co.iter.dbdom.DBCharacterData
- All Implemented Interfaces:
- CharacterData, Node
- Direct Known Subclasses:
- DBComment, DBText
- public class DBCharacterData
- extends DBNode
- implements CharacterData
The CharacterData
interface extends Node with a set of
attributes and methods for accessing character data in the DOM. For
clarity this set is defined here rather than on each object that uses
these attributes and methods. No DOM objects correspond directly to
CharacterData
, though Text
and others do
inherit the interface from it. All offsets
in this interface
start from 0
.
As explained in the DOMString
interface, text strings in
the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In
the following, the term 16-bit units is used whenever necessary to
indicate that indexing on CharacterData is done in 16-bit units.
See also the Document Object Model (DOM) Level 2 Core Specification.
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 |
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)
Not Implemented
Remove a range of 16-bit units from the node. |
java.lang.String |
getData()
The character data of the node that implements this interface. |
int |
getLength()
The number of 16-bit units that are available through data
and the substringData method below. |
void |
insertData(int offset,
java.lang.String arg)
Not Implemented
Insert a string at the specified 16-bit unit offset. |
void |
replaceData(int offset,
int count,
java.lang.String arg)
Not Implemented
Replace the characters starting at the specified 16-bit unit offset
with the specified string. |
void |
setData(java.lang.String data)
|
java.lang.String |
substringData(int offset,
int count)
Not Implemented
Extracts a range of data from the node. |
Methods inherited from class il.co.iter.dbdom.DBNode |
appendChild, cloneNode, getAttributes, getChildNodes, getDbDomImplementation, getFirstChild, getId, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.w3c.dom.Node |
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix |
DBCharacterData
protected DBCharacterData(DBDOMImplementation dbDomImplementation,
long id)
- Calls super(dbDomImplementation, id)
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
getLength
public int getLength()
- The number of 16-bit units 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
- Not Implemented
Extracts a range of data from the node.
- Specified by:
substringData
in interface CharacterData
- Parameters:
offsetStart
- offset of substring to extract.countThe
- number of 16-bit units to extract.- Returns:
- The specified substring. If the sum of
offset
and
count
exceeds the length
, then all 16-bit
units 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 16-bit units 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:
argThe
- 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
- Not Implemented
Insert a string at the specified 16-bit unit offset.
- Specified by:
insertData
in interface CharacterData
- Parameters:
offsetThe
- character offset at which to insert.argThe
- DOMString
to insert.- Throws:
DOMException
- INDEX_SIZE_ERR: Raised if the specified offset
is
negative or greater than the number of 16-bit units in
data
.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
deleteData
public void deleteData(int offset,
int count)
throws DOMException
- Not Implemented
Remove a range of 16-bit units from the node. Upon success,
data
and length
reflect the change.
- Specified by:
deleteData
in interface CharacterData
- Parameters:
offsetThe
- offset from which to start removing.countThe
- number of 16-bit units to delete. If the sum of
offset
and count
exceeds
length
then all 16-bit units 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 16-bit units 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
- Not Implemented
Replace the characters starting at the specified 16-bit unit offset
with the specified string.
- Specified by:
replaceData
in interface CharacterData
- Parameters:
offsetThe
- offset from which to start replacing.countThe
- number of 16-bit units to replace. If the sum of
offset
and count
exceeds
length
, then all 16-bit units 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).argThe
- 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 16-bit units in
data
, or if the specified count
is
negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.