io.warp10.script.functions

Class HHCODEFUNC

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.functions.HHCODEFUNC

All Implemented Interfaces:

WarpScriptStackFunction

public class HHCODEFUNC
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

Template function to interface with HHCodeHelper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HHCODEFUNC.HHCodeAction

Constructor Summary

Constructors

Constructor and Description
HHCODEFUNC(java.lang.String name, HHCODEFUNC.HHCodeAction action)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(WarpScriptStack stack)
static long[]	hhAndRes(java.lang.Object hhcode) Convert a HHCode representation to a long hhcode and an int resolution.

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HHCODEFUNC

public HHCODEFUNC(java.lang.String name,
                  HHCODEFUNC.HHCodeAction action)

Method Detail

apply

public java.lang.Object apply(WarpScriptStack stack)
                       throws WarpScriptException

Specified by:

apply in interface WarpScriptStackFunction

Throws:

WarpScriptException

hhAndRes

public static long[] hhAndRes(java.lang.Object hhcode)
                       throws WarpScriptException

Convert a HHCode representation to a long hhcode and an int resolution. The resolution is even and between 2 and 32, inclusive.

Parameters:

hhcode - The HHCode representation, which may be a String, a byte[] or a Long.

Returns:

an array of two long, the first being the HHCode and the second being the resolution, which can be safely casted to an int.

Throws:

WarpScriptException - if the given Object is not a Long, a byte[] of length <= 8 or a String or length <= 16.