You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by mm...@locus.apache.org on 2000/12/14 20:06:18 UTC
cvs commit: xml-xalan/java/src/org/apache/xalan/lib/sql Column.java ColumnAttribute.java ColumnData.java ColumnHeader.java Row.java RowSet.java StreamableNode.java XConnection.java XStatement.java
mmidy 00/12/14 11:06:17
Modified: java/src/org/apache/xalan/lib/sql Column.java
ColumnAttribute.java ColumnData.java
ColumnHeader.java Row.java RowSet.java
StreamableNode.java XConnection.java
XStatement.java
Log:
Javadoc updates
Revision Changes Path
1.4 +14 -14 xml-xalan/java/src/org/apache/xalan/lib/sql/Column.java
Index: Column.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/Column.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Column.java 2000/10/30 18:56:31 1.3
+++ Column.java 2000/12/14 19:06:05 1.4
@@ -70,26 +70,26 @@
public class Column extends StreamableNode
{
- /** NEEDSDOC Field m_columnIndex */
+ /** column Index */
int m_columnIndex;
- /** NEEDSDOC Field m_parent */
+ /** Parent row node */
Row m_parent;
- /** NEEDSDOC Field DEBUG */
+ /** Flag indicating if in DEBUG mode */
private static final boolean DEBUG = false;
- /** NEEDSDOC Field m_text */
+ /** Column data */
ColumnData m_text;
/**
* Constructor Column
*
*
- * NEEDSDOC @param statement
- * NEEDSDOC @param parent
- * NEEDSDOC @param columnIndex
- * NEEDSDOC @param metadata
+ * @param statement Current Document
+ * @param parent Parent row node of this column
+ * @param columnIndex Index for this column
+ * @param metadata Meta data (column header).
*/
public Column(XStatement statement, Row parent, int columnIndex,
ResultSetMetaData metadata)
@@ -105,7 +105,7 @@
/**
* The parent of col is #Document (represented by XStatement).
*
- * NEEDSDOC ($objectName$) @return
+ * @return The parent of this column
*/
public Document getOwnerDocument()
{
@@ -115,7 +115,7 @@
/**
* Return "col".
*
- * NEEDSDOC ($objectName$) @return
+ * @return the deault column name "col".
*/
public String getNodeName()
{
@@ -125,7 +125,7 @@
/**
* Return the col text node (the column value).
*
- * NEEDSDOC ($objectName$) @return
+ * @return the column value
*/
public Node getFirstChild()
{
@@ -158,7 +158,7 @@
/**
* The parent node of col is a row.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The parent node of this column
*/
public Node getParentNode()
{
@@ -174,7 +174,7 @@
* which is always true. I.e., col contains a text node
* with a textual representation of the column value.
*
- * NEEDSDOC ($objectName$) @return
+ * @return True
*/
public boolean hasChildNodes()
{
@@ -188,7 +188,7 @@
/**
* Return the metadata for this column.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the metadata for this column(column header).
*/
public NamedNodeMap getAttributes()
{
1.4 +74 -73 xml-xalan/java/src/org/apache/xalan/lib/sql/ColumnAttribute.java
Index: ColumnAttribute.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/ColumnAttribute.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ColumnAttribute.java 2000/10/30 18:56:32 1.3
+++ ColumnAttribute.java 2000/12/14 19:06:05 1.4
@@ -97,130 +97,130 @@
public class ColumnAttribute extends StreamableNode implements Attr
{
- /** NEEDSDOC Field m_owner */
+ /** Column owning this attribute */
Element m_owner;
- /** NEEDSDOC Field m_metadata */
+ /** Meta data (column header) */
ResultSetMetaData m_metadata;
- /** NEEDSDOC Field m_name */
+ /** Attribute name */
String m_name;
- /** NEEDSDOC Field m_type */
+ /** Attribute type */
int m_type;
- /** NEEDSDOC Field m_columnIndex */
+ /** Owner Column index */
int m_columnIndex;
- /** NEEDSDOC Field m_columnAttr */
+ /** Column attribute */
ColumnAttribute m_columnAttr;
- /** NEEDSDOC Field S_ISTRUE */
+ /** Constant for ISTRUE */
static final String S_ISTRUE = "true";
- /** NEEDSDOC Field S_ISFALSE */
+ /** Constant for ISFALSE */
static final String S_ISFALSE = "false";
- /** NEEDSDOC Field CATALOGUE_NAME */
+ /** Constant for CATALOGUE_NAME */
public static final int CATALOGUE_NAME = 0;
- /** NEEDSDOC Field DISPLAY_SIZE */
+ /** Constnat for DISPLAY_SIZE */
public static final int DISPLAY_SIZE = 1;
- /** NEEDSDOC Field COLUMN_LABEL */
+ /** Constant for COLUMN_LABEL */
public static final int COLUMN_LABEL = 2;
- /** NEEDSDOC Field COLUMN_NAME */
+ /** Constant for COLUMN_NAME */
public static final int COLUMN_NAME = 3;
- /** NEEDSDOC Field COLUMN_TYPE */
+ /** Constant for COLUMN_TYPE */
public static final int COLUMN_TYPE = 4;
- /** NEEDSDOC Field COLUMN_TYPENAME */
+ /** Constant for COLUMN_TYPENAME */
public static final int COLUMN_TYPENAME = 5;
- /** NEEDSDOC Field PRECISION */
+ /** Constant for PRECISION */
public static final int PRECISION = 6;
- /** NEEDSDOC Field SCALE */
+ /** Constant for SCALE */
public static final int SCALE = 7;
- /** NEEDSDOC Field SCHEMA_NAME */
+ /** Constant for SCHEMA_NAME */
public static final int SCHEMA_NAME = 8;
- /** NEEDSDOC Field TABLE_NAME */
+ /** Constant for TABLE_NAME */
public static final int TABLE_NAME = 9;
- /** NEEDSDOC Field CASESENSITIVE */
+ /** Constant for CASESENSITIVE */
public static final int CASESENSITIVE = 10;
- /** NEEDSDOC Field DEFINATELYWRITABLE */
+ /** Constant for DEFINATELYWRITABLE */
public static final int DEFINATELYWRITABLE = 11;
- /** NEEDSDOC Field ISNULLABLE */
+ /** Constant for ISNULLABLE */
public static final int ISNULLABLE = 12;
- /** NEEDSDOC Field ISSIGNED */
+ /** Constant for ISSIGNED */
public static final int ISSIGNED = 13;
- /** NEEDSDOC Field ISWRITEABLE */
+ /** Constant for ISWRITEABLE */
public static final int ISWRITEABLE = 14;
- /** NEEDSDOC Field ISSEARCHABLE */
+ /** Constant for ISSEARCHABLE */
public static final int ISSEARCHABLE = 15;
- /** NEEDSDOC Field NUMBER_ATTRIBUTES */
+ /** Constant for NUMBER_ATTRIBUTES */
public static final int NUMBER_ATTRIBUTES = 16;
- /** NEEDSDOC Field S_CATALOGUE_NAME */
+ /** Constant for S_CATALOGUE_NAME */
public static final String S_CATALOGUE_NAME = "catalogue-name";
- /** NEEDSDOC Field S_DISPLAY_SIZE */
+ /** Constant for S_DISPLAY_SIZE */
public static final String S_DISPLAY_SIZE = "column-display-size";
- /** NEEDSDOC Field S_COLUMN_LABEL */
+ /** Constant for S_COLUMN_LABEL */
public static final String S_COLUMN_LABEL = "column-label";
- /** NEEDSDOC Field S_COLUMN_NAME */
+ /** Constant for S_COLUMN_NAME */
public static final String S_COLUMN_NAME = "column-name";
- /** NEEDSDOC Field S_COLUMN_TYPE */
+ /** Constant for S_COLUMN_TYPE */
public static final String S_COLUMN_TYPE = "column-type";
- /** NEEDSDOC Field S_COLUMN_TYPENAME */
+ /** Constant for S_COLUMN_TYPENAME */
public static final String S_COLUMN_TYPENAME = "column-type-name";
- /** NEEDSDOC Field S_PRECISION */
+ /** Constant for S_PRECISION */
public static final String S_PRECISION = "precision";
- /** NEEDSDOC Field S_SCALE */
+ /** Constant for S_SCALE */
public static final String S_SCALE = "scale";
- /** NEEDSDOC Field S_SCHEMA_NAME */
+ /** Constant for S_SCHEMA_NAME */
public static final String S_SCHEMA_NAME = "schema-name";
- /** NEEDSDOC Field S_TABLE_NAME */
+ /** Constant for S_TABLE_NAME */
public static final String S_TABLE_NAME = "table-name";
- /** NEEDSDOC Field S_CASESENSITIVE */
+ /** Constant for S_CASESENSITIVE */
public static final String S_CASESENSITIVE = "case-sensitive";
- /** NEEDSDOC Field S_DEFINATELYWRITABLE */
+ /** Constant for S_DEFINATELYWRITABLE */
public static final String S_DEFINATELYWRITABLE = "definitely-writable";
- /** NEEDSDOC Field S_ISNULLABLE */
+ /** Constant for S_ISNULLABLE */
public static final String S_ISNULLABLE = "nullable";
- /** NEEDSDOC Field S_ISSIGNED */
+ /** Constant for S_ISSIGNED */
public static final String S_ISSIGNED = "signed";
- /** NEEDSDOC Field S_ISWRITEABLE */
+ /** Constant for S_ISWRITEABLE */
public static final String S_ISWRITEABLE = "writable";
- /** NEEDSDOC Field S_ISSEARCHABLE */
+ /** Constant for S_ISSEARCHABLE */
public static final String S_ISSEARCHABLE = "searchable";
- /** NEEDSDOC Field m_namelookup */
+ /** Table of column attribute names */
static java.util.Hashtable m_namelookup = new java.util.Hashtable();
static
@@ -247,11 +247,11 @@
* Constructor ColumnAttribute
*
*
- * NEEDSDOC @param statement
- * NEEDSDOC @param owner
- * NEEDSDOC @param columnIndex
- * NEEDSDOC @param type
- * NEEDSDOC @param metadata
+ * @param statement Owning document
+ * @param owner Column owning this attribute
+ * @param columnIndex Owning column index
+ * @param type attribute type
+ * @param metadata Column header
*/
public ColumnAttribute(XStatement statement, Element owner,
int columnIndex, int type,
@@ -267,12 +267,13 @@
}
/**
- * NEEDSDOC Method getAttrNameFromPos
+ * Get column attribute name using constant value
*
*
- * NEEDSDOC @param pos
+ * @param pos Constant value of attribute
*
- * NEEDSDOC (getAttrNameFromPos) @return
+ * @return Attribute name corresponding to the given value
+ * or null if not found
*/
static String getAttrNameFromPos(int pos)
{
@@ -317,12 +318,12 @@
}
/**
- * NEEDSDOC Method getAttrPosFromName
+ * Get attribute constant value from name
*
*
- * NEEDSDOC @param name
+ * @param name Name of attribute
*
- * NEEDSDOC (getAttrPosFromName) @return
+ * @return Attribute value or -1 if not found
*/
static int getAttrPosFromName(String name)
{
@@ -338,12 +339,12 @@
}
/**
- * NEEDSDOC Method setName
+ * Set column name
*
*
- * NEEDSDOC @param name
+ * @param name column attribute name
*
- * NEEDSDOC (setName) @return
+ * @return True if the name is found in the lookup table
*/
public boolean setName(String name)
{
@@ -356,10 +357,10 @@
}
/**
- * NEEDSDOC Method getNodeName
+ * Get the column name
*
*
- * NEEDSDOC (getNodeName) @return
+ * @return the column name
*/
public String getNodeName()
{
@@ -367,10 +368,10 @@
}
/**
- * NEEDSDOC Method getName
+ * Get the column name
*
*
- * NEEDSDOC (getName) @return
+ * @return the column name
*/
public String getName()
{
@@ -378,10 +379,10 @@
}
/**
- * NEEDSDOC Method getSpecified
+ * Return Specified
*
*
- * NEEDSDOC (getSpecified) @return
+ * @return true
*/
public boolean getSpecified()
{
@@ -389,10 +390,10 @@
}
/**
- * NEEDSDOC Method getNodeValue
+ * Return column value
*
*
- * NEEDSDOC (getNodeValue) @return
+ * @return column value
*/
public String getNodeValue()
{
@@ -400,10 +401,10 @@
}
/**
- * NEEDSDOC Method getValue
+ * Return column value
*
*
- * NEEDSDOC (getValue) @return
+ * @return column value
*/
public String getValue()
{
@@ -459,10 +460,10 @@
}
/**
- * NEEDSDOC Method setValue
+ * setValue - Not supported
*
*
- * NEEDSDOC @param value
+ * @param value column value to set
*
* @throws DOMException
*/
@@ -472,10 +473,10 @@
}
/**
- * NEEDSDOC Method getOwnerElement
+ * Return column owner
*
*
- * NEEDSDOC (getOwnerElement) @return
+ * @return Column owner
*/
public Element getOwnerElement()
{
@@ -483,10 +484,10 @@
}
/**
- * NEEDSDOC Method getParentNode
+ * Get parent node
*
*
- * NEEDSDOC (getParentNode) @return
+ * @return null
*/
public Node getParentNode()
{
@@ -496,7 +497,7 @@
/**
* Return Node.ATTRIBUTE_NODE.
*
- * NEEDSDOC ($objectName$) @return
+ * @return ATTRIBUTE_NODE type
*/
public short getNodeType()
{
1.4 +35 -35 xml-xalan/java/src/org/apache/xalan/lib/sql/ColumnData.java
Index: ColumnData.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/ColumnData.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ColumnData.java 2000/10/30 18:56:32 1.3
+++ ColumnData.java 2000/12/14 19:06:06 1.4
@@ -73,18 +73,18 @@
public class ColumnData extends StreamableNode implements Text
{
- /** NEEDSDOC Field m_parent */
+ /** The column for which this is the data */
Column m_parent;
- /** NEEDSDOC Field DEBUG */
+ /** Flag for debug mode */
private static final boolean DEBUG = false;
/**
* Constructor ColumnData
*
*
- * NEEDSDOC @param statement
- * NEEDSDOC @param parent
+ * @param statement Owning document
+ * @param parent Owning column
*/
public ColumnData(XStatement statement, Column parent)
{
@@ -95,9 +95,9 @@
}
/**
- * Return Node.TEXT_NODE.
+ * Return node type, Node.TEXT_NODE.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Node.TEXT_NODE.
*/
public short getNodeType()
{
@@ -105,12 +105,12 @@
}
/**
- * NEEDSDOC Method splitText
+ * splitText - not supported
*
*
- * NEEDSDOC @param offset
+ * @param offset Offset where to split text
*
- * NEEDSDOC (splitText) @return
+ * @return null
*
* @throws DOMException
*/
@@ -126,7 +126,7 @@
* Return the value for this col element text node. I.e., return a String representation
* of the data for this column in the current row.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the data for this column
*
* @throws DOMException
*/
@@ -160,7 +160,7 @@
* of the data for this column in the current row.
* Calls @link #getNodeValue() getNodeValue()}.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the value for this column
*
* @throws DOMException
*/
@@ -175,7 +175,7 @@
* This may have the value zero, i.e., <code>CharacterData</code> nodes
* may be empty.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Number of characters in data
*/
public int getLength()
{
@@ -186,12 +186,12 @@
}
/**
- * Not supported.
+ * substringData - Not supported.
*
- * NEEDSDOC @param offset
- * NEEDSDOC @param count
+ * @param offset Starting offset of substring
+ * @param count Number of characters isn substring
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -206,7 +206,7 @@
/**
* Not supported.
*
- * NEEDSDOC @param arg
+ * @param arg
*
* @throws DOMException
*/
@@ -218,8 +218,8 @@
/**
* Not supported.
*
- * NEEDSDOC @param offset
- * NEEDSDOC @param arg
+ * @param offset
+ * @param arg
*
* @throws DOMException
*/
@@ -231,8 +231,8 @@
/**
* Not supported.
*
- * NEEDSDOC @param offset
- * NEEDSDOC @param count
+ * @param offset
+ * @param count
*
* @throws DOMException
*/
@@ -244,9 +244,9 @@
/**
* Not supported.
*
- * NEEDSDOC @param offset
- * NEEDSDOC @param count
- * NEEDSDOC @param arg
+ * @param offset
+ * @param count
+ * @param arg
*
* @throws DOMException
*/
@@ -259,7 +259,7 @@
/**
* Not supported.
*
- * NEEDSDOC @param data
+ * @param data
*
* @throws DOMException
*/
@@ -272,9 +272,9 @@
}
/**
- * The owner of a col text ode is the #Document (represented by XStatement).
+ * The owner of a col text node is the #Document (represented by XStatement).
*
- * NEEDSDOC ($objectName$) @return
+ * @return The owning document
*/
public Document getOwnerDocument()
{
@@ -282,9 +282,9 @@
}
/**
- * Return "#Text".
+ * Return node name, "#Text".
*
- * NEEDSDOC ($objectName$) @return
+ * @return "#Text".
*/
public String getNodeName()
{
@@ -292,9 +292,9 @@
}
/**
- * Return null.
+ * Return First child. This always returns null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getFirstChild()
{
@@ -306,9 +306,9 @@
}
/**
- * This always returns null.
+ * Return next sibling. This always returns null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getNextSibling()
{
@@ -322,7 +322,7 @@
/**
* The parent node of the col text node is the col node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The parent node i.e the column node
*/
public Node getParentNode()
{
@@ -337,7 +337,7 @@
* Tell if there are any children of the col node,
* which is always false.
*
- * NEEDSDOC ($objectName$) @return
+ * @return false
*/
public boolean hasChildNodes()
{
1.4 +44 -44 xml-xalan/java/src/org/apache/xalan/lib/sql/ColumnHeader.java
Index: ColumnHeader.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/ColumnHeader.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ColumnHeader.java 2000/10/30 18:56:32 1.3
+++ ColumnHeader.java 2000/12/14 19:06:06 1.4
@@ -73,26 +73,26 @@
public class ColumnHeader extends StreamableNode implements NamedNodeMap
{
- /** NEEDSDOC Field DEBUG */
+ /** Flag for DEBUG mode */
private static final boolean DEBUG = false;
- /** NEEDSDOC Field m_columnIndex */
+ /** Column index */
int m_columnIndex;
- /** NEEDSDOC Field m_metaData */
+ /** Meta data */
ResultSetMetaData m_metaData;
- /** NEEDSDOC Field m_parent */
+ /** Parent node, a row-set */
RowSet m_parent;
/**
* Constructor ColumnHeader
*
*
- * NEEDSDOC @param statement
- * NEEDSDOC @param parent
- * NEEDSDOC @param columnIndex
- * NEEDSDOC @param metaData
+ * @param statement Owning document
+ * @param parent Parent node, a row-set
+ * @param columnIndex Index of column this header is for
+ * @param metaData Meta data
*/
public ColumnHeader(XStatement statement, RowSet parent, int columnIndex,
ResultSetMetaData metaData)
@@ -106,9 +106,9 @@
}
/**
- * Return "column-header".
+ * Return Node name, "column-header".
*
- * NEEDSDOC ($objectName$) @return
+ * @return "column-header".
*/
public String getNodeName()
{
@@ -116,9 +116,9 @@
}
/**
- * Always returns null.
+ * getFirstChild - Always returns null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getFirstChild()
{
@@ -174,9 +174,8 @@
/**
* The parent node of a column-header Node is the row-set Node.
- * @returns a RowSet.
*
- * NEEDSDOC ($objectName$) @return
+ * @return a RowSet.
*/
public Node getParentNode()
{
@@ -191,7 +190,7 @@
* Tell if there are any children of the column-header Node,
* which is always false.
*
- * NEEDSDOC ($objectName$) @return
+ * @return false
*/
public boolean hasChildNodes()
{
@@ -205,7 +204,7 @@
/**
* Return the metadata for this column.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node.
*/
public NamedNodeMap getAttributes()
{
@@ -214,11 +213,11 @@
// ============= NamedNodeMap ===============
- /** NEEDSDOC Field m_attributes */
+ /** Array of attributes for column */
ColumnAttribute[] m_attributes = null;
/**
- * NEEDSDOC Method allocAttrs
+ * Allocate an array of attributes for this column
*
*/
private void allocAttrs()
@@ -237,13 +236,13 @@
}
/**
- * NEEDSDOC Method allocAttr
+ * Create an attribute
*
*
- * NEEDSDOC @param pos
- * NEEDSDOC @param name
+ * @param pos Index of attribute in array
+ * @param name Attribut name
*
- * NEEDSDOC (allocAttr) @return
+ * @return The attribute at the given index
*/
private ColumnAttribute allocAttr(int pos, String name)
{
@@ -264,9 +263,9 @@
/**
* Get an attribute by name from the metadata for this column.
*
- * NEEDSDOC @param name
+ * @param name Attribute name
*
- * NEEDSDOC ($objectName$) @return
+ * @return Attribute with given name or null if not found
*/
public Node getNamedItem(String name)
{
@@ -287,9 +286,9 @@
/**
* Get an attribute by index from the metadata for this column.
*
- * NEEDSDOC @param index
+ * @param index Index of attribut to get
*
- * NEEDSDOC ($objectName$) @return
+ * @return Attribute node at given index or null if not found
*/
public Node item(int index)
{
@@ -310,7 +309,7 @@
/**
* Get the number of attributes of column metadata attributes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the number of attributes of column
*/
public int getLength()
{
@@ -318,13 +317,14 @@
}
/**
- * NEEDSDOC Method getNamedItemNS
+ * Get an attribute by namespaced name from the metadata for this column.
*
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param localName
+ * @param namespaceURI Namespace URI of attribute
+ * @param localName Local name of attribute
*
- * NEEDSDOC (getNamedItemNS) @return
+ * @return the attribute with the given local name and a null
+ * namespace, or null.
*/
public Node getNamedItemNS(String namespaceURI, String localName)
{
@@ -336,12 +336,12 @@
}
/**
- * NEEDSDOC Method setNamedItem
+ * Set an attribute from the metadata for this column. Not supported
*
*
- * NEEDSDOC @param arg
+ * @param arg
*
- * NEEDSDOC (setNamedItem) @return
+ * @return null
*
* @throws DOMException
*/
@@ -354,12 +354,12 @@
}
/**
- * NEEDSDOC Method removeNamedItem
+ * Remove an attribute - Not supported
*
*
- * NEEDSDOC @param name
+ * @param name
*
- * NEEDSDOC (removeNamedItem) @return
+ * @return null
*
* @throws DOMException
*/
@@ -372,12 +372,12 @@
}
/**
- * NEEDSDOC Method setNamedItemNS
+ * Set namespaced attribute - Not supported
*
*
- * NEEDSDOC @param arg
+ * @param arg
*
- * NEEDSDOC (setNamedItemNS) @return
+ * @return null
*
* @throws DOMException
*/
@@ -390,13 +390,13 @@
}
/**
- * NEEDSDOC Method removeNamedItemNS
+ * Removed namespaced attribute - Not supported
*
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param localName
+ * @param namespaceURI
+ * @param localName
*
- * NEEDSDOC (removeNamedItemNS) @return
+ * @return null
*
* @throws DOMException
*/
1.6 +16 -15 xml-xalan/java/src/org/apache/xalan/lib/sql/Row.java
Index: Row.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/Row.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Row.java 2000/11/23 04:57:21 1.5
+++ Row.java 2000/12/14 19:06:06 1.6
@@ -76,33 +76,33 @@
public class Row extends StreamableNode
{
- /** NEEDSDOC Field m_childCount */
+ /** Number of children for this row */
int m_childCount;
- /** NEEDSDOC Field m_columns */
+ /** Number of columns in this row */
Column[] m_columns;
- /** NEEDSDOC Field m_metadata */
+ /** Meta data */
ResultSetMetaData m_metadata;
- /** NEEDSDOC Field m_isStreamable */
+ /** Flag for whether this is streamable */
boolean m_isStreamable = false;
- /** NEEDSDOC Field m_next */
+ /** Next row */
Row m_next; // normally null, if streamable.
- /** NEEDSDOC Field DEBUG */
+ /** Flag for DEBUG mode */
private static final boolean DEBUG = false;
- /** NEEDSDOC Field m_parent */
+ /** Parent node, a row-set */
RowSet m_parent;
/**
* Constructor Row
*
*
- * NEEDSDOC @param statement
- * NEEDSDOC @param parent
+ * @param statement Owning document
+ * @param parent parent node, a row-set
*/
public Row(XStatement statement, RowSet parent)
{
@@ -138,7 +138,7 @@
/**
* The parent of a row is #Document represented by XStatement).
*
- * NEEDSDOC ($objectName$) @return
+ * @return The owning document
*/
public Document getOwnerDocument()
{
@@ -146,9 +146,9 @@
}
/**
- * Return "row".
+ * Return node name: "row".
*
- * NEEDSDOC ($objectName$) @return
+ * @return "row".
*/
public String getNodeName()
{
@@ -158,7 +158,8 @@
/**
* Return the first col element for the current row.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the first col element for the current row or
+ * null if none
*/
public Node getFirstChild()
{
@@ -176,7 +177,7 @@
* Return next row in the row-set. Use the same Row object over and over
* if the row-set is streamable.
*
- * NEEDSDOC ($objectName$) @return
+ * @return next row in the row-set or null if none
*/
public Node getNextSibling()
{
@@ -253,7 +254,7 @@
* Tell if the row Node has any children (col Nodes),
* which should always be true.
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the row has any children
*/
public boolean hasChildNodes()
{
1.4 +10 -10 xml-xalan/java/src/org/apache/xalan/lib/sql/RowSet.java
Index: RowSet.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/RowSet.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- RowSet.java 2000/10/30 18:56:33 1.3
+++ RowSet.java 2000/12/14 19:06:07 1.4
@@ -71,20 +71,20 @@
public class RowSet extends StreamableNode
{
- /** NEEDSDOC Field m_columnHeaders */
+ /** Array of column headers in this row-set */
ColumnHeader[] m_columnHeaders;
- /** NEEDSDOC Field m_firstrow */
+ /** First row in this row-set */
Row m_firstrow;
- /** NEEDSDOC Field DEBUG */
+ /** Flag for debug mode */
private static final boolean DEBUG = false;
/**
* Constructor RowSet
*
*
- * NEEDSDOC @param statement
+ * @param statement Owning document
*/
public RowSet(XStatement statement)
{
@@ -94,9 +94,9 @@
// ===== Element implementation =====
/**
- * Return "row-set".
+ * Return node name: "row-set".
*
- * NEEDSDOC ($objectName$) @return
+ * @return "row-set".
*/
public String getNodeName()
{
@@ -166,9 +166,9 @@
}
/**
- * This always returns null.
+ * getNextSibling - This always returns null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getNextSibling()
{
@@ -182,7 +182,7 @@
/**
* The parent node of row-set is #Document (represented by XStatement).
*
- * NEEDSDOC ($objectName$) @return
+ * @return Owner document
*/
public Node getParentNode()
{
@@ -197,7 +197,7 @@
* Tell if there are any children of the document,
* which is always true.
*
- * NEEDSDOC ($objectName$) @return
+ * @return True
*/
public boolean hasChildNodes()
{
1.9 +50 -50 xml-xalan/java/src/org/apache/xalan/lib/sql/StreamableNode.java
Index: StreamableNode.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/StreamableNode.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- StreamableNode.java 2000/12/05 20:54:49 1.8
+++ StreamableNode.java 2000/12/14 19:06:07 1.9
@@ -75,14 +75,14 @@
implements NodeTestFilter, NamedNodeMap, DOMOrder
{
- /** NEEDSDOC Field m_statement */
+ /** Owning document */
private XStatement m_statement;
/**
- * NEEDSDOC Method getXStatement
+ * Get XStatement (owning document)
*
*
- * NEEDSDOC (getXStatement) @return
+ * @return owning document
*/
public XStatement getXStatement()
{
@@ -90,13 +90,13 @@
}
/**
- * NEEDSDOC Method isSupported
+ * Check if a given feature is supported
*
*
- * NEEDSDOC @param feature
- * NEEDSDOC @param version
+ * @param feature Feature to check
+ * @param version Version to check
*
- * NEEDSDOC (supports) @return
+ * @return True if NodeTest feature is supported
*/
public boolean isSupported(String feature, String version)
{
@@ -104,14 +104,14 @@
|| feature.equals(AxesWalker.FEATURE_NODETESTFILTER);
}
- /** NEEDSDOC Field m_nodetest */
+ /** Instance of a NodeTest */
private NodeTest m_nodetest;
/**
- * NEEDSDOC Method getNodeTest
+ * Return the current NodeTest instance
*
*
- * NEEDSDOC (getNodeTest) @return
+ * @return the current NodeTest instance
*/
public NodeTest getNodeTest()
{
@@ -122,7 +122,7 @@
* Constructor StreamableNode
*
*
- * NEEDSDOC @param statement
+ * @param statement Owning document
*/
public StreamableNode(XStatement statement)
{
@@ -136,10 +136,10 @@
}
/**
- * NEEDSDOC Method setNodeTest
+ * Set NodeTest instance
*
*
- * NEEDSDOC @param nodeTest
+ * @param nodeTest The NodeTest to use
*/
public void setNodeTest(NodeTest nodeTest)
{
@@ -147,10 +147,10 @@
}
/**
- * NEEDSDOC Method getOwnerDocument
+ * Get Owner Document
*
*
- * NEEDSDOC (getOwnerDocument) @return
+ * @return owner document
*/
public Document getOwnerDocument()
{
@@ -160,7 +160,7 @@
/**
* Streamable nodes default to being elements.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Node.ELEMENT_NODE;
*/
public short getNodeType()
{
@@ -170,7 +170,7 @@
/**
* Return NodeName.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the node name
*/
public String getLocalName()
{
@@ -178,9 +178,9 @@
}
/**
- * Returns null.
+ * getNamespaceURI - Always Returns null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getNamespaceURI()
{
@@ -188,9 +188,9 @@
}
/**
- * Returns null.
+ * getPrefix - Always Returns null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getPrefix()
{
@@ -198,10 +198,10 @@
}
/**
- * NEEDSDOC Method getAttributes
+ * Get list of attributes
*
*
- * NEEDSDOC (getAttributes) @return
+ * @return the list of attributes for this node, itself
*/
public NamedNodeMap getAttributes()
{
@@ -209,12 +209,12 @@
}
/**
- * NEEDSDOC Method getNamedItem
+ * Get the attribute with the given name - Not implemented
*
*
- * NEEDSDOC @param name
+ * @param name attribute name to get
*
- * NEEDSDOC (getNamedItem) @return
+ * @return null
*/
public Node getNamedItem(String name)
{
@@ -222,12 +222,12 @@
}
/**
- * NEEDSDOC Method item
+ * Return the attribute at the given index - Not implemented
*
*
- * NEEDSDOC @param index
+ * @param index Index of attribute to get
*
- * NEEDSDOC (item) @return
+ * @return null
*/
public Node item(int index)
{
@@ -235,10 +235,10 @@
}
/**
- * NEEDSDOC Method getLength
+ * The number of attributes for this node - Not implemented
*
*
- * NEEDSDOC (getLength) @return
+ * @return 0
*/
public int getLength()
{
@@ -246,13 +246,13 @@
}
/**
- * NEEDSDOC Method getNamedItemNS
+ * Get the attribute with the given namespaced name - Not implemented
*
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param localName
+ * @param namespaceURI Namespace URI of the attribute to get
+ * @param localName Local name of the attribute to get
*
- * NEEDSDOC (getNamedItemNS) @return
+ * @return null
*/
public Node getNamedItemNS(String namespaceURI, String localName)
{
@@ -260,12 +260,12 @@
}
/**
- * NEEDSDOC Method setNamedItem
+ * Set the given attribute - Not supported
*
*
- * NEEDSDOC @param arg
+ * @param arg attribute node
*
- * NEEDSDOC (setNamedItem) @return
+ * @return null
*
* @throws DOMException
*/
@@ -278,12 +278,12 @@
}
/**
- * NEEDSDOC Method removeNamedItem
+ * Remove the attribute with the given name - Not supported
*
*
- * NEEDSDOC @param name
+ * @param name Attribute name
*
- * NEEDSDOC (removeNamedItem) @return
+ * @return null
*
* @throws DOMException
*/
@@ -296,12 +296,12 @@
}
/**
- * NEEDSDOC Method setNamedItemNS
+ * Set the attribute with the given namespaced name - Not supported
*
*
- * NEEDSDOC @param arg
+ * @param arg Attriute node
*
- * NEEDSDOC (setNamedItemNS) @return
+ * @return null
*
* @throws DOMException
*/
@@ -314,13 +314,13 @@
}
/**
- * NEEDSDOC Method removeNamedItemNS
+ * Remove the attribute with the given namespaced name - Not supported
*
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param localName
+ * @param namespaceURI Namespace URI of the attribute to remove
+ * @param localName Local name of the attribute to remove
*
- * NEEDSDOC (removeNamedItemNS) @return
+ * @return null
*
* @throws DOMException
*/
@@ -333,13 +333,13 @@
return null;
}
- /** NEEDSDOC Field m_orderIndex */
+ /** Document Order index of this node */
int m_orderIndex = -1;
/**
* Get the UID (document order index).
*
- * NEEDSDOC ($objectName$) @return
+ * @return document order index for this node
*/
public int getUid()
{
1.5 +14 -18 xml-xalan/java/src/org/apache/xalan/lib/sql/XConnection.java
Index: XConnection.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/XConnection.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- XConnection.java 2000/11/15 17:13:10 1.4
+++ XConnection.java 2000/12/14 19:06:08 1.5
@@ -85,7 +85,7 @@
public class XConnection
{
- /** NEEDSDOC Field DEBUG */
+ /** Flag for DEBUG mode */
private static final boolean DEBUG = false;
/**
@@ -153,9 +153,8 @@
* Create an XConnection object with a connection protocol
* @param driver JDBC driver of the form foo.bar.Driver.
* @param dbURL database URL of the form jdbc:subprotocol:subname.
- * @param protocol list of string tag/value connection arguments,
+ * @param protocolElem list of string tag/value connection arguments,
* normally including at least "user" and "password".
- * NEEDSDOC @param protocolElem
*/
public XConnection(String driver, String dbURL, Element protocolElem)
{
@@ -168,12 +167,13 @@
/**
* Initialize.
*
- * NEEDSDOC @param driver
- * NEEDSDOC @param dbURL
- * NEEDSDOC @param user
- * NEEDSDOC @param password
- * NEEDSDOC @param protocolElem
- * NEEDSDOC @param getConnectionArgs
+ * @param driver JDBC driver of the form foo.bar.Driver.
+ * @param dbURL database URL of the form jdbc:subprotocol:subname.
+ * @param user user ID
+ * @param password connection password.
+ * @param protocolElem list of string tag/value connection arguments,
+ * normally including at least "user" and "password".
+ * @param getConnectionArgs Connection arguments
*/
private void init(String driver, String dbURL, String user,
String password, Element protocolElem,
@@ -206,13 +206,13 @@
/**
* Connect to the JDBC database.
* @param driver Database url of the form jdbc:subprotocol:subname .
- * NEEDSDOC @param dbURL
- * NEEDSDOC @param user
- * NEEDSDOC @param password
+ * @param dbURL database URL of the form jdbc:subprotocol:subname.
+ * @param user user ID
+ * @param password connection password.
* @param protocol List of arbitrary string tag/value pairs as
* connection arguments; normally at least a "user" and "password"
* property should be included.
- * NEEDSDOC @param getConnectionArgs
+ * @param getConnectionArgs Connection arguments
*/
public void connect(String driver, String dbURL, String user,
String password, Properties protocol,
@@ -283,12 +283,8 @@
return new XStatement(this, queryString);
}
- /*
- * Close the connection to the data source.
- */
-
/**
- * NEEDSDOC Method close
+ * Close the connection to the data source.
*
*
* @throws SQLException
1.6 +66 -53 xml-xalan/java/src/org/apache/xalan/lib/sql/XStatement.java
Index: XStatement.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/lib/sql/XStatement.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- XStatement.java 2000/11/14 23:15:09 1.5
+++ XStatement.java 2000/12/14 19:06:08 1.6
@@ -78,20 +78,20 @@
implements NodeIterator, ContextNodeList, Cloneable
{
- /** NEEDSDOC Field DEBUG */
+ /** Flag for DEBUG mode */
private static final boolean DEBUG = false;
- /** NEEDSDOC Field m_statement */
+ /** JDBC Query statement */
private Statement m_statement;
- /** NEEDSDOC Field m_nodeCounter */
+ /** Node counter */
private int m_nodeCounter = 0;
/**
- * NEEDSDOC Method getAndIncrementNodeCounter
+ * Get And Increment Node Counter
*
*
- * NEEDSDOC (getAndIncrementNodeCounter) @return
+ * @return Node counter
*/
int getAndIncrementNodeCounter()
{
@@ -104,52 +104,52 @@
}
/**
- * NEEDSDOC Method getStatement
+ * Get the JDBC Query statement
*
*
- * NEEDSDOC (getStatement) @return
+ * @return the JDBC Query statement
*/
public Statement getStatement()
{
return m_statement;
}
- /** NEEDSDOC Field m_resultSet */
+ /** ResultSet instance from executing the query string */
ResultSet m_resultSet;
/**
- * NEEDSDOC Method getResultSet
+ * Get the ResultSet from executing the query string
*
*
- * NEEDSDOC (getResultSet) @return
+ * @return ResultSet instance
*/
public ResultSet getResultSet()
{
return m_resultSet;
}
- /** NEEDSDOC Field m_xconnection */
+ /** XConnection instance (for access to JDBC data). */
private XConnection m_xconnection;
- /** NEEDSDOC Field m_queryString */
+ /** The SQL Query string */
private String m_queryString;
- /** NEEDSDOC Field m_rowset */
+ /** Rowset instance (for the JDBC query result set). */
RowSet m_rowset;
- /** NEEDSDOC Field m_nextHasBeenCalled */
+ /** Flag */
boolean m_nextHasBeenCalled = false;
- /** NEEDSDOC Field S_DOCELEMENTNAME */
+ /** Constant for DOCELEMENTNAME */
static final String S_DOCELEMENTNAME = "row-set";
- /** NEEDSDOC Field S_COLUMNHEADERNAME */
+ /** Constant for COLUMNHEADERNAME */
static final String S_COLUMNHEADERNAME = "column-header";
- /** NEEDSDOC Field S_ROWNAME */
+ /** Constant for ROWNAME */
static final String S_ROWNAME = "row";
- /** NEEDSDOC Field S_COLUMNNAME */
+ /** Constant for COLUMNNAME */
static final String S_COLUMNNAME = "col";
/**
@@ -185,10 +185,10 @@
}
/**
- * NEEDSDOC Method getXStatement
+ * Get the representation of the JDBC Query statement
*
*
- * NEEDSDOC (getXStatement) @return
+ * @return the representation of the JDBC Query statement, this
*/
public XStatement getXStatement()
{
@@ -215,7 +215,7 @@
* iterator. The available set of constants is defined in the
* <code>NodeFilter</code> interface.
*
- * NEEDSDOC ($objectName$) @return
+ * @return which node types are to be presented
*/
public int getWhatToShow()
{
@@ -289,7 +289,7 @@
* Throw an exception, since streaming nodes and iterators can not
* go backwards.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -329,10 +329,10 @@
}
/**
- * NEEDSDOC Method toString
+ * Return the String value of this object
*
*
- * NEEDSDOC (toString) @return
+ * @return String value of the JDBC query string
*/
public String toString()
{
@@ -344,7 +344,7 @@
/**
* The parent of a document is null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Document getOwnerDocument()
{
@@ -352,9 +352,9 @@
}
/**
- * Return Node.DOCUMENT_NODE.
+ * Return node type: Node.DOCUMENT_NODE.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Node.DOCUMENT_NODE.
*/
public short getNodeType()
{
@@ -362,9 +362,9 @@
}
/**
- * Return "#Document".
+ * Return node name: "#Document".
*
- * NEEDSDOC ($objectName$) @return
+ * @return "#Document".
*/
public String getNodeName()
{
@@ -374,7 +374,7 @@
/**
* Return the row-set node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the row-set node or null if not found.
*/
public Node getFirstChild()
{
@@ -400,9 +400,9 @@
}
/**
- * This always returns null.
+ * getNextSibling - This always returns null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getNextSibling()
{
@@ -416,7 +416,7 @@
/**
* The parent node of document is always null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getParentNode()
{
@@ -431,7 +431,7 @@
* Tell if there are any children of the document,
* which is always true.
*
- * NEEDSDOC ($objectName$) @return
+ * @return true
*/
public boolean hasChildNodes()
{
@@ -445,10 +445,10 @@
// ===== ContextNodeList implementation =====
/**
- * NEEDSDOC Method getCurrentNode
+ * The current node is the RowSet
*
*
- * NEEDSDOC (getCurrentNode) @return
+ * @return The row-set
*/
public Node getCurrentNode()
{
@@ -456,10 +456,10 @@
}
/**
- * NEEDSDOC Method getCurrentPos
+ * Get Current Position
*
*
- * NEEDSDOC (getCurrentPos) @return
+ * @return 0
*/
public int getCurrentPos()
{
@@ -467,7 +467,7 @@
}
/**
- * NEEDSDOC Method reset
+ * Reset this object
*
*/
public void reset()
@@ -476,10 +476,10 @@
}
/**
- * NEEDSDOC Method setShouldCacheNodes
+ * Set whether nodes should be cached - not implemented
*
*
- * NEEDSDOC @param b
+ * @param b Flag indicating whether nodes should be cached
*/
public void setShouldCacheNodes(boolean b)
{
@@ -488,10 +488,10 @@
}
/**
- * NEEDSDOC Method runTo
+ * Not implemented
*
*
- * NEEDSDOC @param index
+ * @param index
*/
public void runTo(int index)
{
@@ -500,10 +500,10 @@
}
/**
- * NEEDSDOC Method setCurrentPos
+ * Not implemented
*
*
- * NEEDSDOC @param i
+ * @param i
*/
public void setCurrentPos(int i)
{
@@ -512,10 +512,10 @@
}
/**
- * NEEDSDOC Method size
+ * Return size
*
*
- * NEEDSDOC (size) @return
+ * @return 1
*/
public int size()
{
@@ -523,10 +523,10 @@
}
/**
- * NEEDSDOC Method isFresh
+ * Return whether this iterator is fresh
*
*
- * NEEDSDOC (isFresh) @return
+ * @return True if this has not been called
*/
public boolean isFresh()
{
@@ -534,10 +534,10 @@
}
/**
- * NEEDSDOC Method cloneWithReset
+ * Overide cloneWithReset method
*
*
- * NEEDSDOC (cloneWithReset) @return
+ * @return A clone of this which has been reset
*
* @throws CloneNotSupportedException
*/
@@ -552,10 +552,10 @@
}
/**
- * NEEDSDOC Method clone
+ * Clone this object
*
*
- * NEEDSDOC (clone) @return
+ * @return A clone of this object
*
* @throws CloneNotSupportedException
*/
@@ -567,13 +567,26 @@
return clone;
}
+ /** Index of Last node found by this iterator */
private int m_last = 0;
+ /**
+ * Get index of the last found node
+ *
+ *
+ * @return index of last found node
+ */
public int getLast()
{
return m_last;
}
+ /**
+ * Set the index of the last found node
+ *
+ *
+ * @aram index of last found node
+ */
public void setLast(int last)
{
m_last = last;