Package com.orientechnologies.lucene.functions

Class OLuceneSearchOnIndexFunction

java.lang.Object

com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

com.orientechnologies.lucene.functions.OLuceneSearchFunctionTemplate

com.orientechnologies.lucene.functions.OLuceneSearchOnIndexFunction

All Implemented Interfaces:

OIndexableSQLFunction, OSQLFunction

public class OLuceneSearchOnIndexFunction
extends OLuceneSearchFunctionTemplate

Created by frank on 15/01/2017.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MEMORY_INDEX
static final String	NAME

Fields inherited from class com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

maxParams, minParams, name

Constructor Summary

Constructors

Constructor	Description
OLuceneSearchOnIndexFunction()

Method Summary

Modifier and Type	Method	Description
Object	execute(Object iThis, OIdentifiable iCurrentRecord, Object iCurrentResult, Object[] params, OCommandContext ctx)	Process a record.
boolean	filterResult()	A function can act both as transformation or filtering records.
String	getName()	Function name, the name is used by the sql parser to identify a call this function.
Object	getResult(OCommandContext ctx)	Only called when function aggregates results after all records have been passed to the function.
String	getSyntax()	Returns a convenient SQL String representation of the function.
protected OLuceneFullTextIndex	searchForIndex(OFromClause target, OCommandContext ctx, OExpression... args)
Iterable<OIdentifiable>	searchFromTarget(OFromClause target, OBinaryCompareOperator operator, Object rightValue, OCommandContext ctx, OExpression... args)	returns all the entries belonging to the target that match the binary condition where this function appears

Methods inherited from class com.orientechnologies.lucene.functions.OLuceneSearchFunctionTemplate

allowsIndexedExecution, canExecuteInline, estimate, getMetadata, shouldExecuteAfterSearch

Methods inherited from class com.orientechnologies.orient.core.sql.functions.OSQLFunctionAbstract

aggregateResults, config, getDatabase, getDistributedStorageId, getMaxParams, getMinParams, getSingleItem, getSingleProperty, mergeDistributedResult, returnDistributedResult, setResult, shouldMergeDistributedResult, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.core.sql.functions.OSQLFunction

aggregateResults, config, getMaxParams, getMinParams, mergeDistributedResult, setResult, shouldMergeDistributedResult

Field Details

MEMORY_INDEX

public static final String MEMORY_INDEX

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

OLuceneSearchOnIndexFunction

public OLuceneSearchOnIndexFunction()

Method Details

getName

public String getName()

Description copied from interface: OSQLFunction

Function name, the name is used by the sql parser to identify a call this function.

Specified by:

getName in interface OSQLFunction

Overrides:

getName in class OSQLFunctionAbstract

Returns:

String , function name, never null or empty.

execute

public Object execute(Object iThis,
 OIdentifiable iCurrentRecord,
 Object iCurrentResult,
 Object[] params,
 OCommandContext ctx)

Description copied from interface: OSQLFunction

Process a record.

iCurrentRecord - : current record

iCurrentResult - TODO

params - : function parameters, number is ensured to be within minParams and maxParams.

ctx - : object calling this function

Returns:

function result, can be null. Special cases : can be null if function aggregate results, can be null if function filter results : this mean result is excluded

getSyntax

public String getSyntax()

Description copied from interface: OSQLFunction

Returns a convenient SQL String representation of the function.

Example :

  myFunction( param1, param2, [optionalParam3])
 

This text will be used in exception messages.

Returns:

String , never null.

filterResult

public boolean filterResult()

Description copied from interface: OSQLFunction

A function can act both as transformation or filtering records. If the function may reduce the number final records than it must return true.

Function should return null for the execute method if the record must be excluded.

Specified by:

filterResult in interface OSQLFunction

Overrides:

filterResult in class OSQLFunctionAbstract

Returns:

true if the function acts as a record filter.

searchFromTarget

public Iterable<OIdentifiable> searchFromTarget(OFromClause target,
 OBinaryCompareOperator operator,
 Object rightValue,
 OCommandContext ctx,
 OExpression... args)

Description copied from interface: OIndexableSQLFunction

returns all the entries belonging to the target that match the binary condition where this function appears

Parameters:

target - the query target

operator - the operator after the function, eg. in select from Foo where myFunction(name) > 4 the operator is >

rightValue - the value that has to be compared to the function result, eg. in select from Foo where myFunction(name) > 4 the right value is 4

ctx - the command context for this query

args - the function arguments, eg. in select from Foo where myFunction(name) > 4 the arguments are [name]

Returns:

an iterable of records that match the condition; null means that the execution could not be performed for some reason.

searchForIndex

protected OLuceneFullTextIndex searchForIndex(OFromClause target,
 OCommandContext ctx,
 OExpression... args)

Specified by:

searchForIndex in class OLuceneSearchFunctionTemplate

getResult

public Object getResult(OCommandContext ctx)

Description copied from interface: OSQLFunction

Only called when function aggregates results after all records have been passed to the function.

Specified by:

getResult in interface OSQLFunction

Overrides:

getResult in class OSQLFunctionAbstract

Parameters:

ctx - TODO

Returns:

Aggregation result