You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@metamodel.apache.org by ka...@apache.org on 2018/10/01 03:17:44 UTC
metamodel git commit: Fixed several javadoc issues
Repository: metamodel
Updated Branches:
refs/heads/master 9611e5edf -> 5b88926f4
Fixed several javadoc issues
Project: http://git-wip-us.apache.org/repos/asf/metamodel/repo
Commit: http://git-wip-us.apache.org/repos/asf/metamodel/commit/5b88926f
Tree: http://git-wip-us.apache.org/repos/asf/metamodel/tree/5b88926f
Diff: http://git-wip-us.apache.org/repos/asf/metamodel/diff/5b88926f
Branch: refs/heads/master
Commit: 5b88926f459c64580a31dd01aa31f8f8e481123e
Parents: 9611e5e
Author: Kasper Sørensen <i....@gmail.com>
Authored: Tue Sep 25 21:21:23 2018 -0700
Committer: Kasper Sørensen <i....@gmail.com>
Committed: Tue Sep 25 21:21:23 2018 -0700
----------------------------------------------------------------------
.../main/java/org/apache/metamodel/query/SelectItem.java | 2 +-
.../java/org/apache/metamodel/util/HasNameMapper.java | 4 +---
.../elasticsearch/AbstractElasticSearchDataContext.java | 7 +++----
.../elasticsearch/rest/ElasticSearchRestDataContext.java | 10 ++++------
.../metamodel/mongodb/mongo2/MongoDbDataContext.java | 6 +++---
5 files changed, 12 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/metamodel/blob/5b88926f/core/src/main/java/org/apache/metamodel/query/SelectItem.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/metamodel/query/SelectItem.java b/core/src/main/java/org/apache/metamodel/query/SelectItem.java
index 40ac3fc..bbbed79 100644
--- a/core/src/main/java/org/apache/metamodel/query/SelectItem.java
+++ b/core/src/main/java/org/apache/metamodel/query/SelectItem.java
@@ -255,7 +255,7 @@ public class SelectItem extends BaseObject implements QueryItem, Cloneable {
}
/**
- * Gets any parameters to the {@link #getFunction()} used.
+ * Gets any parameters to the {@link #getAggregateFunction()} or {@link #getScalarFunction()} used.
*
* @return
*/
http://git-wip-us.apache.org/repos/asf/metamodel/blob/5b88926f/core/src/main/java/org/apache/metamodel/util/HasNameMapper.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/metamodel/util/HasNameMapper.java b/core/src/main/java/org/apache/metamodel/util/HasNameMapper.java
index e0d253b..63be443 100644
--- a/core/src/main/java/org/apache/metamodel/util/HasNameMapper.java
+++ b/core/src/main/java/org/apache/metamodel/util/HasNameMapper.java
@@ -22,9 +22,7 @@ import java.io.Serializable;
import java.util.function.Function;
/**
- * {@link Func} useful for mapping {@link HasName} instances to names, using
- * {@link CollectionUtils#map(Object[], Func)} and
- * {@link CollectionUtils#map(Iterable, Func)}.
+ * Useful {@link Function} for mapping {@link HasName} instances to names.
*/
public final class HasNameMapper implements Function<HasName, String>, Serializable {
http://git-wip-us.apache.org/repos/asf/metamodel/blob/5b88926f/elasticsearch/common/src/main/java/org/apache/metamodel/elasticsearch/AbstractElasticSearchDataContext.java
----------------------------------------------------------------------
diff --git a/elasticsearch/common/src/main/java/org/apache/metamodel/elasticsearch/AbstractElasticSearchDataContext.java b/elasticsearch/common/src/main/java/org/apache/metamodel/elasticsearch/AbstractElasticSearchDataContext.java
index c8ffae3..d39f1da 100644
--- a/elasticsearch/common/src/main/java/org/apache/metamodel/elasticsearch/AbstractElasticSearchDataContext.java
+++ b/elasticsearch/common/src/main/java/org/apache/metamodel/elasticsearch/AbstractElasticSearchDataContext.java
@@ -51,7 +51,7 @@ public abstract class AbstractElasticSearchDataContext extends QueryPostprocessD
protected final List<SimpleTableDef> dynamicTableDefinitions = new ArrayList<>();
/**
- * Constructs a {@link ElasticSearchRestDataContext}. This constructor
+ * Constructs a {@link AbstractElasticSearchDataContext}. This constructor
* accepts a custom array of {@link SimpleTableDef}s which allows the user
* to define his own view on the indexes in the engine.
*
@@ -72,11 +72,10 @@ public abstract class AbstractElasticSearchDataContext extends QueryPostprocessD
}
/**
- * Performs an analysis of the available indexes in an ElasticSearch cluster
- * {@link JestClient} instance and detects the elasticsearch types structure
+ * Performs an analysis of the available indexes in an ElasticSearch
+ * cluster instance and detects the elasticsearch types structure
* based on the metadata provided by the ElasticSearch java client.
*
- * @see {@link #detectTable(JsonObject, String)}
* @return a mutable schema instance, useful for further fine tuning by the
* user.
*/
http://git-wip-us.apache.org/repos/asf/metamodel/blob/5b88926f/elasticsearch/rest/src/main/java/org/apache/metamodel/elasticsearch/rest/ElasticSearchRestDataContext.java
----------------------------------------------------------------------
diff --git a/elasticsearch/rest/src/main/java/org/apache/metamodel/elasticsearch/rest/ElasticSearchRestDataContext.java b/elasticsearch/rest/src/main/java/org/apache/metamodel/elasticsearch/rest/ElasticSearchRestDataContext.java
index 5b32d14..81c1305 100644
--- a/elasticsearch/rest/src/main/java/org/apache/metamodel/elasticsearch/rest/ElasticSearchRestDataContext.java
+++ b/elasticsearch/rest/src/main/java/org/apache/metamodel/elasticsearch/rest/ElasticSearchRestDataContext.java
@@ -107,8 +107,7 @@ public class ElasticSearchRestDataContext extends AbstractElasticSearchDataConte
/**
* Constructs a {@link ElasticSearchRestDataContext} and automatically
- * detects the schema structure/view on all indexes (see
- * {@link #detectTable(JsonObject, String)}).
+ * detects the schema structure/view on an index.
*
* @param client
* the ElasticSearch client
@@ -163,9 +162,8 @@ public class ElasticSearchRestDataContext extends AbstractElasticSearchDataConte
}
/**
- * Performs an analysis of an available index type in an ElasticSearch
- * {@link JestClient} client and tries to detect the index structure based
- * on the metadata provided by the java client.
+ * Performs an analysis of an available metadata properties/mapping
+ * for a particula document type.
*
* @param metadataProperties
* the ElasticSearch mapping
@@ -295,7 +293,7 @@ public class ElasticSearchRestDataContext extends AbstractElasticSearchDataConte
}
/**
- * Gets the {@link JestClient} that this {@link DataContext} is wrapping.
+ * Gets the {@link ElasticSearchRestClient} that this {@link DataContext} is wrapping.
*/
public ElasticSearchRestClient getElasticSearchClient() {
return elasticSearchClient;
http://git-wip-us.apache.org/repos/asf/metamodel/blob/5b88926f/mongodb/mongo2/src/main/java/org/apache/metamodel/mongodb/mongo2/MongoDbDataContext.java
----------------------------------------------------------------------
diff --git a/mongodb/mongo2/src/main/java/org/apache/metamodel/mongodb/mongo2/MongoDbDataContext.java b/mongodb/mongo2/src/main/java/org/apache/metamodel/mongodb/mongo2/MongoDbDataContext.java
index 898e3b4..be93413 100644
--- a/mongodb/mongo2/src/main/java/org/apache/metamodel/mongodb/mongo2/MongoDbDataContext.java
+++ b/mongodb/mongo2/src/main/java/org/apache/metamodel/mongodb/mongo2/MongoDbDataContext.java
@@ -72,7 +72,7 @@ import com.mongodb.WriteConcern;
* Since MongoDB has no schema, a virtual schema will be used in this
* DataContext. This implementation supports either automatic discovery of a
* schema or manual specification of a schema, through the
- * {@link MongoDbTableDef} class.
+ * {@link SimpleTableDef} class.
*/
public class MongoDbDataContext extends QueryPostprocessDataContext implements UpdateableDataContext {
@@ -85,13 +85,13 @@ public class MongoDbDataContext extends QueryPostprocessDataContext implements U
/**
* Constructs a {@link MongoDbDataContext}. This constructor accepts a
- * custom array of {@link MongoDbTableDef}s which allows the user to define
+ * custom array of {@link SimpleTableDef}s which allows the user to define
* his own view on the collections in the database.
*
* @param mongoDb
* the mongo db connection
* @param tableDefs
- * an array of {@link MongoDbTableDef}s, which define the table
+ * an array of {@link SimpleTableDef}s, which define the table
* and column model of the mongo db collections. (consider using
* {@link #detectSchema(DB)} or {@link #detectTable(DB, String)}
* ).