Module org.apache.derby.optionaltools
Package org.apache.derby.optional.api

## Interface LuceneIndexDescriptor

- All Known Implementing Classes:
    `LuceneUtils.DefaultIndexDescriptor`

      public interface LuceneIndexDescriptor

  A descriptor for how a Lucene index is created and queried.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `org.apache.lucene.analysis.Analyzer` | `getAnalyzer()` | Get the Analyzer used to create index terms
    `String[]` | `getFieldNames()` | Get the names of the fields which are created when text is indexed.
    `org.apache.lucene.queryparser.classic.QueryParser` | `getQueryParser()` | Get the QueryParser used to parse query text

- - ### Method Detail

    - #### getFieldNames

          String[] getFieldNames()

      Get the names of the fields which are created when text is indexed. These fields can be mentioned later on when querying the index.
      Returns:
        an array of field names

    - #### getAnalyzer

          org.apache.lucene.analysis.Analyzer getAnalyzer()
                                                   throws SQLException

      Get the Analyzer used to create index terms
      Returns:
        the Analyzer
      Throws:
        `SQLException` - on error

    - #### getQueryParser

          org.apache.lucene.queryparser.classic.QueryParser getQueryParser()
                                                                    throws SQLException

      Get the QueryParser used to parse query text
      Returns:
        the QueryParser
      Throws:
        `SQLException` - on error