Jump to: navigation, search

Difference between revisions of "SMILA/Documentation/LuceneIndexPipelet"

Line 14: Line 14:
 
|-
 
|-
 
|executionMode||ADD or DELETE||''ADD'' - add or update the record, ''DELETE'' - delete the record from the index
 
|executionMode||ADD or DELETE||''ADD'' - add or update the record, ''DELETE'' - delete the record from the index
 +
|-
 +
|allowDoublets||boolean||''true'' - allow doublets in the index, no check if a document already exists is performed, ''false'' do a check if a document already exists and if so delete it first. Default is ''false''
 
|}
 
|}
  
Line 19: Line 21:
  
 
* <tt>configuration/org.eclipse.smila.search.datadictionary/DataDictionary.xml</tt>
 
* <tt>configuration/org.eclipse.smila.search.datadictionary/DataDictionary.xml</tt>
Here the Lucene index structure and the search template are configured. It is possible to define more than one index here. The index to work on is set by the Annotation "indexName". The defined "FieldNo" are referenced in LuceneAttributeMapping.xml and LuceneAttachmentMapping.xml. For more information about configuration of DataDictionary.xml see Anyfinder documentation.
+
Here the Lucene index structure and the search template are configured. It is possible to define more than one index here. The index to work on is set in the pipeline by the Annotation "indexName". The defined "FieldNo" are referenced in file Mappings.xml. For more information about configuration of DataDictionary.xml see Anyfinder documentation.
This file is used to prepared the settings for indicies. When an index is needed, it is created automatically on demand, and configuration is loaded from this file to created the index.
+
This file is used to prepare the settings for indicies. When an index is needed, it is created automatically on demand, and configuration is loaded from this file to created the index.
 
(Beside: the Framework creates a Datadictionary.xml file also in the workspace. This file only contains the information(settings/configuration) for created indices).
 
(Beside: the Framework creates a Datadictionary.xml file also in the workspace. This file only contains the information(settings/configuration) for created indices).
 
The Framework will create an index by itself, when a record is configured to be stored in an index. But the user can also use the createIndex JMX-command to create an index.
 
The Framework will create an index by itself, when a record is configured to be stored in an index. But the user can also use the createIndex JMX-command to create an index.
 +
 +
There are some new optional configuration options available for each index configuration to modify the flushing behavior of the underlying lucene index. If none of these are specified the old logic ()flush after every add/delete) is executed.
 +
 +
<source lang="xml">
 +
...
 +
<Index Name="test_index" ForceFlush="false" RAMBufferSize="20" MaxBufferedDocs="100000" MaxBufferedDeleteTerms="100000" >
 +
...
 +
</source>
 +
 +
{| border = 1
 +
!Name!!Value!!Description
 +
|-
 +
|ForceFlush||boolean||''true'' a flush is forced after a document is added/deleted, ''false'' flushing is configured by the parameters below. Default is ''true''. If set to ''true'' the parameters below have no effect.
 +
|-
 +
| RAMBufferSize || Integer || The amount of RAM in MB that may be used before the buffered in-memory documents are flushed. If no value is specified the lucene default 16 MB is used. See Lucene documentation for details.
 +
|-
 +
| MaxBufferedDocs || Integer || The minimal number of documents required before the buffered in-memory documents are flushed. If no value is specified lucene uses flushing by RAMBufferSize by default. See Lucene documentation for details.
 +
|-
 +
| MaxBufferedDeleteTerms || Integer || The minimal number of delete terms required before the buffered in-memory delete terms are applied and flushed. If no value is specified lucene uses flushing by RAMBufferSize by default. See Lucene documentation for details.
 +
|}
 +
 +
;Note:
 +
For best performance use ForceFlush="false" and RAMBufferSize with a meaningful value depending on your system resources. It is important to understand, that if ForceFlush="false" then added/deleted documents may not be visible in a search until a final flush is triggered. A flush is always performed when bundle <tt>org.eclipse.smila.lucene</tt> is stopped. It is also possible to perform a manual flush via the JMX Console.
  
  
Line 28: Line 53:
 
Here a mapping of attribute and attachment names to Lucene "FieldNo" (defined in DataDictionary.xml) is configured. It is possible to define mappings for multiple indexes in this file, using the same "indexName" as in file DataDictionary.xml.
 
Here a mapping of attribute and attachment names to Lucene "FieldNo" (defined in DataDictionary.xml) is configured. It is possible to define mappings for multiple indexes in this file, using the same "indexName" as in file DataDictionary.xml.
  
The Field XMLID is a required field. It is used to store the xml representation of Id objects to be able to restore Id objects from xml in search results. This is not possible using the Id string or hash value.
 
  
 
==== Example ====
 
==== Example ====
Line 45: Line 69:
 
                 <rec:V n="indexName">test_index</rec:V>
 
                 <rec:V n="indexName">test_index</rec:V>
 
                 <rec:V n="executionMode">ADD</rec:V>
 
                 <rec:V n="executionMode">ADD</rec:V>
 +
                <rec:V n="allowDoublets">false</rec:V>
 
             </rec:An>
 
             </rec:An>
 
         </proc:setAnnotations>
 
         </proc:setAnnotations>

Revision as of 04:39, 24 June 2009

Bundle: org.eclipse.smila.lucene.LuceneIndexService

Description

This ProcessingService is used to index SMILA records in a Lucene document index. It supports adding, updating and deleting of records.

Configuration

Annotations

The LuceneIndexService uses the Annotation org.eclipse.smila.lucene.LuceneIndexService on records to decide how to handle a record. It supports the following required values.

Name Value Description
indexName a String the name of the index to work on
executionMode ADD or DELETE ADD - add or update the record, DELETE - delete the record from the index
allowDoublets boolean true - allow doublets in the index, no check if a document already exists is performed, false do a check if a document already exists and if so delete it first. Default is false

Configuration files

  • configuration/org.eclipse.smila.search.datadictionary/DataDictionary.xml

Here the Lucene index structure and the search template are configured. It is possible to define more than one index here. The index to work on is set in the pipeline by the Annotation "indexName". The defined "FieldNo" are referenced in file Mappings.xml. For more information about configuration of DataDictionary.xml see Anyfinder documentation. This file is used to prepare the settings for indicies. When an index is needed, it is created automatically on demand, and configuration is loaded from this file to created the index. (Beside: the Framework creates a Datadictionary.xml file also in the workspace. This file only contains the information(settings/configuration) for created indices). The Framework will create an index by itself, when a record is configured to be stored in an index. But the user can also use the createIndex JMX-command to create an index.

There are some new optional configuration options available for each index configuration to modify the flushing behavior of the underlying lucene index. If none of these are specified the old logic ()flush after every add/delete) is executed.

...
<Index Name="test_index" ForceFlush="false" RAMBufferSize="20" MaxBufferedDocs="100000" MaxBufferedDeleteTerms="100000" >
...
Name Value Description
ForceFlush boolean true a flush is forced after a document is added/deleted, false flushing is configured by the parameters below. Default is true. If set to true the parameters below have no effect.
RAMBufferSize Integer The amount of RAM in MB that may be used before the buffered in-memory documents are flushed. If no value is specified the lucene default 16 MB is used. See Lucene documentation for details.
MaxBufferedDocs Integer The minimal number of documents required before the buffered in-memory documents are flushed. If no value is specified lucene uses flushing by RAMBufferSize by default. See Lucene documentation for details.
MaxBufferedDeleteTerms Integer The minimal number of delete terms required before the buffered in-memory delete terms are applied and flushed. If no value is specified lucene uses flushing by RAMBufferSize by default. See Lucene documentation for details.
Note

For best performance use ForceFlush="false" and RAMBufferSize with a meaningful value depending on your system resources. It is important to understand, that if ForceFlush="false" then added/deleted documents may not be visible in a search until a final flush is triggered. A flush is always performed when bundle org.eclipse.smila.lucene is stopped. It is also possible to perform a manual flush via the JMX Console.


  • configuration/org.eclipse.smila.lucene/Mappings.xml

Here a mapping of attribute and attachment names to Lucene "FieldNo" (defined in DataDictionary.xml) is configured. It is possible to define mappings for multiple indexes in this file, using the same "indexName" as in file DataDictionary.xml.


Example

The following example was used in the SMILA example application to index records delivered by Filesystem- and WebCrawler.

addpipeline.bpel

...
<extensionActivity name="invokeLuceneService">
    <proc:invokeService>
        <proc:service name="LuceneIndexService" />
        <proc:variables input="request" output="request" />
        <proc:setAnnotations>
            <rec:An n="org.eclipse.smila.lucene.LuceneIndexService">
                <rec:V n="indexName">test_index</rec:V>
                <rec:V n="executionMode">ADD</rec:V>
                <rec:V n="allowDoublets">false</rec:V>
            </rec:An>
        </proc:setAnnotations>
    </proc:invokeService>
</extensionActivity>
...

DataDictionary.xml

<?xml version="1.0" encoding="UTF-8"?>
<AnyFinderDataDictionary xmlns="http://www.anyfinder.de/DataDictionary" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.anyfinder.de/DataDictionary ../xml/AnyFinderDataDictionary.xsd">
  <Index Name="test_index">
    <Connection xmlns="http://www.anyfinder.de/DataDictionary/Connection" MaxConnections="5"/>
    <IndexStructure xmlns="http://www.anyfinder.de/IndexStructure" Name="test_index">
      <Analyzer ClassName="org.apache.lucene.analysis.standard.StandardAnalyzer"/>
      <IndexField FieldNo="8" IndexValue="true" Name="MimeType" StoreText="true" Tokenize="true" Type="Text"/>
      <IndexField FieldNo="7" IndexValue="true" Name="Size" StoreText="true" Tokenize="true" Type="Text"/>
      <IndexField FieldNo="6" IndexValue="true" Name="Extension" StoreText="true" Tokenize="true" Type="Text"/>
      <IndexField FieldNo="5" IndexValue="true" Name="Title" StoreText="true" Tokenize="true" Type="Text"/>
      <IndexField FieldNo="4" IndexValue="true" Name="Url" StoreText="true" Tokenize="false" Type="Text">
        <Analyzer ClassName="org.apache.lucene.analysis.WhitespaceAnalyzer"/>
      </IndexField>
      <IndexField FieldNo="3" IndexValue="true" Name="LastModifiedDate" StoreText="true" Tokenize="false" Type="Text"/>
      <IndexField FieldNo="2" IndexValue="true" Name="Path" StoreText="true" Tokenize="true" Type="Text"/>
      <IndexField FieldNo="1" IndexValue="true" Name="Filename" StoreText="true" Tokenize="true" Type="Text"/>
      <IndexField FieldNo="0" IndexValue="true" Name="Content" StoreText="true" Tokenize="true" Type="Text"/>
    </IndexStructure>
    <Result>
      <Field FieldNo="0" Name="ID"/>            
    </Result>
    <Configuration xmlns="http://www.anyfinder.de/DataDictionary/Configuration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.anyfinder.de/DataDictionary/Configuration ../xml/DataDictionaryConfiguration.xsd">
      <DefaultConfig>
        <Field FieldNo="8">
          <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
            <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
          </FieldConfig>
        </Field>
        <Field FieldNo="7">
          <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
            <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
          </FieldConfig>
        </Field>
        <Field FieldNo="6">
          <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
            <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
          </FieldConfig>
        </Field>        
        <Field FieldNo="5">
          <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
            <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
          </FieldConfig>
        </Field>
        <Field FieldNo="4">
          <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
            <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
          </FieldConfig>
        </Field>
        <Field FieldNo="3">
          <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
            <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
          </FieldConfig>
        </Field>
        <Field FieldNo="2">
          <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
            <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
          </FieldConfig>
        </Field>
        <Field FieldNo="1">
          <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
            <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
          </FieldConfig>
        </Field>
        <Field FieldNo="0">
          <FieldConfig Constraint="optional" Weight="1" xsi:type="FTText">
            <NodeTransformer xmlns="http://www.anyfinder.de/Search/ParameterObjects" Name="urn:ExtendedNodeTransformer">
              <ParameterSet xmlns="http://www.brox.de/ParameterSet"/>
            </NodeTransformer>
            <Parameter xmlns="http://www.anyfinder.de/Search/TextField" Operator="OR" Tolerance="exact"/>
          </FieldConfig>
        </Field>
      </DefaultConfig>
    </Configuration>
  </Index>
</AnyFinderDataDictionary>

Mappings.xml

<?xml version="1.0" encoding="utf-8" ?>
<Mappings xmlns="http://www.eclipse.org/smila/lucene"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="schemas/Mappings.xsd"
>
  <Mapping indexName="test_index">
    <Attributes>
	    <Attribute name="Filename" fieldNo="1" />
	    <Attribute name="Path" fieldNo="2" />    
	    <Attribute name="LastModifiedDate" fieldNo="3" />
	    <Attribute name="Url" fieldNo="4" />
	    <Attribute name="Title" fieldNo="5" />    
	    <Attribute name="Extension" fieldNo="6" />
	    <Attribute name="Size" fieldNo="7" />
	    <Attribute name="MimeType" fieldNo="8" />           
    </Attributes>
    <Attachments>
        <Attachment name="Content" fieldNo="0" />      
    </Attachments>
  </Mapping>
</Mappings>