Author: thomasm Date: Tue Jul 24 14:13:17 2012 New Revision: 1365072 URL: http://svn.apache.org/viewvc?rev=1365072&view=rev Log: OAK-154 Full text search index - javadocs
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneEditor.java jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndex.java jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndexProvider.java jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/OakDirectory.java Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneEditor.java URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneEditor.java?rev=1365072&r1=1365071&r2=1365072&view=diff ============================================================================== --- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneEditor.java (original) +++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneEditor.java Tue Jul 24 14:13:17 2012 @@ -42,6 +42,9 @@ import static org.apache.jackrabbit.oak. import static org.apache.jackrabbit.oak.plugins.lucene.FieldFactory.newPropertyField; import static org.apache.jackrabbit.oak.plugins.lucene.TermFactory.newPathTerm; +/** + * This class updates a Lucene index when node content is changed. + */ public class LuceneEditor implements CommitEditor { private static final Tika TIKA = new Tika(); Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndex.java URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndex.java?rev=1365072&r1=1365071&r2=1365072&view=diff ============================================================================== --- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndex.java (original) +++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndex.java Tue Jul 24 14:13:17 2012 @@ -46,6 +46,9 @@ import org.apache.lucene.search.TermRang import org.apache.lucene.search.TopDocs; import org.apache.lucene.store.Directory; +/** + * This index uses internally runs a query against a Lucene index. + */ public class LuceneIndex implements QueryIndex { private final NodeStore store; Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndexProvider.java URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndexProvider.java?rev=1365072&r1=1365071&r2=1365072&view=diff ============================================================================== --- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndexProvider.java (original) +++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/LuceneIndexProvider.java Tue Jul 24 14:13:17 2012 @@ -25,6 +25,10 @@ import org.apache.jackrabbit.oak.spi.Que import org.apache.jackrabbit.oak.spi.QueryIndexProvider; import org.apache.jackrabbit.oak.spi.state.NodeStore; +/** + * A provider for Lucene indexes. There is exactly one Lucene index instance per + * MicroKernel. + */ public class LuceneIndexProvider implements QueryIndexProvider { @Override Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/OakDirectory.java URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/OakDirectory.java?rev=1365072&r1=1365071&r2=1365072&view=diff ============================================================================== --- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/OakDirectory.java (original) +++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/lucene/OakDirectory.java Tue Jul 24 14:13:17 2012 @@ -37,6 +37,10 @@ import org.apache.lucene.store.NoLockFac import com.google.common.collect.Iterables; +/** + * An implementation of the Lucene directory (a flat list of files) that allows + * to store Lucene index content in an Oak repository. + */ class OakDirectory extends Directory { private final CoreValueFactory factory;