You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by fe...@apache.org on 2011/10/06 13:11:50 UTC

svn commit: r1179570 - in /james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search: LuceneMessageSearchIndex.java StrictImapSearchAnalyzer.java

Author: felixk
Date: Thu Oct  6 11:11:50 2011
New Revision: 1179570

URL: http://svn.apache.org/viewvc?rev=1179570&view=rev
Log:
Update javadocs

Modified:
    james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/LuceneMessageSearchIndex.java
    james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/StrictImapSearchAnalyzer.java

Modified: james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/LuceneMessageSearchIndex.java
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/LuceneMessageSearchIndex.java?rev=1179570&r1=1179569&r2=1179570&view=diff
==============================================================================
--- james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/LuceneMessageSearchIndex.java (original)
+++ james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/LuceneMessageSearchIndex.java Thu Oct  6 11:11:50 2011
@@ -139,22 +139,22 @@ public class LuceneMessageSearchIndex<Id
     
     
     /**
-     * {@link Field} which will contain uid of the {@link MailboxMembership}
+     * {@link Field} which will contain uid of the {@link Message}
      */
     public final static String UID_FIELD = "uid";
     
     /**
-     * {@link Field} which will contain the {@link Flags} of the {@link MailboxMembership}
+     * {@link Field} which will contain the {@link Flags} of the {@link Message}
      */
     public final static String FLAGS_FIELD = "flags";
   
     /**
-     * {@link Field} which will contain the size of the {@link MailboxMembership}
+     * {@link Field} which will contain the size of the {@link Message}
      */
     public final static String SIZE_FIELD = "size";
 
     /**
-     * {@link Field} which will contain the body of the {@link MailboxMembership}
+     * {@link Field} which will contain the body of the {@link Message}
      */
     public final static String BODY_FIELD = "body";
     
@@ -165,7 +165,7 @@ public class LuceneMessageSearchIndex<Id
     public final static String PREFIX_HEADER_FIELD ="header_";
     
     /**
-     * {@link Field} which will contain the whole message header of the {@link MailboxMembership}
+     * {@link Field} which will contain the whole message header of the {@link Message}
      */
     public final static String HEADERS_FIELD ="headers";
 
@@ -368,7 +368,7 @@ public class LuceneMessageSearchIndex<Id
     }
     
     /**
-     * Create a {@link Analyzer} which is used to index the {@link MailboxMembership}'s
+     * Create a {@link Analyzer} which is used to index the {@link Message}'s
      * 
      * @param lenient 
      * 
@@ -398,9 +398,8 @@ public class LuceneMessageSearchIndex<Id
     
     
     
-    /*
-     * (non-Javadoc)
-     * @see org.apache.james.mailbox.store.MessageSearchIndex#search(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.SearchQuery)
+    /**
+     * @see org.apache.james.mailbox.store.search.MessageSearchIndex#search(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.SearchQuery)
      */
     public Iterator<Long> search(MailboxSession session, Mailbox<Id> mailbox, SearchQuery searchQuery) throws MailboxException {
         Set<Long> uids = new LinkedHashSet<Long>();
@@ -416,7 +415,7 @@ public class LuceneMessageSearchIndex<Id
             for (int i = 0; i < crits.size(); i++) {
                 query.add(createQuery(crits.get(i), mailbox, searchQuery.getRecentMessageUids()), BooleanClause.Occur.MUST);
             }
-             
+
             // query for all the documents sorted as specified in the SearchQuery
             TopDocs docs = searcher.search(query, null, maxQueryResults, createSort(searchQuery.getSorts()));
             ScoreDoc[] sDocs = docs.scoreDocs;
@@ -440,7 +439,7 @@ public class LuceneMessageSearchIndex<Id
 
    
     /**
-     * Create a new {@link Document} for the given {@link MailboxMembership}. This Document does not contain any flags data. The {@link Flags} are stored in a seperate Document. 
+     * Create a new {@link Document} for the given {@link Message}. This Document does not contain any flags data. The {@link Flags} are stored in a seperate Document. 
      * 
      * See {@link #createFlagsDocument(Message)}
      * 
@@ -1181,9 +1180,8 @@ public class LuceneMessageSearchIndex<Id
 
     
 
-    /*
-     * (non-Javadoc)
-     * @see org.apache.james.mailbox.store.MessageSearchIndex#add(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.store.mail.model.MailboxMembership)
+    /**
+     * @see org.apache.james.mailbox.store.search.ListeningMessageSearchIndex#add(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.store.mail.model.Message)
      */
     public void add(MailboxSession session, Mailbox<Id> mailbox, Message<Id> membership) throws MailboxException {
         Document doc = createMessageDocument(session, membership);
@@ -1199,9 +1197,8 @@ public class LuceneMessageSearchIndex<Id
         }
     }
 
-    /*
-     * (non-Javadoc)
-     * @see org.apache.james.mailbox.store.MessageSearchIndex#update(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.MessageRange, javax.mail.Flags)
+    /**
+     * @see org.apache.james.mailbox.store.search.ListeningMessageSearchIndex#update(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.MessageRange, javax.mail.Flags)
      */
     public void update(MailboxSession session, Mailbox<Id> mailbox, MessageRange range, Flags f) throws MailboxException {
         try {
@@ -1283,9 +1280,8 @@ public class LuceneMessageSearchIndex<Id
             return NumericRangeQuery.newLongRange(UID_FIELD, 0L, Long.MAX_VALUE, true, true);
         }
     }
-    /*
-     * (non-Javadoc)
-     * @see org.apache.james.mailbox.store.MessageSearchIndex#delete(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.MessageRange)
+    /**
+     * @see org.apache.james.mailbox.store.search.ListeningMessageSearchIndex#delete(org.apache.james.mailbox.MailboxSession, org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.MessageRange)
      */
     public void delete(MailboxSession session, Mailbox<Id> mailbox, MessageRange range) throws MailboxException {
         BooleanQuery query = new BooleanQuery();

Modified: james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/StrictImapSearchAnalyzer.java
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/StrictImapSearchAnalyzer.java?rev=1179570&r1=1179569&r2=1179570&view=diff
==============================================================================
--- james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/StrictImapSearchAnalyzer.java (original)
+++ james/mailbox/trunk/lucene/src/main/java/org/apache/james/mailbox/lucene/search/StrictImapSearchAnalyzer.java Thu Oct  6 11:11:50 2011
@@ -48,8 +48,8 @@ public final class StrictImapSearchAnaly
         this.minTokenLength = minTokenLength;
         this.maxTokenLength = maxTokenLength;
     }
-   /*
-    * (non-Javadoc)
+
+   /**
     * @see org.apache.lucene.analysis.Analyzer#tokenStream(java.lang.String, java.io.Reader)
     */
    public TokenStream tokenStream(String fieldName, Reader reader) {



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org