net.sf.mmm.search.engine.base

Class AbstractSearchQueryBuilder

java.lang.Object

net.sf.mmm.util.component.base.AbstractLoggableObject

net.sf.mmm.search.engine.base.AbstractSearchQueryBuilder

All Implemented Interfaces:

SearchQueryBuilder, Refreshable

Direct Known Subclasses:

LuceneSearchQueryBuilder

public abstract class AbstractSearchQueryBuilder
extends AbstractLoggableObject
implements SearchQueryBuilder

This is the abstract base implementation of the SearchQueryBuilder interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private static CharFilter	CHAR_FILTER_ACCEPT_UNTIL_END_OF_RANGE The CharFilter to match anything except the end of a range query.
private static Set<String>	RANGE_QUERY_SEPARATOR_SET The separator of minimum and maximum in a range query.

Constructor Summary

Constructors

Constructor and Description
AbstractSearchQueryBuilder() The constructor.

Method Summary

Modifier and Type	Method and Description
protected SearchQuery	createNullQuery() This method creates (or gets) a query that matches anything.
private SearchQuery	parseStandardClause(CharSequenceScanner parser, String defaultField, int depth, SearchQueryBuilderOptions options)
private SearchQuery	parseStandardQuery(CharSequenceScanner parser, SearchQueryBuilderOptions options, String defaultProperty, int depth)
SearchQuery	parseStandardQuery(String query) This method parses the given query string in the standard query language of this specification.
SearchQuery	parseStandardQuery(String query, SearchQueryBuilderOptions options) This method parses the given query string in the standard query language of this specification.

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableObject

getLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.mmm.search.engine.api.SearchQueryBuilder

createComplexQuery, createPhraseQuery, createRangeQuery, createWordQuery, refresh

Field Detail

CHAR_FILTER_ACCEPT_UNTIL_END_OF_RANGE

private static final CharFilter CHAR_FILTER_ACCEPT_UNTIL_END_OF_RANGE

The CharFilter to match anything except the end of a range query.

RANGE_QUERY_SEPARATOR_SET

private static final Set<String> RANGE_QUERY_SEPARATOR_SET

The separator of minimum and maximum in a range query. Has to be separated with whitespaces.

Constructor Detail

AbstractSearchQueryBuilder

public AbstractSearchQueryBuilder()

The constructor.

Method Detail

createNullQuery

protected SearchQuery createNullQuery()

This method creates (or gets) a query that matches anything.

Returns:

a query that matches any entry.

parseStandardQuery

public SearchQuery parseStandardQuery(String query)
                               throws SearchException

This method parses the given query string in the standard query language of this specification.

Specified by:

parseStandardQuery in interface SearchQueryBuilder

Parameters:

query - is the query to parse as string.

Returns:

the parsed query.

Throws:

SearchException - if the given query string is illegal and can NOT be parsed. Implementations should be tolerant and try to avoid this situation.

See Also:

SearchQueryBuilder.parseStandardQuery(String, SearchQueryBuilderOptions)

parseStandardQuery

private SearchQuery parseStandardQuery(CharSequenceScanner parser,
                                       SearchQueryBuilderOptions options,
                                       String defaultProperty,
                                       int depth)

Parameters:

parser - is the scanner of the query-string.

options - are the SearchQueryBuilderOptions.

defaultProperty - is the property to use as default for unqualified search-terms.

depth - is the depth of the query expression (number of open parenthesis).

Returns:

the parsed query or null if this a call with a depth greater than 0 and the parsed query segment was void.

See Also:

parseStandardQuery(String, SearchQueryBuilderOptions)

parseStandardClause

private SearchQuery parseStandardClause(CharSequenceScanner parser,
                                        String defaultField,
                                        int depth,
                                        SearchQueryBuilderOptions options)

Parameters:

parser - is the scanner of the query-string.

defaultField - is the field to use as default for unqualified search-terms.

depth - is the depth of the query expression (number of open parenthesis).

options - are the SearchQueryBuilderOptions.

Returns:

the parsed query or null if the parsed query segment was void.

parseStandardQuery

public SearchQuery parseStandardQuery(String query,
                                      SearchQueryBuilderOptions options)

This method parses the given query string in the standard query language of this specification.
The standard query language is defined by the following EBNF grammar:

 <WHITESPACE> = (' '|'\t'|'\n'|'\r')
 <WHITESPACES> = (<WHITESPACE>)+
 <START_CHAR> = ^(<WHITESPACE>|'+'|'-'|'('|')'|'"'|'\'')
 <CHAR> = (<START_CHAR>|'+'|'-')
 <WORD> = <START_CHAR> (<CHAR>)*
 <PHRASE> = '"' (^('"'))* '"'
 <TO> = ("TO" | "to" | "-")
 <MIN> = <WORD>
 <MAX> = <WORD>
 <RANGE> = ('{' | '[') <MIN> ' ' <TO> ' ' <MAX> (']' | '}')
 <MATCH> = (<PHRASE> | <WORD> | <RANGE>)
 <FIELD> = ('a'-'z'|'A'-'Z')+
 <CLAUSE> = ['+'|'-'] [<FIELD> ':'] ( <MATCH> | '(' <QUERY> ')' )
 <QUERY> = <CLAUSE> | <CLAUSE> (<WHITESPACES> <QUERY>)* ) 
 

Specified by:

parseStandardQuery in interface SearchQueryBuilder

Parameters:

query - is the query to parse as string.

options - are the SearchQueryBuilderOptions.

Returns:

the parsed query.