adding doc on search framework

[mir.git] / source / mircoders / search / TextSearchTerm.java

diff --git a/source/mircoders/search/TextSearchTerm.java b/source/mircoders/search/TextSearchTerm.java
index 3b5cd44..61fe91a 100755 (executable)
--- a/source/mircoders/search/TextSearchTerm.java
+++ b/source/mircoders/search/TextSearchTerm.java
@@ -39,7 +39,10 @@ import mir.entity.Entity;
 import org.apache.lucene.document.Document;
 import org.apache.lucene.document.Field;
 
-
+/**
+ * tokenizes a string field in an Entity and indexes
+ * it, and stores it for retrieval (used for description)
+ */
 public class TextSearchTerm extends SearchTerm{
   public TextSearchTerm(String anEntityPart,String aParamName,String aMatchField,String aDataField, String aTemplateVariable){
     partOfEntity = anEntityPart;