ucar.unidata.idv.chooser

Class IdvRadarDatasetCollection

java.lang.Object

ucar.nc2.dt.TypedDatasetImpl

ucar.unidata.data.radar.StationRadarCollectionImpl

ucar.unidata.idv.chooser.IdvRadarDatasetCollection

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ucar.nc2.dt.TypedDataset, StationRadarCollection

public class IdvRadarDatasetCollection
extends StationRadarCollectionImpl

Client side for getting data from the TDS radar server.

Author:

yuan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IdvRadarDatasetCollection.DatasetURIInfo The Class DatasetURIInfo.
class	IdvRadarDatasetCollection.InvDatasetInfo Class to hold an InvDataset and a Date
class	IdvRadarDatasetCollection.TDSRadarDatasetInfo Class to hold some information about TDS Radar Datasets

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.jdom2.Namespace	defNS _more_
protected java.util.HashMap<java.lang.String,ucar.unidata.geoloc.Station>	stationHMap map of station name to station

Fields inherited from class ucar.unidata.data.radar.StationRadarCollectionImpl

absTimesList, relTimesList, stations, timeUnit

Fields inherited from class ucar.nc2.dt.TypedDatasetImpl

boundingBox, dataVariables, desc, endDate, location, netcdfDataset, parseInfo, startDate, title

Method Summary

Modifier and Type	Method and Description
boolean	checkStationProduct(Product product) check the exist of a product in this dataset collection
boolean	checkStationProduct(java.lang.String sName, Product product) check the exist of a product in this dataset collection
static IdvRadarDatasetCollection	factory(thredds.catalog.InvDataset ds, java.lang.String dsc_location, java.lang.StringBuffer errlog) tds radar dataset collection factory.
static IdvRadarDatasetCollection	factory(java.lang.String desc, java.lang.String dsc_location, java.lang.StringBuffer errlog) tds radar dataset collection factory.
java.util.List	getData(java.lang.String sName, DateSelection dateInfo) Getting data for a single radar station, with time range.
java.util.List	getData(java.lang.String sName, DateSelection dateSelect, ucar.nc2.util.CancelTask cancel) Getting data for a single radar station, with time range.
ucar.nc2.dt.DataIterator	getDataIterator(int bufferSize) Getting data Iterator for a single radar station.
java.util.List	getDataURIs(java.lang.String sName, DateSelection dateInfo) Getting data URIs for a single radar station, with time range.
java.util.List<java.net.URI>	getDataURIs(java.lang.String sName, DateSelection dateSelect, ucar.nc2.util.CancelTask cancel) getting data uri list
java.lang.String	getDescription() get dataset collection description
java.lang.String	getLocation() get dataset collection URI
java.net.URI	getQueryRadarStationURI(java.lang.String stnName, java.lang.String productID, java.util.Date start, java.util.Date end) _more_
ucar.nc2.dt.RadialDatasetSweep	getRadarDataset(java.lang.String stnName, java.util.Date absTime) Getting dataset for a single radar station.
ucar.nc2.dt.RadialDatasetSweep	getRadarDataset(java.lang.String stnName, java.lang.String productID, java.util.Date absTime) Getting dataset for a single radar station.
java.net.URI	getRadarDatasetURI(java.lang.String stnName, java.util.Date absTime) Getting URI for a single radar station.
java.net.URI	getRadarDatasetURI(java.lang.String stnName, java.lang.String productID, java.util.Date absTime) _more_
java.util.List	getRadarProducts() get products of dataset collection
ucar.unidata.geoloc.LatLonRect	getRadarsBoundingBox() get bounding box of dataset collection
ucar.unidata.geoloc.Station	getRadarStation(java.lang.String sName) get one radar station.
java.util.List	getRadarStationDatasets(java.lang.String stnName, java.util.Date start, java.util.Date end) Getting data Iterator for a single radar station.
java.util.List<ucar.unidata.geoloc.Station>	getRadarStations() get all radar station.
java.util.List<java.util.Date>	getRadarStationTimes(java.lang.String stnName, java.util.Date start, java.util.Date end) Getting data URI list for a single radar station.
java.util.List<java.util.Date>	getRadarStationTimes(java.lang.String stnName, java.lang.String productID, java.util.Date start, java.util.Date end) Getting data URI list for a single radar station.
java.util.List	getRadarStationURIs(java.lang.String stnName, java.util.Date start, java.util.Date end) Getting data for a single radar station.
java.util.List	getRadarTimeSpan() get start and end time of dataset collection
int	getStationProductCount(java.lang.String sName) get the number of products
java.util.List<ucar.unidata.geoloc.Station>	getStations() get all radar station.
java.util.List<ucar.unidata.geoloc.Station>	getStations(ucar.nc2.util.CancelTask cancel) get all radar station within box.
java.util.List<ucar.unidata.geoloc.Station>	getStations(ucar.unidata.geoloc.LatLonRect boundingBox) get all radar station within box.
java.util.List<ucar.unidata.geoloc.Station>	getStations(ucar.unidata.geoloc.LatLonRect boundingBox, ucar.nc2.util.CancelTask cancel) get all radar station within box.
java.lang.String	getTitle() get title of dataset collection
static void	main(java.lang.String[] args) Test the program.
org.jdom2.Element	readElements(org.jdom2.Element elem, java.lang.String eleName) get named element from parent element
java.util.HashMap	readRadarStations(java.lang.String stsXML_location) retrieve all radar stations in this dataset collection
ucar.unidata.geoloc.LatLonRect	readSelectRegion(org.jdom2.Element elem, org.jdom2.Namespace ns) get region from parent element
java.util.List<java.lang.String>	readSelectTime(org.jdom2.Element elem, org.jdom2.Namespace ns) get start and end elemnt form parent element
java.util.List<Product>	readSelectVariable(org.jdom2.Element elem, org.jdom2.Namespace ns) get variable list from parent element
static long	roundTo(long roundTo, long seconds) Getting data for a single radar station, with time range and interval.
protected void	setBoundingBox() _more_
protected void	setEndDate() _more_
protected void	setStartDate() _more_
protected void	setTimeUnits() _more_

Methods inherited from class ucar.unidata.data.radar.StationRadarCollectionImpl

getBoundingBox, getStation

Methods inherited from class ucar.nc2.dt.TypedDatasetImpl

close, findGlobalAttributeIgnoreCase, getDataVariable, getDataVariables, getDetailInfo, getEndDate, getGlobalAttributes, getLocationURI, getNetcdfFile, getStartDate, removeDataVariable, setDescription, setLocationURI, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

stationHMap

protected java.util.HashMap<java.lang.String,ucar.unidata.geoloc.Station> stationHMap

map of station name to station

defNS

protected static final org.jdom2.Namespace defNS

_more_

Method Detail

factory

public static IdvRadarDatasetCollection factory(thredds.catalog.InvDataset ds,
                                                java.lang.String dsc_location,
                                                java.lang.StringBuffer errlog)
                                         throws java.io.IOException

tds radar dataset collection factory.

Parameters:

ds - the ds

dsc_location - the dsc_location

errlog - the errlog

Returns:

any factory

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

factory

public static IdvRadarDatasetCollection factory(java.lang.String desc,
                                                java.lang.String dsc_location,
                                                java.lang.StringBuffer errlog)
                                         throws java.io.IOException

tds radar dataset collection factory.

Parameters:

desc - the desc

dsc_location - the dsc_location

errlog - the errlog

Returns:

dataset collection

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

readRadarStations

public java.util.HashMap readRadarStations(java.lang.String stsXML_location)
                                    throws java.io.IOException

retrieve all radar stations in this dataset collection

Parameters:

stsXML_location - _more_

Returns:

station hashmap

Throws:

java.io.IOException - _more_

readElements

public org.jdom2.Element readElements(org.jdom2.Element elem,
                                      java.lang.String eleName)

get named element from parent element

Parameters:

elem - _more_

eleName - _more_

Returns:

_more_

readSelectRegion

public ucar.unidata.geoloc.LatLonRect readSelectRegion(org.jdom2.Element elem,
                                                       org.jdom2.Namespace ns)

get region from parent element

Parameters:

elem - _more_

ns - _more_

Returns:

_more_

readSelectTime

public java.util.List<java.lang.String> readSelectTime(org.jdom2.Element elem,
                                                       org.jdom2.Namespace ns)

get start and end elemnt form parent element

Parameters:

elem - _more_

ns - _more_

Returns:

list of times

readSelectVariable

public java.util.List<Product> readSelectVariable(org.jdom2.Element elem,
                                                  org.jdom2.Namespace ns)

get variable list from parent element

Parameters:

elem - _more_

ns - _more_

Returns:

list of varibles

setTimeUnits

protected void setTimeUnits()

_more_

setStartDate

protected void setStartDate()

_more_

Specified by:

setStartDate in class ucar.nc2.dt.TypedDatasetImpl

setEndDate

protected void setEndDate()

_more_

Specified by:

setEndDate in class ucar.nc2.dt.TypedDatasetImpl

setBoundingBox

protected void setBoundingBox()

_more_

Specified by:

setBoundingBox in class ucar.nc2.dt.TypedDatasetImpl

getTitle

public java.lang.String getTitle()

get title of dataset collection

Specified by:

getTitle in interface ucar.nc2.dt.TypedDataset

Overrides:

getTitle in class ucar.nc2.dt.TypedDatasetImpl

Returns:

_more_

getLocation

public java.lang.String getLocation()

get dataset collection URI

Overrides:

getLocation in class ucar.nc2.dt.TypedDatasetImpl

Returns:

_more_

getDescription

public java.lang.String getDescription()

get dataset collection description

Specified by:

getDescription in interface ucar.nc2.dt.TypedDataset

Overrides:

getDescription in class ucar.nc2.dt.TypedDatasetImpl

Returns:

_more_

getRadarsBoundingBox

public ucar.unidata.geoloc.LatLonRect getRadarsBoundingBox()

get bounding box of dataset collection

Returns:

_more_

getRadarTimeSpan

public java.util.List getRadarTimeSpan()

get start and end time of dataset collection

Returns:

_more_

getRadarProducts

public java.util.List getRadarProducts()

get products of dataset collection

Returns:

_more_

checkStationProduct

public boolean checkStationProduct(java.lang.String sName,
                                   Product product)

check the exist of a product in this dataset collection

Specified by:

checkStationProduct in interface StationRadarCollection

Overrides:

checkStationProduct in class StationRadarCollectionImpl

Parameters:

sName - _more_

product - _more_

Returns:

_more_

checkStationProduct

public boolean checkStationProduct(Product product)

check the exist of a product in this dataset collection

Parameters:

product - _more_

Returns:

_more_

getStationProductCount

public int getStationProductCount(java.lang.String sName)

get the number of products

Parameters:

sName - _more_

Returns:

_more_

getStations

public java.util.List<ucar.unidata.geoloc.Station> getStations()
                                                        throws java.io.IOException

get all radar station.

Specified by:

getStations in interface StationRadarCollection

Overrides:

getStations in class StationRadarCollectionImpl

Returns:

List of type Station objects

Throws:

java.io.IOException - java io exception

getRadarStations

public java.util.List<ucar.unidata.geoloc.Station> getRadarStations()

get all radar station.

Returns:

List of type Station objects

getRadarStation

public ucar.unidata.geoloc.Station getRadarStation(java.lang.String sName)

get one radar station.

Parameters:

sName - _more_

Returns:

Station object

getStations

public java.util.List<ucar.unidata.geoloc.Station> getStations(ucar.nc2.util.CancelTask cancel)
                                                        throws java.io.IOException

get all radar station within box.

Overrides:

getStations in class StationRadarCollectionImpl

Parameters:

cancel - cancel task

Returns:

List of type Station objects

Throws:

java.io.IOException - java io exception

getStations

public java.util.List<ucar.unidata.geoloc.Station> getStations(ucar.unidata.geoloc.LatLonRect boundingBox)
                                                        throws java.io.IOException

get all radar station within box.

Overrides:

getStations in class StationRadarCollectionImpl

Parameters:

boundingBox - the bounding box

Returns:

List of type Station objects

Throws:

java.io.IOException - java io exception

getStations

public java.util.List<ucar.unidata.geoloc.Station> getStations(ucar.unidata.geoloc.LatLonRect boundingBox,
                                                               ucar.nc2.util.CancelTask cancel)
                                                        throws java.io.IOException

get all radar station within box.

Specified by:

getStations in interface StationRadarCollection

Overrides:

getStations in class StationRadarCollectionImpl

Parameters:

boundingBox - the bounding box

cancel - the cancel task

Returns:

List Station objects

Throws:

java.io.IOException - java io exception

getRadarDataset

public ucar.nc2.dt.RadialDatasetSweep getRadarDataset(java.lang.String stnName,
                                                      java.util.Date absTime)
                                               throws java.io.IOException

Getting dataset for a single radar station.

Parameters:

stnName - radar station name

absTime - is absolute time

Returns:

RadialDatasetSweep object

Throws:

java.io.IOException - java io exception

getRadarDataset

public ucar.nc2.dt.RadialDatasetSweep getRadarDataset(java.lang.String stnName,
                                                      java.lang.String productID,
                                                      java.util.Date absTime)
                                               throws java.io.IOException

Getting dataset for a single radar station.

Parameters:

stnName - radar station name

productID - _more_

absTime - is absolute time

Returns:

RadialDatasetSweep object

Throws:

java.io.IOException - java io exception

getRadarDatasetURI

public java.net.URI getRadarDatasetURI(java.lang.String stnName,
                                       java.util.Date absTime)
                                throws java.io.IOException

Getting URI for a single radar station.

Parameters:

stnName - radar station name

absTime - is absolute time

Returns:

URI

Throws:

java.io.IOException - java io exception

getQueryRadarStationURI

public java.net.URI getQueryRadarStationURI(java.lang.String stnName,
                                            java.lang.String productID,
                                            java.util.Date start,
                                            java.util.Date end)
                                     throws java.io.IOException

_more_

Parameters:

stnName - _more_

productID - _more_

start - _more_

end - _more_

Returns:

_more_

Throws:

java.io.IOException - _more_

getRadarDatasetURI

public java.net.URI getRadarDatasetURI(java.lang.String stnName,
                                       java.lang.String productID,
                                       java.util.Date absTime)
                                throws java.io.IOException

_more_

Parameters:

stnName - _more_

productID - _more_

absTime - _more_

Returns:

_more_

Throws:

java.io.IOException - _more_

getRadarStationURIs

public java.util.List getRadarStationURIs(java.lang.String stnName,
                                          java.util.Date start,
                                          java.util.Date end)
                                   throws java.io.IOException

Getting data for a single radar station.

Parameters:

stnName - radar station name

start - of the time

end - of the time

Returns:

data URI list

Throws:

java.io.IOException - java io exception

getRadarStationDatasets

public java.util.List getRadarStationDatasets(java.lang.String stnName,
                                              java.util.Date start,
                                              java.util.Date end)
                                       throws java.io.IOException

Getting data Iterator for a single radar station.

Parameters:

stnName - radar station name

start - of the time

end - of the time

Returns:

dataset list

Throws:

java.io.IOException - java io exception

getRadarStationTimes

public java.util.List<java.util.Date> getRadarStationTimes(java.lang.String stnName,
                                                           java.util.Date start,
                                                           java.util.Date end)
                                                    throws java.io.IOException

Getting data URI list for a single radar station.

Parameters:

stnName - radar station name

start - of the time

end - of the time

Returns:

list of URIs

Throws:

java.io.IOException - java io exception

getRadarStationTimes

public java.util.List<java.util.Date> getRadarStationTimes(java.lang.String stnName,
                                                           java.lang.String productID,
                                                           java.util.Date start,
                                                           java.util.Date end)
                                                    throws java.io.IOException

Getting data URI list for a single radar station.

Parameters:

stnName - radar station name

productID - _more_

start - of the time

end - of the time

Returns:

list of URIs

Throws:

java.io.IOException - java io exception

getDataIterator

public ucar.nc2.dt.DataIterator getDataIterator(int bufferSize)
                                         throws java.io.IOException

Getting data Iterator for a single radar station.

Parameters:

bufferSize - the buffer size

Returns:

data iterator

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

getDataURIs

public java.util.List getDataURIs(java.lang.String sName,
                                  DateSelection dateInfo)
                           throws java.io.IOException

Getting data URIs for a single radar station, with time range.

Parameters:

sName - radar station name

dateInfo - the date selection information

Returns:

list of URIs

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

getData

public java.util.List getData(java.lang.String sName,
                              DateSelection dateInfo)
                       throws java.io.IOException

Getting data for a single radar station, with time range.

Parameters:

sName - radar station name

dateInfo - the date time selection information

Returns:

list of radialDatasetSweep

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

getData

public java.util.List getData(java.lang.String sName,
                              DateSelection dateSelect,
                              ucar.nc2.util.CancelTask cancel)
                       throws java.io.IOException

Getting data for a single radar station, with time range.

Parameters:

sName - radar station name

dateSelect - the date time selection information

cancel - the cancel

Returns:

list of radialDatasetSweep

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

getDataURIs

public java.util.List<java.net.URI> getDataURIs(java.lang.String sName,
                                                DateSelection dateSelect,
                                                ucar.nc2.util.CancelTask cancel)
                                         throws java.io.IOException

getting data uri list

Parameters:

sName - station name

dateSelect - the date selection

cancel - the cancel task

Returns:

the list of URIs

Throws:

java.io.IOException - problem reading URIs

roundTo

public static long roundTo(long roundTo,
                           long seconds)

Getting data for a single radar station, with time range and interval.

Parameters:

roundTo - the round to

seconds - to be round to

Returns:

round to second

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Test the program.

Parameters:

args - the args

Throws:

java.io.IOException - Signals that an I/O exception has occurred.