manifoldcf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kwri...@apache.org
Subject svn commit: r919414 - in /incubator/lcf/trunk/modules/framework: ./ agents/org/apache/lcf/agents/incrementalingest/ agents/org/apache/lcf/agents/interfaces/ agents/org/apache/lcf/agents/outputconnmgr/ core/org/apache/lcf/core/database/ pull-agent/org/a...
Date Fri, 05 Mar 2010 13:54:29 GMT
Author: kwright
Date: Fri Mar  5 13:54:28 2010
New Revision: 919414

URL: http://svn.apache.org/viewvc?rev=919414&view=rev
Log:
Add doc target to framework build, and fix any discovered javadoc problems.

Modified:
    incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/incrementalingest/IncrementalIngester.java
    incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/AgentFactory.java
    incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IIncrementalIngester.java
    incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IOutputConnector.java
    incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/OutputConnectorManagerFactory.java
    incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/outputconnmgr/OutputConnectorManager.java
    incubator/lcf/trunk/modules/framework/build.xml
    incubator/lcf/trunk/modules/framework/core/org/apache/lcf/core/database/BaseTable.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/authconnmgr/AuthorityConnectorManager.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/interfaces/AuthorityConnectorManagerFactory.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/connmgr/ConnectorManager.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/ConnectorManagerFactory.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IJobManager.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IRepositoryConnectionManager.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/HopCount.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/JobManager.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/Jobs.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleList.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleManager.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/RepositoryConnectionManager.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/ThrottleSpecManager.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/DeleteQueuedDocument.java
    incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/QueuedDocument.java

Modified: incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/incrementalingest/IncrementalIngester.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/incrementalingest/IncrementalIngester.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/incrementalingest/IncrementalIngester.java
(original)
+++ incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/incrementalingest/IncrementalIngester.java
Fri Mar  5 13:54:28 2010
@@ -142,7 +142,7 @@
   }
 
   /** Come up with a maximum time (in minutes) for re-analyzing tables.
-  *@Return the time, in minutes.
+  *@return the time, in minutes.
   */
   public int getAnalyzeTime()
     throws LCFException
@@ -1140,8 +1140,11 @@
 
 
   /** Note the ingestion of a document, or the "update" of a document.
-  *@param identifierHash is the hash of the id of the document.
+  *@param outputConnectionName is the name of the output connection.
+  *@param docKey is the key string describing the document.
   *@param documentVersion is a string describing the new version of the document.
+  *@param outputVersion is the version string calculated for the output connection.
+  *@param authorityNameString is the name of the relevant authority connection.
   *@param ingestTime is the time at which the ingestion took place, in milliseconds since
epoch.
   *@param documentURI is the uri the document can be accessed at, or null (which signals
that we are to record the version, but no
   * ingestion took place).

Modified: incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/AgentFactory.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/AgentFactory.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/AgentFactory.java
(original)
+++ incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/AgentFactory.java
Fri Mar  5 13:54:28 2010
@@ -34,7 +34,7 @@
   }
 
   /** Make an agent, given a class name.
-  *@param threadContext is the thread context.
+  *@param tc is the thread context.
   *@param className is the agent class name.
   *@return the agent.
   */

Modified: incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IIncrementalIngester.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IIncrementalIngester.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IIncrementalIngester.java
(original)
+++ incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IIncrementalIngester.java
Fri Mar  5 13:54:28 2010
@@ -53,7 +53,7 @@
     throws LCFException;
 
   /** Come up with a maximum time (in minutes) for re-analyzing tables.
-  *@Return the time, in minutes.
+  *@return the time, in minutes.
   */
   public int getAnalyzeTime()
     throws LCFException;

Modified: incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IOutputConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IOutputConnector.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IOutputConnector.java
(original)
+++ incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/IOutputConnector.java
Fri Mar  5 13:54:28 2010
@@ -153,7 +153,7 @@
   *@param outputDescription is the description string that was constructed for this document
by the getOutputDescription() method.
   *@param document is the document data to be processed (handed to the output data store).
   *@param authorityNameString is the name of the authority responsible for authorizing any
access tokens passed in with the repository document.  May be null.
-  *@activities is the handle to an object that the implementer of an output connector may
use to perform operations, such as logging processing activity.
+  *@param activities is the handle to an object that the implementer of an output connector
may use to perform operations, such as logging processing activity.
   *@return the document status (accepted or permanently rejected).
   */
   public int addOrReplaceDocument(String documentURI, String outputDescription, RepositoryDocument
document, String authorityNameString, IOutputAddActivity activities)
@@ -164,7 +164,7 @@
   *@param documentURI is the URI of the document.  The URI is presumed to be the unique identifier
which the output data store will use to process
   * and serve the document.  This URI is constructed by the repository connector which fetches
the document, and is thus universal across all output connectors.
   *@param outputDescription is the last description string that was constructed for this
document by the getOutputDescription() method above.
-  *@activities is the handle to an object that the implementer of an output connector may
use to perform operations, such as logging processing activity.
+  *@param activities is the handle to an object that the implementer of an output connector
may use to perform operations, such as logging processing activity.
   */
   public void removeDocument(String documentURI, String outputDescription, IOutputRemoveActivity
activities)
     throws LCFException, ServiceInterruption;

Modified: incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/OutputConnectorManagerFactory.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/OutputConnectorManagerFactory.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/OutputConnectorManagerFactory.java
(original)
+++ incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/interfaces/OutputConnectorManagerFactory.java
Fri Mar  5 13:54:28 2010
@@ -34,7 +34,7 @@
   }
 
   /** Construct an output connector manager.
-  *@param threadContext is the thread context.
+  *@param tc is the thread context.
   *@return the output connector manager handle.
   */
   public static IOutputConnectorManager make(IThreadContext tc)

Modified: incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/outputconnmgr/OutputConnectorManager.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/outputconnmgr/OutputConnectorManager.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/outputconnmgr/OutputConnectorManager.java
(original)
+++ incubator/lcf/trunk/modules/framework/agents/org/apache/lcf/agents/outputconnmgr/OutputConnectorManager.java
Fri Mar  5 13:54:28 2010
@@ -186,7 +186,7 @@
 
   /** Unregister a connector.
   * The connector's deinstall method will also be called.
-  *@param description is the description to unregister.
+  *@param className is the class name of the connector to unregister.
   */
   public void unregisterConnector(String className)
     throws LCFException

Modified: incubator/lcf/trunk/modules/framework/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/build.xml?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/build.xml (original)
+++ incubator/lcf/trunk/modules/framework/build.xml Fri Mar  5 13:54:28 2010
@@ -3,6 +3,17 @@
     <target name="clean">
         <delete dir="build"/>
         <delete dir="dist"/>
+        <delete dir="doc"/>
+    </target>
+    
+    <target name="doc">
+        <mkdir dir="doc"/>
+        <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar">
+            <fileset dir="core" includes="**/*.java"/>
+            <fileset dir="agents" includes="**/*.java"/>
+            <fileset dir="pull-agent" includes="**/*.java"/>
+            <fileset dir="ui-core" includes="**/*.java"/>
+        </javadoc>
     </target>
     
     <target name="compile-core">
@@ -180,6 +191,6 @@
         <copy todir="dist/processes" file="build/jar/lcf-pull-agent.jar"/>
     </target>
 
-    <target name="all" depends="processes,war-authority-service,war-crawler-ui"/>
+    <target name="all" depends="processes,war-authority-service,war-crawler-ui,doc"/>
     
 </project>

Modified: incubator/lcf/trunk/modules/framework/core/org/apache/lcf/core/database/BaseTable.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/core/org/apache/lcf/core/database/BaseTable.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/core/org/apache/lcf/core/database/BaseTable.java
(original)
+++ incubator/lcf/trunk/modules/framework/core/org/apache/lcf/core/database/BaseTable.java
Fri Mar  5 13:54:28 2010
@@ -182,7 +182,7 @@
   }
 
   /** Get the current table schema.
-  *@param cacheKeys are the cache keys, if needed (null if no cache desired).
+  *@param invalidateKeys are the cache keys, if needed (null if no cache desired).
   *@param queryClass is the LRU class name against which this query would be cached,
   * or null if no LRU behavior desired.
   *@return a map of column names & ColumnDescription's, or null.
@@ -194,7 +194,7 @@
   }
 
   /** Get a table's indexes.
-  *@param cacheKeys are the keys against which to cache the query, or null.
+  *@param invalidateKeys are the keys against which to cache the query, or null.
   *@param queryClass is the name of the query class, or null.
   *@return a map of index names and IndexDescription objects, describing the indexes.
   */

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/authconnmgr/AuthorityConnectorManager.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/authconnmgr/AuthorityConnectorManager.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/authconnmgr/AuthorityConnectorManager.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/authconnmgr/AuthorityConnectorManager.java
Fri Mar  5 13:54:28 2010
@@ -186,7 +186,7 @@
 
   /** Unregister a connector.
   * The connector's deinstall method will also be called.
-  *@param description is the description to unregister.
+  *@param className is the class name of the connector to unregister.
   */
   public void unregisterConnector(String className)
     throws LCFException

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/interfaces/AuthorityConnectorManagerFactory.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/interfaces/AuthorityConnectorManagerFactory.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/interfaces/AuthorityConnectorManagerFactory.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/authorities/interfaces/AuthorityConnectorManagerFactory.java
Fri Mar  5 13:54:28 2010
@@ -33,7 +33,7 @@
   }
 
   /** Construct a connector manager.
-  *@param threadContext is the thread context.
+  *@param tc is the thread context.
   *@return the connector manager handle.
   */
   public static IAuthorityConnectorManager make(IThreadContext tc)

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/connmgr/ConnectorManager.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/connmgr/ConnectorManager.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/connmgr/ConnectorManager.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/connmgr/ConnectorManager.java
Fri Mar  5 13:54:28 2010
@@ -182,7 +182,7 @@
 
   /** Unregister a connector.
   * The connector's deinstall method will also be called.
-  *@param description is the description to unregister.
+  *@param className is the class of the connector to unregister.
   */
   public void unregisterConnector(String className)
     throws LCFException

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/ConnectorManagerFactory.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/ConnectorManagerFactory.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/ConnectorManagerFactory.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/ConnectorManagerFactory.java
Fri Mar  5 13:54:28 2010
@@ -34,7 +34,7 @@
   }
 
   /** Construct a connector manager.
-  *@param threadContext is the thread context.
+  *@param tc is the thread context.
   *@return the connector manager handle.
   */
   public static IConnectorManager make(IThreadContext tc)

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IJobManager.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IJobManager.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IJobManager.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IJobManager.java
Fri Mar  5 13:54:28 2010
@@ -454,10 +454,8 @@
   * in the specified job's queue, according to specific state rules.
   *@param jobID is the job identifier.
   *@param legalLinkTypes is the set of legal link types that this connector generates.
-  *@param docIDHash is the hashed local document identifier.
-  *@param docID is the local document identifier.
+  *@param docIDHash is the local document identifier hash value.
   *@param parentIdentifierHash is the optional parent identifier hash value for this document.
 Pass null if none.
-  *@param parentIdentifier is the optional parent identifier of this document.  Pass null
if none.
   *@param relationshipType is the optional link type between this document and its parent.
 Pass null if there
   *       is no relationship with a parent.
   *@param hopcountMethod is either accurate, nodelete, or neverdelete.
@@ -530,7 +528,7 @@
 
   /** Retrieve specific parent data for a given document.
   *@param jobID is the job identifier.
-  *@param docID is the document identifier.
+  *@param docIDHash is the document identifier hash value.
   *@param dataName is the kind of data to retrieve.
   *@return the unique data values.
   */
@@ -721,7 +719,7 @@
     throws LCFException;
 
   /** Complete the sequence that aborts jobs and makes them runnable again.
-  *@param currentTime is the current time in milliseconds since epoch.
+  *@param timestamp is the current time in milliseconds since epoch.
   *@param abortJobs is filled in with the set of IJobDescription objects that were aborted.
   */
   public void finishJobAborts(long timestamp, ArrayList abortJobs)

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IRepositoryConnectionManager.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IRepositoryConnectionManager.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IRepositoryConnectionManager.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/interfaces/IRepositoryConnectionManager.java
Fri Mar  5 13:54:28 2010
@@ -172,7 +172,7 @@
   *@param criteria is the filtering criteria, which selects the records of interest.
   *@param sort is the sorting order, which can specify sort based on the result columns.
   *@param startRow is the first row to include (beginning with 0)
-  *@param is the maximum number of rows to include.
+  *@param maxRowCount is the maximum number of rows to include.
   */
   public IResultSet genHistorySimple(String connectionName, FilterCriteria criteria, SortOrder
sort, int startRow, int maxRowCount)
     throws LCFException;
@@ -200,7 +200,7 @@
   *       for each distinct idBucket value, and the returned activity count will the maximum
found over the
   *       specified interval size.
   *@param startRow is the first row to include (beginning with 0)
-  *@param is the maximum number of rows to include.
+  *@param maxRowCount is the maximum number of rows to include.
   */
   public IResultSet genHistoryActivityCount(String connectionName, FilterCriteria criteria,
SortOrder sort, BucketDescription idBucket,
     long interval, int startRow, int maxRowCount)
@@ -220,7 +220,7 @@
   *       for each distinct idBucket value, and the returned activity count will the maximum
found over the
   *       specified interval size.
   *@param startRow is the first row to include (beginning with 0)
-  *@param is the maximum number of rows to include.
+  *@param maxRowCount is the maximum number of rows to include.
   */
   public IResultSet genHistoryByteCount(String connectionName, FilterCriteria criteria, SortOrder
sort, BucketDescription idBucket,
     long interval, int startRow, int maxRowCount)
@@ -239,7 +239,7 @@
   *@param resultCodeBucket is the description of the bucket based on processed result codes.
   *@param idBucket is the description of the bucket based on processed entity identifiers.
   *@param startRow is the first row to include (beginning with 0)
-  *@param is the maximum number of rows to include.
+  *@param maxRowCount is the maximum number of rows to include.
   */
   public IResultSet genHistoryResultCodes(String connectionName, FilterCriteria criteria,
SortOrder sort,
     BucketDescription resultCodeBucket, BucketDescription idBucket, int startRow, int maxRowCount)

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/HopCount.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/HopCount.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/HopCount.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/HopCount.java
Fri Mar  5 13:54:28 2010
@@ -748,11 +748,10 @@
   *@param jobID is the job the documents belong to.
   *@param affectedLinkTypes are the set of affected link types.
   *@param documentIDHashes are the documents to add.
+  *@param startingAnswers are the hopcounts for the documents as they are currently known.
   *@param sourceDocumentIDHash is the source document identifier for the links from source
to target documents.
-  *@param estimates are the current estimated answers and delete dependencies at the sourceDocumentID
for
-  * each of the affectedLinkType values.  These answers, if not null, will be used to calculate
-  *@param linkEstimates, if not null, provide estimated hopcount distances for each affected
link type,
-  * for all the documentIDs.
+  *@param linkType is the link type for this queue addition.
+  *@param hopcountMethod is the desired method of managing hopcounts.
   */
   protected void addToProcessingQueue(Long jobID, String[] affectedLinkTypes, String[] documentIDHashes,
     Answer[] startingAnswers, String sourceDocumentIDHash, String linkType, int hopcountMethod)
@@ -2383,15 +2382,16 @@
     }
 
     /** Add a child reference.
-    *@param childDocumentIdentifier is the document identifier of the child.
-    *@param linkType is the link type.
+    *@param childRef is the child node reference to add.
     */
     public void addChild(NodeReference childRef)
     {
       childReferences.put(childRef,childRef);
     }
 
-    /** Remove a child reference. */
+    /** Remove a child reference.
+    *@param childRef is the child node reference to remove.
+    */
     public void removeChild(NodeReference childRef)
     {
       childReferences.remove(childRef);

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/JobManager.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/JobManager.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/JobManager.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/JobManager.java
Fri Mar  5 13:54:28 2010
@@ -1170,7 +1170,7 @@
   /** Save a set of document priorities.  In the case where a document was eligible to have
its
   * priority set, but it no longer is eligible, then the provided priority will not be written.
   *@param currentTime is the time in milliseconds since epoch.
-  *@param descriptions are the document descriptions.
+  *@param documentDescriptions are the document descriptions.
   *@param priorities are the desired priorities.
   */
   public void writeDocumentPriorities(long currentTime, DocumentDescription[] documentDescriptions,
double[] priorities)
@@ -2769,7 +2769,7 @@
   * enable the framework to get rid of old, invalid seeds.  They are not queued for processing.
   *@param jobID is the job identifier.
   *@param legalLinkTypes is the set of legal link types that this connector generates.
-  *@param docIDs are the local document identifiers.
+  *@param docIDHashes are the local document identifier hashes.
   *@param hopcountMethod is either accurate, nodelete, or neverdelete.
   */
   public void addRemainingDocumentsInitial(Long jobID, String[] legalLinkTypes, String[]
docIDHashes,
@@ -2910,9 +2910,10 @@
   /** Get the specified hop counts, with the limit as described.
   *@param jobID is the job identifier.
   *@param legalLinkTypes is the set of legal link types that this connector generates.
-  *@param docIDs is the set of documents to find the hopcount for.
+  *@param docIDHashes are the hashes for the set of documents to find the hopcount for.
   *@param linkType is the kind of link to find the hopcount for.
   *@param limit is the limit, beyond which a negative distance may be returned.
+  *@param hopcountMethod is the method for managing hopcounts that is in effect.
   *@return a vector of booleans corresponding to the documents requested.  A true value is
returned
   * if the document is within the specified limit, false otherwise.
   */
@@ -3106,10 +3107,11 @@
   * in the specified job's queue, according to specific state rules.
   *@param jobID is the job identifier.
   *@param legalLinkTypes is the set of legal link types that this connector generates.
-  *@param docIDs are the local document identifiers.
-  *@param parentIdentifier is the optional parent identifier of this document.  Pass null
if none.
+  *@param docIDHashes are the local document identifier hashes.
+  *@param parentIdentifierHash is the optional parent identifier hash of this document. 
Pass null if none.
   *@param relationshipType is the optional link type between this document and its parent.
 Pass null if there
   *       is no relationship with a parent.
+  *@param hopcountMethod is the desired method for managing hopcounts.
   *@param dataNames are the names of the data to carry down to the child from this parent.
   *@param dataValues are the values to carry down to the child from this parent, corresponding
to dataNames above.  If CharacterInput objects are passed in here,
   *       it is the caller's responsibility to clean these up.
@@ -3371,10 +3373,11 @@
   * in the specified job's queue, according to specific state rules.
   *@param jobID is the job identifier.
   *@param legalLinkTypes is the set of legal link types that this connector generates.
-  *@param docID is the local document identifier.
-  *@param parentIdentifier is the optional parent identifier of this document.  Pass null
if none.
+  *@param docIDHash is the local document identifier hash value.
+  *@param parentIdentifierHash is the optional parent identifier hash of this document. 
Pass null if none.
   *@param relationshipType is the optional link type between this document and its parent.
 Pass null if there
   *       is no relationship with a parent.
+  *@param hopcountMethod is the desired method for managing hopcounts.
   *@param dataNames are the names of the data to carry down to the child from this parent.
   *@param dataValues are the values to carry down to the child from this parent, corresponding
to dataNames above.
   *@param currentTime is the time in milliseconds since epoch that will be recorded for this
operation.
@@ -3398,7 +3401,7 @@
   * This method is called at the end of document processing, to help the hopcount tracking
engine do its bookkeeping.
   *@param jobID is the job identifier.
   *@param legalLinkTypes is the set of legal link types that this connector generates.
-  *@param parentIdentifiers are the document identifiers for whom child link extraction just
took place.
+  *@param parentIdentifierHashes are the document identifier hashes for whom child link extraction
just took place.
   *@param hopcountMethod describes how to handle deletions for hopcount purposes.
   *@return the set of documents for which carrydown data was changed by this operation. 
These documents are likely
   *  to be requeued as a result of the change.
@@ -3773,7 +3776,7 @@
 
   /** Retrieve specific parent data for a given document.
   *@param jobID is the job identifier.
-  *@param docID is the document identifier.
+  *@param docIDHash is the document identifier hash value.
   *@param dataName is the kind of data to retrieve.
   *@return the unique data values.
   */
@@ -3785,7 +3788,7 @@
 
   /** Retrieve specific parent data for a given document.
   *@param jobID is the job identifier.
-  *@param docID is the document identifier.
+  *@param docIDHash is the document identifier hash value.
   *@param dataName is the kind of data to retrieve.
   *@return the unique data values.
   */
@@ -4984,7 +4987,6 @@
 
   /** Delete jobs in need of being deleted (which are marked "ready for delete").
   * This method is meant to be called periodically to perform delete processing on jobs.
-  *@return the set of jobs that are ready to be deleted.
   */
   public void deleteJobsReadyForDelete()
     throws LCFException

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/Jobs.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/Jobs.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/Jobs.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/Jobs.java
Fri Mar  5 13:54:28 2010
@@ -302,7 +302,7 @@
   }
 
   /** Come up with a maximum time (in minutes) for re-analyzing tables.
-  *@Return the time, in minutes.
+  *@return the time, in minutes.
   */
   public int getAnalyzeTime()
     throws LCFException
@@ -2004,7 +2004,6 @@
 
   /** Get multiple jobs (without caching)
   *@param ids is the set of ids to get jobs for.
-  *@param readOnlies are set to true if the job is meant to be read as "read only".
   *@return the corresponding job descriptions.
   */
   protected JobDescription[] getJobsMultiple(Long[] ids)

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleList.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleList.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleList.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleList.java
Fri Mar  5 13:54:28 2010
@@ -62,7 +62,7 @@
   }
 
   /** Add a record.
-  *@param record is the record to add to the end.
+  *@param sr is the record to add to the end.
   */
   public void addRecord(ScheduleRecord sr)
   {

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleManager.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleManager.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleManager.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/jobs/ScheduleManager.java
Fri Mar  5 13:54:28 2010
@@ -182,7 +182,7 @@
 
   /** Write a schedule list into the database.
   *@param ownerID is the owning identifier.
-  *@param schedule is the schedule list.
+  *@param list is the job description that is the source of the schedule.
   */
   public void writeRows(Long ownerID, IJobDescription list)
     throws LCFException

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/RepositoryConnectionManager.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/RepositoryConnectionManager.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/RepositoryConnectionManager.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/RepositoryConnectionManager.java
Fri Mar  5 13:54:28 2010
@@ -579,7 +579,7 @@
   *@param criteria is the filtering criteria, which selects the records of interest.
   *@param sort is the sorting order, which can specify sort based on the result columns.
   *@param startRow is the first row to include (beginning with 0)
-  *@param is the maximum number of rows to include.
+  *@param maxRowCount is the maximum number of rows to include.
   */
   public IResultSet genHistorySimple(String connectionName, FilterCriteria criteria, SortOrder
sort, int startRow, int maxRowCount)
     throws LCFException
@@ -601,7 +601,7 @@
   *       for each distinct idBucket value, and the returned activity count will the maximum
found over the
   *       specified interval size.
   *@param startRow is the first row to include (beginning with 0)
-  *@param is the maximum number of rows to include.
+  *@param maxRowCount is the maximum number of rows to include.
   */
   public IResultSet genHistoryActivityCount(String connectionName, FilterCriteria criteria,
SortOrder sort, BucketDescription idBucket,
     long interval, int startRow, int maxRowCount)
@@ -624,7 +624,7 @@
   *       for each distinct idBucket value, and the returned activity count will the maximum
found over the
   *       specified interval size.
   *@param startRow is the first row to include (beginning with 0)
-  *@param is the maximum number of rows to include.
+  *@param maxRowCount is the maximum number of rows to include.
   */
   public IResultSet genHistoryByteCount(String connectionName, FilterCriteria criteria, SortOrder
sort, BucketDescription idBucket,
     long interval, int startRow, int maxRowCount)
@@ -646,7 +646,7 @@
   *@param resultCodeBucket is the description of the bucket based on processed result codes.
   *@param idBucket is the description of the bucket based on processed entity identifiers.
   *@param startRow is the first row to include (beginning with 0)
-  *@param is the maximum number of rows to include.
+  *@param maxRowCount is the maximum number of rows to include.
   */
   public IResultSet genHistoryResultCodes(String connectionName, FilterCriteria criteria,
SortOrder sort,
     BucketDescription resultCodeBucket, BucketDescription idBucket, int startRow, int maxRowCount)

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/ThrottleSpecManager.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/ThrottleSpecManager.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/ThrottleSpecManager.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/repository/ThrottleSpecManager.java
Fri Mar  5 13:54:28 2010
@@ -106,8 +106,8 @@
   }
 
   /** Read rows for a given owner name.
-  *@param id is the owner name.
-  *@param return a list, with columns: "description", "match", and "value".
+  *@param name is the owner name.
+  *@return a list, with columns: "description", "match", and "value".
   */
   public IResultSet readRows(String name)
     throws LCFException

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/DeleteQueuedDocument.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/DeleteQueuedDocument.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/DeleteQueuedDocument.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/DeleteQueuedDocument.java
Fri Mar  5 13:54:28 2010
@@ -41,7 +41,6 @@
 
   /** Constructor.
   *@param documentDescription is the document description.
-  *@param lastIngestedVersion is the last ingested version.
   */
   public DeleteQueuedDocument(DocumentDescription documentDescription)
   {

Modified: incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/QueuedDocument.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/QueuedDocument.java?rev=919414&r1=919413&r2=919414&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/QueuedDocument.java
(original)
+++ incubator/lcf/trunk/modules/framework/pull-agent/org/apache/lcf/crawler/system/QueuedDocument.java
Fri Mar  5 13:54:28 2010
@@ -45,7 +45,8 @@
 
   /** Constructor.
   *@param documentDescription is the document description.
-  *@param lastIngestedVersion is the last ingested version.
+  *@param lastIngestedStatus is the document's last ingested status.
+  *@param binNames are the bins associated with the document.
   */
   public QueuedDocument(DocumentDescription documentDescription, DocumentIngestStatus lastIngestedStatus,
String[] binNames)
   {



Mime
View raw message