org.codetome.hexameter.core.internal.impl

Class HexagonImpl<T extends SatelliteData>

java.lang.Object

org.codetome.hexameter.core.internal.impl.HexagonImpl<T>

All Implemented Interfaces:

Hexagon<T>

public class HexagonImpl<T extends SatelliteData>
extends Object
implements Hexagon<T>

Default implementation of the Hexagon interface.

Constructor Summary

Constructors

Constructor and Description
HexagonImpl(GridData gridData, CubeCoordinate coordinate, HexagonDataStorage<T> hexagonDataStorage) Creates a new Hexagon object from shared data and a coordinate.

Method Summary

Modifier and Type	Method and Description
void	clearSatelliteData() Clears the satellite data of this Hexagon.
boolean	equals(Object object)
double	getCenterX() Returns the center x (pixel) coordinate of this Hexagon.
double	getCenterY() Returns the center y (pixel) coordinate of this Hexagon.
CubeCoordinate	getCubeCoordinate() Returns the CubeCoordinate of this Hexagon.
int	getGridX() Returns this Hexagon's x (cube) coordinate on the HexagonalGrid.
int	getGridY() Returns this Hexagon's y coordinate on the HexagonalGrid.
int	getGridZ() Returns this Hexagon's z (cube) coordinate on the HexagonalGrid.
String	getId() Returns an unique String representing this Hexagon.
List<Point>	getPoints() Returns a list containing the Points of this Hexagon.
Optional<T>	getSatelliteData() Returns this Hexagon's satellite data.
int	hashCode()
void	setSatelliteData(T satelliteData) Can be used to add arbitrary satellite data to a Hexagon.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HexagonImpl

public HexagonImpl(GridData gridData,
                   CubeCoordinate coordinate,
                   HexagonDataStorage<T> hexagonDataStorage)

Creates a new Hexagon object from shared data and a coordinate.

Parameters:

gridData - grid data

coordinate - coordinate

hexagonDataStorage - data map

Method Detail

getId

public final String getId()

Description copied from interface: Hexagon

Returns an unique String representing this Hexagon.

Specified by:

getId in interface Hexagon<T extends SatelliteData>

getPoints

public final List<Point> getPoints()

Description copied from interface: Hexagon

Returns a list containing the Points of this Hexagon.

Specified by:

getPoints in interface Hexagon<T extends SatelliteData>

getCubeCoordinate

public final CubeCoordinate getCubeCoordinate()

Description copied from interface: Hexagon

Returns the CubeCoordinate of this Hexagon.

Specified by:

getCubeCoordinate in interface Hexagon<T extends SatelliteData>

getGridX

public final int getGridX()

Description copied from interface: Hexagon

Returns this Hexagon's x (cube) coordinate on the HexagonalGrid.

Specified by:

getGridX in interface Hexagon<T extends SatelliteData>

getGridY

public final int getGridY()

Description copied from interface: Hexagon

Returns this Hexagon's y coordinate on the HexagonalGrid. The Y coordinate is not present in the cube model but it is in the cube model. This method is just for convenience.

Specified by:

getGridY in interface Hexagon<T extends SatelliteData>

getGridZ

public final int getGridZ()

Description copied from interface: Hexagon

Returns this Hexagon's z (cube) coordinate on the HexagonalGrid.

Specified by:

getGridZ in interface Hexagon<T extends SatelliteData>

getCenterX

public final double getCenterX()

Description copied from interface: Hexagon

Returns the center x (pixel) coordinate of this Hexagon.

Specified by:

getCenterX in interface Hexagon<T extends SatelliteData>

getCenterY

public final double getCenterY()

Description copied from interface: Hexagon

Returns the center y (pixel) coordinate of this Hexagon.

Specified by:

getCenterY in interface Hexagon<T extends SatelliteData>

Returns:

center y

getSatelliteData

public final Optional<T> getSatelliteData()

Description copied from interface: Hexagon

Returns this Hexagon's satellite data.

Specified by:

getSatelliteData in interface Hexagon<T extends SatelliteData>

setSatelliteData

public final void setSatelliteData(T satelliteData)

Description copied from interface: Hexagon

Can be used to add arbitrary satellite data to a Hexagon.

Specified by:

setSatelliteData in interface Hexagon<T extends SatelliteData>

clearSatelliteData

public final void clearSatelliteData()

Description copied from interface: Hexagon

Clears the satellite data of this Hexagon.

Specified by:

clearSatelliteData in interface Hexagon<T extends SatelliteData>

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object object)

Overrides:

equals in class Object