RLP For Lucene integrates Rosette Linguistic Platform (RLP) with the open-source search engine library Lucene for Java and the search engine application Solr.
The main components of this module are in a jar file, btrlplucene.jar, that contains two Java packages.
Another jar file, btrlpextra.jar, contains just one class that is needed by btrlplucene.jar and must be loaded by the application server's class loader.
The {@link com.basistech.rlp.lucene} package integrates RLP with Lucene. Developers writing search engine applications to the Lucene API should review this package.
The second package, com.basistech.rlp.solr, integrates RLP with Solr, an open-source search engine application based on Lucene.
Only editing of the Solr configuration file, schema.xml, is needed to use this package; no coding is required.
These packages requires an RLP license to use the base linguistics language processors for the target languages (such as BL1 for English and other European languages, and JLA for Japanese).
For Japanese, the license should also permit the use of RCLU in order to use the default RLP Context Definition for Japanese. If your RLP license does not include RCLU, write an RLP Context Definition that only includes the JLA language processor, and pass it to the appropriate constructor. Without RCLU, however, a katakana word written in half-width katakana will not match its equivalent in full-width katakana, and vice versa.
A system property, bt.root, must be given to the Java VM, usually via -Dbt.root=/full/path argument of the java command. bt.root should point to the installation directory of RLP, under which the "rlp" subdirectory is located.
Another system property, bt.rlp.env, is optional. This specifies the RLP Environment Definition file, an XML file. In the absence of this property, bt.root/rlp/etc/rlp-global.xml, is used. This is sufficient for most purposes.
SL4J (Simple Logging Facade for Java) is used for logging. As the name implies, SL4J is not a logging system by itself. You can choose an actual logging system at runtimei> by including the adapter JAR file for the logging system in the classpath. The provided build.xml file is configured to use the JDK java.util.logging system.