You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geode.apache.org by nabarunnag <gi...@git.apache.org> on 2017/05/09 22:58:52 UTC
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
GitHub user nabarunnag opened a pull request:
https://github.com/apache/geode/pull/503
GEODE-2907: Removed @Experimental tag from the Lucene module
* Removed the @experimental tag fromt the files in Lucene module.
* Improve on the javadocs for the interfaces present in the Lucene module.
This is the first draft for the javadocs improvements as a part of the task to remove the @Experimatal tags present in the Lucene Module.
Potential reviewers
@upthewaterspout @jhuynh1 @boglesby @ladyVader @gesterzhou
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/nabarunnag/incubator-geode feature/GEODE-2907
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/geode/pull/503.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #503
----
commit daf89a331ce59c87ca0d1c3c414bf76f78c1edfb
Author: nabarun <nn...@pivotal.io>
Date: 2017-05-09T22:15:59Z
GEODE-2907: Removed @Experimental tag from the Lucene module
* Removed the @experimental tag fromt the files in Lucene module.
* Improve on the javadocs for the interfaces present in the Lucene module.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by upthewaterspout <gi...@git.apache.org>.
Github user upthewaterspout commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115624028
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneQuery.java ---
@@ -60,7 +82,16 @@
* the limit specified by {@link #getLimit()} A {@link LuceneResultStruct} contains the region
* key, value, and a score for that entry.
*
+ * @return a List of LuceneResultStruct that match the Lucene query
* @throws LuceneQueryException if the query could not be parsed or executed.
+ * @throws CacheClosedException if the cache was closed while the Lucene query was being executed.
+ * @throws PrimaryBucketException if the primary bucket was moved from the node on which the
--- End diff --
Another PrimaryBucketException
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by upthewaterspout <gi...@git.apache.org>.
Github user upthewaterspout commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115623974
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneQuery.java ---
@@ -37,21 +42,38 @@
* Results are returned in order of their score with respect to this query.
* </p>
*/
-@Experimental
public interface LuceneQuery<K, V> {
/**
* Execute the query and return the region keys that match this query, up to the limit specified
* by {@link #getLimit()}.
- *
+ *
+ * @return Collection of Apache Geode region keys that satisfy the Lucene query.
* @throws LuceneQueryException if the query could not be parsed or executed.
+ * @throws CacheClosedException if the cache was closed while the Lucene query was being executed.
+ * @throws PrimaryBucketException if the primary bucket was moved from the node on which the
+ * Lucene query was to be executed.
+ * @throws FunctionException if the function execution mechanism encounters an error while
+ * executing the Lucene query.
+ * @throws PartitionOfflineException if the node containing the buckets required to execute the
+ * Lucene query goes offline.
+ * @throws CancelException if a cancel is in progress while the Lucene query was being executed.
*/
public Collection<K> findKeys() throws LuceneQueryException;
/**
* Execute the query and return the region values that match this query, up to the limit specified
* by {@link #getLimit()}
- *
+ *
+ * @return a Collection of Apache Geode region values that satisfy the Lucene query.
* @throws LuceneQueryException if the query could not be parsed or executed.
+ * @throws CacheClosedException if the cache was closed while the Lucene query was being executed.
+ * @throws PrimaryBucketException if the primary bucket was moved from the node on which the
--- End diff --
Another PrimaryBucketException
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by ladyVader <gi...@git.apache.org>.
Github user ladyVader commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115627251
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneIndex.java ---
@@ -19,39 +19,62 @@
import org.apache.lucene.analysis.Analyzer;
-import org.apache.geode.annotations.Experimental;
-
/**
* <p>
- * An Lucene index is built over the data stored in a GemFire Region.
+ * LuceneIndex represents the Lucene index created over the data stored in Apache Geode regions. The
+ * Lucene indexes are maintained automatically by Apache Geode whenever the entries are updated in
+ * the associated regions. Lucene Indexes are created using {@link LuceneService#createIndexFactory}
+ * by specifying the Lucene index name, the region associated with the Lucene index, the fields on
--- End diff --
maybe just add the word "and" before the last phrase here ... "and the fields on ..."
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by nabarunnag <gi...@git.apache.org>.
Github user nabarunnag commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115629507
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneResultStruct.java ---
@@ -39,6 +41,8 @@
* Return score the score of the entry matching the query. Scores are computed by Lucene based on
* how closely documents match the query.
*
+ * @return float value representing the score of the document / entry obtained as a result of
--- End diff --
Fixed on both the lines
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by nabarunnag <gi...@git.apache.org>.
Github user nabarunnag commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115629459
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneQuery.java ---
@@ -37,21 +42,38 @@
* Results are returned in order of their score with respect to this query.
* </p>
*/
-@Experimental
public interface LuceneQuery<K, V> {
/**
* Execute the query and return the region keys that match this query, up to the limit specified
* by {@link #getLimit()}.
- *
+ *
+ * @return Collection of Apache Geode region keys that satisfy the Lucene query.
* @throws LuceneQueryException if the query could not be parsed or executed.
+ * @throws CacheClosedException if the cache was closed while the Lucene query was being executed.
+ * @throws PrimaryBucketException if the primary bucket was moved from the node on which the
--- End diff --
Fixed
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by upthewaterspout <gi...@git.apache.org>.
Github user upthewaterspout commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115624258
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneResultStruct.java ---
@@ -39,6 +41,8 @@
* Return score the score of the entry matching the query. Scores are computed by Lucene based on
* how closely documents match the query.
*
+ * @return float value representing the score of the document / entry obtained as a result of
--- End diff --
what does document / entry mean in this case? We should probably just use entry instead of document here?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by upthewaterspout <gi...@git.apache.org>.
Github user upthewaterspout commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115623920
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneQuery.java ---
@@ -37,21 +42,38 @@
* Results are returned in order of their score with respect to this query.
* </p>
*/
-@Experimental
public interface LuceneQuery<K, V> {
/**
* Execute the query and return the region keys that match this query, up to the limit specified
* by {@link #getLimit()}.
- *
+ *
+ * @return Collection of Apache Geode region keys that satisfy the Lucene query.
* @throws LuceneQueryException if the query could not be parsed or executed.
+ * @throws CacheClosedException if the cache was closed while the Lucene query was being executed.
+ * @throws PrimaryBucketException if the primary bucket was moved from the node on which the
--- End diff --
PrimaryBucketException is an internal exception, which should not be part of the API. Do we actually throw this exception from this method? It seems like we should be retrying in any case.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/geode/pull/503
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by ladyVader <gi...@git.apache.org>.
Github user ladyVader commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115626998
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneResultStruct.java ---
@@ -39,6 +41,8 @@
* Return score the score of the entry matching the query. Scores are computed by Lucene based on
* how closely documents match the query.
*
+ * @return float value representing the score of the document / entry obtained as a result of
--- End diff --
So, we should probably use entry (instead of document) in line 42 as well.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by nabarunnag <gi...@git.apache.org>.
Github user nabarunnag commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115629448
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneIndex.java ---
@@ -19,39 +19,62 @@
import org.apache.lucene.analysis.Analyzer;
-import org.apache.geode.annotations.Experimental;
-
/**
* <p>
- * An Lucene index is built over the data stored in a GemFire Region.
+ * LuceneIndex represents the Lucene index created over the data stored in Apache Geode regions. The
+ * Lucene indexes are maintained automatically by Apache Geode whenever the entries are updated in
+ * the associated regions. Lucene Indexes are created using {@link LuceneService#createIndexFactory}
+ * by specifying the Lucene index name, the region associated with the Lucene index, the fields on
--- End diff --
Fixed.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode pull request #503: GEODE-2907: Removed @Experimental tag from the Luce...
Posted by upthewaterspout <gi...@git.apache.org>.
Github user upthewaterspout commented on a diff in the pull request:
https://github.com/apache/geode/pull/503#discussion_r115624102
--- Diff: geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneQuery.java ---
@@ -69,17 +100,33 @@
* {@link PageableLuceneQueryResults} provides the ability to fetch a page of results at a time,
* as specified by {@link #getPageSize()}
*
+ * @return a PageableLuceneQuery that can be used to fetch one page of result at a time.
* @throws LuceneQueryException if the query could not be parsed or executed.
+ * @throws CacheClosedException if the cache was closed while the Lucene query was being executed.
+ * @throws PrimaryBucketException if the primary bucket was moved from the node on which the
--- End diff --
Another PrimaryBucketException
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---