gov.usgs.earthquake.nshmp.geo

Class LocationGrid

java.lang.Object

gov.usgs.earthquake.nshmp.geo.LocationGrid

All Implemented Interfaces:

Iterable<Location>

public final class LocationGrid
extends Object
implements Iterable<Location>

An immutable, tabular grid of locations that supplies row and column data as LocationLists.

Internally, the grid is backed by a Guava ArrayTable.

Author:

Peter Powers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocationGrid.Builder A single-use builder of LocationGrids.

Method Summary

Modifier and Type	Method and Description
Bounds	bounds() Lazily compute the bounds of the Locations in this grid.
static LocationGrid.Builder	builder(int rows, int columns) Return a new builder.
LocationList	column(int index) Return the column at index.
int	columns() Return the number of columns in this grid.
LocationList	firstColumn() Return the first column.
LocationList	firstRow() Return the first row.
Iterator<Location>	iterator()
LocationList	lastColumn() Return the last column.
LocationList	lastRow() Return the last row.
static void	main(String[] args)
LocationGrid	parent() Return the parent grid.
LocationList	row(int index) Return the row at index.
int	rows() Return the number of rows in this grid.
int	size() Return the number of Locations in this grid.
String	toString()
LocationGrid	window(int rowStart, int rowWidth, int columnStart, int columnWidth) Return a new grid that is a window into this one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

size

public int size()

Return the number of Locations in this grid.

rows

public int rows()

Return the number of rows in this grid.

row

public LocationList row(int index)

Return the row at index.

Parameters:

index - of the row to retrieve

Throws:

IndexOutOfBoundsException - if index < 0 || index >= rows()

firstRow

public LocationList firstRow()

Return the first row.

lastRow

public LocationList lastRow()

Return the last row.

columns

public int columns()

Return the number of columns in this grid.

column

public LocationList column(int index)

Return the column at index.

Parameters:

index - of the column to retrieve

Throws:

IndexOutOfBoundsException - if index < 0 || index >= columns()

firstColumn

public LocationList firstColumn()

Return the first column.

lastColumn

public LocationList lastColumn()

Return the last column.

window

public LocationGrid window(int rowStart,
                           int rowWidth,
                           int columnStart,
                           int columnWidth)

Return a new grid that is a window into this one. The specified window dimensions must be less than or equal to the dimensions of this grid.

Parameters:

rowStart - first row of window

rowWidth - number of rows in the window

columnStart - first column of window

columnWidth -

parent

public LocationGrid parent()

Return the parent grid. Method returns itself unless it was created using one or more calls to window(int, int, int, int). In this case, a grid equivalent to this grid's greatest ancestor is returned.

bounds

public Bounds bounds()

Lazily compute the bounds of the Locations in this grid. Method delegates to Locations.bounds(Iterable).

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<Location> iterator()

Specified by:

iterator in interface Iterable<Location>

builder

public static LocationGrid.Builder builder(int rows,
                                           int columns)

Return a new builder.

Parameters:

rows - expected number of rows

columns - expected number of columns

main

public static void main(String[] args)