org.ka2ddo.yaac.gui.rastermap

Class RasterMapCatalog

java.lang.Object

javax.swing.table.AbstractTableModel

org.ka2ddo.yaac.gui.rastermap.RasterMapCatalog

All Implemented Interfaces:

java.io.Serializable, javax.swing.table.TableModel

public final class RasterMapCatalog
extends javax.swing.table.AbstractTableModel

This class maintains a catalog of registered raster map images that can be superimposed over the MapBean. Each image has its RasterMapEntry describing the image.

Author:

Andrew Pavlin, KA2DDO

See Also:

RasterMapEntry, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTTPS_RADAR_WEATHER_PREFIX Prefix of URLs used to download radar mosaics from US National Weather Service.
java.util.ArrayList<RasterMapEntry>	imageList Collection of raster images to overlay in the containing RasterMapOverlay.
static int	MIN_DELAY_BEFORE_REFRESH_MSEC Minimum time delay before cxausing a refresh of a downloaded raster.
static java.lang.String	RASTER_MAP_PREFS_NODE Name of Java Preferences node containing RasterMapEntry persistence information.
ReschedulableTimerTask	WXRASTER_TIMERTASK ReschedulableTimerTask for reloading updated US NWS weather raster.

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
RasterMapCatalog(GeoMapGuiIfc2 geoMap, RasterMapOverlay rasterMapOverlay) Create a RasterMapCatalog instance for a given GeographicalMap window's RasterMapOverlay.

Method Summary

Modifier and Type	Method and Description
int	add(RasterMapEntry rme) Add the specified RasterMapEntry to the persisted list of raster map overlays.
static void	addRasterViewportChangeListener(RasterViewportChangeListener rvcl) Register a new RasterViewportChangeListener.
void	deleteRow(int rowIndex) Delete an entire RasterMapEntry from the catalog.
RasterMapEntry	findMatchingEntry(java.util.regex.Pattern imagePattern) Find a RasterMapEntry that matches the specified regular expression.
RasterMapEntry	get(int index) Get the specified RasterMapEntry in this catalog.
java.lang.Class<?>	getColumnClass(int columnIndex) Returns the data Class for the specified column.
int	getColumnCount() Returns the number of columns in the model.
java.lang.String	getColumnName(int column) Returns the localized name for the column.
RasterMapOverlay	getRasterMapOverlay() Get the RasterMapOverlay this RasterMapCatalog is associated with.
static ReschedulableTimer	getReloadTimer() Get the raster refresh timer so tasks can be associated with it.
int	getRowCount() Returns the number of rows in the model.
java.lang.Object	getValueAt(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex.
boolean	isCellEditable(int rowIndex, int columnIndex) Indicate which columns can be edited.
static java.util.Date	loadReloadableWebMap(RasterMapEntry rme, long now) Load a fresh gzipped raster GeoTIFF image from a web source.
static long	readImageFromNetwork(java.lang.String url, RasterMapEntry rme) Reads an image specified by an URL string from the network and load it into a RasterMapEntry.
static long	readImageFromUrlConnection(java.net.URLConnection urlConnection, RasterMapEntry rme, long now) Read an image from an opened URLConnection into a RasterMapEntry object.
static void	readTiffImage(RasterMapEntry rme, long startTime, java.lang.String preferredFile, long afterDir, java.io.InputStream gzis, java.lang.String preferredFileName)
void	remove(int index) Remove the indexed record from the persisted RasterMapCatalog.
void	remove(RasterMapEntry rme) Remove the matching record from the persisted RasterMapCatalog.
static void	removeRasterViewportChangeListener(RasterViewportChangeListener rvcl) Unregister a RasterViewportChangeListener.
void	setValueAt(java.lang.Object aValue, int rowIndex, int columnIndex) Store a new value for an editable table cell.

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, removeTableModelListener

Methods inherited from class java.lang.Object

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

Field Detail

HTTPS_RADAR_WEATHER_PREFIX

public static final java.lang.String HTTPS_RADAR_WEATHER_PREFIX

Prefix of URLs used to download radar mosaics from US National Weather Service.

See Also:

Constant Field Values

RASTER_MAP_PREFS_NODE

public static final java.lang.String RASTER_MAP_PREFS_NODE

Name of Java Preferences node containing RasterMapEntry persistence information.

See Also:

Constant Field Values

MIN_DELAY_BEFORE_REFRESH_MSEC

public static final int MIN_DELAY_BEFORE_REFRESH_MSEC

Minimum time delay before cxausing a refresh of a downloaded raster. Note this has existed since the original beta build of YAAC, but wasn't exposed to plugins until build 215.

Since:

PROVIDER_API_VERSION == 54

See Also:

Constant Field Values

imageList

public java.util.ArrayList<RasterMapEntry> imageList

Collection of raster images to overlay in the containing RasterMapOverlay.

WXRASTER_TIMERTASK

public transient ReschedulableTimerTask WXRASTER_TIMERTASK

ReschedulableTimerTask for reloading updated US NWS weather raster.

Constructor Detail

RasterMapCatalog

public RasterMapCatalog(GeoMapGuiIfc2 geoMap,
                        RasterMapOverlay rasterMapOverlay)

Create a RasterMapCatalog instance for a given GeographicalMap window's RasterMapOverlay.

Parameters:

geoMap - GeoMapGuiIfc2 using this instance of RasterMapCatalog

rasterMapOverlay - RasterMapOverlay using this instance of RasterMapCatalog

Method Detail

findMatchingEntry

public RasterMapEntry findMatchingEntry(java.util.regex.Pattern imagePattern)

Find a RasterMapEntry that matches the specified regular expression.

Parameters:

imagePattern - regular expression Pattern to look for

Returns:

first matching RasterMapEntry, or null if no match

Since:

PROVIDER_API_VERSION == 54

addRasterViewportChangeListener

public static void addRasterViewportChangeListener(RasterViewportChangeListener rvcl)

Register a new RasterViewportChangeListener.

Parameters:

rvcl - RasterViewportChangeListener to register

Since:

PROVIDER_API_VERSION == 54

removeRasterViewportChangeListener

public static void removeRasterViewportChangeListener(RasterViewportChangeListener rvcl)

Unregister a RasterViewportChangeListener.

Parameters:

rvcl - RasterViewportChangeListener to unregister

Since:

PROVIDER_API_VERSION == 54

getReloadTimer

public static ReschedulableTimer getReloadTimer()

Get the raster refresh timer so tasks can be associated with it.

Returns:

ReschedulableTimer used for raster refreshes

Since:

PROVIDER_API_VERSION == 54

getRasterMapOverlay

public RasterMapOverlay getRasterMapOverlay()

Get the RasterMapOverlay this RasterMapCatalog is associated with.

Returns:

RasterMapOverlay rendering the contents of this RasterMapCatalog

Since:

PROVIDER_API_VERSION == 54

readImageFromNetwork

public static long readImageFromNetwork(java.lang.String url,
                                        RasterMapEntry rme)
                                 throws java.net.MalformedURLException,
                                        java.io.IOException

Reads an image specified by an URL string from the network and load it into a RasterMapEntry.

Parameters:

url - String of the image URL

rme - RasterMapEntry into which to load the image

Returns:

a long time in milliseconds since 1 Jan 1970 UTC when the downloaded image will expire and will need to be downloaded again

Throws:

java.net.MalformedURLException - if the URL string has illegal syntax

java.io.IOException - any other reason why the image could not be downloaded

readImageFromUrlConnection

public static long readImageFromUrlConnection(java.net.URLConnection urlConnection,
                                              RasterMapEntry rme,
                                              long now)
                                       throws java.io.IOException,
                                              org.apache.commons.imaging.ImageReadException

Read an image from an opened URLConnection into a RasterMapEntry object.

Parameters:

urlConnection - URLConnection for reading the image

rme - RasterMapEntry to store the image

now - current time in milliseconds since midnight 1 Jan 1970 UTC

Returns:

a long time in milliseconds since 1 Jan 1970 UTC when the downloaded image will expire and will need to be downloaded again

Throws:

java.io.IOException - if the image type is not supported by YAAC or a network I/O error occurs

org.apache.commons.imaging.ImageReadException - if the image byte stream could not be parsed as an image of the type specified by the URLConnection's Content-Type header

loadReloadableWebMap

public static java.util.Date loadReloadableWebMap(RasterMapEntry rme,
                                                  long now)
                                           throws java.io.IOException

Load a fresh gzipped raster GeoTIFF image from a web source.

Parameters:

rme - RasterMapEntry for the web-sourced overlay layer

now - current time in milliseconds since Jan 1970 UTC

Returns:

the Date when the loaded raster image will expire and should be loaded again

Throws:

java.io.IOException - if image file cannot be downloaded

readTiffImage

public static void readTiffImage(RasterMapEntry rme,
                                 long startTime,
                                 java.lang.String preferredFile,
                                 long afterDir,
                                 java.io.InputStream gzis,
                                 java.lang.String preferredFileName)
                          throws org.apache.commons.imaging.ImageReadException,
                                 java.io.IOException

Throws:

org.apache.commons.imaging.ImageReadException

java.io.IOException

add

public int add(RasterMapEntry rme)

Add the specified RasterMapEntry to the persisted list of raster map overlays.

Parameters:

rme - RasterMapEntry to add

Returns:

int index of newly added entry

get

public RasterMapEntry get(int index)
                   throws java.lang.IndexOutOfBoundsException

Get the specified RasterMapEntry in this catalog.

Parameters:

index - zero-based row index into catalog

Returns:

RasterMapEntry at the specified index

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 ot >= getRowCount()

Since:

PROVIDER_API_VERSION == 54

remove

public void remove(int index)

Remove the indexed record from the persisted RasterMapCatalog.

Parameters:

index - zero-based int index of the record to remove

remove

public void remove(RasterMapEntry rme)

Remove the matching record from the persisted RasterMapCatalog.

Parameters:

rme - RasterMapEntry to remove from catalog

Since:

PROVIDER_API_VERSION == 54

getColumnClass

public java.lang.Class<?> getColumnClass(int columnIndex)

Returns the data Class for the specified column.

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class javax.swing.table.AbstractTableModel

Parameters:

columnIndex - the column being queried

Returns:

the Class object for the column's data

getColumnName

public java.lang.String getColumnName(int column)

Returns the localized name for the column.

Specified by:

getColumnName in interface javax.swing.table.TableModel

Overrides:

getColumnName in class javax.swing.table.AbstractTableModel

Parameters:

column - the column being queried

Returns:

a string containing the name of column

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Indicate which columns can be edited.

Specified by:

isCellEditable in interface javax.swing.table.TableModel

Overrides:

isCellEditable in class javax.swing.table.AbstractTableModel

Parameters:

rowIndex - the row being queried

columnIndex - the column being queried

Returns:

false

setValueAt

public void setValueAt(java.lang.Object aValue,
                       int rowIndex,
                       int columnIndex)

Store a new value for an editable table cell.

Specified by:

setValueAt in interface javax.swing.table.TableModel

Overrides:

setValueAt in class javax.swing.table.AbstractTableModel

Parameters:

aValue - value to assign to cell

rowIndex - row of cell

columnIndex - column of cell

getColumnCount

public int getColumnCount()

Returns the number of columns in the model.

Returns:

the number of columns in the model

See Also:

getRowCount()

getRowCount

public int getRowCount()

Returns the number of rows in the model. A JTable uses this method to determine how many rows it should display. This method should be quick, as it is called frequently during rendering.

Returns:

the number of rows in the model

See Also:

getColumnCount()

getValueAt

public java.lang.Object getValueAt(int rowIndex,
                                   int columnIndex)

Returns the value for the cell at columnIndex and rowIndex.

Parameters:

rowIndex - the row whose value is to be queried

columnIndex - the column whose value is to be queried

Returns:

the value Object at the specified cell

deleteRow

public void deleteRow(int rowIndex)

Delete an entire RasterMapEntry from the catalog.

Parameters:

rowIndex - zero-based row index into the catalog table model