com.marklogic.client.admin.config

Class QueryOptions.Heatmap

java.lang.Object

com.marklogic.client.admin.config.QueryOptions.Heatmap

Enclosing class:

QueryOptions

public static class QueryOptions.Heatmap
extends Object

Models a two-dimensional grid used to categorize data along two dimensions. Use with geographic indexes

Constructor Summary

Constructors

Constructor and Description
Heatmap()

Method Summary

Modifier and Type	Method and Description
double	getE() Returns the east longitude.
int	getLatdivs() Returns the number of latitudinal divisions.
int	getLondivs() Returns the number of longitudinal divisions.
double	getN() Returns the north latitude.
double	getS() Returns the south latitude.
double	getW() Returns the west longitude.
QueryOptions.Heatmap	setE(double e) Specifies the east longitude.
QueryOptions.Heatmap	setLatdivs(int latdivs) Specifies the number of latitudinal divisions.
QueryOptions.Heatmap	setLondivs(int londivs) Specifies the number of longitudinal divisions.
QueryOptions.Heatmap	setN(double n) Specifies the north latitude.
QueryOptions.Heatmap	setS(double s) Specifies the south latitude.
QueryOptions.Heatmap	setW(double w) Specifies the west longitude.

Methods inherited from class java.lang.Object

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

Constructor Detail

Heatmap

public Heatmap()

Method Detail

getE

public double getE()

Returns the east longitude.

Returns:

the longitude

getLatdivs

public int getLatdivs()

Returns the number of latitudinal divisions.

Returns:

the number of divisions

getLondivs

public int getLondivs()

Returns the number of longitudinal divisions.

Returns:

the number of divisions

getN

public double getN()

Returns the north latitude.

Returns:

the latitude

getS

public double getS()

Returns the south latitude.

Returns:

the latitude

getW

public double getW()

Returns the west longitude.

Returns:

the longitude

setE

public QueryOptions.Heatmap setE(double e)

Specifies the east longitude.

Parameters:

e - the longitude

Returns:

this heatmap

setLatdivs

public QueryOptions.Heatmap setLatdivs(int latdivs)

Specifies the number of latitudinal divisions.

Parameters:

latdivs - the number of divisions

Returns:

this heatmap

setLondivs

public QueryOptions.Heatmap setLondivs(int londivs)

Specifies the number of longitudinal divisions.

Parameters:

londivs - the number of divisions

Returns:

this heatmap

setN

public QueryOptions.Heatmap setN(double n)

Specifies the north latitude.

Parameters:

n - the latitude

Returns:

this heatmap

setS

public QueryOptions.Heatmap setS(double s)

Specifies the south latitude.

Parameters:

s - the latitude

Returns:

this heatmap

setW

public QueryOptions.Heatmap setW(double w)

Specifies the west longitude.

Parameters:

w - the longitude

Returns:

this heatmap