org.jsimpledb.parse.func

Class ForEachFunction

java.lang.Object

org.jsimpledb.parse.func.AbstractFunction

org.jsimpledb.parse.func.ApplyExprFunction

org.jsimpledb.parse.func.ForEachFunction

All Implemented Interfaces:

Function

public class ForEachFunction
extends ApplyExprFunction

Field Summary

Fields inherited from class org.jsimpledb.parse.func.AbstractFunction

log, name, spaceParser

Constructor Summary

Constructors

Constructor and Description
ForEachFunction()

Method Summary

Modifier and Type	Method and Description
protected Value	apply(ParseSession session, org.jsimpledb.parse.func.ApplyExprFunction.ParamInfo params) Apply this function.
String	getHelpDetail() Get expanded help (typically multiple lines).
String	getHelpSummary() Get summarized help (typically a single line).
EnumSet<SessionMode>	getSessionModes() Get the SessionMode(s) supported by this instance.
String	getUsage() Get function usage string.

Methods inherited from class org.jsimpledb.parse.func.ApplyExprFunction

apply, evaluate, parseParams

Methods inherited from class org.jsimpledb.parse.func.AbstractFunction

getName, parseExpressionParams, parseNextParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ForEachFunction

public ForEachFunction()

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

getSessionModes

public EnumSet<SessionMode> getSessionModes()

Description copied from class: AbstractFunction

Get the SessionMode(s) supported by this instance.

The implementation in AbstractFunction returns an EnumSet containing SessionMode.CORE_API and SessionMode.JSIMPLEDB.

Specified by:

getSessionModes in interface Function

Overrides:

getSessionModes in class AbstractFunction

Returns:

supported SessionModes

apply

protected Value apply(ParseSession session,
                      org.jsimpledb.parse.func.ApplyExprFunction.ParamInfo params)

Description copied from class: ApplyExprFunction

Apply this function.

Specified by:

apply in class ApplyExprFunction

Parameters:

session - parse session

params - function parameters

Returns:

the value of this function