[infinispan-commits] Infinispan SVN: r1278 - in trunk/demos/lucene-directory: src/main/java/org/infinispan/lucenedemo and 1 other directories.
infinispan-commits at lists.jboss.org
infinispan-commits at lists.jboss.org
Thu Dec 10 10:36:04 EST 2009
Author: sannegrinovero
Date: 2009-12-10 10:36:03 -0500 (Thu, 10 Dec 2009)
New Revision: 1278
Modified:
trunk/demos/lucene-directory/README-lucene-directory.txt
trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DemoActions.java
trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DemoDriver.java
trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DirectoryFactory.java
trunk/demos/lucene-directory/src/main/resources/log4j.xml
Log:
Javadoc and readme cleanup for lucene-directory-demo
Modified: trunk/demos/lucene-directory/README-lucene-directory.txt
===================================================================
--- trunk/demos/lucene-directory/README-lucene-directory.txt 2009-12-10 14:22:15 UTC (rev 1277)
+++ trunk/demos/lucene-directory/README-lucene-directory.txt 2009-12-10 15:36:03 UTC (rev 1278)
@@ -1,10 +1,16 @@
-This is an interactive demo of the Lucene Directory.
-Run several copies of the demo, they should cluster automatically and see
-from the commandline how you can index text on one node and search for it
-on the others.
+This is an interactive demo of the Lucene Directory implementation based on Infinispan.
-To build the demo, do:
+Run more copies of the demo, they should cluster automatically.
+Using a simple commandline interface you can play with it adding terms to the index and search from them.
+See how different nodes interact and share the same index, you can add terms on one node and search from it on another.
+The provided configuration is meant to work in most environment, for best performance
+
+To build the demo, run:
+
mvn package appassembler:assemble
-this should download dependencies and produce proper scripts to run it in target/assembly
\ No newline at end of file
+This command requires Maven2 and will download dependencies and produce scripts to run the demo in
+
+ ./target/assembly/bin
+
Modified: trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DemoActions.java
===================================================================
--- trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DemoActions.java 2009-12-10 14:22:15 UTC (rev 1277)
+++ trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DemoActions.java 2009-12-10 15:36:03 UTC (rev 1278)
@@ -44,7 +44,8 @@
import org.infinispan.remoting.transport.Address;
/**
- * DemoActions.
+ * DemoActions does some basic operations on the Lucene index,
+ * to be used by DemoDriver to show base operations on Lucene.
*
* @author Sanne Grinovero
* @since 4.0
@@ -80,7 +81,7 @@
}
/**
- * Returns all stored fields
+ * Returns a list of the values of all stored fields
* @throws IOException
*/
public List<String> listAllDocuments() throws IOException {
@@ -89,7 +90,7 @@
}
/**
- * Creates a new document having just one field containing a string.
+ * Creates a new document having just one field containing a string
*
* @param line The text snippet to add
* @throws IOException
@@ -109,6 +110,7 @@
/**
* Parses a query using the single field as default
+ *
* @throws ParseException
*/
public Query parseQuery(String queryLine) throws ParseException {
@@ -118,7 +120,7 @@
}
/**
- * Returns a list of Adresses of all members in the cluster
+ * Returns a list of Addresses of all members in the cluster
*/
public List<Address> listAllMembers() {
return index.getCache().getCacheManager().getMembers();
Modified: trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DemoDriver.java
===================================================================
--- trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DemoDriver.java 2009-12-10 14:22:15 UTC (rev 1277)
+++ trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DemoDriver.java 2009-12-10 15:36:03 UTC (rev 1278)
@@ -30,7 +30,9 @@
import org.infinispan.remoting.transport.Address;
/**
- * DemoBoot.
+ * DemoDriver is a console hello-world application to show the Lucene
+ * clustering capabilities.
+ * This class parses the user input and drives the actions implemented in DemoActions.
*
* @author Sanne Grinovero
* @since 4.0
Modified: trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DirectoryFactory.java
===================================================================
--- trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DirectoryFactory.java 2009-12-10 14:22:15 UTC (rev 1277)
+++ trunk/demos/lucene-directory/src/main/java/org/infinispan/lucenedemo/DirectoryFactory.java 2009-12-10 15:36:03 UTC (rev 1278)
@@ -35,8 +35,10 @@
import java.util.Map;
/**
- * Utility to create a Directory for the demo.
+ * Utility to create an InfinispanDirectory for the demo.
*
+ * @see org.infinispan.lucene.InfinispanDirectory
+ *
* @author Sanne Grinovero
* @since 4.0
*/
Modified: trunk/demos/lucene-directory/src/main/resources/log4j.xml
===================================================================
--- trunk/demos/lucene-directory/src/main/resources/log4j.xml 2009-12-10 14:22:15 UTC (rev 1277)
+++ trunk/demos/lucene-directory/src/main/resources/log4j.xml 2009-12-10 15:36:03 UTC (rev 1278)
@@ -2,7 +2,7 @@
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<!--
- For more configuration infromation and examples see the Apache Log4j website: http://logging.apache.org/log4j/
+ For more configuration information and examples see the Apache Log4j website: http://logging.apache.org/log4j/
-->
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="false">
@@ -14,18 +14,11 @@
<!-- Rollover at midnight each day -->
<param name="DatePattern" value="'.'yyyy-MM-dd"/>
- <!-- Rollover at the top of each hour
- <param name="DatePattern" value="'.'yyyy-MM-dd-HH"/>
- -->
<param name="Threshold" value="TRACE"/>
<layout class="org.apache.log4j.PatternLayout">
<!-- The default pattern: Date Priority [Category] Message\n -->
<param name="ConversionPattern" value="%d %-5p [%c] (%t) %m%n"/>
-
- <!-- The full pattern: Date MS Priority [Category] (Thread:NDC) Message\n
- <param name="ConversionPattern" value="%d %-5r %-5p [%c] (%t:%x) %m%n"/>
- -->
</layout>
</appender>
@@ -52,14 +45,6 @@
<priority value="INFO"/>
</category>
- <category name="org.infinispan.profiling">
- <priority value="WARN"/>
- </category>
-
- <category name="org.infinispan.jmx">
- <priority value="WARN"/>
- </category>
-
<category name="org.infinispan.factories">
<priority value="WARN"/>
</category>
More information about the infinispan-commits
mailing list