jkesselm 01/05/22 06:47:26
Modified: java/src/org/apache/xml/dtm Tag: DTM_EXP
DTMAxisTraverser.java DTMDefaultBase.java
Log:
Clarify description of DTMAxisTraverser
Revision Changes Path
No revision
No revision
1.1.2.3 +20 -5
xml-xalan/java/src/org/apache/xml/dtm/Attic/DTMAxisTraverser.java
Index: DTMAxisTraverser.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/dtm/Attic/DTMAxisTraverser.java,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- DTMAxisTraverser.java 2001/05/21 16:03:21 1.1.2.2
+++ DTMAxisTraverser.java 2001/05/22 13:47:17 1.1.2.3
@@ -80,6 +80,8 @@
* <p>This method needs to be overloaded only by those axis that process
* the self node. <\p>
*
+ * @param context The context node of this traversal. This is the point
+ * that the traversal starts from.
* @return the first node in the traversal.
*/
public int first(int context)
@@ -95,7 +97,8 @@
* <p>This method needs to be overloaded only by those axis that process
* the self node. <\p>
*
- * @param context The context node if this traversal.
+ * @param context The context node of this traversal. This is the point
+ * of origin for the traversal -- its "root node" or starting point.
* @param extendedTypeID The extended type ID that must match.
*
* @return the first node in the traversal.
@@ -108,10 +111,16 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this traversal.
- * @param current The current node of the traversal.
+ * @param context The context node of this traversal. This is the point
+ * of origin for the traversal -- its "root node" or starting point.
+ * @param current The current node of the traversal. This is the last known
+ * location in the traversal, typically the node-handle returned by the
+ * previous traversal step. For the first traversal step, context
+ * should be set equal to current. Note that in order to test whether
+ * context is in the set, you must use the first() method instead.
*
* @return the next node in the iteration, or DTM.NULL.
+ * @see first(int)
*/
public abstract int next(int context, int current);
@@ -119,11 +128,17 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this traversal.
- * @param current The current node of the traversal.
+ * @param context The context node of this traversal. This is the point
+ * of origin for the traversal -- its "root node" or starting point.
+ * @param current The current node of the traversal. This is the last known
+ * location in the traversal, typically the node-handle returned by the
+ * previous traversal step. For the first traversal step, context
+ * should be set equal to current. Note that in order to test whether
+ * context is in the set, you must use the first() method instead.
* @param extendedTypeID The extended type ID that must match.
*
* @return the next node in the iteration, or DTM.NULL.
+ * @see first(int,int)
*/
public abstract int next(int context, int current, int extendedTypeID);
}
1.1.2.12 +33 -33
xml-xalan/java/src/org/apache/xml/dtm/Attic/DTMDefaultBase.java
Index: DTMDefaultBase.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/dtm/Attic/DTMDefaultBase.java,v
retrieving revision 1.1.2.11
retrieving revision 1.1.2.12
diff -u -r1.1.2.11 -r1.1.2.12
--- DTMDefaultBase.java 2001/05/21 19:43:44 1.1.2.11
+++ DTMDefaultBase.java 2001/05/22 13:47:19 1.1.2.12
@@ -1726,7 +1726,7 @@
*
* @param axis One of Axes.ANCESTORORSELF, etc.
*
- * @return A DTMAxisIterator, or null if the givin axis isn't supported.
+ * @return A DTMAxisTraverser, or null if the given axis isn't supported.
*/
public DTMAxisTraverser getAxisTraverser(final int axis)
{
@@ -1813,7 +1813,7 @@
* @param axis One of Axes.ANCESTORORSELF, etc.
* @param type An extended type ID.
*
- * @return A DTMAxisIterator, or null if the givin axis isn't supported.
+ * @return A DTMAxisIterator, or null if the given axis isn't supported.
*/
public DTMAxisIterator getTypedAxisIterator(int axis, int type)
{
@@ -1885,7 +1885,7 @@
*
* @param axis One of Axes.ANCESTORORSELF, etc.
*
- * @return A DTMAxisIterator, or null if the givin axis isn't supported.
+ * @return A DTMAxisIterator, or null if the given axis isn't supported.
*/
public DTMAxisIterator getAxisIterator(final int axis)
{
@@ -3608,7 +3608,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -3640,7 +3640,7 @@
* returned or the iteration will go into an infinate loop. To see if
* the self node should be processed, use this function.
*
- * @param context The context node if this traversal.
+ * @param context The context node of this traversal.
*
* @return the first node in the traversal.
*/
@@ -3656,7 +3656,7 @@
* node does not match the extended type ID, this function will return
* false.
*
- * @param context The context node if this traversal.
+ * @param context The context node of this traversal.
* @param extendedTypeID The extended type ID that must match.
*
* @return the first node in the traversal.
@@ -3677,7 +3677,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -3692,7 +3692,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -3724,7 +3724,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -3741,7 +3741,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -3786,7 +3786,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -3814,7 +3814,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -3851,7 +3851,7 @@
* returned or the iteration will go into an infinate loop. To see if
* the self node should be processed, use this function.
*
- * @param context The context node if this traversal.
+ * @param context The context node of this traversal.
*
* @return the first node in the traversal.
*/
@@ -3867,7 +3867,7 @@
* node does not match the extended type ID, this function will return
* false.
*
- * @param context The context node if this traversal.
+ * @param context The context node of this traversal.
* @param extendedTypeID The extended type ID that must match.
*
* @return the first node in the traversal.
@@ -3888,7 +3888,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -3919,7 +3919,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -3952,7 +3952,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -3992,7 +3992,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -4006,7 +4006,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -4034,7 +4034,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -4051,7 +4051,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -4085,7 +4085,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -4102,7 +4102,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -4136,7 +4136,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -4154,7 +4154,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -4209,7 +4209,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -4238,7 +4238,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -4274,7 +4274,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return the next node in the iteration, or DTM.NULL.
@@ -4288,7 +4288,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
@@ -4318,7 +4318,7 @@
* returned or the iteration will go into an infinate loop. To see if
* the self node should be processed, use this function.
*
- * @param context The context node if this traversal.
+ * @param context The context node of this traversal.
*
* @return the first node in the traversal.
*/
@@ -4334,7 +4334,7 @@
* node does not match the extended type ID, this function will return
* false.
*
- * @param context The context node if this traversal.
+ * @param context The context node of this traversal.
* @param extendedTypeID The extended type ID that must match.
*
* @return the first node in the traversal.
@@ -4347,7 +4347,7 @@
/**
* Traverse to the next node after the current node.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
*
* @return Always return NULL for this axis.
@@ -4361,7 +4361,7 @@
* Traverse to the next node after the current node that is matched
* by the extended type ID.
*
- * @param context The context node if this iteration.
+ * @param context The context node of this iteration.
* @param current The current node of the iteration.
* @param extendedTypeID The extended type ID that must match.
*
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
