org.geomajas.layer.tile

Class TileCode

java.lang.Object

org.geomajas.layer.tile.TileCode

All Implemented Interfaces:

Serializable, CacheableObject

@Api(allMethods=true)
public class TileCode
extends Object
implements Serializable, CacheableObject

A unique spatial code determining the location of a tile. It implements the Serializable interface as it is often used as a data transfer object.

Tiling mechanisms are usually build in several levels, where the top level has only one tile, and for each level that you go deeper, the number of tiles doubles in both the X and the Y directions. All 3 parameters (tileLevel, X and Y) must always be positive integers.

Note that at a certain tile level, X and Y must always be a value between 0 and (2^tileLevel) - 1. For example:

• Tile level = 0: X=0, Y=0
• Tile level = 1: X=[0, 1], Y=[0, 1]
• Tile level = 2: X=[0, 3], Y=[0, 3]
• Tile level = 3: X=[0, 7], Y=[0, 7]
• Tile level = N: X=[0, (2^N) - 1], Y=[0, (2^N) - 1]

Since:

1.6.0

Author:

Pieter De Graef

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TileCode() Default constructor.
TileCode(int tileLevel, int x, int y) The only constructor available.

Method Summary

Methods

Modifier and Type	Method and Description
TileCode	clone() Create a clone from this object.
boolean	equals(Object o) Are the two objects equal?
String	getCacheId() String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result.
int	getTileLevel() Get the tiling depth level.
int	getX() Get the X-ordinate at the given level: X=[0, (2^tileLevel) - 1].
int	getY() Get the Y-ordinate at the given level: Y=[0, (2^tileLevel) - 1].
int	hashCode() Calculate object hash code.
void	setTileLevel(int tileLevel) set the tiling depth level.
void	setX(int x) The X-ordinate at the given level: X=[0, (2^tileLevel) - 1].
void	setY(int y) The Y-ordinate at the given level: Y=[0, (2^tileLevel) - 1].
String	toString() Return the values as a readable text: TileLevel-X-Y.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TileCode

public TileCode()

Default constructor.

TileCode

public TileCode(int tileLevel,
        int x,
        int y)

The only constructor available. It requires you to immediately set all it's values.

Parameters:

tileLevel - The tiling depth level. Where 0 means the top level. Make sure this is always a positive integer!

x - The X-ordinate at the given level: X=[0, (2^tileLevel) - 1].

y - The Y-ordinate at the given level: Y=[0, (2^tileLevel) - 1].

Method Detail

clone

public TileCode clone()

Create a clone from this object.

Overrides:

clone in class Object

Returns:

cloned tile code

toString

public String toString()

Return the values as a readable text: TileLevel-X-Y.

Overrides:

toString in class Object

Returns:

readable tile code

getTileLevel

public int getTileLevel()

Get the tiling depth level. Where 0 means the top level. Make sure this is always a positive integer!

Returns:

tile level

setTileLevel

public void setTileLevel(int tileLevel)

set the tiling depth level. Where 0 means the top level. Make sure this is always a positive integer!

Parameters:

tileLevel - The new value.

getX

public int getX()

Get the X-ordinate at the given level: X=[0, (2^tileLevel) - 1].

Returns:

x-ordinate

setX

public void setX(int x)

The X-ordinate at the given level: X=[0, (2^tileLevel) - 1].

Parameters:

x - The new value.

getY

public int getY()

Get the Y-ordinate at the given level: Y=[0, (2^tileLevel) - 1].

Returns:

y-ordinate

setY

public void setY(int y)

The Y-ordinate at the given level: Y=[0, (2^tileLevel) - 1].

Parameters:

y - The new value.

getCacheId

public String getCacheId()

String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result. It is typically used as basis for calculation of hash codes (like MD5, SHA1, SHA2 etc) of (collections of) objects.

Specified by:

getCacheId in interface CacheableObject

Returns:

cacheId

Since:

1.8.0

equals

public boolean equals(Object o)

Are the two objects equal?

Overrides:

equals in class Object

Parameters:

o - object to compare

Returns:

true when objects are equal

hashCode

public int hashCode()

Calculate object hash code.

Overrides:

hashCode in class Object

Returns:

hash code