applying patch tuscany_2552_phillipe_ramalho_09_30_2009.patch from TUSCANY-2552

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@830448 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 18 insertions, 0 deletions

diff --git a/branches/sca-java-1.x/modules/domain-search/src/main/java/org/apache/tuscany/sca/domain/search/ResultFactory.java b/branches/sca-java-1.x/modules/domain-search/src/main/java/org/apache/tuscany/sca/domain/search/ResultFactory.java
index dd4bc74284..7a4fb1f5f4 100644
--- a/branches/sca-java-1.x/modules/domain-search/src/main/java/org/apache/tuscany/sca/domain/search/ResultFactory.java
+++ b/branches/sca-java-1.x/modules/domain-search/src/main/java/org/apache/tuscany/sca/domain/search/ResultFactory.java
@@ -21,13 +21,31 @@ package org.apache.tuscany.sca.domain.search;
 import org.apache.lucene.document.Document;
 
 /**
+ * This interface should be implemented to provide a way to create
+ * {@link Result} objects from a field name and its value or a {@link Document}
+ * resulted from a search.
  * 
+ * @see Result
  * @version $Rev$ $Date$
  */
 public interface ResultFactory<T extends Result> {
 
+    /**
+     * Creates a {@link Result} instance from a field name and its value.
+     * 
+     * @param field the field name
+     * @param value the value
+     * @return the {@link Result} instance
+     */
     T createResult(String field, String value);
 
+    /**
+     * Creates a {@link Result} instance from a {@link Document} object resulted
+     * from a search.
+     * 
+     * @param document the result {@link Document}
+     * @return the {@link Result} instance
+     */
     T createResult(Document document);
 
 }