ucar.unidata.data.imagery

Class ImageDataSource

java.lang.Object

ucar.unidata.collab.SharableImpl

ucar.unidata.data.DataSourceImpl

ucar.unidata.data.imagery.ImageDataSource

All Implemented Interfaces:

Sharable, DataSource, DataSourceFactory, XmlPersistable

Direct Known Subclasses:

AddeImageDataSource, McIDASImageDataSource

public abstract class ImageDataSource
extends DataSourceImpl

Abstract DataSource class for images files.

Author:

IDV development team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageDataSource.ImageDataInfo Class ImageDataInfo Holds an index and an AddeImageDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List	imageList list of images
protected java.util.List	imageTimes list of image times
static java.lang.String	PROP_BANDINFO satellite type
static java.lang.String	PROP_IMAGETYPE Type of image, radar or satellite.
static java.lang.String	TYPE_RADAR radar type
static java.lang.String	TYPE_SATELLITE satellite type

Fields inherited from class ucar.unidata.data.DataSourceImpl

changeDataPathsCbx, dataCacheKey, dataChoices, geoSelectionPanel, haveBeenUnPersisted, okToContinue, PARAM_SHOW_HIDE, PARAM_SHOW_NO, PARAM_SHOW_YES

Fields inherited from interface ucar.unidata.data.DataSource

DATAPATH_DATE_FORMAT, DATAPATH_DATE_PATTERN, MOST_RECENT, ordinalNames, PROP_AUTOCREATEDISPLAY, PROP_BASEDIRECTORY, PROP_CACHEABLE, PROP_DATACHOICENAME, PROP_DISPLAYPROPERTIES, PROP_DOCUMENTLINKS, PROP_FILEPATTERN, PROP_GEOLOCATION, PROP_ICON, PROP_NAME, PROP_POLLINFO, PROP_RESOLVERURL, PROP_SERVICE_HTTP, PROP_SUBPROPERTIES, PROP_TIMELABELS, PROP_TIMESTRIDE, PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
ImageDataSource() The parameterless constructor for unpersisting.
ImageDataSource(DataSourceDescriptor descriptor, ImageDataset ids, java.util.Hashtable properties) Create a new ImageDataSource with the given ImageDataset.
ImageDataSource(DataSourceDescriptor descriptor, java.util.List images, java.util.Hashtable properties) Create a new ImageDataSource with a list of (String) images.
ImageDataSource(DataSourceDescriptor descriptor, java.lang.String[] images, java.util.Hashtable properties) Create a new ImageDataSource with a list of (String) images.

Method Summary

Modifier and Type	Method and Description
boolean	canCacheDataToDisk() Can this data source cache its
boolean	canSaveDataToLocalDisk() Is this data source capable of saving its data to local disk
void	doMakeDataChoices() Create the set of DataChoice that represent the data held by this data source.
java.util.List	doMakeDateTimes() Override the base class method to return the list of times we created.
void	doRemove() Called when Datasource is removed.
boolean	equals(java.lang.Object o) Check to see if this ImageDataSource is equal to the object in question.
java.util.List	getAllDateTimes(DataChoice dataChoice) Override the base class method for the non composite choices.
java.util.List	getBandCategories() Return the list of DataCategory used for single time step data with band information.
java.util.List	getBandTimeSeriesCategories() Return the list of DataCategory used for multiple time step data with band information.
boolean	getCacheDataToDisk() Get whether we should cache to disk
java.util.List	getCompositeDataChoices(CompositeDataChoice compositeDataChoice, java.util.List dataChoices) This is used when we are unbundled and we may have different times than when we were saved.
protected visad.Data	getDataInner(DataChoice dataChoice, DataCategory category, DataSelection dataSelection, java.util.Hashtable requestProperties) Create the actual data represented by the given DataChoice.
java.lang.String	getDataName() Get the name for the main data object
java.util.List	getDataPaths() Get the paths for saving data files
AddeImageDescriptor	getDescriptor(java.lang.Object object) A utility method that helps us deal with legacy bundles that used to have String file names as the id of a data choice.
protected java.util.List	getDescriptors(DataChoice dataChoice, DataSelection subset) Get a list of descriptors from the choice and subset
java.util.List	getDescriptorsToUse() Return the list of AddeImageDescriptors that define this data source.
java.lang.String	getFullDescription() Get an expanded description for the details display.
abstract java.lang.String	getImageDataSourceName() A hook for the derived classes to return their specific name (eg, ADDE data source, McIDAS data source.
java.util.List	getImageList() Return the list of AddeImageDescriptors that define this data source.
protected java.util.List	getLocationsForPolling() Get the location where we poll.
java.util.List	getSelectedDateTimes(DataChoice dataChoice) Override the base class method for the non-composite choices.
java.util.List	getTwoDCategories() Return the list of DataCategory used for single time step data.
java.util.List	getTwoDTimeSeriesCategories() Return the list of DataCategory used for multiple time step data.
int	hashCode() Override the hashCode method.
void	initAfterUnpersistence() Override the init method for when this data source is unpersisted.
protected boolean	initDataFromPollingInfo() Method for intializing the data.
protected boolean	isFileBased() Are we getting images from a file or from adde
protected visad.meteorology.SingleBandedImage	makeImage(AddeImageDescriptor aid, visad.MathType rangeType, boolean fromSequence, java.lang.String readLabel) Create the single image defined by the given dataChoice.
protected visad.meteorology.SingleBandedImage	makeImage(DataChoice dataChoice, DataSelection subset) Create the single image defined by the given dataChoice.
static ImageDataset	makeImageDataset(java.lang.String[] addeURLs) Make an ImageDataset from an array of ADDE URLs or AREA file names
static java.util.List	makeImageDescriptors(java.lang.String[] addeURLs) Make a list of image descriptors
protected visad.meteorology.ImageSequence	makeImageSequence(DataChoice dataChoice, DataSelection subset) Create the image sequence defined by the given dataChoice.
void	newFileFromPolling(java.io.File file) If we are polling some directory this method gets called when there is a new file.
protected void	propertiesChanged() The user changed the properties.
void	reloadData() Reload the data
void	reloadData(java.lang.Object object, java.util.Hashtable properties) Reload data
protected java.util.List	saveDataToLocalDisk(java.lang.String prefix, java.lang.Object loadId, boolean changeLinks) Save files to local disk
void	setImageList(java.util.List l) Set the list of AddeImageDescriptors that define this data source.
void	setNewFiles(java.util.List files) Handle when this data source gets new files to use at runtime (e.g., from isl)
void	updateState(java.lang.Object newObject, java.util.Hashtable newProperties) Update the state

Methods inherited from class ucar.unidata.data.DataSourceImpl

addActions, addDataChangeListener, addDataChoice, addPropertiesTabs, addReloadTab, applyFieldMask, applyProperties, beginWritingDataToLocalDisk, canAddCurrentName, canChangeData, canDoAllLevels, canDoFieldMask, canDoGeoSelection, canDoGeoSelectionMap, canDoGeoSelectionStride, canPoll, canShowParameter, checkForInitAfterUnPersistence, clearCachedData, clearFileCache, clearTimes, convertSourceFile, convertToFilesIfDirectory, createAutoDisplay, createCacheKey, createElement, decrOutstandingGetDataCalls, doDirectory, doMakeGeoSelectionPanel, doMakeGeoSelectionPanel, doMakeGeoSelectionPanel, doMakeGeoSubsetPropertiesComponent, endWritingDataToLocalDisk, expandIfNeeded, findDataChoice, findDataChoices, flushCache, getAbsoluteDateTimes, getActions, getAlias, getAllDateTimes, getAllLevels, getAllLevels, getAllTimesForTimeDriver, getCache, getCache, getCacheClearDelay, getData, getData, getDataCachePath, getDataChangeListeners, getDataChoices, getDataContext, getDataInner, getDataIsEditable, getDataPrefix, getDataSelection, getDataSelectionComponents, getDataSource, getDateTimes, getDateTimeSelection, getDefaultSave, getDescription, getDescriptor, getErrorMessage, getEverChangedName, getExtraGeoSelectionComponent, getExtraTimesComponent, getFileFilterForPolling, getid, getIdv, getInError, getLocalDirectory, getLocationForPolling, getMostRecentFiles, getName, getNameForDataSource, getNeedToShowErrorToUser, getNextId, getOutstandingGetDataCalls, getPartialDescription, getPassword, getPathsThatCanBeRelative, getPollingInfo, getProperties, getPropertiesComponents, getPropertiesHeader, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getRelativePaths, getSampleDataProjection, getSaveDataFileLabel, getSelectedDateTimes, getTimesFromDataSelection, getTmpPaths, getTypeName, getUserName, handlePropertiesAction, hasPollingInfo, holdsDateTimes, holdsIndices, identifiedBy, identifiedByName, incrOutstandingGetDataCalls, initAfter, initAfterCreation, initDataChoice, initDataSelectionComponents, initFromXml, isPolling, loadFieldMask, loadFieldMask, loadLatestFile, logException, logException, makeDerivedDataChoices, makeSaveLocalActions, newFilesFromPolling, notifyDataChange, putCache, putCache, reloadProperties, removeCache, removeDataChangeListener, removeDataChoice, removeProperty, replaceDataChoice, resetTmpState, saveDataToLocalDisk, saveDataToLocalDisk, selectTimesFromList, setAlias, setAskToUpdate, setCacheClearDelay, setCacheDataToDisk, setDataEditableStrings, setDataIsEditable, setDataIsRelative, setDataRelativeStrings, setDataSelection, setDateTimeSelection, setDefaultSave, setDescription, setDescriptor, setDirectory, setEverChangedName, setInError, setInError, setInError, setName, setObjectProperties, setObjectProperty, setPassword, setPollingInfo, setPollLocation, setProperties, setProperty, setProperty, setRelativePaths, setTemplateName, setTmpPaths, setUserName, shouldCache, shouldCache, showPasswordDialog, showPropertiesDialog, showPropertiesDialog, showPropertiesDialog, showWaitDialog, tick, toString, toStringTruncated, updateDetailsText, writeFieldMaskFile, writeFieldMaskFile

Methods inherited from class ucar.unidata.collab.SharableImpl

applySharableProperties, doShare, doShare, doShareExternal, doShareInternal, getReceiveShareTime, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, receiveShareData, removeSharable, setReceiveShareTime, setShareGroup, setSharing, setUniqueId, showSharableDialog

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.unidata.data.DataSource

getUniqueId

Field Detail

PROP_IMAGETYPE

public static final java.lang.String PROP_IMAGETYPE

Type of image, radar or satellite. Set by the chooser to disambiguate between types

See Also:

Constant Field Values

TYPE_RADAR

public static final java.lang.String TYPE_RADAR

radar type

See Also:

Constant Field Values

TYPE_SATELLITE

public static final java.lang.String TYPE_SATELLITE

satellite type

See Also:

Constant Field Values

PROP_BANDINFO

public static final java.lang.String PROP_BANDINFO

satellite type

See Also:

Constant Field Values

imageList

protected java.util.List imageList

list of images

imageTimes

protected java.util.List imageTimes

list of image times

Constructor Detail

ImageDataSource

public ImageDataSource()

The parameterless constructor for unpersisting.

ImageDataSource

public ImageDataSource(DataSourceDescriptor descriptor,
                       java.lang.String[] images,
                       java.util.Hashtable properties)

Create a new ImageDataSource with a list of (String) images. These can either be AREA files or ADDE URLs.

Parameters:

descriptor - The descriptor for this data source.

images - Array of file anmes or urls.

properties - The properties for this data source.

ImageDataSource

public ImageDataSource(DataSourceDescriptor descriptor,
                       java.util.List images,
                       java.util.Hashtable properties)

Create a new ImageDataSource with a list of (String) images. These can either be AREA files or ADDE URLs.

Parameters:

descriptor - The descriptor for this data source.

images - Array of file anmes or urls.

properties - The properties for this data source.

ImageDataSource

public ImageDataSource(DataSourceDescriptor descriptor,
                       ImageDataset ids,
                       java.util.Hashtable properties)

Create a new ImageDataSource with the given ImageDataset. The dataset may hold eight AREA file filepaths or ADDE URLs.

Parameters:

descriptor - The descriptor for this data source.

ids - The dataset.

properties - The properties for this data source.

Method Detail

reloadData

public void reloadData(java.lang.Object object,
                       java.util.Hashtable properties)

Reload data

Specified by:

reloadData in interface DataSource

Overrides:

reloadData in class DataSourceImpl

Parameters:

object - the object to reload

properties - the properties

setNewFiles

public void setNewFiles(java.util.List files)

Handle when this data source gets new files to use at runtime (e.g., from isl)

Specified by:

setNewFiles in interface DataSource

Overrides:

setNewFiles in class DataSourceImpl

Parameters:

files - List of files

updateState

public void updateState(java.lang.Object newObject,
                        java.util.Hashtable newProperties)

Update the state

Specified by:

updateState in interface DataSource

Overrides:

updateState in class DataSourceImpl

Parameters:

newObject - the new object

newProperties - the new properties

getDataPaths

public java.util.List getDataPaths()

Get the paths for saving data files

Specified by:

getDataPaths in interface DataSource

Overrides:

getDataPaths in class DataSourceImpl

Returns:

data paths

initAfterUnpersistence

public void initAfterUnpersistence()

Override the init method for when this data source is unpersisted. We simply check the imageList to see if this object came from a legacy bundle.

Specified by:

initAfterUnpersistence in interface DataSource

Overrides:

initAfterUnpersistence in class DataSourceImpl

canCacheDataToDisk

public boolean canCacheDataToDisk()

Can this data source cache its

Overrides:

canCacheDataToDisk in class DataSourceImpl

Returns:

can cache data to disk

canSaveDataToLocalDisk

public boolean canSaveDataToLocalDisk()

Is this data source capable of saving its data to local disk

Specified by:

canSaveDataToLocalDisk in interface DataSource

Overrides:

canSaveDataToLocalDisk in class DataSourceImpl

Returns:

Can save to local disk

saveDataToLocalDisk

protected java.util.List saveDataToLocalDisk(java.lang.String prefix,
                                             java.lang.Object loadId,
                                             boolean changeLinks)
                                      throws java.lang.Exception

Save files to local disk

Overrides:

saveDataToLocalDisk in class DataSourceImpl

Parameters:

prefix - destination dir and file prefix

loadId - For JobManager

changeLinks - Change internal file references

Returns:

Files copied

Throws:

java.lang.Exception - On badness

initDataFromPollingInfo

protected boolean initDataFromPollingInfo()

Method for intializing the data.

Returns:

result

propertiesChanged

protected void propertiesChanged()

The user changed the properties. Update me.

Overrides:

propertiesChanged in class DataSourceImpl

makeImageDataset

public static ImageDataset makeImageDataset(java.lang.String[] addeURLs)

Make an ImageDataset from an array of ADDE URLs or AREA file names

Parameters:

addeURLs - array of ADDE URLs

Returns:

ImageDataset

makeImageDescriptors

public static java.util.List makeImageDescriptors(java.lang.String[] addeURLs)

Make a list of image descriptors

Parameters:

addeURLs - array of ADDE URLs

Returns:

ImageDataset

getLocationsForPolling

protected java.util.List getLocationsForPolling()

Get the location where we poll.

Overrides:

getLocationsForPolling in class DataSourceImpl

Returns:

Directory to poll on.

isFileBased

protected boolean isFileBased()

Are we getting images from a file or from adde

Returns:

is the data from files

getDescriptor

public AddeImageDescriptor getDescriptor(java.lang.Object object)

A utility method that helps us deal with legacy bundles that used to have String file names as the id of a data choice.

Parameters:

object - May be an AddeImageDescriptor (for new bundles) or a String that is converted to an image descriptor.

Returns:

The image descriptor.

getCompositeDataChoices

public java.util.List getCompositeDataChoices(CompositeDataChoice compositeDataChoice,
                                              java.util.List dataChoices)

This is used when we are unbundled and we may have different times than when we were saved. Use the current set of data choices.

Specified by:

getCompositeDataChoices in interface DataSource

Overrides:

getCompositeDataChoices in class DataSourceImpl

Parameters:

compositeDataChoice - The composite

dataChoices - Its choices

Returns:

The current choices

getImageDataSourceName

public abstract java.lang.String getImageDataSourceName()

A hook for the derived classes to return their specific name (eg, ADDE data source, McIDAS data source.

Returns:

The name of this data source.

getImageList

public java.util.List getImageList()

Return the list of AddeImageDescriptors that define this data source.

Returns:

The list of image descriptors.

getDescriptorsToUse

public java.util.List getDescriptorsToUse()

Return the list of AddeImageDescriptors that define this data source.

Returns:

The list of image descriptors.

setImageList

public void setImageList(java.util.List l)

Set the list of AddeImageDescriptors that define this data source.

Parameters:

l - The list of image descriptors.

doMakeDateTimes

public java.util.List doMakeDateTimes()

Override the base class method to return the list of times we created.

Overrides:

doMakeDateTimes in class DataSourceImpl

Returns:

The list of times held by this data source.

getTwoDCategories

public java.util.List getTwoDCategories()

Return the list of DataCategory used for single time step data.

Returns:

A list of categories.

getTwoDTimeSeriesCategories

public java.util.List getTwoDTimeSeriesCategories()

Return the list of DataCategory used for multiple time step data.

Returns:

A list of categories.

getBandCategories

public java.util.List getBandCategories()

Return the list of DataCategory used for single time step data with band information.

Returns:

A list of categories.

getBandTimeSeriesCategories

public java.util.List getBandTimeSeriesCategories()

Return the list of DataCategory used for multiple time step data with band information.

Returns:

A list of categories.

doMakeDataChoices

public void doMakeDataChoices()

Create the set of DataChoice that represent the data held by this data source. We create one top-level CompositeDataChoice that represents all of the image time steps. We create a set of children DirectDataChoice, one for each time step.

Overrides:

doMakeDataChoices in class DataSourceImpl

getDataInner

protected visad.Data getDataInner(DataChoice dataChoice,
                                  DataCategory category,
                                  DataSelection dataSelection,
                                  java.util.Hashtable requestProperties)
                           throws visad.VisADException,
                                  java.rmi.RemoteException

Create the actual data represented by the given DataChoice.

Overrides:

getDataInner in class DataSourceImpl

Parameters:

dataChoice - Either the CompositeDataChoice representing all time steps or a DirectDataChoice representing a single time step.

category - Not really used.

dataSelection - Defines any time subsets.

requestProperties - extra request properties

Returns:

The image or image sequence data.

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - VisAD problem

getAllDateTimes

public java.util.List getAllDateTimes(DataChoice dataChoice)

Override the base class method for the non composite choices.

Specified by:

getAllDateTimes in interface DataSource

Overrides:

getAllDateTimes in class DataSourceImpl

Parameters:

dataChoice - Either the CompositeDataChoice representing all time steps or a DirectDataChoice representing a single time step.

Returns:

The list of times represented by the given dataChoice.

getSelectedDateTimes

public java.util.List getSelectedDateTimes(DataChoice dataChoice)

Override the base class method for the non-composite choices.

Specified by:

getSelectedDateTimes in interface DataSource

Overrides:

getSelectedDateTimes in class DataSourceImpl

Parameters:

dataChoice - Either the CompositeDataChoice representing all time steps or a DirectDataChoice representing a single time step.

Returns:

The list of times represented by the given dataChoice.

makeImage

protected final visad.meteorology.SingleBandedImage makeImage(DataChoice dataChoice,
                                                              DataSelection subset)
                                                       throws visad.VisADException,
                                                              java.rmi.RemoteException

Create the single image defined by the given dataChoice.

Parameters:

dataChoice - The choice.

subset - any time subsets.

Returns:

The data.

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - VisAD problem

makeImage

protected visad.meteorology.SingleBandedImage makeImage(AddeImageDescriptor aid,
                                                        visad.MathType rangeType,
                                                        boolean fromSequence,
                                                        java.lang.String readLabel)
                                                 throws visad.VisADException,
                                                        java.rmi.RemoteException

Create the single image defined by the given dataChoice.

Parameters:

aid - AddeImageDescriptor

rangeType - This is the sample rangeType. For the first image this is null and this method will immediately read the data

fromSequence - from a sequence

readLabel - the label

Returns:

The data.

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - VisAD problem

reloadData

public void reloadData()

Reload the data

Specified by:

reloadData in interface DataSource

Overrides:

reloadData in class DataSourceImpl

getCacheDataToDisk

public boolean getCacheDataToDisk()

Get whether we should cache to disk

Overrides:

getCacheDataToDisk in class DataSourceImpl

Returns:

true

makeImageSequence

protected visad.meteorology.ImageSequence makeImageSequence(DataChoice dataChoice,
                                                            DataSelection subset)
                                                     throws visad.VisADException,
                                                            java.rmi.RemoteException

Create the image sequence defined by the given dataChoice.

Parameters:

dataChoice - The choice.

subset - any time subsets.

Returns:

The image sequence.

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - VisAD problem

getDescriptors

protected java.util.List getDescriptors(DataChoice dataChoice,
                                        DataSelection subset)

Get a list of descriptors from the choice and subset

Parameters:

dataChoice - Data choice

subset - subsetting info

Returns:

list of descriptors matching the selection

equals

public boolean equals(java.lang.Object o)

Check to see if this ImageDataSource is equal to the object in question.

Overrides:

equals in class DataSourceImpl

Parameters:

o - object in question

Returns:

true if they are the same or equivalent objects

hashCode

public int hashCode()

Override the hashCode method. Use name and imageList.

Overrides:

hashCode in class java.lang.Object

Returns:

The hashcode.

getDataName

public java.lang.String getDataName()

Get the name for the main data object

Returns:

name of main data object

getFullDescription

public java.lang.String getFullDescription()

Get an expanded description for the details display. Override base class implementation to add more info.

Specified by:

getFullDescription in interface DataSource

Overrides:

getFullDescription in class DataSourceImpl

Returns:

full description of this data source

newFileFromPolling

public void newFileFromPolling(java.io.File file)

If we are polling some directory this method gets called when there is a new file. We set the file name, clear our state, reload the metadata and tell listeners of the change.

Overrides:

newFileFromPolling in class DataSourceImpl

Parameters:

file - new File to use.

doRemove

public void doRemove()

Called when Datasource is removed.

Specified by:

doRemove in interface DataSource

Overrides:

doRemove in class DataSourceImpl