|
Oracle® XML Java API Reference 10g Release 1 (10.1) B12024-02 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
|
+--oracle.xml.parser.v2.XMLNode
|
+--oracle.xml.parser.v2.XMLNSNode
|
+--oracle.xml.parser.v2.XMLElement
This class implements the DOM Element Interface
| Field Summary | |
static short |
ANY_CONTENTTYPE |
static short |
ELEMENTS_CONTENTTYPE |
static short |
EMPTY_CONTENTTYPE |
static short |
MIXED_CONTENTTYPE |
| Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
| Fields inherited from interface org.w3c.dom.validation.ElementEditVAL |
VAL_ANY_CONTENTTYPE, VAL_ELEMENTS_CONTENTTYPE, VAL_EMPTY_CONTENTTYPE, VAL_MIXED_CONTENTTYPE, VAL_SIMPLE_CONTENTTYPE |
| Fields inherited from interface org.w3c.dom.validation.NodeEditVAL |
VAL_FALSE, VAL_INCOMPLETE, VAL_NS_WF, VAL_SCHEMA, VAL_TRUE, VAL_UNKNOWN, VAL_WF |
| Method Summary | |
short |
canAppendChild(Node newChild)Determines whether the Node.appendChild operation would make this document not compliant with the VAL_INCOMPLETE validity type. |
short |
canInsertBefore(Node newChild, Node refChild)Determines whether the Node.insertBefore operation would make this document not compliant with the VAL_INCOMPLETE validity type. |
short |
canRemoveAttribute(java.lang.String attrname)Verifies if an attribute by the given name can be removed. |
short |
canRemoveAttributeNode(Node attrNode)Determines if an attribute node can be removed. |
short |
canRemoveAttributeNS(java.lang.String namespaceURI, java.lang.String localName)Verifies if an attribute by the given local name and namespace can be removed. |
short |
canRemoveChild(Node oldChild)Determines whether the Node.removeChild operation would make this document not compliant with the VAL_INCOMPLETE validity type. |
short |
canReplaceChild(Node newChild, Node oldChild)Determines whether the Node.replaceChild operation would make this document not compliant with the VAL_INCOMPLETE validity type. |
short |
canSetAttribute(java.lang.String attrname, java.lang.String attrval)Determines if the value for specified attribute can be set. |
short |
canSetAttributeNode(Attr attrNode)Determines if an attribute node can be added. |
short |
canSetAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value)Determines if the attribute with given namespace and qualified name can be created if not already present in the attribute list of the element. |
short |
canSetTextContent(java.lang.String possibleTextContent)Determines if the text content of this node and its descendants can be set to the string passed in. |
NameList |
getAllowedAttributes()A NameList, as described in [DOM Level 3 Core] , of all possible attribute information items or wildcards that can appear as attributes of this element, or null if this element has no context or schema. |
NameList |
getAllowedChildren()A NameList, as described in [DOM Level 3 Core] , of all possible element information items or wildcards that can appear as children of this element, or null if this element has no context or schema. |
NameList |
getAllowedFirstChildren()A NameList, as described in [DOM Level 3 Core] , of all possible element information items or wildcards that can appear as a first child of this element, or null if this element has no context or schema. |
NameList |
getAllowedNextSiblings()A NameList, as described in [DOM Level 3 Core] , of all possible element information items or wildcards that can appear as a next sibling of this element, or null if this element has no context or schema. |
NameList |
getAllowedParents()A NameList, as described in [DOM Level 3 Core] , of all possible element information items that can appear as a parent this element, or null if this element has no context or schema. |
NameList |
getAllowedPreviousSiblings()A NameList, as described in [DOM Level 3 Core] , of all possible element information items or wildcards that can appear as a previous sibling of this element, or null if this element has no context or schema. |
java.lang.String |
getAttribute(java.lang.String name)Retrieves an attribute value by name. |
Attr |
getAttributeNode(java.lang.String name)Retrieves an Attr node by name. |
Attr |
getAttributeNode(java.lang.String name, java.lang.String namespace)Deprecated. As of DOM 2 |
Attr |
getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)Retrieves an Attr node by local name and namespace URI. |
java.lang.String |
getAttributeNS(java.lang.String namespaceURI, java.lang.String localName)Retrieves an attribute value by local name and namespace URI. |
NamedNodeMap |
getAttributes()A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. |
NodeList |
getChildrenByTagName(java.lang.String name)Returns a NodeList of all immediate children with a given tag name, |
NodeList |
getChildrenByTagName(java.lang.String name, java.lang.String ns)Returns a NodeList of all immediate children with a given tag name and namespace |
short |
getContentType()The content type of an element. |
java.lang.String |
getDefaultValue()The default value specified in an attribute or an element declaration or null if unspecified. |
NodeList |
getElementsByTagName(java.lang.String name)Returns a NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree. |
NodeList |
getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)Returns a NodeList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree. |
DOMStringList |
getEnumeratedValues()A DOMStringList, as described in [DOM Level 3 Core] , of distinct values for an attribute or an element declaration or null if unspecified. |
java.lang.String |
getExpandedName()Get the fully resolved name for this element. |
XMLNode |
getFirstAttribute()Retrieves the first Attr. |
java.lang.String |
getLocalName()Gets the Local Name of this node |
java.lang.String |
getNamespaceURI()Gets the namespace URI of this node. |
java.lang.String |
getNodeName()Gets the name of this node, depending on its type |
short |
getNodeType()Gets a code representing the type of the underlying object |
java.lang.String |
getPrefix()Get the namespace prefix for this element. |
java.lang.String |
getQualifiedName()Deprecated. - Use getNodeName |
NameList |
getRequiredAttributes()A NameList, as described in [DOM Level 3 Core] , of required attribute information items that must appear on this element, or null if this element has no context or schema. |
java.lang.String |
getTagName()Gets the name of the element. |
boolean |
hasAttribute(java.lang.String name)Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. |
boolean |
hasAttributeNS(java.lang.String namespaceURI, java.lang.String localName)Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value,false otherwise |
boolean |
hasAttributes()Returns whether this node (if it is an element) has any attributes. |
short |
isElementDefined(java.lang.String name)Determines if name is defined in the schema. |
short |
isElementDefinedNS(java.lang.String namespaceURI, java.lang.String name)Determines if name in this namespace is defined in the current context. |
short |
nodeValidity(short wFValidityCheckLevel)Determines if the node is valid relative to the validation type specified in valType. |
void |
normalize()Deprecated. As of DOM 2 |
void |
readExternal(java.io.ObjectInput inArg)This method restores the information written by writeExternal by reading the input stream and regenerating the objects as per the information of the input stream. |
void |
removeAttribute(java.lang.String name)Removes an attribute by name. |
Attr |
removeAttributeNode(Attr attr)Removes the specified attribute. |
void |
removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName)Removes an attribute by local name and namespace URI. |
void |
reportSAXEvents(ContentHandler cntHandler)Report SAX Events from a DOM Tree |
java.lang.String |
resolveNamespacePrefix(java.lang.String prefix)Given a namespace prefix, find the namespace definition in scope in this element. |
void |
setAttribute(java.lang.String name, java.lang.String value)Adds a new attribute. |
Attr |
setAttributeNode(Attr attr)Adds a new attribute. |
Attr |
setAttributeNodeNS(Attr newAttr)Adds a new attribute. |
void |
setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value)Adds a new attribute. |
void |
setPrefix(java.lang.String prefix)Sets the prefix of this node |
boolean |
validateContent(DTD dtd)Validates the content of a element node. |
boolean |
validateContent(XMLSchema schema)Validates the content of the element against given XML Schema |
boolean |
validateContent(XMLSchema schema, java.lang.String mode)Validates the content of the element against given XML Schema in the given mode. |
void |
writeExternal(java.io.ObjectOutput outArg)This method saves the state of the object by writing the object information in a binary compressed stream. |
| Methods inherited from class oracle.xml.parser.v2.XMLNSNode |
addText, addText, appendChild, getChildNodes, getFirstChild, getLastChild, getText, insertBefore, removeChild, replaceChild |
| Methods inherited from class oracle.xml.parser.v2.XMLNode |
addEventListener, cloneNode, dispatchEvent, getColumnNumber, getDebugMode, getLineNumber, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getPrimitiveTypeId, getProperty, getSystemId, getXMLError, hasChildNodes, isDocumentFlag, isNodeFlag, isSupported, print, print, print, print, removeEventListener, resetNodeFlag, selectNodes, selectNodes, selectSingleNode, selectSingleNode, setDebugInfo, setNodeFlag, setNodeFlag, setNodeFlag, setNodeValue, setProperty, transformNode, valueOf, valueOf |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.w3c.dom.Node |
appendChild, cloneNode, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, isSupported, removeChild, replaceChild, setNodeValue |
| Methods inherited from interface oracle.xml.util.NSName |
getNamespace |
| Methods inherited from interface org.w3c.dom.validation.ElementEditVAL |
getAllowedFirstChildElements |
| Field Detail |
public static final short EMPTY_CONTENTTYPE
public static final short ANY_CONTENTTYPE
public static final short MIXED_CONTENTTYPE
public static final short ELEMENTS_CONTENTTYPE
| Method Detail |
public short getNodeType()
getNodeType in interface NodegetNodeType in class XMLNodepublic java.lang.String getNodeName()
getNodeName in interface NodegetNodeName in class XMLNodepublic java.lang.String getTagName()
getTagName in interface Elementpublic java.lang.String getLocalName()
getLocalName in interface NodegetLocalName in class XMLNodepublic java.lang.String getNamespaceURI()
getNamespaceURI in interface NodegetNamespaceURI in class XMLNodepublic java.lang.String getPrefix()
getPrefix in interface NodegetPrefix in class XMLNode
public void setPrefix(java.lang.String prefix)
throws DOMException
setPrefix in interface NodesetPrefix in class XMLNodeprefix - set the prefixDOMException - if any DOM Exception occurspublic NamedNodeMap getAttributes()
NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.getAttributes in interface NodegetAttributes in class XMLNodepublic void normalize()
Text nodes in the full depth of the sub-tree underneath this Element into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are no adjacent Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular doc1ument tree structure are to be used.normalize in interface Nodenormalize in class XMLNSNodeXMLNode.normalize()public boolean hasAttribute(java.lang.String name)
hasAttribute in interface Element
public boolean hasAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
hasAttributeNS in interface Elementpublic boolean hasAttributes()
hasAttributes in interface NodehasAttributes in class XMLNodetrue if this node has any attributes, false otherwise.public java.lang.String getAttribute(java.lang.String name)
getAttribute in interface Elementname - The name of the attribute to retrieve.Attr value as a string, or the empty string if that attribute does not have a specified or default value.
public void setAttribute(java.lang.String name,
java.lang.String value)
throws DOMException
Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to assign it as the value of an attribute. This method is namespace unaware and hence wont result in update of namespace table if a new attr is added thru this methodsetAttribute in interface Elementname - The name of the attribute to create or alter.value - Value to set in string form.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.
public void removeAttribute(java.lang.String name)
throws DOMException
removeAttribute in interface Elementname - The name of the attribute to remove.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public java.lang.String getAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
getAttributeNS in interface ElementnamespaceURI - namespace of the attribute requestedlocalName - local name of the attribute requested
public void setAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String value)
throws DOMException
setAttributeNS in interface ElementnamespaceURI - namespace of the attribute to be addedqualifiedName - qualified name of the attribute to be addedvalue - value of the attribute to be addedDOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains illegal Characters NAMESPACE_ERR : Raised if the qualified name is malformed if the qualified name has a prefix and the namespace URI is null or an empty string,or if the qulaifiedName is "xmlns" and namespace URI is different from "http://www.w3.org/2000/xmlns/" ,or if qualifiedName has a prefix that is "xml" and the namespaceURI is different from http://www.w3.org/XML/1998/namespaces NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly
public void removeAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
throws DOMException
removeAttributeNS in interface ElementDOMEXception - NO_MODIFICATIONS_ALLOWED_ERR : if this element is readonlyDOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.public Attr getAttributeNode(java.lang.String name)
Attr node by name.getAttributeNode in interface Elementname - The name of the attribute to retrieve.Attr node with the specified attribute name or null if there is no such attribute.
public Attr setAttributeNode(Attr attr)
throws DOMException
setAttributeNode in interface ElementnewAttr attribute replaces an existing attribute with the same name, the previously existing Attr node is returned, otherwise null is returned.DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
public Attr removeAttributeNode(Attr attr)
throws DOMException
removeAttributeNode in interface ElementAttr node that was removed.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.oldAttr is not an attribute of the element.
public Attr getAttributeNodeNS(java.lang.String namespaceURI,
java.lang.String localName)
getAttributeNodeNS in interface ElementnamespaceURI - namespace URIlocalName - the attribute to be retrieved
public Attr setAttributeNodeNS(Attr newAttr)
throws DOMException
setAttributeNodeNS in interface ElementnewAttr - node to be addedDOMException - WRONG_DOCUMENT_ERR : raised if the newAttr was created from a document different from the one that created the document NO_MODIFICATIONS_ALLOWED_ERR :Raised if this element is readonly INUSE_ATTRIBUTE_ERR : Raised if newAttr is already an attribute of another Element objectpublic NodeList getElementsByTagName(java.lang.String name)
NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree.getElementsByTagName in interface Elementname - The name of the tag to match on. The special value "*" matches all tags.Element nodes.
public NodeList getElementsByTagNameNS(java.lang.String namespaceURI,
java.lang.String localName)
getElementsByTagNameNS in interface ElementnamespaceURI - the namespace of the elementlocalName - the local name of the elementNodeList object containing all the matched Elements.public java.lang.String getDefaultValue()
null if unspecified. Elena wanted mention of XML Schema's canonical lexical representation here. Why?getDefaultValue in interface NodeEditVALgetDefaultValue in class XMLNodepublic DOMStringList getEnumeratedValues()
DOMStringList, as described in [DOM Level 3 Core] , of distinct values for an attribute or an element declaration or null if unspecified. Elena wanted mention of XML Schema's canonical lexical representation here. Why?getEnumeratedValues in interface NodeEditVALgetEnumeratedValues in class XMLNodepublic short canInsertBefore(Node newChild, Node refChild)
Node.insertBefore operation would make this document not compliant with the VAL_INCOMPLETE validity type.canInsertBefore in interface NodeEditVALcanInsertBefore in class XMLNodenewChild - Node to be inserted.refChild - Reference Node.public short canRemoveChild(Node oldChild)
Node.removeChild operation would make this document not compliant with the VAL_INCOMPLETE validity type.canRemoveChild in interface NodeEditVALcanRemoveChild in class XMLNodeoldChild - Node to be removed.public short canReplaceChild(Node newChild, Node oldChild)
Node.replaceChild operation would make this document not compliant with the VAL_INCOMPLETE validity type.canReplaceChild in interface NodeEditVALcanReplaceChild in class XMLNodenewChild - New Node.oldChild - Node to be replaced.public short canAppendChild(Node newChild)
Node.appendChild operation would make this document not compliant with the VAL_INCOMPLETE validity type.canAppendChild in interface NodeEditVALcanAppendChild in class XMLNodenewChild - Node to be appended.public short nodeValidity(short wFValidityCheckLevel)
valType. This operation doesn't normalize before checking if it is valid. To do so, one would need to explicitly call a normalize method. The difference between this method and the validateDocument method on the DocumentVAL interface is that validateDocument only checks to determine whether the entire document is valid.nodeValidity in interface NodeEditVALnodeValidity in class XMLNodewFValidityCheckLevel - Flag to tell at what level validity and well-formedness checking is done.public NameList getAllowedChildren()
NameList, as described in [DOM Level 3 Core] , of all possible element information items or wildcards that can appear as children of this element, or null if this element has no context or schema. Duplicate pairs of {namespaceURI, name} are eliminated.getAllowedChildren in interface ElementEditVALpublic NameList getAllowedFirstChildren()
NameList, as described in [DOM Level 3 Core] , of all possible element information items or wildcards that can appear as a first child of this element, or null if this element has no context or schema. Duplicate pairs of {namespaceURI, name} are eliminated.public NameList getAllowedParents()
NameList, as described in [DOM Level 3 Core] , of all possible element information items that can appear as a parent this element, or null if this element has no context or schema.getAllowedParents in interface ElementEditVALpublic NameList getAllowedNextSiblings()
NameList, as described in [DOM Level 3 Core] , of all possible element information items or wildcards that can appear as a next sibling of this element, or null if this element has no context or schema. Duplicate pairs of {namespaceURI, name} are eliminated.getAllowedNextSiblings in interface ElementEditVALpublic NameList getAllowedPreviousSiblings()
NameList, as described in [DOM Level 3 Core] , of all possible element information items or wildcards that can appear as a previous sibling of this element, or null if this element has no context or schema.getAllowedPreviousSiblings in interface ElementEditVALpublic NameList getAllowedAttributes()
ElementEditVALNameList, as described in [DOM Level 3 Core] , of all possible attribute information items or wildcards that can appear as attributes of this element, or null if this element has no context or schema. Duplicate pairs of {namespaceURI, name} are eliminated.getAllowedAttributes in interface ElementEditVALpublic NameList getRequiredAttributes()
NameList, as described in [DOM Level 3 Core] , of required attribute information items that must appear on this element, or null if this element has no context or schema. Duplicate pairs of {namespaceURI, name} are eliminated.getRequiredAttributes in interface ElementEditVALpublic short getContentType()
getContentType in interface ElementEditVAL
public short canSetAttribute(java.lang.String attrname,
java.lang.String attrval)
canSetAttribute in interface ElementEditVALattrname - Name of attribute.attrval - Value to be assigned to the attribute.public short canSetAttributeNode(Attr attrNode)
canSetAttributeNode in interface ElementEditVALattrNode - Node in which the attribute can possibly be set.
public short canSetAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String value)
setAttributeNS.canSetAttributeNS in interface ElementEditVALnamespaceURI - namespaceURI of namespace.qualifiedName - Qualified name of attribute.value - Value to be assigned to the attribute.public short canRemoveAttribute(java.lang.String attrname)
canRemoveAttribute in interface ElementEditVALattrname - Name of attribute.
public short canRemoveAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
canRemoveAttributeNS in interface ElementEditVALnamespaceURI - The namespace URI of the attribute to remove.localName - Local name of the attribute to be removed.public short canRemoveAttributeNode(Node attrNode)
canRemoveAttributeNode in interface ElementEditVALattrNode - The Attr node to remove from the attribute list.public short canSetTextContent(java.lang.String possibleTextContent)
possibleTextContent - Possible text content string.public short isElementDefined(java.lang.String name)
name is defined in the schema. This only applies to global declarations.isElementDefined in interface ElementEditVALname - Name of element.
public short isElementDefinedNS(java.lang.String namespaceURI,
java.lang.String name)
name in this namespace is defined in the current context. Thus not only does this apply to global declarations . but depending on the content, this may also apply to local definitions.isElementDefinedNS in interface ElementEditVALnamespaceURI - namespaceURI of namespace.name - Name of element.public java.lang.String getExpandedName()
getExpandedName in interface NSNamepublic XMLNode getFirstAttribute()
Attr.Attr node null if there is no attribute.public java.lang.String resolveNamespacePrefix(java.lang.String prefix)
resolveNamespacePrefix in interface NSResolverprefix - Namespace prefix to be resolved if the prefix == #default, return the default namespacepublic NodeList getChildrenByTagName(java.lang.String name)
NodeList of all immediate children with a given tag name,name - The name of the tag to match on.
public NodeList getChildrenByTagName(java.lang.String name,
java.lang.String ns)
NodeList of all immediate children with a given tag name and namespacename - The name of the tag to match on. (should be local name)ns - The name space
public void reportSAXEvents(ContentHandler cntHandler)
throws SAXException
reportSAXEvents in class XMLNodecntHandler - ContentHandlerSAXException - thrown by SAX Callback functionspublic boolean validateContent(DTD dtd)
public boolean validateContent(XMLSchema schema)
throws XMLParseException
schema - schema used to validateXMLParseException
public boolean validateContent(XMLSchema schema,
java.lang.String mode)
throws XMLParseException
mode - - the validation modeXMLParseException
public void writeExternal(java.io.ObjectOutput outArg)
throws java.io.IOException
writeExternal in interface java.io.ExternalizablewriteExternal in class XMLNodeoutArg - The ObjectOutput stream used to write the serialized/ comressed stream.java.io.IOException - is thrown when there is an exception while writing the compressed stream.
public void readExternal(java.io.ObjectInput inArg)
throws java.io.IOException,
java.lang.ClassNotFoundException
readExternal in interface java.io.ExternalizablereadExternal in class XMLNodeinArg - the ObjectInput used for reading the compressed streamjava.io.IOException - is thrown when there is an exception reading the compressed stream.java.lang.ClassNotFoundException - is thrown when the class is not found
public Attr getAttributeNode(java.lang.String name,
java.lang.String namespace)
getAttributeNodeNS(String ,String)public java.lang.String getQualifiedName()
getQualifiedName in interface NSName
|
Oracle® XML Java API Reference 10g Release 1 (10.1) B12024-02 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||