You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by me...@apache.org on 2012/03/02 12:53:24 UTC
svn commit: r1296160 - in /incubator/accumulo/trunk/src:
core/src/main/java/org/apache/accumulo/core/bloomfilter/
core/src/main/java/org/apache/accumulo/core/client/
core/src/main/java/org/apache/accumulo/core/client/admin/
core/src/main/java/org/apach...
Author: medined
Date: Fri Mar 2 11:53:23 2012
New Revision: 1296160
URL: http://svn.apache.org/viewvc?rev=1296160&view=rev
Log:
fixes to javadocs warnings as per ACCUMULO-441
Modified:
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/bloomfilter/Filter.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Connector.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Instance.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/impl/ConnectorImpl.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/AccumuloFileOutputFormat.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/InputFormatBase.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockShell.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockTable.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/AggregatingIterator.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/Combiner.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/IteratorUtil.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/Aggregator.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/LongSummation.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumArraySummation.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumSummation.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMax.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMin.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringSummation.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/system/MapFileIterator.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/user/RowFilter.java
incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/util/shell/Shell.java
incubator/accumulo/trunk/src/examples/simple/src/main/java/org/apache/accumulo/examples/simple/combiner/StatsCombiner.java
incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java
incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java
incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java
incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java
incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java
incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java
incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java
incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java
incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java
incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java
incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/balancer/TabletBalancer.java
incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/state/TabletStateStore.java
incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/tabletserver/MemValue.java
incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/test/randomwalk/Framework.java
incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/util/TServerUtils.java
incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooLock.java
incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooReaderWriter.java
incubator/accumulo/trunk/src/trace/src/main/java/cloudtrace/instrument/Sampler.java
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/bloomfilter/Filter.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/bloomfilter/Filter.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/bloomfilter/Filter.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/bloomfilter/Filter.java Fri Mar 2 11:53:23 2012
@@ -113,7 +113,7 @@ public abstract class Filter implements
*
* @param key
* The key to add.
- * @return
+ * @return true if the key was added, false otherwise.
*/
public abstract boolean add(Key key);
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Connector.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Connector.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Connector.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Connector.java Fri Mar 2 11:53:23 2012
@@ -44,14 +44,14 @@ public class Connector {
* when a generic exception occurs
* @throws AccumuloSecurityException
* when a user's credentials are invalid
- * @see Instance.getConnector(String user, byte[] password)
+ * @see Instance#getConnector(String user, byte[] password)
*/
public Connector(Instance instance, String user, byte[] password) throws AccumuloException, AccumuloSecurityException {
impl = instance.getConnector(user, password);
}
/**
- * @see Instance.getConnector(String user, byte[] password)
+ * @see Instance#getConnector(String user, byte[] password)
* @deprecated Not for client use
*/
public Connector() {
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Instance.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Instance.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Instance.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/Instance.java Fri Mar 2 11:53:23 2012
@@ -87,10 +87,8 @@ public interface Instance {
/**
* Returns a connection to accumulo.
*
- * @param user
- * a valid accumulo user
- * @param pass
- * A UTF-8 encoded password. The password may be cleared after making this call.
+ * @param auth
+ * An AuthInfo object.
* @return the accumulo Connector
* @throws AccumuloException
* when a generic exception occurs
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java Fri Mar 2 11:53:23 2012
@@ -44,8 +44,6 @@ public interface InstanceOperations {
/**
* Removes a instance property from zookeeper
*
- * @param tableName
- * the name of the table
* @param property
* the name of a per-table property
* @throws AccumuloException
@@ -62,16 +60,17 @@ public interface InstanceOperations {
/**
* List the currently active tablet servers participating in the accumulo instance
*
- * @return
+ * @return A list of currently active tablet servers.
*/
public List<String> getTabletServers();
/**
- * List the active scans on tablet server. The tablet server address should be of the form <ip address>:<port>
+ * List the active scans on tablet server.
*
* @param tserver
- * @return
+ * The tablet server address should be of the form <ip address>:<port>
+ * @return A list of active scans on tablet server.
* @throws AccumuloException
* @throws AccumuloSecurityException
*/
@@ -83,7 +82,7 @@ public interface InstanceOperations {
*
* @param className
* @param asTypeName
- * @return
+ * @return true if the instance can load the given class as the given type, false otherwise
* @throws AccumuloException
*/
public boolean testClassLoad(final String className, final String asTypeName) throws AccumuloException, AccumuloSecurityException;
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java Fri Mar 2 11:53:23 2012
@@ -88,8 +88,6 @@ public interface TableOperations {
* the name of the table
* @param timeType
* specifies logical or real-time based time recording for entries in the table
- * @param limitVersion
- * Enables/disables the versioning iterator, which will limit the number of Key versions kept.
* @throws AccumuloException
* if a general error occurs
* @throws AccumuloSecurityException
@@ -412,7 +410,7 @@ public interface TableOperations {
/**
* @deprecated Since 1.4
- * @see {@link TableOperations#importDirectory(String, String, String)};
+ * @see #importDirectory(String, String, String, boolean)
*/
public AssignmentStats importDirectory(String tableName, String dir, String failureDir, int numThreads, int numAssignThreads, boolean disableGC)
throws IOException, AccumuloException, AccumuloSecurityException;
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/impl/ConnectorImpl.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/impl/ConnectorImpl.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/impl/ConnectorImpl.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/impl/ConnectorImpl.java Fri Mar 2 11:53:23 2012
@@ -50,14 +50,14 @@ public class ConnectorImpl extends Conne
/**
*
- * Use {@link Instance#getConnector(String, byte[])
+ * Use {@link Instance#getConnector(String, byte[])}
*
* @param instance
* @param user
* @param password
* @throws AccumuloException
* @throws AccumuloSecurityException
- * @see Instance.getConnector(String user, byte[] password)
+ * @see Instance#getConnector(String user, byte[] password)
* @deprecated Not for client use
*/
public ConnectorImpl(Instance instance, String user, byte[] password) throws AccumuloException, AccumuloSecurityException {
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/AccumuloFileOutputFormat.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/AccumuloFileOutputFormat.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/AccumuloFileOutputFormat.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/AccumuloFileOutputFormat.java Fri Mar 2 11:53:23 2012
@@ -114,7 +114,7 @@ public class AccumuloFileOutputFormat ex
/**
*
* @param job
- * @return
+ * @return The Accumulo instance.
*
* @deprecated since 1.4, use {@link #setBlockSize(Configuration, int)} no other configurations are used by OutputFormat
*/
@@ -125,7 +125,7 @@ public class AccumuloFileOutputFormat ex
/**
*
* @param conf
- * @return
+ * @return The Accumulo instance.
*
* @deprecated since 1.4, use {@link #setBlockSize(Configuration, int)} no other configurations are used by OutputFormat
*/
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/InputFormatBase.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/InputFormatBase.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/InputFormatBase.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mapreduce/InputFormatBase.java Fri Mar 2 11:53:23 2012
@@ -136,7 +136,9 @@ public abstract class InputFormatBase<K,
* Enable or disable use of the {@link IsolatedScanner}. By default it is not enabled.
*
* @param conf
+ * The Hadoop configuration object
* @param enable
+ * if true, enable usage of the IsolatedScanner. Otherwise, disable.
*/
public static void setIsolated(Configuration conf, boolean enable) {
conf.setBoolean(ISOLATED, enable);
@@ -145,8 +147,10 @@ public abstract class InputFormatBase<K,
/**
* Enable or disable use of the {@link ClientSideIteratorScanner}. By default it is not enabled.
*
- * @param job
+ * @param conf
+ * The Hadoop configuration object
* @param enable
+ * if true, enable usage of the ClientSideInteratorScanner. Otherwise, disable.
*/
public static void setLocalIterators(Configuration conf, boolean enable) {
conf.setBoolean(LOCAL_ITERATORS, enable);
@@ -248,8 +252,6 @@ public abstract class InputFormatBase<K,
*
* @param conf
* The job in which to save the iterator configuration
- * @param priority
- * The priority of the iterator
* @param cfg
* The configuration of the iterator
*/
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockShell.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockShell.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockShell.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockShell.java Fri Mar 2 11:53:23 2012
@@ -119,8 +119,9 @@ public class MockShell extends Shell {
/**
* Convenience method to create the byte-array to hand to the console
- * @param commands Array of commands to run
- * @return
+ * @param commands
+ * An array of commands to run
+ * @return A byte[] input stream which can be handed to the console.
*/
public static ByteArrayInputStream makeCommands(String... commands) {
StringBuilder sb = new StringBuilder(commands.length * 8);
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockTable.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockTable.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockTable.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/client/mock/MockTable.java Fri Mar 2 11:53:23 2012
@@ -114,7 +114,8 @@ public class MockTable {
}
/**
- * @deprecated since 1.4 {@link #attachIterator(String, IteratorSetting)}
+ * @deprecated since 1.4
+ * @see TableOperations#attachIterator(String, IteratorSetting)
*/
public void addAggregators(List<? extends org.apache.accumulo.core.iterators.conf.PerColumnIteratorConfig> aggregators) {
for (Entry<String,String> entry : IteratorUtil.generateAggTableProperties(aggregators).entrySet()) {
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/AggregatingIterator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/AggregatingIterator.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/AggregatingIterator.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/AggregatingIterator.java Fri Mar 2 11:53:23 2012
@@ -36,7 +36,7 @@ import org.apache.log4j.Logger;
* This iterator wraps another iterator. It automatically aggregates.
*
* @deprecated since 1.4
- * @use org.apache.accumulo.core.iterators.Combiner
+ * @see org.apache.accumulo.core.iterators.Combiner
*/
public class AggregatingIterator implements SortedKeyValueIterator<Key,Value>, OptionDescriber {
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/Combiner.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/Combiner.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/Combiner.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/Combiner.java Fri Mar 2 11:53:23 2012
@@ -295,13 +295,12 @@ public abstract class Combiner extends W
}
/**
- * A convenience method to set the "all columns" option on a Combiner. If true, the columns option will be ignored and the Combiner will be applied to all
- * columns.
+ * A convenience method to set the "all columns" option on a Combiner.
*
* @param is
* iterator settings object to configure
- * @param enableAllColumns
- * if true the combiner will be applied to all columns
+ * @param combineAllColumns
+ * if true, the columns option is ignored and the Combiner will be applied to all columns
*/
public static void setCombineAllColumns(IteratorSetting is, boolean combineAllColumns) {
is.addOption(ALL_OPTION, Boolean.toString(combineAllColumns));
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/IteratorUtil.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/IteratorUtil.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/IteratorUtil.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/IteratorUtil.java Fri Mar 2 11:53:23 2012
@@ -61,9 +61,9 @@ public class IteratorUtil {
/**
* @deprecated since 1.4
* @param aggregators
- * @return
+ * @return A map of Aggregator Table Properties.
*
- * @see {@link TableOperations#attachIterators(String, IteratorSetting)}
+ * @see TableOperations#attachIterator(String, IteratorSetting)
*/
public static Map<String,String> generateAggTableProperties(List<? extends PerColumnIteratorConfig> aggregators) {
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/Aggregator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/Aggregator.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/Aggregator.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/Aggregator.java Fri Mar 2 11:53:23 2012
@@ -20,7 +20,7 @@ import org.apache.accumulo.core.data.Val
/**
* @deprecated since 1.4
- * @use org.apache.accumulo.core.iterators.Combiner
+ * @see org.apache.accumulo.core.iterators.Combiner
*/
public interface Aggregator {
void reset();
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/LongSummation.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/LongSummation.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/LongSummation.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/LongSummation.java Fri Mar 2 11:53:23 2012
@@ -23,7 +23,7 @@ import org.apache.log4j.Logger;
/**
* @deprecated since 1.4
- * @use org.apache.accumulo.core.iterators.user.SummingCombiner with SummingCombiner.Type.FIXEDLEN
+ * @see org.apache.accumulo.core.iterators.user.SummingCombiner with SummingCombiner.Type.FIXEDLEN
*/
public class LongSummation implements Aggregator {
private static final Logger log = Logger.getLogger(LongSummation.class);
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumArraySummation.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumArraySummation.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumArraySummation.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumArraySummation.java Fri Mar 2 11:53:23 2012
@@ -27,7 +27,7 @@ import org.apache.hadoop.io.WritableUtil
/**
* @deprecated since 1.4
- * @use org.apache.accumulo.core.iterators.user.SummingArrayCombiner with SummingArrayCombiner.Type.VARLONG
+ * @see org.apache.accumulo.core.iterators.user.SummingArrayCombiner with SummingArrayCombiner.Type.VARLONG
*/
public class NumArraySummation implements Aggregator {
long[] sum = new long[0];
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumSummation.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumSummation.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumSummation.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/NumSummation.java Fri Mar 2 11:53:23 2012
@@ -27,7 +27,7 @@ import org.apache.hadoop.io.WritableUtil
/**
* @deprecated since 1.4
- * @use org.apache.accumulo.core.iterators.user.SummingCombiner with SummingCombiner.Type.VARLEN
+ * @see org.apache.accumulo.core.iterators.user.SummingCombiner with SummingCombiner.Type.VARLEN
*/
public class NumSummation implements Aggregator {
long sum = 0l;
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMax.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMax.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMax.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMax.java Fri Mar 2 11:53:23 2012
@@ -20,7 +20,7 @@ import org.apache.accumulo.core.data.Val
/**
* @deprecated since 1.4
- * @use org.apache.accumulo.core.iterators.user.MaxCombiner with MaxCombiner.Type.STRING
+ * @see org.apache.accumulo.core.iterators.user.MaxCombiner with MaxCombiner.Type.STRING
*/
public class StringMax implements Aggregator {
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMin.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMin.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMin.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringMin.java Fri Mar 2 11:53:23 2012
@@ -20,7 +20,7 @@ import org.apache.accumulo.core.data.Val
/**
* @deprecated since 1.4
- * @use org.apache.accumulo.core.iterators.user.MinCombiner with MinCombiner.Type.STRING
+ * @see org.apache.accumulo.core.iterators.user.MinCombiner with MinCombiner.Type.STRING
*/
public class StringMin implements Aggregator {
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringSummation.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringSummation.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringSummation.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/aggregation/StringSummation.java Fri Mar 2 11:53:23 2012
@@ -20,7 +20,7 @@ import org.apache.accumulo.core.data.Val
/**
* @deprecated since 1.4
- * @use org.apache.accumulo.core.iterators.user.SummingCombiner with SummingCombiner.Type.STRING
+ * @see org.apache.accumulo.core.iterators.user.SummingCombiner with SummingCombiner.Type.STRING
*/
public class StringSummation implements Aggregator {
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/system/MapFileIterator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/system/MapFileIterator.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/system/MapFileIterator.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/system/MapFileIterator.java Fri Mar 2 11:53:23 2012
@@ -52,8 +52,8 @@ public class MapFileIterator implements
/**
* @param acuconf
- * @param fs2
- * @param file
+ * @param fs
+ * @param dir
* @param conf
* @throws IOException
*/
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/user/RowFilter.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/user/RowFilter.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/user/RowFilter.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/user/RowFilter.java Fri Mar 2 11:53:23 2012
@@ -95,7 +95,7 @@ public abstract class RowFilter extends
*
* @param rowIterator
* - An iterator over the row.
- * @return
+ * @return false if a row should be suppressed, otherwise true.
* @throws IOException
*/
public abstract boolean acceptRow(SortedKeyValueIterator<Key,Value> rowIterator) throws IOException;
Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/util/shell/Shell.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/util/shell/Shell.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/util/shell/Shell.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/util/shell/Shell.java Fri Mar 2 11:53:23 2012
@@ -950,8 +950,7 @@ public class Shell extends ShellOptions
/**
* Return the formatter for this table, .
*
- * @param tableName
- * @return The formatter class for the given table
+ * @return The formatter class for this table
*/
public Class<? extends Formatter> getFormatter() {
return getFormatter(this.tableName);
Modified: incubator/accumulo/trunk/src/examples/simple/src/main/java/org/apache/accumulo/examples/simple/combiner/StatsCombiner.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/simple/src/main/java/org/apache/accumulo/examples/simple/combiner/StatsCombiner.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/simple/src/main/java/org/apache/accumulo/examples/simple/combiner/StatsCombiner.java (original)
+++ incubator/accumulo/trunk/src/examples/simple/src/main/java/org/apache/accumulo/examples/simple/combiner/StatsCombiner.java Fri Mar 2 11:53:23 2012
@@ -100,8 +100,8 @@ public class StatsCombiner extends Combi
*
* @param iterConfig
* Iterator settings to configure
- * @param maxSize
- * Maximum set size
+ * @param base
+ * The expected base/radix of the numbers.
*/
public static void setRadix(IteratorSetting iterConfig, int base) {
iterConfig.addOption(RADIX_OPTION, base + "");
Modified: incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java Fri Mar 2 11:53:23 2012
@@ -112,7 +112,7 @@ public class WikipediaMapper extends Map
*
* @param article
* @param numPartitions
- * @return
+ * @return The number of the partition for a given article.
* @throws IllegalFormatException
*/
public static int getPartitionId(Article article, int numPartitions) throws IllegalFormatException {
Modified: incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java Fri Mar 2 11:53:23 2012
@@ -62,9 +62,9 @@ public class TextUtil {
/**
* Appends the UTF-8 bytes of the given string to the given {@link Text}
*
- * @param text
+ * @param t
* the Text to which to append
- * @param string
+ * @param s
* the String to append
*/
public static void textAppendNoNull(Text t, String s) {
Modified: incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java Fri Mar 2 11:53:23 2012
@@ -114,10 +114,10 @@ public abstract class AbstractEvaluating
public abstract void fillMap(EventFields event, Key key, Value value) throws Exception;
/**
- * Check to see if this key should be acted upon. Provides the ability to skip this key and all of the following ones that match using the comparator.
+ * Provides the ability to skip this key and all of the following ones that match using the comparator.
*
* @param key
- * @return
+ * @return true if the key should be acted upon, otherwise false.
* @throws IOException
*/
public abstract boolean isKeyAccepted(Key key) throws IOException;
Modified: incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java Fri Mar 2 11:53:23 2012
@@ -96,7 +96,7 @@ public class AndIterator implements Sort
* Returns the given key's dataLocation
*
* @param key
- * @return
+ * @return The given key's dataLocation
*/
protected Text getDataLocation(Key key) {
return key.getColumnFamily();
@@ -106,7 +106,7 @@ public class AndIterator implements Sort
* Returns the given key's term
*
* @param key
- * @return
+ * @return The given key's term
*/
protected Text getTerm(Key key) {
int idx = 0;
@@ -120,7 +120,7 @@ public class AndIterator implements Sort
* Returns the given key's DocID
*
* @param key
- * @return
+ * @return The given key's DocID
*/
protected Text getDocID(Key key) {
int idx = 0;
@@ -134,7 +134,7 @@ public class AndIterator implements Sort
* Returns the given key's UID
*
* @param key
- * @return
+ * @return The given key's UID
*/
protected String getUID(Key key) {
int idx = 0;
@@ -151,7 +151,7 @@ public class AndIterator implements Sort
* The desired row
* @param dataLocation
* The desired dataLocation
- * @return
+ * @return A Key object built from the given row and dataLocation.
*/
protected Key buildKey(Text row, Text dataLocation) {
return new Key(row, (dataLocation == null) ? nullText : dataLocation);
@@ -166,7 +166,7 @@ public class AndIterator implements Sort
* The desired dataLocation
* @param term
* The desired term
- * @return
+ * @return A Key object built from the given row, dataLocation, and term.
*/
protected Key buildKey(Text row, Text dataLocation, Text term) {
return new Key(row, (dataLocation == null) ? nullText : dataLocation, (term == null) ? nullText : term);
@@ -177,7 +177,7 @@ public class AndIterator implements Sort
*
* @param key
* The key who will be directly before the returned key
- * @return
+ * @return The key directly following the given key.
*/
protected Key buildFollowingPartitionKey(Key key) {
return key.followingKey(PartialKey.ROW);
@@ -589,7 +589,7 @@ public class AndIterator implements Sort
*
* @param columns
* The columns to be encoded
- * @return
+ * @return A Base64 encoded string (using a \n delimiter) of all columns to intersect on.
*/
public static String encodeColumns(Text[] columns) {
StringBuilder sb = new StringBuilder();
@@ -605,7 +605,7 @@ public class AndIterator implements Sort
*
* @param terms
* The terms to be encoded
- * @return
+ * @return A Base64 encoded string (using a \n delimiter) of all terms to intersect on.
*/
public static String encodeTermValues(Text[] terms) {
StringBuilder sb = new StringBuilder();
@@ -622,7 +622,7 @@ public class AndIterator implements Sort
*
* @param flags
* The array of NOTs
- * @return
+ * @return A base64 encoded string of which columns are NOT'ed
*/
public static String encodeBooleans(boolean[] flags) {
byte[] bytes = new byte[flags.length];
@@ -641,7 +641,7 @@ public class AndIterator implements Sort
*
* @param columns
* The Base64 encoded String of the columns
- * @return
+ * @return A Text array of the decoded columns
*/
public static Text[] decodeColumns(String columns) {
String[] columnStrings = columns.split("\n");
@@ -658,7 +658,7 @@ public class AndIterator implements Sort
*
* @param terms
* The Base64 encoded String of the terms
- * @return
+ * @return A Text array of decoded terms.
*/
public static Text[] decodeTermValues(String terms) {
String[] termStrings = terms.split("\n");
@@ -674,7 +674,7 @@ public class AndIterator implements Sort
* Decode the encoded NOT flags into a <code>boolean</code> array
*
* @param flags
- * @return
+ * @return A boolean array of decoded NOT flags
*/
public static boolean[] decodeBooleans(String flags) {
// return null of there were no flags
Modified: incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java Fri Mar 2 11:53:23 2012
@@ -150,7 +150,7 @@ public class OrIterator implements Sorte
* Returns the given key's row
*
* @param key
- * @return
+ * @return The given key's row
*/
protected Text getPartition(Key key) {
return key.getRow();
@@ -160,7 +160,7 @@ public class OrIterator implements Sorte
* Returns the given key's dataLocation
*
* @param key
- * @return
+ * @return The given key's dataLocation
*/
protected Text getDataLocation(Key key) {
return key.getColumnFamily();
@@ -170,7 +170,7 @@ public class OrIterator implements Sorte
* Returns the given key's term
*
* @param key
- * @return
+ * @return The given key's term
*/
protected Text getTerm(Key key) {
int idx = 0;
@@ -184,7 +184,7 @@ public class OrIterator implements Sorte
* Returns the given key's DocID
*
* @param key
- * @return
+ * @return The given key's DocID
*/
protected Text getDocID(Key key) {
int idx = 0;
@@ -198,7 +198,7 @@ public class OrIterator implements Sorte
* Returns the given key's UID
*
* @param key
- * @return
+ * @return The given key's UID
*/
static protected String getUID(Key key) {
try {
@@ -260,7 +260,7 @@ public class OrIterator implements Sorte
* Construct the topKey given the current <code>TermSource</code>
*
* @param TS
- * @return
+ * @return The top Key for a given TermSource
*/
protected Key buildTopKey(TermSource TS) {
if ((TS == null) || (TS.topKey == null)) {
Modified: incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java Fri Mar 2 11:53:23 2012
@@ -222,8 +222,6 @@ public abstract class AbstractQueryLogic
* @param c
* @param auths
* @param queryLiterals
- * @param begin
- * @param end
* @param datatypes
* - optional list of types
* @return map of indexed field names to types to normalizers used in this date range
@@ -286,8 +284,6 @@ public abstract class AbstractQueryLogic
* @param c
* @param auths
* @param value
- * @param begin
- * @param end
* @param datatypes
* - optional list of types
* @return ranges that fit into the date range.
@@ -305,11 +301,6 @@ public abstract class AbstractQueryLogic
* multimap of indexed field name and Normalizers used
* @param terms
* multimap of field name and QueryTerm object
- * @param begin
- * query begin date
- * @param end
- * query end date
- * @param dateFormatter
* @param indexTableName
* @param reverseIndexTableName
* @param queryString
Modified: incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java Fri Mar 2 11:53:23 2012
@@ -90,7 +90,7 @@ public class FieldIndexQueryReWriter {
*
* @param query
* @param options
- * @return
+ * @return String representation of a given query.
* @throws ParseException
* @throws Exception
*/
@@ -115,7 +115,7 @@ public class FieldIndexQueryReWriter {
*
* @param query
* @param options
- * @return
+ * @return String representation of a given query.
* @throws ParseException
* @throws Exception
*/
@@ -140,7 +140,7 @@ public class FieldIndexQueryReWriter {
* @param query
* @param fNameUpper
* @param fValueUpper
- * @return
+ * @return String representation of a given query.
* @throws ParseException
*/
public String applyCaseSensitivity(String query, boolean fNameUpper, boolean fValueUpper) throws ParseException {
@@ -748,9 +748,7 @@ public class FieldIndexQueryReWriter {
}
/**
- *
* @param options
- * @return
*/
public Multimap<String,String> parseIndexedTerms(Map<String,String> options) {
if (options.get(INDEXED_TERMS_LIST) != null) {
@@ -782,9 +780,7 @@ public class FieldIndexQueryReWriter {
}
/**
- *
* @param root
- * @return
*/
public RewriterTreeNode refactorTree(RewriterTreeNode root) {
Enumeration<?> dfe = root.breadthFirstEnumeration();
@@ -983,8 +979,7 @@ public class FieldIndexQueryReWriter {
}
/**
- *
- * @return
+ * @return The field name.
*/
public String getFieldName() {
return fieldName;
@@ -1000,7 +995,7 @@ public class FieldIndexQueryReWriter {
/**
*
- * @return
+ * @return The field value.
*/
public String getFieldValue() {
return fieldValue;
@@ -1016,7 +1011,7 @@ public class FieldIndexQueryReWriter {
/**
*
- * @return
+ * @return true if negated, otherwise false.
*/
public boolean isNegated() {
return negated;
@@ -1032,7 +1027,7 @@ public class FieldIndexQueryReWriter {
/**
*
- * @return
+ * @return The operator.
*/
public String getOperator() {
return operator;
@@ -1048,7 +1043,7 @@ public class FieldIndexQueryReWriter {
/**
*
- * @return
+ * @return The type.
*/
public int getType() {
return type;
@@ -1070,10 +1065,6 @@ public class FieldIndexQueryReWriter {
this.removal = removal;
}
- /**
- *
- * @return
- */
public String getContents() {
StringBuilder s = new StringBuilder("[");
s.append(toString());
@@ -1092,7 +1083,7 @@ public class FieldIndexQueryReWriter {
/**
*
- * @return
+ * @return A string represenation of the field name and value.
*/
public String printNode() {
StringBuilder s = new StringBuilder("[");
Modified: incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java Fri Mar 2 11:53:23 2012
@@ -201,7 +201,6 @@ public class QueryEvaluator {
* Evaluates the query against an event.
*
* @param eventFields
- * @return
*/
public boolean evaluate(EventFields eventFields) {
Modified: incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java Fri Mar 2 11:53:23 2012
@@ -279,9 +279,6 @@ public class RangeCalculator extends Que
* @param auths
* @param indexedTerms
* @param terms
- * @param begin
- * @param end
- * @param dateFormatter
* @param query
* @param logic
* @param typeFilter
@@ -564,7 +561,6 @@ public class RangeCalculator extends Que
* mapKey for wildcard and range queries that specify which mapkey to use in the results
* @param typeFilter
* - optional list of datatypes
- * @return
* @throws TableNotFoundException
*/
protected Map<MapKey,TermRange> queryGlobalIndex(Map<MapKey,Set<Range>> indexRanges, String specificFieldName, String tableName, boolean isReverse,
Modified: incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java (original)
+++ incubator/accumulo/trunk/src/examples/wikisearch/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java Fri Mar 2 11:53:23 2012
@@ -204,7 +204,7 @@ public class Query implements IQuery {
*
* @param query
* @param auths
- * @return
+ * @return The results of a query
* @throws ParseException
*/
public Results query(String query, String auths) {
Modified: incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/balancer/TabletBalancer.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/balancer/TabletBalancer.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/balancer/TabletBalancer.java (original)
+++ incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/balancer/TabletBalancer.java Fri Mar 2 11:53:23 2012
@@ -42,18 +42,15 @@ public abstract class TabletBalancer {
private static final Logger log = Logger.getLogger(TabletBalancer.class);
/**
- * Assign tablets to tablet servers
+ * Assign tablets to tablet servers. This method is called whenever the master finds tablets that are unassigned.
*
* @param current
* The current table-summary state of all the online tablet servers. Read-only. The TabletServerStatus for each server may be null if the tablet
* server has not yet responded to a recent request for status.
* @param unassigned
* A map from unassigned tablet to the last known tablet server. Read-only.
- * @param assignements
+ * @param assignments
* A map from tablet to assigned server. Write-only.
- * @return
- *
- * This method is called whenever the master finds tablets that are unassigned.
*/
abstract public void getAssignments(SortedMap<TServerInstance,TabletServerStatus> current, Map<KeyExtent,TServerInstance> unassigned,
Map<KeyExtent,TServerInstance> assignments);
@@ -79,7 +76,7 @@ public abstract class TabletBalancer {
*
* @param tserver
* The tablet server to ask.
- * @param table
+ * @param tableId
* The table id
* @return a list of tablet statistics
* @throws ThriftSecurityException
@@ -110,7 +107,7 @@ public abstract class TabletBalancer {
*
* @param current
* @param migrations
- * @return
+ * @return A list of TabletMigration object that passed sanity checks.
*/
public static List<TabletMigration> checkMigrationSanity(Set<TServerInstance> current, List<TabletMigration> migrations) {
List<TabletMigration> result = new ArrayList<TabletMigration>(migrations.size());
Modified: incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/state/TabletStateStore.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/state/TabletStateStore.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/state/TabletStateStore.java (original)
+++ incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/master/state/TabletStateStore.java Fri Mar 2 11:53:23 2012
@@ -44,10 +44,7 @@ public abstract class TabletStateStore i
/**
* Store the assigned locations in the data store.
*
- * @param extent
- * The tablet definition
- * @param tabletSession
- * the tablet server the tablet is to be assigned
+ * @param assignments
* @throws DistributedStoreException
*/
abstract public void setFutureLocations(Collection<Assignment> assignments) throws DistributedStoreException;
@@ -55,10 +52,7 @@ public abstract class TabletStateStore i
/**
* Tablet servers will update the data store with the location when they bring the tablet online
*
- * @param extent
- * the tablet definition
- * @param tabletSession
- * the tablet server that opened the tablet
+ * @param assignments
* @throws DistributedStoreException
*/
abstract public void setLocations(Collection<Assignment> assignments) throws DistributedStoreException;
@@ -66,7 +60,7 @@ public abstract class TabletStateStore i
/**
* Mark the tablets as having no known or future location.
*
- * @param extent
+ * @param tablets
* the tablets' current information
* @throws DistributedStoreException
*/
Modified: incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/tabletserver/MemValue.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/tabletserver/MemValue.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/tabletserver/MemValue.java (original)
+++ incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/tabletserver/MemValue.java Fri Mar 2 11:53:23 2012
@@ -78,7 +78,7 @@ public class MemValue extends Value {
* Takes a Value and will take out the embedded kvCount, and then return that value while replacing the Value with the original unembedded version
*
* @param v
- * @return
+ * @return The kvCount embedded in v.
*/
public static int splitKVCount(Value v) {
if (v instanceof MemValue)
Modified: incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/test/randomwalk/Framework.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/test/randomwalk/Framework.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/test/randomwalk/Framework.java (original)
+++ incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/test/randomwalk/Framework.java Fri Mar 2 11:53:23 2012
@@ -50,8 +50,8 @@ public class Framework {
*
* @param startName
* Full name of starting graph or test
- * @param traversals
- * Number of nodes that should be visited
+ * @param state
+ * @param confDir
*/
public int run(String startName, State state, String confDir) {
Modified: incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/util/TServerUtils.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/util/TServerUtils.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/util/TServerUtils.java (original)
+++ incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/util/TServerUtils.java Fri Mar 2 11:53:23 2012
@@ -73,7 +73,7 @@ public class TServerUtils {
/**
* Start a server, at the given port, or higher, if that port is not available.
*
- * @param portHint
+ * @param portHintProperty
* the port to attempt to open, can be zero, meaning "any available port"
* @param processor
* the service to be started
@@ -81,6 +81,9 @@ public class TServerUtils {
* the name of the class that is providing the service
* @param threadName
* name this service's thread for better debugging
+ * @param portSearchProperty
+ * @param minThreadProperty
+ * @param timeBetweenThreadChecksProperty
* @return the server object created, and the port actually used
* @throws UnknownHostException
* when we don't know our own address
Modified: incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooLock.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooLock.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooLock.java (original)
+++ incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooLock.java Fri Mar 2 11:53:23 2012
@@ -279,7 +279,7 @@ public class ZooLock implements Watcher
/**
* indicates if the lock was acquired in the past.... helps discriminate between the case where the lock was never held, or held and lost....
*
- * @return
+ * @return true if the lock was aquired, otherwise false.
*/
public synchronized boolean wasLockAcquired() {
return lockWasAcquired;
Modified: incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooReaderWriter.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooReaderWriter.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooReaderWriter.java (original)
+++ incubator/accumulo/trunk/src/server/src/main/java/org/apache/accumulo/server/zookeeper/ZooReaderWriter.java Fri Mar 2 11:53:23 2012
@@ -153,7 +153,7 @@ public class ZooReaderWriter extends Zoo
/**
* get an instance that retries when zookeeper connection errors occur
*
- * @return
+ * @return an instance that retries when Zookeeper connection errors occur.
*/
public static synchronized IZooReaderWriter getRetryingInstance() {
Modified: incubator/accumulo/trunk/src/trace/src/main/java/cloudtrace/instrument/Sampler.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/trace/src/main/java/cloudtrace/instrument/Sampler.java?rev=1296160&r1=1296159&r2=1296160&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/trace/src/main/java/cloudtrace/instrument/Sampler.java (original)
+++ incubator/accumulo/trunk/src/trace/src/main/java/cloudtrace/instrument/Sampler.java Fri Mar 2 11:53:23 2012
@@ -19,7 +19,7 @@ package cloudtrace.instrument;
/**
* Extremely simple callback to determine the frequency that an action should be performed.
*
- * @see Trace.wrapAll
+ * see Trace.wrapAll
*/
public interface Sampler {