com.goldencode.p2j.xml

Interface XNodeRef

All Superinterfaces:

LocalName, NamespaceURI, SubTypeAttribute, UniqueID, WrappedResource, XCommon, XEntity

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

XNodeRefImpl

public interface XNodeRef
extends XEntity, LocalName

Interface describing X-Node-Reference specific features of the DOM XML objects.

Method Summary

Modifier and Type	Method and Description
logical	cloneNode(handle xNodeRef, boolean deep) Creating the new node within the current Document object.
logical	cloneNode(handle xNodeRef, logical deep) Creating the new node within the current Document object.
logical	deleteNode() Deleting the internals of the current X-Node-Reference.
character	getAttribute(character name) Getting the attribute value for a given attribute name.
character	getAttribute(java.lang.String name) Getting the attribute value for a given attribute name.
character	getAttributeNames() Getting the attribute names available for current node reference.
logical	getAttributeNode(handle handle, character attributeName) Associates XML attribute node with the specified name to the given X-Noderef object handle.
logical	getAttributeNode(handle handle, java.lang.String attributeName) Associates XML attribute node with the specified name to the given X-Noderef object handle.
character	getNodeValue() Getting the value of the XML node value attribute.
logical	getParent(handle hNoderefParent) Getting the Parent of current node.
logical	longcharToNodeValue(longchar value) Setting the binary value of the XML node value attribute.
logical	memptrToNodeValue(memptr value) Setting the binary value of the XML node value attribute.
logical	nodeValueToLongchar(longchar value) Setting the XML node value attribute to binary value of longchar.
logical	nodeValueToMemptr(memptr value) Setting the XML node value attribute to binary value of memptr.
logical	normalize() Normalizes TEXT and ATTRIBUTE nodes in the full depth of the sub-tree under this XML node.
logical	setAttribute(character name, character value) Setting the attribute value for a given attribute name.
logical	setAttribute(character name, java.lang.String value) Setting the attribute value for a given attribute name.
logical	setAttribute(java.lang.String name, character value) Setting the attribute value for a given attribute name.
logical	setAttribute(java.lang.String name, java.lang.String value) Setting the attribute value for a given attribute name.
logical	setAttributeNode(handle handle) Associates XML attribute node with the given X-Noderef object handle.
default void	setNodeValue(BaseDataType value) Setting the value of the XML node value attribute.
void	setNodeValue(character value) Setting the value of the XML node value attribute.
void	setNodeValue(java.lang.String value) Setting the value of the XML node value attribute.

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

appendChild, getChild, getChild, getChildNum, getNumChildren, getOwnerDocument, insertBefore, removeChild, replaceChild

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

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

getLocalName

Method Detail

getAttributeNames

character getAttributeNames()

Getting the attribute names available for current node reference.

Returns:

The comma separated character string of all available attributed.

getParent

logical getParent(handle hNoderefParent)

Getting the Parent of current node.

Parameters:

hNoderefParent - A valid handle to assign parent XML node.

Returns:

The true in case of success false otherwise.

getNodeValue

character getNodeValue()

Getting the value of the XML node value attribute.

Returns:

The character value of the node reference.

setNodeValue

void setNodeValue(character value)

Setting the value of the XML node value attribute.

Parameters:

value - The new value of the node value attribute.

setNodeValue

void setNodeValue(java.lang.String value)

Setting the value of the XML node value attribute.

Parameters:

value - The new value of the node value attribute.

setNodeValue

default void setNodeValue(BaseDataType value)

Setting the value of the XML node value attribute. NODE-VALUE is a _POLY attribute, it accepts any value (any type) and it will silently convert it to CHARACTER on-the-fly.

Parameters:

value - The new value of the node value attribute.

deleteNode

logical deleteNode()

Deleting the internals of the current X-Node-Reference.

Returns:

The true in case of success false otherwise.

getAttribute

character getAttribute(java.lang.String name)

Getting the attribute value for a given attribute name.

Parameters:

name - The name of the attribute to return.

Returns:

The comma separated character string of all available attributed.

getAttribute

character getAttribute(character name)

Getting the attribute value for a given attribute name.

Parameters:

name - The name of the attribute to return.

Returns:

The comma separated character string of all available attributed.

setAttribute

logical setAttribute(java.lang.String name,
                     java.lang.String value)

Setting the attribute value for a given attribute name.

Parameters:

name - The name of the attribute to change.

value - The new value for the given attribute name.

Returns:

The true in case of success false otherwise.

setAttribute

logical setAttribute(java.lang.String name,
                     character value)

Setting the attribute value for a given attribute name.

Parameters:

name - The name of the attribute to change.

value - The new value for the given attribute name.

Returns:

The true in case of success false otherwise.

setAttribute

logical setAttribute(character name,
                     java.lang.String value)

Setting the attribute value for a given attribute name.

Parameters:

name - The name of the attribute to change.

value - The new value for the given attribute name.

Returns:

The true in case of success false otherwise.

setAttribute

logical setAttribute(character name,
                     character value)

Setting the attribute value for a given attribute name.

Parameters:

name - The name of the attribute to change.

value - The new value for the given attribute name.

Returns:

The true in case of success false otherwise.

setAttributeNode

logical setAttributeNode(handle handle)

Associates XML attribute node with the given X-Noderef object handle.

Parameters:

handle - The handle that represents an XML attribute node created with create node or create node namespace.

Returns:

The true in case of success false otherwise.

getAttributeNode

logical getAttributeNode(handle handle,
                         java.lang.String attributeName)

Associates XML attribute node with the specified name to the given X-Noderef object handle.

Parameters:

handle - The handle that represents an XML attribute node with the specified name.

attributeName - The string that represents an XML attribute node with the specified name.

Returns:

The true in case of success false otherwise.

getAttributeNode

logical getAttributeNode(handle handle,
                         character attributeName)

Associates XML attribute node with the specified name to the given X-Noderef object handle.

Parameters:

handle - The handle that represents an XML attribute node with the specified name.

attributeName - The character that represents an XML attribute node with the specified name.

Returns:

The true in case of success false otherwise.

longcharToNodeValue

logical longcharToNodeValue(longchar value)

Setting the binary value of the XML node value attribute.

Parameters:

value - The new value of the node value attribute.

Returns:

The true in case of success false otherwise.

nodeValueToLongchar

logical nodeValueToLongchar(longchar value)

Setting the XML node value attribute to binary value of longchar.

Parameters:

value - To save the value on XML node to this parameter.

Returns:

The true in case of success false otherwise.

memptrToNodeValue

logical memptrToNodeValue(memptr value)

Setting the binary value of the XML node value attribute.

Parameters:

value - The new value of the node value attribute.

Returns:

The true in case of success false otherwise.

nodeValueToMemptr

logical nodeValueToMemptr(memptr value)

Setting the XML node value attribute to binary value of memptr.

Parameters:

value - To save the value on XML node to this parameter.

Returns:

The true in case of success false otherwise.

cloneNode

logical cloneNode(handle xNodeRef,
                  logical deep)

Creating the new node within the current Document object.

Parameters:

xNodeRef - The valid handle class instance to use for the cloned XML node.

deep - A logical that if true specifies that the whole sub-trees is to be copied. The default value is false.

Returns:

The true in case of success false otherwise.

cloneNode

logical cloneNode(handle xNodeRef,
                  boolean deep)

Creating the new node within the current Document object.

Parameters:

xNodeRef - The valid handle class instance to use for the cloned XML node.

deep - A logical that if true specifies that the whole sub-trees is to be copied. The default value is false.

Returns:

The true in case of success false otherwise.

normalize

logical normalize()

Normalizes TEXT and ATTRIBUTE nodes in the full depth of the sub-tree under this XML node.

Returns:

The true in case of success false otherwise.