org.apache.jackrabbit.oak.plugins.index.lucene.util

Class FunctionIndexProcessor

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.lucene.util.FunctionIndexProcessor

public class FunctionIndexProcessor
extends Object

A parser for function-based indexes. It converts the human-readable function definition (XPath) to the internal Polish notation.

Method Summary

Modifier and Type	Method and Description
static String	convertToPolishNotation(String function) Convert a function (in human-readable form) to the polish notation.
static String[]	getFunctionCode(String functionDescription) Split the polish notation into a tokens that can more easily be processed.
static String[]	getProperties(String[] functionCode) Get the list of properties used in the given function code.
static PropertyState	tryCalculateValue(String path, NodeState state, String[] functionCode) Try to calculate the value for the given function code.

Methods inherited from class java.lang.Object

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

Method Detail

getProperties

public static String[] getProperties(String[] functionCode)

Get the list of properties used in the given function code.

Parameters:

functionCode - the tokens, for example ["function", "lower", "@name"]

Returns:

the list of properties, for example ["name"]

tryCalculateValue

public static PropertyState tryCalculateValue(String path,
                                              NodeState state,
                                              String[] functionCode)

Try to calculate the value for the given function code.

Parameters:

path - the path of the node

state - the node state

functionCode - the tokens, for example ["function", "lower", "@name"]

Returns:

null, or the calculated value

getFunctionCode

public static String[] getFunctionCode(String functionDescription)

Split the polish notation into a tokens that can more easily be processed.

Parameters:

functionDescription - in polish notation, for example "function*lower*@name"

Returns:

tokens, for example ["function", "lower", "@name"]

convertToPolishNotation

public static String convertToPolishNotation(String function)

Convert a function (in human-readable form) to the polish notation.

Parameters:

function - the function, for example "lower([name])"

Returns:

the polish notation, for example "function*lower*@name"