You are viewing a plain text version of this content. The canonical link for it is here.
Posted to xindice-dev@xml.apache.org by vl...@apache.org on 2002/11/22 11:15:35 UTC
cvs commit: xml-xindice/java/src/org/apache/xindice/xml/sax CompressionHandler.java
vladimir 2002/11/22 02:15:35
Modified: java/src/org/apache/xindice/client/xmldb/services
CollectionManager.java DatabaseInstanceManager.java
java/src/org/apache/xindice/client/xmldb/xmlrpc
CollectionImpl.java
java/src/org/apache/xindice/core Collection.java
java/src/org/apache/xindice/core/data Variant.java
java/src/org/apache/xindice/core/filer BTree.java Paged.java
java/src/org/apache/xindice/core/indexer IndexManager.java
java/src/org/apache/xindice/core/xupdate XUpdateImpl.java
java/src/org/apache/xindice/server/rpc/messages Query.java
java/src/org/apache/xindice/util Configuration.java
java/src/org/apache/xindice/xml/dom
DOMImplementationImpl.java NodeImpl.java
java/src/org/apache/xindice/xml/sax CompressionHandler.java
Log:
fixed some javadoc problems
Revision Changes Path
1.7 +3 -6 xml-xindice/java/src/org/apache/xindice/client/xmldb/services/CollectionManager.java
Index: CollectionManager.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/client/xmldb/services/CollectionManager.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- CollectionManager.java 21 Nov 2002 07:44:35 -0000 1.6
+++ CollectionManager.java 22 Nov 2002 10:15:34 -0000 1.7
@@ -103,7 +103,7 @@
/**
* Drops a child collection from this collection.
*
- * @param collection The child collection to drop.
+ * @param name The name of the child collection to drop.
* @exception XMLDBException
*/
public void dropCollection(String name) throws XMLDBException;
@@ -119,7 +119,6 @@
/**
* Creates a new Indexer for this collection.
*
- * @param name The name for this indexer
* @param configuration The configuration to use for this indexer.
* @exception XMLDBException
*/
@@ -148,9 +147,7 @@
* The XMLObject will be added to the collection using the provided name as
* a key.
*
- * @param name The name of this XMLObject
* @param configuration The XML configuration to use
- * @return The created XMLObject
* @exception XMLDBException
*/
public void createXMLObject(Document configuration) throws XMLDBException;
@@ -158,7 +155,7 @@
/**
* Drops a collection level XMLObject from the collection.
*
- * @param object The XMLObject to drop.
+ * @param name The name of the XMLObject to drop.
* @exception XMLDBException
*/
public void dropXMLObject(String name)
1.5 +1 -2 xml-xindice/java/src/org/apache/xindice/client/xmldb/services/DatabaseInstanceManager.java
Index: DatabaseInstanceManager.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/client/xmldb/services/DatabaseInstanceManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DatabaseInstanceManager.java 31 Oct 2002 06:58:48 -0000 1.4
+++ DatabaseInstanceManager.java 22 Nov 2002 10:15:34 -0000 1.5
@@ -81,7 +81,6 @@
/**
* Shutsdown the Database instance
*
- * @return the result of the shutdown operation
* @exception XMLDBException
*/
public void shutdown() throws XMLDBException;
1.17 +5 -5 xml-xindice/java/src/org/apache/xindice/client/xmldb/xmlrpc/CollectionImpl.java
Index: CollectionImpl.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/client/xmldb/xmlrpc/CollectionImpl.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- CollectionImpl.java 21 Nov 2002 07:44:35 -0000 1.16
+++ CollectionImpl.java 22 Nov 2002 10:15:34 -0000 1.17
@@ -181,14 +181,14 @@
* <code>ErrorCodes.COLLECTION_CLOSED</code> if the <code>close</code>
* method has been called on the <code>Collection</code><br />
*/
- public Resource getResource(String resourceName) throws XMLDBException {
+ public Resource getResource(String id) throws XMLDBException {
checkOpen();
try {
Hashtable params = new Hashtable();
params.put(RPCDefaultMessage.COLLECTION, collPath);
- params.put(RPCDefaultMessage.NAME, resourceName);
+ params.put(RPCDefaultMessage.NAME, id);
params.put(RPCDefaultMessage.COMPRESSED, "true");
Object result = runRemoteCommand("GetDocument", params);
@@ -198,12 +198,12 @@
if ( result instanceof Hashtable ) {
Hashtable compressed = (Hashtable) result;
SymbolDeserializer symbolDeserial = new SymbolDeserializer();
- return new XMLResourceImpl(resourceName, resourceName, this,
+ return new XMLResourceImpl(id, id, this,
symbolDeserial.getSymbols(compressed),
(byte []) compressed.get("document"));
}
else {
- return new XMLResourceImpl(resourceName, (String) result, this);
+ return new XMLResourceImpl(id, (String) result, this);
}
} catch (Exception e) {
1.12 +2 -2 xml-xindice/java/src/org/apache/xindice/core/Collection.java
Index: Collection.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/core/Collection.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Collection.java 4 Nov 2002 06:39:55 -0000 1.11
+++ Collection.java 22 Nov 2002 10:15:34 -0000 1.12
@@ -610,7 +610,7 @@
* insertDocument inserts a new Document into a Xindice Collection.
*
* @param docKey The document Key
- * @param value The Document
+ * @param document The document to insert
*/
public final void insertDocument(Object docKey, Document document) throws DBException {
putDocument(createNewKey(docKey), document /*, true */);
1.4 +4 -4 xml-xindice/java/src/org/apache/xindice/core/data/Variant.java
Index: Variant.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/core/data/Variant.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Variant.java 31 Oct 2002 06:59:56 -0000 1.3
+++ Variant.java 22 Nov 2002 10:15:34 -0000 1.4
@@ -291,10 +291,10 @@
*
* @param value The value
*/
- public void set(Object object) {
+ public void set(Object value) {
this.value = value;
- type = value != null ? Types.OBJECT
- : Types.EMPTY;
+ this.type = this.value != null ? Types.OBJECT
+ : Types.EMPTY;
}
/**
1.10 +2 -2 xml-xindice/java/src/org/apache/xindice/core/filer/BTree.java
Index: BTree.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/core/filer/BTree.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- BTree.java 31 Oct 2002 06:59:57 -0000 1.9
+++ BTree.java 22 Nov 2002 10:15:34 -0000 1.10
@@ -324,7 +324,7 @@
* provided BTreeNode's page number.
*
* @param root The root to reset
- * @param rootNode the new root node to use
+ * @param newRoot the new root node to use
*/
protected final void setRootNode(BTreeRootInfo root, BTreeNode newRoot) throws IOException, BTreeException {
BTreeRootInfo parent = root.getParent();
1.11 +2 -2 xml-xindice/java/src/org/apache/xindice/core/filer/Paged.java
Index: Paged.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/core/filer/Paged.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- Paged.java 31 Oct 2002 06:59:57 -0000 1.10
+++ Paged.java 22 Nov 2002 10:15:34 -0000 1.11
@@ -332,7 +332,7 @@
* unlinkPages unlinks a set of pages starting at the specified
* page number.
*
- * @param page The starting page number to unlink
+ * @param pageNum The starting page number to unlink
* @throws IOException if an Exception occurs
*/
protected final void unlinkPages(long pageNum) throws IOException {
1.11 +2 -2 xml-xindice/java/src/org/apache/xindice/core/indexer/IndexManager.java
Index: IndexManager.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/core/indexer/IndexManager.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- IndexManager.java 19 Nov 2002 05:16:58 -0000 1.10
+++ IndexManager.java 22 Nov 2002 10:15:35 -0000 1.11
@@ -388,7 +388,7 @@
/**
* get retrieves an Indexer by name.
*
- * @name The Indexer name
+ * @param name The Indexer name
* @return The Indexer
*/
public Indexer get(String name) {
1.6 +2 -2 xml-xindice/java/src/org/apache/xindice/core/xupdate/XUpdateImpl.java
Index: XUpdateImpl.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/core/xupdate/XUpdateImpl.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- XUpdateImpl.java 31 Oct 2002 06:59:59 -0000 1.5
+++ XUpdateImpl.java 22 Nov 2002 10:15:35 -0000 1.6
@@ -183,7 +183,7 @@
/**
* Execute the set of XUpdate commands against a collection.
*
- * @param contextNode Description of Parameter
+ * @param col The collection against which the command will be executed
* @exception Exception Description of Exception
*/
public void execute(Collection col) throws Exception {
1.3 +1 -2 xml-xindice/java/src/org/apache/xindice/server/rpc/messages/Query.java
Index: Query.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/server/rpc/messages/Query.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Query.java 31 Oct 2002 07:00:44 -0000 1.2
+++ Query.java 22 Nov 2002 10:15:35 -0000 1.3
@@ -74,7 +74,6 @@
/**
* Executes a query against a document or collection
- * @return The result of the query as XML.
*/
public class Query extends RPCDefaultMessage {
1.7 +2 -2 xml-xindice/java/src/org/apache/xindice/util/Configuration.java
Index: Configuration.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/util/Configuration.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Configuration.java 31 Oct 2002 07:16:52 -0000 1.6
+++ Configuration.java 22 Nov 2002 10:15:35 -0000 1.7
@@ -777,7 +777,7 @@
* Note! This method does NOT perform a deep copy on the DOM Node that
* newConfig manages.
*
- * @param config The Configuration node to add
+ * @param newConfig The Configuration node to add
* @throws ReadOnlyException if the Configuration is read-only
*/
public void add(Configuration newConfig) throws ReadOnlyException {
1.2 +7 -7 xml-xindice/java/src/org/apache/xindice/xml/dom/DOMImplementationImpl.java
Index: DOMImplementationImpl.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/xml/dom/DOMImplementationImpl.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DOMImplementationImpl.java 6 Dec 2001 19:33:59 -0000 1.1
+++ DOMImplementationImpl.java 22 Nov 2002 10:15:35 -0000 1.2
@@ -113,10 +113,10 @@
* future version of the DOM will provide a way for populating a
* <code>DocumentType</code>.
* <br>HTML-only DOM implementations do not need to implement this method.
- * @param qualifiedNameThe qualified name of the document type to be
+ * @param qualifiedName The qualified name of the document type to be
* created.
- * @param publicIdThe external subset public identifier.
- * @param systemIdThe external subset system identifier.
+ * @param publicId The external subset public identifier.
+ * @param systemId The external subset system identifier.
* @return A new <code>DocumentType</code> node with
* <code>Node.ownerDocument</code> set to <code>null</code>.
* @exception DOMException
@@ -134,10 +134,10 @@
* Creates an XML <code>Document</code> object of the specified type with
* its document element. HTML-only DOM implementations do not need to
* implement this method.
- * @param namespaceURIThe namespace URI of the document element to create.
- * @param qualifiedNameThe qualified name of the document element to be
+ * @param namespaceURI The namespace URI of the document element to create.
+ * @param qualifiedName The qualified name of the document element to be
* created.
- * @param doctypeThe type of document to be created or <code>null</code>.
+ * @param doctype The type of document to be created or <code>null</code>.
* When <code>doctype</code> is not <code>null</code>, its
* <code>Node.ownerDocument</code> attribute is set to the document
* being created.
1.5 +7 -7 xml-xindice/java/src/org/apache/xindice/xml/dom/NodeImpl.java
Index: NodeImpl.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/xml/dom/NodeImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- NodeImpl.java 31 Oct 2002 07:02:23 -0000 1.4
+++ NodeImpl.java 22 Nov 2002 10:15:35 -0000 1.5
@@ -788,7 +788,7 @@
* Returns whether this node is the same node as the given one. Do we
* really want to make this different from equals?Yes, change name from
* isIdentical to isSameNode. (Telcon 4 Jul 2000).
- * @param otherThe node to test against.
+ * @param other The node to test against.
* @return Returns <code>true</code> if the nodes are the same,
* <code>false</code> otherwise.
*/
@@ -799,7 +799,7 @@
/**
* Look up the prefix associated to the given namespace URI, starting from
* this node.
- * @param namespaceURIThe namespace URI to look for.
+ * @param namespaceURI The namespace URI to look for.
* @return Returns the associated namespace prefix or <code>null</code>
* if none is found.
*/
@@ -823,7 +823,7 @@
* Look up the namespace URI associated to the given prefix, starting from
* this node.Name? May need to change depending on ending of the
* relative namespace URI reference nightmare.
- * @param prefixThe prefix to look for.
+ * @param prefix The prefix to look for.
* @return Returns the associated namespace URI or <code>null</code> if
* none is found.
*/
@@ -866,8 +866,8 @@
* the application?What happens if the node is cloned?What should Object
* be mapped to in ECMAScript? For IDL we need to define this type
* somehow.
- * @param dataThe piece of data to attach to this node.
- * @param keyThe key to associate this data to.
+ * @param data The piece of data to attach to this node.
+ * @param key The key to associate this data to.
* @return The object previously associated to this node and the given
* key or <code>null</code>.
*/
@@ -882,7 +882,7 @@
/**
* This method allows to retreive a user object previously attached to a
* Node with <code>setUserData</code>.
- * @param keyThe key to look for.
+ * @param key The key to look for.
* @return The object associated to this node and the given key or
* <code>null</code>.
*/
1.3 +2 -2 xml-xindice/java/src/org/apache/xindice/xml/sax/CompressionHandler.java
Index: CompressionHandler.java
===================================================================
RCS file: /home/cvs/xml-xindice/java/src/org/apache/xindice/xml/sax/CompressionHandler.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CompressionHandler.java 31 Oct 2002 07:02:23 -0000 1.2
+++ CompressionHandler.java 22 Nov 2002 10:15:35 -0000 1.3
@@ -107,7 +107,7 @@
* Attribute) this value needs to be stored until the type of Node
* is reported.
*
- * @param symbol The Symbol ID
+ * @param symbolID The Symbol ID
*/
void symbolID(short symbolID);
}