io.warp10.script.functions

Class GEOCELLTO

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.functions.GEOCELLTO

All Implemented Interfaces:

WarpScriptStackFunction

public class GEOCELLTO
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

Converts a geocell long to a String HHCode prefix whose resolution is implicitly given by its length. It cannot convert to a byte[] representation because they are limited to resolutions multiple of 4.

Constructor Summary

Constructors

Constructor and Description
GEOCELLTO(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(WarpScriptStack stack)
static java.lang.String	geocellToHHCodePrefix(long geocell) Converts a geocell (4 bits resolution + 60 bits hhcode) to an HHCode prefix String whose resolution is implicitly given by the length of the String.

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

GEOCELLTO

public GEOCELLTO(java.lang.String name)

Method Detail

apply

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

Specified by:

apply in interface WarpScriptStackFunction

Throws:

WarpScriptException

geocellToHHCodePrefix

public static java.lang.String geocellToHHCodePrefix(long geocell)

Converts a geocell (4 bits resolution + 60 bits hhcode) to an HHCode prefix String whose resolution is implicitly given by the length of the String.

Parameters:

geocell - The geocell to convert.

Returns:

An HHCode prefix String whose resolution is implicitly given by the length of the String. Thus its length is between 1 and 15, inclusive.