BEA Systems, Inc.

WebLogic Server 6.1 API Reference

weblogic.apache.xalan.lib.sql
Class ColumnHeader

java.lang.Object
  |
  +--weblogic.apache.xml.utils.UnImplNode
        |
        +--weblogic.apache.xalan.lib.sql.StreamableNode
              |
              +--weblogic.apache.xalan.lib.sql.ColumnHeader

public class ColumnHeader
extends StreamableNode
implements org.w3c.dom.NamedNodeMap

This class represents a column-header Node, which contains the metadata for a column.

This class is based on an implementation from the Apache XML Project. In future releases the XML parser, XSLT processor, and associated classes will likely be updated to be based on a later version of the Apache implementations. Since Apache does not guarantee backwards compatibility between versions of their software, we cannot guarantee backwards compatibility of any of the classes contained in the weblogic.apache package or sub-packages.


Constructor Summary
ColumnHeader(XStatement statement, RowSet parent, int columnIndex, java.sql.ResultSetMetaData metaData)
          Constructor ColumnHeader
 
Method Summary
 org.w3c.dom.NamedNodeMap getAttributes()
          Return the metadata for this column.
 org.w3c.dom.Node getFirstChild()
          getFirstChild - Always returns null.
 int getLength()
          Get the number of attributes of column metadata attributes.
 org.w3c.dom.Node getNamedItem(java.lang.String name)
          Get an attribute by name from the metadata for this column.
 org.w3c.dom.Node getNamedItemNS(java.lang.String namespaceURI, java.lang.String localName)
          Get an attribute by namespaced name from the metadata for this column.
 org.w3c.dom.Node getNextSibling()
          Returns column-header Node for the next column.
 java.lang.String getNodeName()
          Return Node name, "column-header".
 org.w3c.dom.Node getParentNode()
          The parent node of a column-header Node is the row-set Node.
 boolean hasChildNodes()
          Tell if there are any children of the column-header Node, which is always false.
 org.w3c.dom.Node item(int index)
          Get an attribute by index from the metadata for this column.
 org.w3c.dom.Node removeNamedItem(java.lang.String name)
          Remove an attribute - Not supported
 org.w3c.dom.Node removeNamedItemNS(java.lang.String namespaceURI, java.lang.String localName)
          Removed namespaced attribute - Not supported
 org.w3c.dom.Node setNamedItem(org.w3c.dom.Node arg)
          Set an attribute from the metadata for this column.
 org.w3c.dom.Node setNamedItemNS(org.w3c.dom.Node arg)
          Set namespaced attribute - Not supported
 
Methods inherited from class weblogic.apache.xalan.lib.sql.StreamableNode
getLocalName, getNamespaceURI, getNodeTest, getNodeType, getOwnerDocument, getPrefix, getUid, getXStatement, isSupported, setNodeTest
 
Methods inherited from class weblogic.apache.xml.utils.UnImplNode
appendChild, appendData, cloneNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, error, error, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildNodes, getDoctype, getDocumentElement, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getLastChild, getNodeValue, getOwnerElement, getPreviousSibling, getSpecified, getTagName, hasAttribute, hasAttributeNS, hasAttributes, importNode, insertBefore, insertData, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, replaceChild, replaceData, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setData, setNodeValue, setPrefix, setValue, splitText, substringData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ColumnHeader

public ColumnHeader(XStatement statement,
                    RowSet parent,
                    int columnIndex,
                    java.sql.ResultSetMetaData metaData)
Constructor ColumnHeader

Parameters:
statement - Owning document
parent - Parent node, a row-set
columnIndex - Index of column this header is for
metaData - Meta data
Method Detail

getNodeName

public java.lang.String getNodeName()
Return Node name, "column-header".

Returns:
"column-header".
Overrides:
getNodeName in class UnImplNode

getFirstChild

public org.w3c.dom.Node getFirstChild()
getFirstChild - Always returns null.

Returns:
null
Overrides:
getFirstChild in class UnImplNode

getNextSibling

public org.w3c.dom.Node getNextSibling()
Returns column-header Node for the next column.

Returns:
a ColumnHeader Node or null.
Overrides:
getNextSibling in class UnImplNode

getParentNode

public org.w3c.dom.Node getParentNode()
The parent node of a column-header Node is the row-set Node.

Returns:
a RowSet.
Overrides:
getParentNode in class UnImplNode

hasChildNodes

public boolean hasChildNodes()
Tell if there are any children of the column-header Node, which is always false.

Returns:
false
Overrides:
hasChildNodes in class UnImplNode

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()
Return the metadata for this column.

Returns:
This node.
Overrides:
getAttributes in class StreamableNode

getNamedItem

public org.w3c.dom.Node getNamedItem(java.lang.String name)
Get an attribute by name from the metadata for this column.
Specified by:
getNamedItem in interface org.w3c.dom.NamedNodeMap

Parameters:
name - Attribute name
Returns:
Attribute with given name or null if not found
Overrides:
getNamedItem in class StreamableNode

item

public org.w3c.dom.Node item(int index)
Get an attribute by index from the metadata for this column.
Specified by:
item in interface org.w3c.dom.NamedNodeMap

Parameters:
index - Index of attribut to get
Returns:
Attribute node at given index or null if not found
Overrides:
item in class StreamableNode

getLength

public int getLength()
Get the number of attributes of column metadata attributes.
Specified by:
getLength in interface org.w3c.dom.NamedNodeMap

Returns:
the number of attributes of column
Overrides:
getLength in class StreamableNode

getNamedItemNS

public org.w3c.dom.Node getNamedItemNS(java.lang.String namespaceURI,
                                       java.lang.String localName)
Get an attribute by namespaced name from the metadata for this column.
Specified by:
getNamedItemNS in interface org.w3c.dom.NamedNodeMap

Parameters:
namespaceURI - Namespace URI of attribute
localName - Local name of attribute
Returns:
the attribute with the given local name and a null namespace, or null.
Overrides:
getNamedItemNS in class StreamableNode

setNamedItem

public org.w3c.dom.Node setNamedItem(org.w3c.dom.Node arg)
                              throws org.w3c.dom.DOMException
Set an attribute from the metadata for this column. Not supported
Specified by:
setNamedItem in interface org.w3c.dom.NamedNodeMap

Parameters:
arg -  
Returns:
null
Throws:
org.w3c.dom.DOMException -  
Overrides:
setNamedItem in class StreamableNode

removeNamedItem

public org.w3c.dom.Node removeNamedItem(java.lang.String name)
                                 throws org.w3c.dom.DOMException
Remove an attribute - Not supported
Specified by:
removeNamedItem in interface org.w3c.dom.NamedNodeMap

Parameters:
name -  
Returns:
null
Throws:
org.w3c.dom.DOMException -  
Overrides:
removeNamedItem in class StreamableNode

setNamedItemNS

public org.w3c.dom.Node setNamedItemNS(org.w3c.dom.Node arg)
                                throws org.w3c.dom.DOMException
Set namespaced attribute - Not supported
Specified by:
setNamedItemNS in interface org.w3c.dom.NamedNodeMap

Parameters:
arg -  
Returns:
null
Throws:
org.w3c.dom.DOMException -  
Overrides:
setNamedItemNS in class StreamableNode

removeNamedItemNS

public org.w3c.dom.Node removeNamedItemNS(java.lang.String namespaceURI,
                                          java.lang.String localName)
                                   throws org.w3c.dom.DOMException
Removed namespaced attribute - Not supported
Specified by:
removeNamedItemNS in interface org.w3c.dom.NamedNodeMap

Parameters:
namespaceURI -  
localName -  
Returns:
null
Throws:
org.w3c.dom.DOMException -  
Overrides:
removeNamedItemNS in class StreamableNode

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs61

WebLogic classes and methods that do not appear in this reference are not public and are not supported.