Activity - addIndexFile

Activity Type: Indexed Files

Description

Imports a new text file into the file system and generates an index using the full-text search engine Jakarta Lucene.

Example

<addIndexFile name="addfile">
  <fromLocal from="data"/>
  <filename>uniprot.dat</filename>
  <directory>data</directory>
  <filetype>SwissProt</filetype>
  <field>ID</field>
  <field>AC</field>
  <index>index</index>
</addIndexFile>

Specification

Element addIndexFile:

• Attribute name - unique name for the activity within the scope of a request.
• Element fromLocal (required) - input stream providing the file data.
  • Attribute from - the name of the input stream providing the file data.
• Element filename (required) - the name of the new file that is to be imported and indexed
• Element directory (required) - the name of the contains the path to the directory where the new file is to be placed. This path should be relative to the top-level directory exposed by the associated OGSA-DAI service and must not attempt to traverse up the directory hierarchy higher than this directory.
• Element filetype (required) - the format of the flat file that is being indexed. Currently, supported types are: SwissProt and OMIM.
• Element field (one or more) - the fields in the flat file that are being indexed
• Element index (optional) - the path where the index will be placed

Input and Output Types

• Input: fromLocal - byte[] containing file data

Configuration

A configuration file must be provided for this activity. The configuration contains information about the flat file types that can be indexed by this activity and the helper classes used. The location of the configuration file is specified in the activity configuration document.

For example:

<configuration>
   <fileIndexer implementation="uk.org.ogsadai.activity.indexedfiles.SwissProtIndexWriter"
                filetype="SwissProt"
                analyzer="org.apache.lucene.analysis.standard.StandardAnalyzer" />
   <fileIndexer implementation="uk.org.ogsadai.activity.indexedfiles.OMIMIndexWriter"
                filetype="OMIM"
                analyzer="org.apache.lucene.analysis.standard.StandardAnalyzer" />
</configuration>

Element configuration - root element of the configuration:

• Element fileIndexer - specifies the name of a flat file type and the classes used for indexing this type.
  • Attribute filetype - a name for the type of flat file. The name identifies the supported flat file types.
  • Attribute implementation - a class implementing uk.org.ogsadai.indexedfiles.FlatFileIndexWriter which will be used for indexing this file type. Currently, the following implementations are provided:
    • uk.org.ogsadai.activity.indexedfiles.SwissProtIndexWriter
    • uk.org.ogsadai.activity.indexedfiles.OMIMIndexWriter
  • Attribute analyzer - a class extending org.apache.lucene.analysis.Analyzer which will be used for indexing. See the documentation for Jakarta Lucene for more information on analyzers.

Warning to Service Deployers

This activity can be used by clients to potentially access any directory on your server below that exposed by the associated OGSA-DAI service.

Data Resource Accessor

This activity requires a data resource accessor that implements the following interface: uk.org.ogsadai.dataresource.FileAccessProvider

Required Libraries

The use of this activity requires the following jar to be loaded on the server:

• lucene-1.4-final.jar — handles file indexing

XML Schema

OGSA-DAI/schema/ogsadai/xsd/activities/add_index_file.xsd

Class

uk.org.ogsadai.activity.indexedfiles.AddAndIndexFileActivity

Client Toolkit Class

uk.org.ogsadai.client.toolkit.activity.indexedfiles.AddAndIndexFile