io.permazen.parse.func

Class QueryCompositeIndexFunction

java.lang.Object

io.permazen.parse.func.AbstractFunction

io.permazen.parse.func.QueryCompositeIndexFunction

All Implemented Interfaces:

Function

public class QueryCompositeIndexFunction
extends AbstractFunction

Field Summary

Fields inherited from class io.permazen.parse.func.AbstractFunction

log, name

Constructor Summary

Constructors

Constructor and Description
QueryCompositeIndexFunction()

Method Summary

Modifier and Type	Method and Description
protected Value	apply(ParseSession session, Class<?> objectType, String indexName, Class<?>[] valueTypes) Handle multi-argument form.
protected Value	apply(ParseSession session, int storageId) Handle single argument form.
Value	apply(ParseSession session, Object result) Evaluate this function.
String	getHelpDetail() Get expanded help (typically multiple lines).
String	getHelpSummary() Get summarized help (typically a single line).
String	getUsage() Get function usage string.
protected int	parseName(ParseSession session, ParseContext ctx, boolean complete) Attempt to parse an index name.
Object	parseParams(ParseSession session, ParseContext ctx, boolean complete) Returns one of: Integer, Node, or Node[].

Methods inherited from class io.permazen.parse.func.AbstractFunction

getName, getSessionModes, parseExpressionParams, parseNextParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryCompositeIndexFunction

public QueryCompositeIndexFunction()

Method Detail

getHelpSummary

public String getHelpSummary()

Description copied from interface: Function

Get summarized help (typically a single line).

Returns:

one line summarized description of this function

getUsage

public String getUsage()

Description copied from interface: Function

Get function usage string. For example: pow(base, exponent).

Returns:

function usage string

getHelpDetail

public String getHelpDetail()

Description copied from class: AbstractFunction

Get expanded help (typically multiple lines). May refer to the usage string.

The implementation in AbstractFunction delegates to getHelpSummary().

The implementation in AbstractFunction just delegates to getHelpSummary().

Specified by:

getHelpDetail in interface Function

Overrides:

getHelpDetail in class AbstractFunction

Returns:

detailed description of this function

parseName

protected int parseName(ParseSession session,
                        ParseContext ctx,
                        boolean complete)

Attempt to parse an index name.

Parameters:

session - parse session

ctx - parse context

complete - false if parse is "for real", true if only for tab completion calculation

Returns:

indexed field or composite index storage ID

apply

protected Value apply(ParseSession session,
                      Class<?> objectType,
                      String indexName,
                      Class<?>[] valueTypes)

Handle multi-argument form.

Parameters:

session - parse session

objectType - target object type

indexName - field or composite index name

valueTypes - index value type(s)

Returns:

query return value

parseParams

public Object parseParams(ParseSession session,
                          ParseContext ctx,
                          boolean complete)

Returns one of: Integer, Node, or Node[].

Parameters:

session - parse session

ctx - parse context

complete - false if parse is "for real", true if only for tab completion calculation

Returns:

parsed parameters object to be passed to apply()

apply

public Value apply(ParseSession session,
                   Object result)

Description copied from interface: Function

Evaluate this function. There will be a transaction open.

Parameters:

session - parse session

result - parsed parameters returned by parseParams()

Returns:

value returned by this function

apply

protected Value apply(ParseSession session,
                      int storageId)

Handle single argument form.

Parameters:

session - parse session

storageId - field or composite index storage ID

Returns:

query return value