You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by uj...@apache.org on 2014/03/19 17:08:24 UTC
[14/50] [abbrv] git commit: ACCUMULO-441 ACCUMULO-411 merged javadocs
fixes from trunk to 1.4 and added better links
ACCUMULO-441 ACCUMULO-411 merged javadocs fixes from trunk to 1.4 and added better links
git-svn-id: https://svn.apache.org/repos/asf/incubator/accumulo/branches/1.4@1297265 13f79535-47bb-0310-9956-ffa450edef68
Project: http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/commit/0266eaed
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/tree/0266eaed
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/diff/0266eaed
Branch: refs/heads/master
Commit: 0266eaed00e090933f32ccb3c8405ca5af7df5df
Parents: e24faaf
Author: Billie Rinaldi <bi...@apache.org>
Authored: Mon Mar 5 22:49:35 2012 +0000
Committer: Billie Rinaldi <bi...@apache.org>
Committed: Mon Mar 5 22:49:35 2012 +0000
----------------------------------------------------------------------
.../wikisearch/ingest/WikipediaMapper.java | 2 +-
.../examples/wikisearch/util/TextUtil.java | 4 +--
.../iterator/AbstractEvaluatingIterator.java | 4 +--
.../wikisearch/iterator/AndIterator.java | 26 +++++++++----------
.../wikisearch/iterator/OrIterator.java | 12 ++++-----
.../wikisearch/logic/AbstractQueryLogic.java | 9 -------
.../parser/FieldIndexQueryReWriter.java | 27 +++++++-------------
.../wikisearch/parser/QueryEvaluator.java | 1 -
.../wikisearch/parser/RangeCalculator.java | 4 ---
.../examples/wikisearch/query/Query.java | 2 +-
10 files changed, 34 insertions(+), 57 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java
----------------------------------------------------------------------
diff --git a/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java b/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java
index a06c57f..fc328cc 100644
--- a/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java
+++ b/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/ingest/WikipediaMapper.java
@@ -112,7 +112,7 @@ public class WikipediaMapper extends Mapper<LongWritable,Text,Text,Mutation> {
*
* @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 {
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java
----------------------------------------------------------------------
diff --git a/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java b/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java
index 34b40d1..1623d55 100644
--- a/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java
+++ b/ingest/src/main/java/org/apache/accumulo/examples/wikisearch/util/TextUtil.java
@@ -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) {
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java
----------------------------------------------------------------------
diff --git a/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java b/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java
index b3f7213..87b4da2 100644
--- a/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java
+++ b/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AbstractEvaluatingIterator.java
@@ -114,10 +114,10 @@ public abstract class AbstractEvaluatingIterator implements SortedKeyValueIterat
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;
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java
----------------------------------------------------------------------
diff --git a/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java b/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java
index b675e9b..74fbc0c 100644
--- a/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java
+++ b/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/AndIterator.java
@@ -96,7 +96,7 @@ public class AndIterator implements SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
*
* @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 SortedKeyValueIterator<Key,Value> {
*
* @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 SortedKeyValueIterator<Key,Value> {
*
* @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 SortedKeyValueIterator<Key,Value> {
*
* @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 SortedKeyValueIterator<Key,Value> {
*
* @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 SortedKeyValueIterator<Key,Value> {
*
* @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 SortedKeyValueIterator<Key,Value> {
* 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
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java
----------------------------------------------------------------------
diff --git a/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java b/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java
index d632c82..a217701 100644
--- a/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java
+++ b/query/src/main/java/org/apache/accumulo/examples/wikisearch/iterator/OrIterator.java
@@ -150,7 +150,7 @@ public class OrIterator implements SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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 SortedKeyValueIterator<Key,Value> {
* 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)) {
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java
----------------------------------------------------------------------
diff --git a/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java b/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java
index 0f2d472..cb90e92 100644
--- a/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java
+++ b/query/src/main/java/org/apache/accumulo/examples/wikisearch/logic/AbstractQueryLogic.java
@@ -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
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java
----------------------------------------------------------------------
diff --git a/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java b/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java
index fc81df2..acfb4f4 100644
--- a/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java
+++ b/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/FieldIndexQueryReWriter.java
@@ -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("[");
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java
----------------------------------------------------------------------
diff --git a/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java b/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java
index feac1d3..aaac3d8 100644
--- a/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java
+++ b/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/QueryEvaluator.java
@@ -201,7 +201,6 @@ public class QueryEvaluator {
* Evaluates the query against an event.
*
* @param eventFields
- * @return
*/
public boolean evaluate(EventFields eventFields) {
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java
----------------------------------------------------------------------
diff --git a/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java b/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java
index ca3f9bb..d416f60 100644
--- a/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java
+++ b/query/src/main/java/org/apache/accumulo/examples/wikisearch/parser/RangeCalculator.java
@@ -279,9 +279,6 @@ public class RangeCalculator extends QueryParser {
* @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 QueryParser {
* 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,
http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch/blob/0266eaed/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java
----------------------------------------------------------------------
diff --git a/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java b/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java
index 82ac8e5..bffe8ad 100644
--- a/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java
+++ b/query/src/main/java/org/apache/accumulo/examples/wikisearch/query/Query.java
@@ -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) {