water.rapids.ast.prims.time

Class AstTime

java.lang.Object

water.Iced<T>

water.rapids.ast.AstRoot<T>

water.rapids.ast.AstPrimitive

water.rapids.ast.prims.time.AstTime

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

Direct Known Subclasses:

AstDay, AstDayOfWeek, AstHour, AstMillis, AstMinute, AstMonth, AstSecond, AstWeek, AstYear

public abstract class AstTime
extends AstPrimitive

Basic time accessors; extract hours/days/years/etc from H2O's internal msec-since-Unix-epoch time

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AstTime()

Method Summary

Modifier and Type	Method and Description
Val	apply(Env env, Env.StackHelp stk, AstRoot[] asts) Primary method to invoke this function, passing all the parameters as the `asts` list.
java.lang.String[]	args() List of argument names.
protected java.lang.String[][]	factors()
int	nargs() Number of function's arguments + 1.
abstract long	op(org.joda.time.MutableDateTime dt)

Methods inherited from class water.rapids.ast.AstPrimitive

description, example, exec

Methods inherited from class water.rapids.ast.AstRoot

str, toString

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Constructor Detail

AstTime

public AstTime()

Method Detail

args

public java.lang.String[] args()

Description copied from class: AstPrimitive

List of argument names. The length of the returned array should be equal to `nargs() - 1` (unless `nargs()` returns -1, in which case this function may return {"..."} or something similar).

Specified by:

args in class AstPrimitive

nargs

public int nargs()

Description copied from class: AstPrimitive

Number of function's arguments + 1. Thus, a binary operator like '+' should be declared with 3 nargs: ["+", lhs, rhs]. For variable-argument functions this method should return -1.

Specified by:

nargs in class AstPrimitive

factors

protected java.lang.String[][] factors()

op

public abstract long op(org.joda.time.MutableDateTime dt)

apply

public Val apply(Env env,
                 Env.StackHelp stk,
                 AstRoot[] asts)

Description copied from class: AstPrimitive

Primary method to invoke this function, passing all the parameters as the `asts` list.

Specified by:

apply in class AstPrimitive

Parameters:

env - Current execution environment. Variables are looked up here.

stk - TODO need clarification

asts - List of AstRoot expressions that are arguments to the function. First element in this list is the function itself.

Returns:

value resulting from calling the function with the provided list of arguments.