public abstract class XEntityImpl extends XCommonImpl implements XEntity
Modifier and Type | Field and Description |
---|---|
(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 integer |
uniqueID
Corresponds to UNIQUE-ID attribute.
|
private org.w3c.dom.Node |
xnode
Element associates with current XEntity class.
|
isValid
name, nextSibling, prevSibling
instProc
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
logical |
getChild(handle hChild,
int index)
Getting the handle object of the child node with specified index.
|
logical |
getChild(handle hChild,
integer index)
Getting the handle object of the child node with specified index.
|
character |
getNamespacePrefix()
Returns the value of the the NAMESPACE-PREFIX attribute.
|
character |
getNamespaceURI()
Returns the value of the the NAMESPACE-URI attribute.
|
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. |
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 |
setNamespacePrefix(character prefix)
Setter for NAMESPACE-PREFIX attribute.
|
void |
setNamespacePrefix(java.lang.String prefix)
Setter for NAMESPACE-PREFIX attribute.
|
void |
setNamespaceURI(character uri)
Setter for NAMESPACE-URI attribute.
|
void |
setNamespaceURI(java.lang.String uri)
Setter for NAMESPACE-URI attribute.
|
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.
|
addSchemaLocation, addSchemaLocation, addSchemaLocation, addSchemaLocation, getNonamespaceSchemaLocation, hasNextSibling, hasPrevSibling, invalidArgumentAssignError, invalidArgumentError, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, setNonamespaceSchemaLocation, setNonamespaceSchemaLocation, valid
delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameReadOnly, hasParent, hasPrivateData, interlink, isChained, lastResource, lastResource, name, name, readOnlyError, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData
getResourceType, id, id, implicitDeletion, instantiatingProcedure, invalidAttribute, setInstantiatingProcedure, type, unknown
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getChildNum, getOwnerDocument
addSchemaLocation, addSchemaLocation, addSchemaLocation, addSchemaLocation, getNonamespaceSchemaLocation, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, removeAttribute, setNonamespaceSchemaLocation, setNonamespaceSchemaLocation
id, id, unknown, valid
getResourceType
static final java.lang.String IS_INVALID_NODE
private org.w3c.dom.Node xnode
private integer uniqueID
protected XEntityImpl(UniqueIdGenerator.IdKind idKind)
idKind
- The discriminator for unique id allocation.protected XEntityImpl(org.w3c.dom.Node node, UniqueIdGenerator.IdKind idKind)
node
- The DOM XML node object to be associated with the given
handle object.idKind
- The discriminator for unique id allocation.static void setNodeToHandle(handle handle, org.w3c.dom.Node node)
handle
- The handle class instance to set new node value.node
- The node value to set.static boolean isXNodeHandle(handle handle)
true
if and only if handle
contains resource of type XNodeRef.handle
- The handle class instance to check type.static boolean isXEntityHandle(handle handle)
true
if and only if handle
contains resource of type XNodeRef or XDocument.handle
- The handle class instance to check type.static boolean isXNodeHandleInitialized(handle handle)
true
if and only if handle
contains resource of type XNodeRef.handle
- The handle class instance to check type.public org.w3c.dom.Node getNode()
protected boolean resourceDelete()
resourceDelete
in class XCommonImpl
true
if the resource was deleted.public character getSubType()
getSubType
in interface SubTypeAttribute
public void setSubType(character value)
setSubType
in interface SubTypeAttribute
value
- The new value of the subtype object attribute.public void setSubType(java.lang.String value)
setSubType
in interface SubTypeAttribute
value
- The new value of the subtype object attribute.public logical insertBefore(handle handle1, handle handle2)
insertBefore
in interface XEntity
handle1
- The handle representing the child to insert.handle2
- The handle representing the XML node to be inserted before.true
in case of success false
otherwise.public integer getNumChildren()
getNumChildren
in interface XEntity
public logical replaceChild(handle newChildHandle, handle oldChildHandle)
replaceChild
in interface XEntity
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.true
in case of success false
otherwise.public logical appendChild(handle hChild)
appendChild
in interface XEntity
hChild
- The valid handle class instance of the child to be appended.true
in case of success false
otherwise.public logical getChild(handle hChild, int index)
public logical getChild(handle hChild, integer index)
public logical removeChild(handle hChild)
removeChild
in interface XEntity
hChild
- The valid handle class instance of the child to be removed.true
in case of success
false
otherwise.public integer getUniqueID()
getUniqueID
in interface UniqueID
public character getNamespaceURI()
getNamespaceURI
in interface NamespaceURI
public void setNamespaceURI(java.lang.String uri)
HandleChain.readOnlyError(java.lang.String)
, as this attribute is r/o
for this resource.setNamespaceURI
in interface NamespaceURI
uri
- Not used.public void setNamespaceURI(character uri)
HandleChain.readOnlyError(java.lang.String)
, as this attribute is r/o
for this resource.setNamespaceURI
in interface NamespaceURI
uri
- Not used.public logical removeAttribute(character name, character uri)
removeAttribute
in interface XCommon
name
- The name of the attribute to remove.uri
- The URI of the attribute to remove.true
in case of success false
otherwise.public logical removeAttribute(NumberType index, character uri)
removeAttribute
in interface XCommon
index
- The 1-based index of the attribute to remove.uri
- The URI of the attribute to remove.true
in case of success false
otherwise.public void setNamespacePrefix(java.lang.String prefix)
setNamespacePrefix
in interface XEntity
prefix
- The new value of the NAMESPACE-PREFIX attribute.public void setNamespacePrefix(character prefix)
setNamespacePrefix
in interface XEntity
prefix
- The new value of the NAMESPACE-PREFIX attribute.public character getNamespacePrefix()
getNamespacePrefix
in interface XEntity
public character name()
name
attribute of handle.name
in interface Nameable
name
in class HandleChain
public void setNode(org.w3c.dom.Node xnode)
xnode
- The node value to set.protected void invalidNodeError(java.lang.String attribute)
attribute
- The read-only attribute.protected void commonDomError(java.lang.String attribute, java.lang.String message)
attribute
- The read-only attribute.message
- Error message to display.protected void unsupportedDomError(java.lang.String type)
type
- The read-only attribute.boolean isInitialized()
true
if object is initialized.