com.goldencode.p2j.xml

Class XNodeRefImpl

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.xml.XCommonImpl

com.goldencode.p2j.xml.XEntityImpl

com.goldencode.p2j.xml.XNodeRefImpl

All Implemented Interfaces:

CommonHandle, CommonHandleChain, Deletable, InstantiatingProcedure, LocalName, Nameable, NamespaceURI, SubTypeAttribute, UniqueID, WrappedResource, XCommon, XEntity, XNodeRef, Printable

public class XNodeRefImpl
extends XEntityImpl
implements XNodeRef

Implementation of the X-Node-Reference specific features of the Progress DOM XML support objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESTRICTED_DOCUMENT The key for a restricted document mapping in the Document's user-data.

Fields inherited from class com.goldencode.p2j.xml.XEntityImpl

IS_INVALID_NODE

Fields inherited from class com.goldencode.p2j.xml.XCommonImpl

isValid

Fields inherited from class com.goldencode.p2j.util.HandleChain

name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Constructor Summary

Constructors

Constructor and Description
XNodeRefImpl() Default constructor.
XNodeRefImpl(org.w3c.dom.Node node) Special constructor accepting the namespace URI specification to make another node reference case.

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.
integer	getChildNum() Gets the number of child for the current one.
character	getLocalName() Get the value of the LOCAL-NAME attribute.
character	getNodeValue() Getting the value of the XML node value attribute.
handle	getOwnerDocument() Getting the Document the current reference belongs to.
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.
void	namespacePrefix(character prefix) Setter for NAMESPACE-PREFIX 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.
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 class com.goldencode.p2j.xml.XEntityImpl

_name, appendChild, commonDomError, commonDomError, getChild, getChild, getNode, getNumChildren, getSubType, getUniqueID, insertBefore, invalidNodeError, isInitialized, isXEntityHandle, isXNodeHandle, isXNodeHandleInitialized, name, namespacePrefix, namespacePrefix, namespaceURI, namespaceURI, namespaceURI, removeAttribute, removeAttribute, removeChild, replaceChild, resourceDelete, setNode, setNodeToHandle, setSubType, setSubType, unsupportedDomError

Methods inherited from class com.goldencode.p2j.xml.XCommonImpl

addSchemaLocation, addSchemaLocation, addSchemaLocation, addSchemaLocation, getNonamespaceSchemaLocation, hasNextSibling, hasPrevSibling, invalidArgumentAssignError, invalidArgumentError, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, setNonamespaceSchemaLocation, setNonamespaceSchemaLocation, valid

Methods inherited from class com.goldencode.p2j.util.HandleChain

delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNameReadOnly, hasParent, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, readOnlyError, readOnlyError, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

setNodeValue

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

appendChild, getChild, getChild, getNumChildren, 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, namespaceURI, namespaceURI, namespaceURI

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

getSubType, setSubType, setSubType

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

resourceType

Methods inherited from interface com.goldencode.util.Printable

asString, print

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

allowDelete

Field Detail

RESTRICTED_DOCUMENT

public static final java.lang.String RESTRICTED_DOCUMENT

The key for a restricted document mapping in the Document's user-data.

See Also:

Constant Field Values

Constructor Detail

XNodeRefImpl

public XNodeRefImpl()

Default constructor.

XNodeRefImpl

public XNodeRefImpl(org.w3c.dom.Node node)

Special constructor accepting the namespace URI specification to make another node reference case.

Parameters:

node - The node associated with this node.

Method Detail

getAttributeNames

public character getAttributeNames()

Getting the attribute names available for current node reference.

Specified by:

getAttributeNames in interface XNodeRef

Returns:

The comma separated character string of all available attributed.

getNodeValue

public character getNodeValue()

Getting the value of the XML node value attribute.

Specified by:

getNodeValue in interface XNodeRef

Returns:

The character value of the node reference.

setNodeValue

public void setNodeValue(character value)

Setting the value of the XML node value attribute.

Specified by:

setNodeValue in interface XNodeRef

Parameters:

value - The new value of the node value attribute.

setNodeValue

public void setNodeValue(java.lang.String value)

Setting the value of the XML node value attribute.

Specified by:

setNodeValue in interface XNodeRef

Parameters:

value - The new value of the node value attribute.

cloneNode

public logical cloneNode(handle xNodeRef,
                         logical deep)

Creating the new node within the current Document object.

Specified by:

cloneNode in interface XNodeRef

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

public logical cloneNode(handle xNodeRef,
                         boolean deep)

Creating the new node within the current Document object.

Specified by:

cloneNode in interface XNodeRef

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.

getParent

public logical getParent(handle hNoderefParent)

Getting the Parent of current node.

Specified by:

getParent in interface XNodeRef

Parameters:

hNoderefParent - A valid handle to assign parent XML node.

Returns:

The true in case of success false otherwise.

deleteNode

public logical deleteNode()

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

Specified by:

deleteNode in interface XNodeRef

Returns:

The true in case of success false otherwise.

getAttribute

public character getAttribute(java.lang.String name)

Getting the attribute value for a given attribute name.

Specified by:

getAttribute in interface XNodeRef

Parameters:

name - The name of the attribute to return.

Returns:

The comma separated character string of all available attributed.

getAttribute

public character getAttribute(character name)

Getting the attribute value for a given attribute name.

Specified by:

getAttribute in interface XNodeRef

Parameters:

name - The name of the attribute to return.

Returns:

Value as a character string, or the empty string if that attribute does not have a specified or default value.

setAttribute

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

Setting the attribute value for a given attribute name.

Specified by:

setAttribute in interface XNodeRef

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

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

Setting the attribute value for a given attribute name.

Specified by:

setAttribute in interface XNodeRef

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

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

Setting the attribute value for a given attribute name.

Specified by:

setAttribute in interface XNodeRef

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

public logical setAttribute(character name,
                            character value)

Setting the attribute value for a given attribute name.

Specified by:

setAttribute in interface XNodeRef

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

public logical setAttributeNode(handle handle)

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

Specified by:

setAttributeNode in interface XNodeRef

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

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

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

Specified by:

getAttributeNode in interface XNodeRef

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

public logical getAttributeNode(handle handle,
                                character attributeName)

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

Specified by:

getAttributeNode in interface XNodeRef

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

public logical longcharToNodeValue(longchar value)

Setting the binary value of the XML node value attribute.

Specified by:

longcharToNodeValue in interface XNodeRef

Parameters:

value - The new value of the node value attribute.

Returns:

The true in case of success false otherwise.

nodeValueToLongchar

public logical nodeValueToLongchar(longchar value)

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

Specified by:

nodeValueToLongchar in interface XNodeRef

Parameters:

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

Returns:

The true in case of success false otherwise.

memptrToNodeValue

public logical memptrToNodeValue(memptr value)

Setting the binary value of the XML node value attribute.

Specified by:

memptrToNodeValue in interface XNodeRef

Parameters:

value - The new value of the node value attribute.

Returns:

The true in case of success false otherwise.

nodeValueToMemptr

public logical nodeValueToMemptr(memptr value)

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

Specified by:

nodeValueToMemptr in interface XNodeRef

Parameters:

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

Returns:

The true in case of success false otherwise.

normalize

public logical normalize()

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

Specified by:

normalize in interface XNodeRef

Returns:

The true in case of success false otherwise.

getLocalName

public character getLocalName()

Get the value of the LOCAL-NAME attribute.

Specified by:

getLocalName in interface LocalName

Returns:

See above.

namespacePrefix

public void namespacePrefix(character prefix)

Setter for NAMESPACE-PREFIX attribute.

Specified by:

namespacePrefix in interface NamespaceURI

Overrides:

namespacePrefix in class XEntityImpl

Parameters:

prefix - The new value of the NAMESPACE-PREFIX attribute.

getChildNum

public integer getChildNum()

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

Specified by:

getChildNum in interface XEntity

Returns:

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

getOwnerDocument

public handle getOwnerDocument()

Getting the Document the current reference belongs to.

Specified by:

getOwnerDocument in interface XEntity

Returns:

The handle of the Document containing tne current reference.