org.alfresco.repo.search.impl.querymodel

Interface FunctionEvaluationContext

All Known Implementing Classes:

AlfrescoFunctionEvaluationContext, CmisFunctionEvaluationContext

public interface FunctionEvaluationContext

The function evaluation context for lucene query implementations. This context is used at query time and also when navigating the results to get column values.

Author:

andyh

Method Summary

Modifier and Type	Method and Description
<Q,S,E extends Throwable> Q	buildLuceneEquality(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName, Serializable value, PredicateMode mode, LuceneFunction luceneFunction)
<Q,S,E extends Throwable> Q	buildLuceneExists(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName, Boolean not) Note: null and not null are not required to support functions from the spec
<Q,S,E extends Throwable> Q	buildLuceneGreaterThan(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName, Serializable value, PredicateMode mode, LuceneFunction luceneFunction)
<Q,S,E extends Throwable> Q	buildLuceneGreaterThanOrEquals(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName, Serializable value, PredicateMode mode, LuceneFunction luceneFunction)
<Q,S,E extends Throwable> Q	buildLuceneIn(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName, Collection<Serializable> values, Boolean not, PredicateMode mode) Note: In is not required to support functions from the spec
<Q,S,E extends Throwable> Q	buildLuceneInequality(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName, Serializable value, PredicateMode mode, LuceneFunction luceneFunction)
<Q,S,E extends Throwable> Q	buildLuceneLessThan(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName, Serializable value, PredicateMode mode, LuceneFunction luceneFunction)
<Q,S,E extends Throwable> Q	buildLuceneLessThanOrEquals(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName, Serializable value, PredicateMode mode, LuceneFunction luceneFunction)
<Q,S,E extends Throwable> Q	buildLuceneLike(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName, Serializable value, Boolean not) Note: Like is not required to support functions from the spec
void	checkFieldApplies(Selector selector, String propertyName)
String	getAlfrescoPropertyName(String propertyName)
String	getAlfrescoTypeName(String staticValue)
String	getLuceneFieldName(String propertyName)
LuceneFunction	getLuceneFunction(FunctionArgument functionArgument)
<Q,S,E extends Throwable> String	getLuceneSortField(LuceneQueryParserAdaptor<Q,S,E> lqpa, String propertyName)
Map<String,NodeRef>	getNodeRefs()
NodeService	getNodeService()
Serializable	getProperty(NodeRef nodeRef, String propertyName) Get a property
Float	getScore()
Map<String,Float>	getScores()
boolean	isMultiValued(String propertyName) Is this a multi-valued property?
boolean	isObjectId(String propertyName)
boolean	isOrderable(String propertyName)
boolean	isQueryable(String propertyName)

Method Detail

getNodeRefs

Map<String,NodeRef> getNodeRefs()

Returns:

the matching nodes by selector (at navigation time)

getScores

Map<String,Float> getScores()

Returns:

the scores by selector (at navigation time)

getProperty

Serializable getProperty(NodeRef nodeRef,
                         String propertyName)

Get a property

Parameters:

nodeRef - NodeRef

propertyName - String

Returns:

the property (at navigation time)

getNodeService

NodeService getNodeService()

Returns:

the node service

getScore

Float getScore()

Returns:

the score (at navigation time)

buildLuceneEquality

<Q,S,E extends Throwable> Q buildLuceneEquality(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                                String propertyName,
                                                Serializable value,
                                                PredicateMode mode,
                                                LuceneFunction luceneFunction)
                                         throws E extends Throwable

Parameters:

propertyName - String

value - Serializable

mode - PredicateMode

luceneFunction - LuceneFunction

Returns:

the query

Throws:

E

E extends Throwable

buildLuceneExists

<Q,S,E extends Throwable> Q buildLuceneExists(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                              String propertyName,
                                              Boolean not)
                                       throws E extends Throwable

Note: null and not null are not required to support functions from the spec

Parameters:

propertyName - String

not - Boolean

Returns:

the query

Throws:

E

E extends Throwable

buildLuceneGreaterThan

<Q,S,E extends Throwable> Q buildLuceneGreaterThan(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                                   String propertyName,
                                                   Serializable value,
                                                   PredicateMode mode,
                                                   LuceneFunction luceneFunction)
                                            throws E extends Throwable

Parameters:

propertyName - String

value - Serializable

mode - PredicateMode

luceneFunction - LuceneFunction

Returns:

the query

Throws:

E

E extends Throwable

buildLuceneGreaterThanOrEquals

<Q,S,E extends Throwable> Q buildLuceneGreaterThanOrEquals(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                                           String propertyName,
                                                           Serializable value,
                                                           PredicateMode mode,
                                                           LuceneFunction luceneFunction)
                                                    throws E extends Throwable

Parameters:

propertyName - String

value - Serializable

mode - PredicateMode

luceneFunction - LuceneFunction

Returns:

the query

Throws:

E

E extends Throwable

buildLuceneLessThan

<Q,S,E extends Throwable> Q buildLuceneLessThan(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                                String propertyName,
                                                Serializable value,
                                                PredicateMode mode,
                                                LuceneFunction luceneFunction)
                                         throws E extends Throwable

Parameters:

propertyName - String

value - Serializable

mode - PredicateMode

luceneFunction - LuceneFunction

Returns:

the query

Throws:

E

E extends Throwable

buildLuceneLessThanOrEquals

<Q,S,E extends Throwable> Q buildLuceneLessThanOrEquals(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                                        String propertyName,
                                                        Serializable value,
                                                        PredicateMode mode,
                                                        LuceneFunction luceneFunction)
                                                 throws E extends Throwable

Parameters:

propertyName - String

value - Serializable

mode - PredicateMode

luceneFunction - LuceneFunction

Returns:

the query

Throws:

E

E extends Throwable

buildLuceneLike

<Q,S,E extends Throwable> Q buildLuceneLike(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                            String propertyName,
                                            Serializable value,
                                            Boolean not)
                                     throws E extends Throwable

Note: Like is not required to support functions from the spec

Parameters:

propertyName - String

value - Serializable

not - Boolean

Returns:

the query

Throws:

E

E extends Throwable

buildLuceneInequality

<Q,S,E extends Throwable> Q buildLuceneInequality(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                                  String propertyName,
                                                  Serializable value,
                                                  PredicateMode mode,
                                                  LuceneFunction luceneFunction)
                                           throws E extends Throwable

Parameters:

propertyName - String

value - Serializable

mode - PredicateMode

luceneFunction - LuceneFunction

Returns:

the query

Throws:

E

E extends Throwable

buildLuceneIn

<Q,S,E extends Throwable> Q buildLuceneIn(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                          String propertyName,
                                          Collection<Serializable> values,
                                          Boolean not,
                                          PredicateMode mode)
                                   throws E extends Throwable

Note: In is not required to support functions from the spec

Parameters:

propertyName - String

not - Boolean

mode - PredicateMode

Returns:

the query

Throws:

E

E extends Throwable

getLuceneSortField

<Q,S,E extends Throwable> String getLuceneSortField(LuceneQueryParserAdaptor<Q,S,E> lqpa,
                                                    String propertyName)
                                             throws E extends Throwable

Parameters:

propertyName - String

Returns:

the field used for sorting the given property

Throws:

E

E extends Throwable

isObjectId

boolean isObjectId(String propertyName)

Parameters:

propertyName - String

Returns:

- is this an object id

isQueryable

boolean isQueryable(String propertyName)

Parameters:

propertyName - String

Returns:

is this property queryable

isOrderable

boolean isOrderable(String propertyName)

Parameters:

propertyName - String

Returns:

Is this property orderable

getLuceneFieldName

String getLuceneFieldName(String propertyName)

Parameters:

propertyName - String

Returns:

the lucene field name for the property

getLuceneFunction

LuceneFunction getLuceneFunction(FunctionArgument functionArgument)

Parameters:

functionArgument - FunctionArgument

Returns:

the lucene function appropriate to a function argument

checkFieldApplies

void checkFieldApplies(Selector selector,
                       String propertyName)

Parameters:

selector - Selector

propertyName - String

isMultiValued

boolean isMultiValued(String propertyName)

Is this a multi-valued property?

Parameters:

propertyName - String

Returns:

boolean

getAlfrescoPropertyName

String getAlfrescoPropertyName(String propertyName)

getAlfrescoTypeName

String getAlfrescoTypeName(String staticValue)

Parameters:

staticValue - String

Returns:

String