Package org.openrefine.grel

Class PureFunction

java.lang.Object

org.openrefine.grel.PureFunction

All Implemented Interfaces:

Serializable, Function

Direct Known Subclasses:

Abs, ACos, And, ArgsToArray, ASin, ATan, ATan2, Ceil, Chomp, Coalesce, Combin, Contains, Cos, Cosh, DatePart, Degrees, Diff, EndsWith, Escape, Even, Exp, Fact, FactN, Find, Fingerprint, Floor, Get, GreatestCommonDenominator, HasField, InArray, Inc, IndexOf, InnerHtml, InnerXml, Join, Jsonize, LastIndexOf, LeastCommonMultiple, Length, Ln, Log, Match, Max, MD5, Min, Mod, Multinomial, NGram, NGramFingerprint, Not, Now, Odd, Or, OwnText, ParseHtml, ParseJson, ParseXml, Partition, Phonetic, Pow, Quotient, Radians, RandomNumber, Range, Replace, ReplaceChars, Reverse, Round, RPartition, SelectXml, SHA1, Sin, Sinh, Slice, SmartSplit, Sort, Split, SplitByCharType, SplitByLengths, StartsWith, Sum, Tan, Tanh, ToDate, ToLowercase, ToNumber, ToString, ToTitlecase, ToUppercase, Trim, Type, Unescape, Unicode, UnicodeType, Uniques, WholeText, XmlAttr, XmlText, Xor

public abstract class PureFunction
extends Object
implements Function

Function whose value only depends on the values of its arguments and not of the global state which can be accessed via the context.

Most functions fall into this category: only a few (cross, facetCount…) rely on the context.

Author:

Antonin Delpeuch

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PureFunction()

Method Summary

Modifier and Type	Method	Description
abstract Object	call(Object[] args)	Computes the value of the function on the given arguments
Object	call(Properties bindings, Object[] args)	Computes the value of the function on the given arguments

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrefine.grel.Function

getDescription, getParams, getReturns

Constructor Detail

PureFunction

public PureFunction()

Method Detail

call

public final Object call(Properties bindings,
                         Object[] args)

Computes the value of the function on the given arguments

Specified by:

call in interface Function

Parameters:

bindings - the evaluation context

args - the values of the arguments

Returns:

the return value of the function

call

public abstract Object call(Object[] args)

Computes the value of the function on the given arguments

Parameters:

args - the values of the arguments

Returns:

the return value of the function