Package org.alfresco.repo.search.adaptor.lucene

Interface LuceneQueryParserAdaptor<Q,S,E extends java.lang.Throwable>

Type Parameters:

Q - the query type used by the query engine implementation

S - the sort type used by the query engine implementation

E - the exception it throws

public interface LuceneQueryParserAdaptor<Q,S,E extends java.lang.Throwable>

Adaptor class principally to wrap lucene parser implementations and encapsulate changes between lucene versions of query building.

Author:

Andy

Method Summary

Modifier and Type	Method	Description
S	buildSort(java.util.List<Ordering> list, FunctionEvaluationContext functionContext)
java.lang.String	getDatetimeSortField(java.lang.String field, PropertyDefinition propertyDef)
LuceneQueryParserExpressionAdaptor<Q,E>	getExpressionAdaptor()	Utility to build conjunctions, disjunctions and negation
java.lang.String	getField()	Get the default field
Q	getFieldQuery(java.lang.String field, java.lang.String value)
Q	getFieldQuery(java.lang.String luceneFieldName, java.lang.String term, AnalysisMode analysisMode, java.lang.Integer slop, LuceneFunction luceneFunction)
Q	getFieldQuery(java.lang.String field, java.lang.String queryText, AnalysisMode analysisMode, LuceneFunction luceneFunction)
Q	getFuzzyQuery(java.lang.String luceneFieldName, java.lang.String term, java.lang.Float minSimilarity)
Q	getIdentifieLikeQuery(java.lang.String field, java.lang.String stringValue, AnalysisMode analysisMode)	Wrap generating a potentially complex id + version query
Q	getIdentifierQuery(java.lang.String field, java.lang.String stringValue, AnalysisMode analysisMode, LuceneFunction luceneFunction)	Wrap generating a potentially complex id + version query
Q	getLikeQuery(java.lang.String field, java.lang.String sqlLikeClause, AnalysisMode analysisMode)
Q	getMatchAllNodesQuery()	A query that matches all alfresco nodes (not extra stuff that may be in the underlying index)
Q	getMatchAllQuery()	A query that matches all docs
Q	getMatchNoneQuery()	A query that matches no docs.
Q	getNegatedQuery(Q query)	Invert a query - add a mandatory must not match anything query alnogside
int	getPhraseSlop()	Get the default phrase slop
Q	getPrefixQuery(java.lang.String luceneFieldName, java.lang.String term, AnalysisMode analysisMode)
Q	getRangeQuery(java.lang.String field, java.lang.String lower, java.lang.String upper, boolean includeLower, boolean includeUpper, AnalysisMode analysisMode, LuceneFunction luceneFunction)
SearchParameters	getSearchParameters()
java.lang.String	getSortField(java.lang.String field)
Q	getSpanQuery(java.lang.String luceneFieldName, java.lang.String first, java.lang.String last, int slop, boolean inOrder)
Q	getWildcardQuery(java.lang.String luceneFieldName, java.lang.String term, AnalysisMode mode)
boolean	sortFieldExists(java.lang.String noLocalField)

Method Detail

getFieldQuery

Q getFieldQuery(java.lang.String field,
                java.lang.String queryText,
                AnalysisMode analysisMode,
                LuceneFunction luceneFunction)
         throws E extends java.lang.Throwable

Parameters:

field - String

queryText - String

analysisMode - AnalysisMode

luceneFunction - LuceneFunction

Returns:

Q

Throws:

E extends java.lang.Throwable

getRangeQuery

Q getRangeQuery(java.lang.String field,
                java.lang.String lower,
                java.lang.String upper,
                boolean includeLower,
                boolean includeUpper,
                AnalysisMode analysisMode,
                LuceneFunction luceneFunction)
         throws E extends java.lang.Throwable

Parameters:

field - String

lower - String

upper - String

includeLower - boolean

includeUpper - boolean

analysisMode - AnalysisMode

luceneFunction - LuceneFunction

Returns:

Q

Throws:

E extends java.lang.Throwable

getMatchAllQuery

Q getMatchAllQuery()
            throws E extends java.lang.Throwable

A query that matches all docs

Returns:

Q

Throws:

E

E extends java.lang.Throwable

getMatchNoneQuery

Q getMatchNoneQuery()
             throws E extends java.lang.Throwable

A query that matches no docs.

Returns:

Q

Throws:

E

E extends java.lang.Throwable

getLikeQuery

Q getLikeQuery(java.lang.String field,
               java.lang.String sqlLikeClause,
               AnalysisMode analysisMode)
        throws E extends java.lang.Throwable

Parameters:

field - String

sqlLikeClause - String

analysisMode - AnalysisMode

Returns:

Q

Throws:

E extends java.lang.Throwable

getSearchParameters

SearchParameters getSearchParameters()

Returns:

SearchParameters

getSortField

java.lang.String getSortField(java.lang.String field)
                       throws E extends java.lang.Throwable

Parameters:

field - String

Returns:

String

Throws:

E extends java.lang.Throwable

getIdentifierQuery

Q getIdentifierQuery(java.lang.String field,
                     java.lang.String stringValue,
                     AnalysisMode analysisMode,
                     LuceneFunction luceneFunction)
              throws E extends java.lang.Throwable

Wrap generating a potentially complex id + version query

Parameters:

field - String

stringValue - String

analysisMode - AnalysisMode

luceneFunction - LuceneFunction

Returns:

Q

Throws:

E extends java.lang.Throwable

getIdentifieLikeQuery

Q getIdentifieLikeQuery(java.lang.String field,
                        java.lang.String stringValue,
                        AnalysisMode analysisMode)
                 throws E extends java.lang.Throwable

Wrap generating a potentially complex id + version query

Parameters:

field - String

stringValue - String

analysisMode - AnalysisMode

Returns:

Q

Throws:

E extends java.lang.Throwable

sortFieldExists

boolean sortFieldExists(java.lang.String noLocalField)

Parameters:

noLocalField - String

Returns:

boolean

getFieldQuery

Q getFieldQuery(java.lang.String field,
                java.lang.String value)
         throws E extends java.lang.Throwable

Parameters:

field - String

value - String

Returns:

Q

Throws:

E

E extends java.lang.Throwable

buildSort

S buildSort(java.util.List<Ordering> list,
            FunctionEvaluationContext functionContext)
     throws E extends java.lang.Throwable

Parameters:

list - List

functionContext - FunctionEvaluationContext

Returns:

S

Throws:

E

E extends java.lang.Throwable

getFuzzyQuery

Q getFuzzyQuery(java.lang.String luceneFieldName,
                java.lang.String term,
                java.lang.Float minSimilarity)
         throws E extends java.lang.Throwable

Parameters:

luceneFieldName - String

term - String

minSimilarity - Float

Returns:

Q

Throws:

E

E extends java.lang.Throwable

getField

java.lang.String getField()

Get the default field

Returns:

String

getPhraseSlop

int getPhraseSlop()

Get the default phrase slop

Returns:

int

getFieldQuery

Q getFieldQuery(java.lang.String luceneFieldName,
                java.lang.String term,
                AnalysisMode analysisMode,
                java.lang.Integer slop,
                LuceneFunction luceneFunction)
         throws E extends java.lang.Throwable

Parameters:

luceneFieldName - String

term - String

analysisMode - AnalysisMode

slop - Integer

luceneFunction - LuceneFunction

Returns:

Q

Throws:

E extends java.lang.Throwable

getPrefixQuery

Q getPrefixQuery(java.lang.String luceneFieldName,
                 java.lang.String term,
                 AnalysisMode analysisMode)
          throws E extends java.lang.Throwable

Parameters:

luceneFieldName - String

term - String

analysisMode - AnalysisMode

Returns:

Q

Throws:

E extends java.lang.Throwable

getSpanQuery

Q getSpanQuery(java.lang.String luceneFieldName,
               java.lang.String first,
               java.lang.String last,
               int slop,
               boolean inOrder)
        throws E extends java.lang.Throwable

Parameters:

luceneFieldName - String

first - String

last - String

slop - int

inOrder - boolean

Returns:

Q

Throws:

E extends java.lang.Throwable

getWildcardQuery

Q getWildcardQuery(java.lang.String luceneFieldName,
                   java.lang.String term,
                   AnalysisMode mode)
            throws E extends java.lang.Throwable

Parameters:

luceneFieldName - String

term - String

mode - AnalysisMode

Returns:

Q

Throws:

E extends java.lang.Throwable

getNegatedQuery

Q getNegatedQuery(Q query)
           throws E extends java.lang.Throwable

Invert a query - add a mandatory must not match anything query alnogside

Parameters:

query - Q

Returns:

Q

Throws:

E extends java.lang.Throwable

getExpressionAdaptor

LuceneQueryParserExpressionAdaptor<Q,E> getExpressionAdaptor()

Utility to build conjunctions, disjunctions and negation

Returns:

LuceneQueryParserExpressionAdaptor

getMatchAllNodesQuery

Q getMatchAllNodesQuery()

A query that matches all alfresco nodes (not extra stuff that may be in the underlying index)

Returns:

Q

getDatetimeSortField

java.lang.String getDatetimeSortField(java.lang.String field,
                                      PropertyDefinition propertyDef)

Parameters:

field - String

propertyDef - PropertyDefinition

Returns:

String