com.goldencode.p2j.xml

Class XEntityImpl

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.xml.XCommonImpl

com.goldencode.p2j.xml.XEntityImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

XDocumentImpl, XNodeRefImpl

public abstract class XEntityImpl
extends XCommonImpl
implements XEntity

Implementation of the common features for DOM.

Field Summary

Fields

Modifier and Type	Field and Description
private UniqueIdGenerator.IdKind	idKind The kind of this entity.
(package private) static java.lang.String	IS_INVALID_NODE Constant to specify uninitialized state for node if owner of this node has been deleted.
private java.lang.Long	uniqueID Corresponds to UNIQUE-ID attribute.
private org.w3c.dom.Node	xnode Element associates with current XEntity class.

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

Modifier	Constructor and Description
protected	XEntityImpl(org.w3c.dom.Node node, UniqueIdGenerator.IdKind idKind) Special constructor accepting a X-Document or X-Node-Reference object.
protected	XEntityImpl(UniqueIdGenerator.IdKind idKind) Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	_name() Get the name attribute of handle as a string.
logical	appendChild(handle hChild) Appending the new child to the current object.
protected void	commonDomError(java.lang.String attribute, java.lang.String message) Process and display unknown node error.
protected void	commonDomError(java.lang.String attribute, java.lang.String message, boolean raiseError) Process and display unknown node error.
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.
org.w3c.dom.Node	getNode() Getting the Element backend object for this XEntity.
integer	getNumChildren() Gets the the number of children objects for the current one.
character	getSubType() Gets the the subtype of the object.
integer	getUniqueID() Gets the the unique ID number associated to this object by the underlying system.
logical	insertBefore(handle handle1, handle handle2) Inserts a node as a child of this document before another node or last if other node is unknown.
protected void	invalidNodeError(java.lang.String attribute) Process and display invalid node error.
(package private) boolean	isInitialized() Reports if this object is not initialized.
(package private) static boolean	isXEntityHandle(handle handle) Check the type of resource in handle.
(package private) static boolean	isXNodeHandle(handle handle) Check the type of resource in handle.
(package private) static boolean	isXNodeHandleInitialized(handle handle) Check the type of resource in handle.
character	name() Get the name attribute of handle.
character	namespacePrefix() Returns the value of the the NAMESPACE-PREFIX attribute.
void	namespacePrefix(character prefix) Setter for NAMESPACE-PREFIX attribute.
void	namespacePrefix(java.lang.String prefix) Setter for NAMESPACE-PREFIX attribute.
character	namespaceURI() Returns the value of the the NAMESPACE-URI attribute.
void	namespaceURI(character uri) Setter for NAMESPACE-URI attribute.
void	namespaceURI(java.lang.String uri) Setter for NAMESPACE-URI attribute.
logical	removeAttribute(character name, character uri) Removes the specified attribute.
logical	removeAttribute(NumberType index, character uri) Removes the specified attribute.
logical	removeChild(handle hChild) Removing the specified child from the node.
logical	replaceChild(handle newChildHandle, handle oldChildHandle) Removing the specified child from the node.
protected boolean	resourceDelete() Delete the resource.
void	setNode(org.w3c.dom.Node xnode) Setting the Element backend object for this XEntity.
(package private) static void	setNodeToHandle(handle handle, org.w3c.dom.Node node) Utility method to set up node value into handle.
void	setSubType(character value) Sets the the subtype of the object.
void	setSubType(java.lang.String value) Sets the the subtype of the object.
protected void	unsupportedDomError(java.lang.String type) Process and display unsupported xml sub-type error.

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.XEntity

getChildNum, getOwnerDocument

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

addSchemaLocation, addSchemaLocation, addSchemaLocation, addSchemaLocation, getNonamespaceSchemaLocation, 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.CommonHandle

resourceType

Methods inherited from interface com.goldencode.util.Printable

asString, print

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

allowDelete

Field Detail

IS_INVALID_NODE

static final java.lang.String IS_INVALID_NODE

Constant to specify uninitialized state for node if owner of this node has been deleted.

See Also:

Constant Field Values

xnode

private org.w3c.dom.Node xnode

Element associates with current XEntity class.

uniqueID

private java.lang.Long uniqueID

Corresponds to UNIQUE-ID attribute.

idKind

private UniqueIdGenerator.IdKind idKind

The kind of this entity.

Constructor Detail

XEntityImpl

protected XEntityImpl(UniqueIdGenerator.IdKind idKind)

Default constructor.

Parameters:

idKind - The discriminator for unique id allocation.

XEntityImpl

protected XEntityImpl(org.w3c.dom.Node node,
                      UniqueIdGenerator.IdKind idKind)

Special constructor accepting a X-Document or X-Node-Reference object.

Parameters:

node - The DOM XML node object to be associated with the given handle object.

idKind - The discriminator for unique id allocation.

Method Detail

setNodeToHandle

static void setNodeToHandle(handle handle,
                            org.w3c.dom.Node node)

Utility method to set up node value into handle. If handle is not XNodeRef or XDocument type then do nothing.

Parameters:

handle - The handle class instance to set new node value.

node - The node value to set.

isXNodeHandle

static boolean isXNodeHandle(handle handle)

Check the type of resource in handle. Return true if and only if handle contains resource of type XNodeRef.

Parameters:

handle - The handle class instance to check type.

Returns:

See above.

isXEntityHandle

static boolean isXEntityHandle(handle handle)

Check the type of resource in handle. Return true if and only if handle contains resource of type XNodeRef or XDocument.

Parameters:

handle - The handle class instance to check type.

Returns:

See above.

isXNodeHandleInitialized

static boolean isXNodeHandleInitialized(handle handle)

Check the type of resource in handle. Return true if and only if handle contains resource of type XNodeRef.

Parameters:

handle - The handle class instance to check type.

Returns:

See above.

getNode

public org.w3c.dom.Node getNode()

Getting the Element backend object for this XEntity.

Returns:

The Element associated with object.

resourceDelete

protected boolean resourceDelete()

Delete the resource.

Overrides:

resourceDelete in class XCommonImpl

Returns:

true if the resource was deleted.

getSubType

public character getSubType()

Gets the the subtype of the object.

Specified by:

getSubType in interface SubTypeAttribute

Returns:

The character value of the subtype attribute.

setSubType

public void setSubType(character value)

Sets the the subtype of the object.

Specified by:

setSubType in interface SubTypeAttribute

Parameters:

value - The new value of the subtype object attribute.

setSubType

public void setSubType(java.lang.String value)

Sets the the subtype of the object.

Specified by:

setSubType in interface SubTypeAttribute

Parameters:

value - The new value of the subtype object attribute.

insertBefore

public logical insertBefore(handle handle1,
                            handle handle2)

Inserts a node as a child of this document before another node or last if other node is unknown.

Specified by:

insertBefore in interface XEntity

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.

getNumChildren

public integer getNumChildren()

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

Specified by:

getNumChildren in interface XEntity

Returns:

The integer number of the children.

replaceChild

public logical replaceChild(handle newChildHandle,
                            handle oldChildHandle)

Removing the specified child from the node.

Specified by:

replaceChild in interface XEntity

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.

appendChild

public logical appendChild(handle hChild)

Appending the new child to the current object.

Specified by:

appendChild in interface XEntity

Parameters:

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

Returns:

The true in case of success false otherwise.

getChild

public logical getChild(handle hChild,
                        int index)

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

Specified by:

getChild in interface XEntity

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

public logical getChild(handle hChild,
                        int64 index)

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

Specified by:

getChild in interface XEntity

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

public logical removeChild(handle hChild)

Removing the specified child from the node.

Specified by:

removeChild in interface XEntity

Parameters:

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

Returns:

The true in case of success false otherwise.

getUniqueID

public integer getUniqueID()

Gets the the unique ID number associated to this object by the underlying system. Not the same as the handle value itself. For X-noderef it's only unique for current xml Document.

Specified by:

getUniqueID in interface UniqueID

Returns:

The integer unique number of node inside document.

namespaceURI

public character namespaceURI()

Returns the value of the the NAMESPACE-URI attribute.

Specified by:

namespaceURI in interface NamespaceURI

Returns:

See above.

namespaceURI

public void namespaceURI(java.lang.String uri)

Setter for NAMESPACE-URI attribute. Calls HandleChain.readOnlyError(java.lang.String), as this attribute is r/o for this resource.

Specified by:

namespaceURI in interface NamespaceURI

Parameters:

uri - Not used.

namespaceURI

public void namespaceURI(character uri)

Setter for NAMESPACE-URI attribute. Calls HandleChain.readOnlyError(java.lang.String), as this attribute is r/o for this resource.

Specified by:

namespaceURI in interface NamespaceURI

Parameters:

uri - Not used.

removeAttribute

public logical removeAttribute(character name,
                               character uri)

Removes the specified attribute.

Specified by:

removeAttribute in interface XCommon

Parameters:

name - The name of the attribute to remove.

uri - The URI of the attribute to remove.

Returns:

The true in case of success false otherwise.

removeAttribute

public logical removeAttribute(NumberType index,
                               character uri)

Removes the specified attribute. This method is not applicable for Dom.

Specified by:

removeAttribute in interface XCommon

Parameters:

index - The 1-based index of the attribute to remove.

uri - The URI of the attribute to remove.

Returns:

The true in case of success false otherwise.

namespacePrefix

public void namespacePrefix(java.lang.String prefix)

Setter for NAMESPACE-PREFIX attribute.

Specified by:

namespacePrefix in interface NamespaceURI

Parameters:

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

namespacePrefix

public void namespacePrefix(character prefix)

Setter for NAMESPACE-PREFIX attribute.

Specified by:

namespacePrefix in interface NamespaceURI

Parameters:

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

namespacePrefix

public character namespacePrefix()

Returns the value of the the NAMESPACE-PREFIX attribute. Only for ELEMENT or ATTRIBUTE, for other attributes return unknown value.

Specified by:

namespacePrefix in interface NamespaceURI

Returns:

See above.

name

public character name()

Get the name attribute of handle.

Specified by:

name in interface Nameable

Overrides:

name in class HandleChain

Returns:

See above.

_name

public java.lang.String _name()

Get the name attribute of handle as a string.

Overrides:

_name in class HandleChain

Returns:

See above.

setNode

public void setNode(org.w3c.dom.Node xnode)

Setting the Element backend object for this XEntity.

Parameters:

xnode - The node value to set.

invalidNodeError

protected void invalidNodeError(java.lang.String attribute)

Process and display invalid node error. It displays appropriate error message.

Parameters:

attribute - The read-only attribute.

commonDomError

protected void commonDomError(java.lang.String attribute,
                              java.lang.String message)

Process and display unknown node error. It displays appropriate error message.

Parameters:

attribute - The read-only attribute.

message - Error message to display.

commonDomError

protected void commonDomError(java.lang.String attribute,
                              java.lang.String message,
                              boolean raiseError)

Process and display unknown node error. It displays appropriate error message.

Parameters:

attribute - The read-only attribute.

message - Error message to display.

raiseError - Flag indicating if an ERROR condition must be raised.

unsupportedDomError

protected void unsupportedDomError(java.lang.String type)

Process and display unsupported xml sub-type error. It displays appropriate error message.

Parameters:

type - The read-only attribute.

isInitialized

boolean isInitialized()

Reports if this object is not initialized. Initialized means that object is created but doesn't have any xml node. If the owner of node has been already deleted then node becomes uninitialized.

Returns:

true if object is initialized.