Package mil.nga.mgrs.grid

Class Grid

java.lang.Object

mil.nga.grid.BaseGrid

mil.nga.mgrs.grid.Grid

All Implemented Interfaces:

Comparable<Grid>

public class Grid
extends BaseGrid
implements Comparable<Grid>

Grid

Author:

wnewman, osbornb

Field Summary

Fields

Modifier and Type	Field	Description
static double	DEFAULT_WIDTH	Default line width

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Grid(GridType type)	Constructor

Method Summary

Modifier and Type	Method	Description
void	clearPrecisionStyles()	Clear the propagated grid type precision styles
int	compareTo(Grid other)
boolean	equals(Object obj)
Color	getColor(GridType gridType)	Get the grid type precision line color
GridLabeler	getLabeler()	Get the grid labeler
List<GridLabel>	getLabels(int zoom, Bounds tileBounds, GridZone zone)	Get the labels for the zoom, tile bounds, and zone
List<GridLabel>	getLabels(GridTile tile, GridZone zone)	Get the labels for the tile and zone
List<GridLine>	getLines(int zoom, Bounds tileBounds, GridZone zone)	Get the lines for the zoom, tile bounds, and zone
List<GridLine>	getLines(Bounds tileBounds, GridZone zone)	Get the lines for the tile bounds and zone
List<GridLine>	getLines(GridTile tile, GridZone zone)	Get the lines for the tile and zone
int	getPrecision()	Get the precision in meters
int	getPrecisionCompare()	Get the precision in meters
GridStyle	getStyle(GridType gridType)	Get the grid type precision line style for the grid type
GridType	getType()	Get the grid type
double	getWidth(GridType gridType)	Get the grid type precision line width
int	hashCode()
boolean	isType(GridType type)	Is the provided grid type
void	setColor(GridType gridType, Color color)	Set the grid type precision line color
protected void	setLabeler(GridLabeler labeler)	Set the grid labeler
void	setStyle(GridType gridType, GridStyle style)	Set the grid type precision line style
void	setWidth(GridType gridType, double width)	Set the grid type precision line width

Methods inherited from class mil.nga.grid.BaseGrid

getColor, getLabelBuffer, getLinesMaxZoom, getLinesMinZoom, getMaxZoom, getMinZoom, getStyle, getWidth, hasLabeler, hasLinesMaxZoom, hasLinesMinZoom, hasMaxZoom, isEnabled, isLabelerWithin, isLinesWithin, isWithin, setColor, setEnabled, setLabeler, setLinesMaxZoom, setLinesMinZoom, setMaxZoom, setMinZoom, setStyle, setWidth

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WIDTH

public static final double DEFAULT_WIDTH

Default line width

Constructor Detail

Grid

protected Grid(GridType type)

Constructor

Parameters:

type - grid type

Method Detail

getType

public GridType getType()

Get the grid type

Returns:

grid type

isType

public boolean isType(GridType type)

Is the provided grid type

Parameters:

type - grid type

Returns:

true if the type

getPrecision

public int getPrecision()

Get the precision in meters

Returns:

precision meters

getStyle

public GridStyle getStyle(GridType gridType)

Get the grid type precision line style for the grid type

Parameters:

gridType - grid type

Returns:

grid type line style

setStyle

public void setStyle(GridType gridType,
                     GridStyle style)

Set the grid type precision line style

Parameters:

gridType - grid type

style - grid line style

clearPrecisionStyles

public void clearPrecisionStyles()

Clear the propagated grid type precision styles

getColor

public Color getColor(GridType gridType)

Get the grid type precision line color

Parameters:

gridType - grid type

Returns:

grid type line color

setColor

public void setColor(GridType gridType,
                     Color color)

Set the grid type precision line color

Parameters:

gridType - grid type

color - grid line color

getWidth

public double getWidth(GridType gridType)

Get the grid type precision line width

Parameters:

gridType - grid type

Returns:

grid type line width

setWidth

public void setWidth(GridType gridType,
                     double width)

Set the grid type precision line width

Parameters:

gridType - grid type

width - grid line width

getLabeler

public GridLabeler getLabeler()

Get the grid labeler

Overrides:

getLabeler in class BaseGrid

Returns:

grid labeler

setLabeler

protected void setLabeler(GridLabeler labeler)

Set the grid labeler

Parameters:

labeler - grid labeler

getLines

public List<GridLine> getLines(GridTile tile,
                               GridZone zone)

Get the lines for the tile and zone

Parameters:

tile - tile

zone - grid zone

Returns:

lines

getLines

public List<GridLine> getLines(int zoom,
                               Bounds tileBounds,
                               GridZone zone)

Get the lines for the zoom, tile bounds, and zone

Parameters:

zoom - zoom level

tileBounds - tile bounds

zone - grid zone

Returns:

lines

getLines

public List<GridLine> getLines(Bounds tileBounds,
                               GridZone zone)

Get the lines for the tile bounds and zone

Parameters:

tileBounds - tile bounds

zone - grid zone

Returns:

lines

getLabels

public List<GridLabel> getLabels(GridTile tile,
                                 GridZone zone)

Get the labels for the tile and zone

Parameters:

tile - tile

zone - grid zone

Returns:

labels

getLabels

public List<GridLabel> getLabels(int zoom,
                                 Bounds tileBounds,
                                 GridZone zone)

Get the labels for the zoom, tile bounds, and zone

Parameters:

zoom - zoom level

tileBounds - tile bounds

zone - grid zone

Returns:

labels

compareTo

public int compareTo(Grid other)

Specified by:

compareTo in interface Comparable<Grid>

getPrecisionCompare

public int getPrecisionCompare()

Get the precision in meters

Returns:

precision meters

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object