org.eclipse.smila.lucene
Interface LuceneSearchService

All Superinterfaces:

LuceneService

All Known Implementing Classes:

LuceneServiceImpl

public interface LuceneSearchService
extends LuceneService

Lucene Search Service interface.

Field Summary

static java.lang.String	DEFAULT_DATE_FORMAT The default date format to use.
static java.lang.String	DEFAULT_DATE_TIME_FORMAT The default date time format to use.
static java.lang.String	MAPPINGS_ATTACHMENTS Name of the attachments mapping key.
static java.lang.String	MAPPINGS_ATTRIBUTES Name of the attributes mapping key.
static java.lang.String	RANKING_OPERATOR Constant for the SearchAnnotation named value Operator of Annotation ranking.
static java.lang.String	RANKING_TOLERANCE Constant for the SearchAnnotation named value Tolerance of Annotation ranking.
static java.lang.String	SEARCH_ANNOTATION_QUERY_ATTRIBUTE Constant for the SearchAnnotation QueryAttribut.
static java.lang.String	SEARCH_ANNOTATION_TEMPLATE_SELECTOR_NAME Constant for the SearchAnnotation TemplateSelectorName.

Fields inherited from interface org.eclipse.smila.lucene.LuceneService

BUNDLE_NAME, CONFIG_FILE_MAPPINGS, ID_FIELD

Method Summary

void	search(Blackboard blackboard, java.lang.String requestId, QueryParameterAccessor parameters) Creates a query and executes the query on the lucene index.

Field Detail

SEARCH_ANNOTATION_QUERY_ATTRIBUTE

static final java.lang.String SEARCH_ANNOTATION_QUERY_ATTRIBUTE

Constant for the SearchAnnotation QueryAttribut. The attribute to use for a default query.

See Also:

Constant Field Values

SEARCH_ANNOTATION_TEMPLATE_SELECTOR_NAME

static final java.lang.String SEARCH_ANNOTATION_TEMPLATE_SELECTOR_NAME

Constant for the SearchAnnotation TemplateSelectorName.

See Also:

Constant Field Values

RANKING_OPERATOR

static final java.lang.String RANKING_OPERATOR

Constant for the SearchAnnotation named value Operator of Annotation ranking.

See Also:

Constant Field Values

RANKING_TOLERANCE

static final java.lang.String RANKING_TOLERANCE

Constant for the SearchAnnotation named value Tolerance of Annotation ranking.

See Also:

Constant Field Values

MAPPINGS_ATTRIBUTES

static final java.lang.String MAPPINGS_ATTRIBUTES

Name of the attributes mapping key.

See Also:

Constant Field Values

MAPPINGS_ATTACHMENTS

static final java.lang.String MAPPINGS_ATTACHMENTS

Name of the attachments mapping key.

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

static final java.lang.String DEFAULT_DATE_FORMAT

The default date format to use.

See Also:

Constant Field Values

DEFAULT_DATE_TIME_FORMAT

static final java.lang.String DEFAULT_DATE_TIME_FORMAT

The default date time format to use.

See Also:

Constant Field Values

Method Detail

search

void search(Blackboard blackboard,
            java.lang.String requestId,
            QueryParameterAccessor parameters)
            throws BlackboardAccessException,
                   IndexException,
                   DataDictionaryException,
                   NodeTransformerException,
                   ProcessingException

Creates a query and executes the query on the lucene index.

Parameters:

blackboard - the BlackBoardService

requestId - the record ID of the search request.

parameters - query parameters

Throws:

BlackboardAccessException - if any error occurs

IndexException - if any error occurs

DataDictionaryException - if any error occurs

NodeTransformerException - if any error occurs

ProcessingException - if parameter SEARCH_ANNOTATION_QUERY_ATTRIBUTE is not set for simple query or any other error occurs