Github user jhuynh1 commented on a diff in the pull request:
https://github.com/apache/geode/pull/410#discussion_r103763560
--- Diff:
geode-lucene/src/main/java/org/apache/geode/cache/lucene/LuceneResultStruct.java
---
@@ -17,34 +17,29 @@
import org.apache.geode.annotations.Experimental;
/**
- * <p>
- * Abstract data structure for one item in query result.
+ * A single result of a lucene query.
*
*/
@Experimental
public interface LuceneResultStruct<K, V> {
/**
- * Return key of the entry
+ * @return The region key of the entry matching the query
*
- * @return key
- * @throws IllegalArgumentException If this struct does not contain key
*/
public K getKey();
/**
- * Return value of the entry
+ * @return the region value of the entry matching the query.
*
- * @return value the whole domain object
- * @throws IllegalArgumentException If this struct does not contain value
*/
public V getValue();
/**
- * Return score of the query
+ * Return score of the score of the entry matching the query. Scores
--- End diff --
I think you meant "Return score of the entry..."?
---
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 infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
