Top Description Methods
org.h2.mvstore.rtree

public Interface Spatial

Known Direct Implementers
org.h2.mvstore.db.SpatialKey, org.h2.mvstore.rtree.DefaultSpatial

Interface Spatial represents boxes in 2+ dimensional space, where total ordering is not that straight-forward. They can be used as keys for MVRTree.
Author
Andrei Tokar

Method Summary

Modifier and TypeMethod and Description
public Spatial

Returns:

a clone
clone
(long
for the new Spatial object
id
)

Creates a copy of this Spatial object with different id.

public boolean

Returns:

true if the contents are the same
equalsIgnoringId
(Spatial
the other key
o
)

Check whether two objects are equals, but do not compare the id fields.

public long

Returns:

id
getId
()

Get id of this Spatial object

public boolean

Returns:

true if it is NULL, false otherwise
isNull
()

Test whether this object has no value

public float

Returns:

the value
max
(int
the dimension
dim
)

Get the maximum value for the given dimension.

public float

Returns:

the value
min
(int
the dimension
dim
)

Get the minimum value for the given dimension.

public void
setMax(int
the dimension
dim
,
float
the value
x
)

Set the maximum value for the given dimension.

public void
setMin(int
the dimension
dim
,
float
the value
x
)

Set the minimum value for the given dimension.

Method Detail

cloneback to summary
public Spatial clone(long id)

Creates a copy of this Spatial object with different id.

Parameters
id:long

for the new Spatial object

Returns:Spatial

a clone

equalsIgnoringIdback to summary
public boolean equalsIgnoringId(Spatial o)

Check whether two objects are equals, but do not compare the id fields.

Parameters
o:Spatial

the other key

Returns:boolean

true if the contents are the same

getIdback to summary
public long getId()

Get id of this Spatial object

Returns:long

id

isNullback to summary
public boolean isNull()

Test whether this object has no value

Returns:boolean

true if it is NULL, false otherwise

maxback to summary
public float max(int dim)

Get the maximum value for the given dimension.

Parameters
dim:int

the dimension

Returns:float

the value

minback to summary
public float min(int dim)

Get the minimum value for the given dimension.

Parameters
dim:int

the dimension

Returns:float

the value

setMaxback to summary
public void setMax(int dim, float x)

Set the maximum value for the given dimension.

Parameters
dim:int

the dimension

x:float

the value

setMinback to summary
public void setMin(int dim, float x)

Set the minimum value for the given dimension.

Parameters
dim:int

the dimension

x:float

the value