com.goldencode.p2j.xml

Interface XEntity

All Superinterfaces:

NamespaceURI, SubTypeAttribute, UniqueID, WrappedResource, XCommon

All Known Subinterfaces:

HandleCommon, XDocument, XNodeRef

All Known Implementing Classes:

XDocumentImpl, XEntityImpl, XNodeRefImpl

public interface XEntity
extends XCommon, UniqueID, NamespaceURI, SubTypeAttribute

Interface describing the common features for DOM and SAX XML support objects.

Method Summary

Modifier and Type	Method and Description
logical	appendChild(handle hChild) Appending the new child to the current object.
logical	getChild(handle hChild, int index) Getting the handle object of the child node with specified index.
logical	getChild(handle hChild, int64 index) Getting the handle object of the child node with specified index.
integer	getChildNum() Gets the number of child for the current one.
integer	getNumChildren() Gets the the number of children objects for the current one.
handle	getOwnerDocument() Getting the Document the current reference belongs to.
logical	insertBefore(handle handle1, handle handle2) Inserts a node as a chaild of this document before another node.
logical	removeChild(handle hChild) Removing the specified child from the node.
logical	replaceChild(handle newChildHandle, handle oldChildHandle) Removing the specified child from the node.

Methods inherited from interface com.goldencode.p2j.xml.XCommon

addSchemaLocation, addSchemaLocation, addSchemaLocation, addSchemaLocation, getNonamespaceSchemaLocation, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, setNonamespaceSchemaLocation, setNonamespaceSchemaLocation

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.util.UniqueID

getUniqueID

Methods inherited from interface com.goldencode.p2j.util.NamespaceURI

namespacePrefix, namespacePrefix, namespacePrefix, namespaceURI, namespaceURI, namespaceURI

Methods inherited from interface com.goldencode.p2j.util.SubTypeAttribute

getSubType, setSubType, setSubType

Method Detail

getNumChildren

integer getNumChildren()

Gets the the number of children objects for the current one.

Returns:

The integer number of the children.

getChildNum

integer getChildNum()

Gets the number of child for the current one. Only for XNodRef

Returns:

The integer number of the child, 1-based index of the child node.

insertBefore

logical insertBefore(handle handle1,
                     handle handle2)

Inserts a node as a chaild of this document before another node.

Parameters:

handle1 - The handle representing the child to insert.

handle2 - The handle representing the XML node to be inserted before.

Returns:

The true in case of success false otherwise.

appendChild

logical appendChild(handle hChild)

Appending the new child to the current object.

Parameters:

hChild - The valid handle class instance of the child to be appended.

Returns:

The true in case of success false otherwise.

getChild

logical getChild(handle hChild,
                 int64 index)

Getting the handle object of the child node with specified index.

Parameters:

hChild - The valid handle class instance of the child to put the results.

index - 1-based index of the child node to be retrieved.

Returns:

The true in case of success false otherwise.

getChild

logical getChild(handle hChild,
                 int index)

Getting the handle object of the child node with specified index.

Parameters:

hChild - The valid handle class instance of the child to put the results.

index - 1-based index of the child node to be retrieved.

Returns:

The true in case of success false otherwise.

removeChild

logical removeChild(handle hChild)

Removing the specified child from the node.

Parameters:

hChild - The valid handle class instance of the child to be removed.

Returns:

The true in case of success false otherwise.

replaceChild

logical replaceChild(handle newChildHandle,
                     handle oldChildHandle)

Removing the specified child from the node.

Parameters:

newChildHandle - The handle class instance that represents the node to insert in the tree.

oldChildHandle - The handle class instance that represents the node to remove from the tree.

Returns:

The true in case of success false otherwise.

getOwnerDocument

handle getOwnerDocument()

Getting the Document the current reference belongs to.

Returns:

The handle of the Document containing tne current reference..