CoordinateMap (repo.hcf.dev/javadoc/ball-api 20200622.0 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - ball.util.MapView<Coordinate,V>
  - - ball.util.CoordinateMap<V>

Type Parameters:

V - The value type.

All Implemented Interfaces:

Serializable, Map<Coordinate,V>, SortedMap<Coordinate,V>, TableModel

Direct Known Subclasses:

Board, Board, Puzzle, Puzzle
```
public class CoordinateMap<V>
extends MapView<Coordinate,V>
implements SortedMap<Coordinate,V>, TableModel
```
Coordinate Map implementation.

Version:

$Revision: 5285 $

Author:

Allen D. Ball

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class ball.util.MapView
  MapView.EntrySet
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class ball.util.MapView
  entrySet

Constructor Summary

Constructors
Constructor and Description
`CoordinateMap()` Constructor to create an empty `CoordinateMap`.
`CoordinateMap(Number yN, Number xN)` Constructor to specify maximum `Y` and `X` (origin `(0, 0)`).
`CoordinateMap(Number y0, Number x0, Number yN, Number xN)` Constructor to specify minimum and maximum `Y` and `X`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTableModelListener(TableModelListener listener)`
`List<V>`	`asList()` Method to get `this` `CoordinateMap` values as a `List`.
`void`	`clear()`
`CoordinateMap<V>`	`column(Number x)` Method to get the `List` representing the specified column backed by the `CoordinateMap`.
`List<CoordinateMap<V>>`	`columns()` Method to get a `List` of columns (see `column(Number)`).
`Comparator<? super Coordinate>`	`comparator()`
`boolean`	`containsKey(Number y, Number x)` See `AbstractMap.containsKey(Object)`.
`protected void`	`fireTableCellUpdated(int row, int column)`
`protected void`	`fireTableChanged(TableModelEvent event)`
`protected void`	`fireTableDataChanged()`
`protected void`	`fireTableRowsDeleted(int start, int end)`
`protected void`	`fireTableRowsInserted(int start, int end)`
`protected void`	`fireTableRowsUpdated(int start, int end)`
`protected void`	`fireTableStructureChanged()`
`Coordinate`	`firstKey()`
`V`	`get(Number y, Number x)` See `MapView.get(Object)`.
`Class<? extends V>`	`getColumnClass(int x)`
`int`	`getColumnCount()`
`String`	`getColumnName(int x)`
`Coordinate`	`getMax()`
`int`	`getMaxX()`
`int`	`getMaxY()`
`Coordinate`	`getMin()`
`int`	`getMinX()`
`int`	`getMinY()`
`int`	`getRowCount()`
`protected TableModelListener[]`	`getTableModelListeners()`
`protected Type`	`getType()` Method to get the value type of `this` `CoordinateMap`.
`V`	`getValueAt(int y, int x)`
`CoordinateMap<V>`	`headMap(Coordinate key)`
`boolean`	`includes(Coordinate coordinate)` Method to determine if the `Coordinate` is included in `this` `CoordinateMap`'s space.
`boolean`	`isCellEditable(int y, int x)`
`Coordinate`	`lastKey()`
`protected SortedMap<Coordinate,V>`	`map()`
`V`	`put(Coordinate key, V value)`
`V`	`put(Number y, Number x, V value)` See `MapView.put(Object,Object)`.
`V`	`remove(Object key)`
`void`	`removeTableModelListener(TableModelListener listener)`
`CoordinateMap<V>`	`resize(Number yN, Number xN)` Method to specify new limits for the `CoordinateMap` with `[y0, x0] = [0, 0]`.
`CoordinateMap<V>`	`resize(Number y0, Number x0, Number yN, Number xN)` Method to specify new limits for the `CoordinateMap`.
`CoordinateMap<V>`	`row(Number y)` Method to get the `List` representing the specified row backed by the `CoordinateMap`.
`List<CoordinateMap<V>>`	`rows()` Method to get a `List` of rows (see `row(Number)`).
`void`	`setValueAt(Object value, int y, int x)`
`CoordinateMap<V>`	`subMap(Coordinate from, Coordinate to)`
`CoordinateMap<V>`	`subMap(Number y0, Number x0, Number yN, Number xN)` Method to get a sub-`Map` of `this` `Map` also backed by `this` `Map`.
`CoordinateMap<V>`	`tailMap(Coordinate key)`

Methods inherited from class ball.util.MapView
entrySet, get

Methods inherited from class java.util.AbstractMap
clone, containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.SortedMap
entrySet, keySet, values

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll, size

- Constructor Detail
  - CoordinateMap
```
public CoordinateMap()
```
    Constructor to create an empty CoordinateMap.
  - CoordinateMap
```
public CoordinateMap(Number y0,
                     Number x0,
                     Number yN,
                     Number xN)
```
    Constructor to specify minimum and maximum Y and X.
    
    Parameters:
    
    y0 - MIN(y)
    
    x0 - MIN(x)
    
    yN - MAX(y) + 1
    
    xN - MAX(x) + 1
  - CoordinateMap
```
public CoordinateMap(Number yN,
                     Number xN)
```
    Constructor to specify maximum Y and X (origin (0, 0)).
    
    Parameters:
    
    yN - MAX(y) + 1
    
    xN - MAX(x) + 1
- Method Detail
  - map
```
protected SortedMap<Coordinate,V> map()
```
    Overrides:
    
    map in class MapView<Coordinate,V>
    
    Returns:
    
    The "wrapped" Map.
  - getType
```
protected Type getType()
```
    Method to get the value type of this CoordinateMap.
    
    Returns:
    
    The value type Class.
  - resize
```
public CoordinateMap<V> resize(Number y0,
                               Number x0,
                               Number yN,
                               Number xN)
```
    Method to specify new limits for the CoordinateMap.
    
    Parameters:
    
    y0 - MIN(y)
    
    x0 - MIN(x)
    
    yN - MAX(y) + 1
    
    xN - MAX(x) + 1
    
    Returns:
    
    this CoordinateMap.
  - resize
```
public CoordinateMap<V> resize(Number yN,
                               Number xN)
```
    Method to specify new limits for the CoordinateMap with [y0, x0] = [0, 0].
    
    Parameters:
    
    yN - MAX(y) + 1
    
    xN - MAX(x) + 1
    
    Returns:
    
    this CoordinateMap.
  - getMin
```
public Coordinate getMin()
```
  - getMax
```
public Coordinate getMax()
```
  - getMinY
```
public int getMinY()
```
  - getMinX
```
public int getMinX()
```
  - getMaxY
```
public int getMaxY()
```
  - getMaxX
```
public int getMaxX()
```
  - includes
```
public boolean includes(Coordinate coordinate)
```
    Method to determine if the Coordinate is included in this CoordinateMap's space. Because the map is sparse, this method may return true when AbstractMap.containsKey(Object) returns false.
    
    Parameters:
    
    coordinate - The Coordinate.
    
    Returns:
    
    true if within the space; false otherwise.
  - columns
```
public List<CoordinateMap<V>> columns()
```
    Method to get a List of columns (see column(Number)).
    
    Returns:
    
    The List of columns.
  - rows
```
public List<CoordinateMap<V>> rows()
```
    Method to get a List of rows (see row(Number)).
    
    Returns:
    
    The List of rows.
  - column
```
public CoordinateMap<V> column(Number x)
```
    Method to get the List representing the specified column backed by the CoordinateMap.
    
    Parameters:
    
    x - The X-coordinate.
    
    Returns:
    
    The CoordinateMap representing the column.
  - row
```
public CoordinateMap<V> row(Number y)
```
    Method to get the List representing the specified row backed by the CoordinateMap.
    
    Parameters:
    
    y - The Y-coordinate.
    
    Returns:
    
    The CoordinateMap representing the row.
  - subMap
```
public CoordinateMap<V> subMap(Number y0,
                               Number x0,
                               Number yN,
                               Number xN)
```
    Method to get a sub-Map of this Map also backed by this Map.
    
    Parameters:
    
    y0 - MIN(y)
    
    x0 - MIN(x)
    
    yN - MAX(y) + 1
    
    xN - MAX(x) + 1
    
    Returns:
    
    The sub-Map (CoordinateMap).
  - asList
```
public List<V> asList()
```
    Method to get this CoordinateMap values as a List. Updates made through List.set(int,Object) will be made to this CoordinateMap.
    
    Returns:
    
    The List of CoordinateMap values.
  - containsKey
```
public boolean containsKey(Number y,
                           Number x)
```
    See AbstractMap.containsKey(Object).
    
    Parameters:
    
    y - The Y-coordinate.
    
    x - The X-coordinate.
    
    Returns:
    
    true if the CoordinateMap contains a key with the specified Coordinate; false otherwise.
  - get
```
public V get(Number y,
             Number x)
```
    See MapView.get(Object).
    
    Parameters:
    
    y - The Y-coordinate.
    
    x - The X-coordinate.
    
    Returns:
    
    The value at the coordinate (may be null).
  - put
```
public V put(Number y,
             Number x,
             V value)
```
    See MapView.put(Object,Object).
    
    Parameters:
    
    y - The Y-coordinate.
    
    x - The X-coordinate.
    
    value - The value at the coordinate.
    
    Returns:
    
    The previous value at the coordinate.
  - put
```
public V put(Coordinate key,
             V value)
```
    Specified by:
    
    put in interface Map<Coordinate,V>
    
    Overrides:
    
    put in class MapView<Coordinate,V>
  - remove
```
public V remove(Object key)
```
    Specified by:
    
    remove in interface Map<Coordinate,V>
    
    Overrides:
    
    remove in class MapView<Coordinate,V>
  - comparator
```
public Comparator<? super Coordinate> comparator()
```
    Specified by:
    
    comparator in interface SortedMap<Coordinate,V>
  - subMap
```
public CoordinateMap<V> subMap(Coordinate from,
                               Coordinate to)
```
    Specified by:
    
    subMap in interface SortedMap<Coordinate,V>
  - headMap
```
public CoordinateMap<V> headMap(Coordinate key)
```
    Specified by:
    
    headMap in interface SortedMap<Coordinate,V>
  - tailMap
```
public CoordinateMap<V> tailMap(Coordinate key)
```
    Specified by:
    
    tailMap in interface SortedMap<Coordinate,V>
  - firstKey
```
public Coordinate firstKey()
```
    Specified by:
    
    firstKey in interface SortedMap<Coordinate,V>
  - lastKey
```
public Coordinate lastKey()
```
    Specified by:
    
    lastKey in interface SortedMap<Coordinate,V>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<Coordinate,V>
    
    Overrides:
    
    clear in class MapView<Coordinate,V>
  - getRowCount
```
public int getRowCount()
```
    Specified by:
    
    getRowCount in interface TableModel
  - getColumnCount
```
public int getColumnCount()
```
    Specified by:
    
    getColumnCount in interface TableModel
  - getColumnName
```
public String getColumnName(int x)
```
    Specified by:
    
    getColumnName in interface TableModel
  - getColumnClass
```
public Class<? extends V> getColumnClass(int x)
```
    Specified by:
    
    getColumnClass in interface TableModel
  - isCellEditable
```
public boolean isCellEditable(int y,
                              int x)
```
    Specified by:
    
    isCellEditable in interface TableModel
  - getValueAt
```
public V getValueAt(int y,
                    int x)
```
    Specified by:
    
    getValueAt in interface TableModel
  - setValueAt
```
public void setValueAt(Object value,
                       int y,
                       int x)
```
    Specified by:
    
    setValueAt in interface TableModel
  - addTableModelListener
```
public void addTableModelListener(TableModelListener listener)
```
    Specified by:
    
    addTableModelListener in interface TableModel
  - removeTableModelListener
```
public void removeTableModelListener(TableModelListener listener)
```
    Specified by:
    
    removeTableModelListener in interface TableModel
  - getTableModelListeners
```
protected TableModelListener[] getTableModelListeners()
```
  - fireTableDataChanged
```
protected void fireTableDataChanged()
```
  - fireTableStructureChanged
```
protected void fireTableStructureChanged()
```
  - fireTableRowsInserted
```
protected void fireTableRowsInserted(int start,
                                     int end)
```
  - fireTableRowsUpdated
```
protected void fireTableRowsUpdated(int start,
                                    int end)
```
  - fireTableRowsDeleted
```
protected void fireTableRowsDeleted(int start,
                                    int end)
```
  - fireTableCellUpdated
```
protected void fireTableCellUpdated(int row,
                                    int column)
```
  - fireTableChanged
```
protected void fireTableChanged(TableModelEvent event)
```

Class CoordinateMap<V>

Nested Class Summary

Nested classes/interfaces inherited from class ball.util.MapView

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class ball.util.MapView

Constructor Summary

Method Summary

Methods inherited from class ball.util.MapView

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

CoordinateMap

CoordinateMap

CoordinateMap

Method Detail

map

getType

resize

resize

getMin

getMax

getMinY

getMinX

getMaxY

getMaxX

includes

columns

rows

column

row

subMap

asList

containsKey

get

put

put

remove

comparator

subMap

headMap

tailMap

firstKey

lastKey

clear

getRowCount

getColumnCount

getColumnName

getColumnClass

isCellEditable

getValueAt

setValueAt

addTableModelListener

removeTableModelListener

getTableModelListeners

fireTableDataChanged

fireTableStructureChanged

fireTableRowsInserted

fireTableRowsUpdated

fireTableRowsDeleted

fireTableCellUpdated

fireTableChanged