ucar.unidata.data.gis
Class GeotiffDataSource

java.lang.Object
  extended by ucar.unidata.collab.SharableImpl
      extended by ucar.unidata.data.DataSourceImpl
          extended by ucar.unidata.data.FilesDataSource
              extended by ucar.unidata.data.gis.GeotiffDataSource
All Implemented Interfaces:
Sharable, DataSource, DataSourceFactory, XmlPersistable

public class GeotiffDataSource
extends FilesDataSource

This is an implementation that will read in a generic data file and return a single Data choice that is a VisAD Data object.

Version:
$Revision: 1.14 $
Author:
IDV Development team

Field Summary
 
Fields inherited from class ucar.unidata.data.FilesDataSource
adapters, oldSourceFromBundles, sources
 
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_TITLE
 
Constructor Summary
GeotiffDataSource()
          Parameterless constructor for XML encoding.
GeotiffDataSource(DataSourceDescriptor descriptor, String filename, Hashtable properties)
          Just pass through to the base class the ctor arguments.
 
Method Summary
 boolean applyProperties()
          Apply properties components
 boolean canSaveDataToLocalDisk()
          Is this data source capable of saving its data to local disk
protected  void doMakeDataChoices()
          This method is called at initialization time and should create a set of DirectDataChoice-s and add them into the base class managed list of DataChoice-s with the method addDataChoice.
protected  List doMakeDateTimes()
          You can also override the base class method to return the list of all date/times that this DataSource holds.
protected  Data getDataInner(DataChoice dataChoice, DataCategory category, DataSelection dataSelection, Hashtable requestProperties)
          This method should create and return the visad.Data that is identified by the given DataChoice.
 String getFullDescription()
          _more_
 String getParamName()
          Get the ParamName property.
 void getPropertiesComponents(List comps)
          Add the gui components into the list for the properties dialog
 String getUnit()
          Get the Unit property.
 void initAfterUnpersistence()
          Initialize if being unpersisted.
 void setParamName(String value)
          Set the ParamName property.
 void setUnit(String value)
          Set the Unit property.
 
Methods inherited from class ucar.unidata.data.FilesDataSource
doRemove, equals, getDataFileExtension, getDataPaths, getFilePath, getInputStreams, getLocationsForPolling, getPartialDescription, getSource, getSources, haveSources, initAfterCreation, initWithPollingInfo, isFileBased, newFilesFromPolling, processDataFilename, propertiesChanged, reloadData, reloadData, saveDataToLocalDisk, setNewFiles, setSource, setSources, sourcesChanged, updateState
 
Methods inherited from class ucar.unidata.data.DataSourceImpl
addActions, addDataChangeListener, addDataChoice, addPropertiesTabs, addReloadTab, applyFieldMask, beginWritingDataToLocalDisk, canAddCurrentName, canCacheDataToDisk, canChangeData, 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, getAllDateTimes, getAllLevels, getAllLevels, getAllTimesForTimeDriver, getCache, getCache, getCacheClearDelay, getCacheDataToDisk, getCompositeDataChoices, getData, getData, getDataCachePath, getDataChangeListeners, getDataChoices, getDataContext, getDataInner, getDataIsEditable, getDataPrefix, getDataSelection, getDataSelectionComponents, getDataSource, getDateTimes, getDateTimeSelection, getDescription, getDescriptor, getErrorMessage, getEverChangedName, getExtraGeoSelectionComponent, getExtraTimesComponent, getFileFilterForPolling, getid, getIdv, getInError, getLocalDirectory, getLocationForPolling, getMostRecentFiles, getName, getNameForDataSource, getNeedToShowErrorToUser, getNextId, getOutstandingGetDataCalls, getPassword, getPathsThatCanBeRelative, getPollingInfo, getProperties, getPropertiesHeader, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getRelativePaths, getSampleDataProjection, getSaveDataFileLabel, getSelectedDateTimes, getSelectedDateTimes, getTimesFromDataSelection, getTmpPaths, getTypeName, getUserName, handlePropertiesAction, hasPollingInfo, holdsDateTimes, holdsIndices, identifiedBy, identifiedByName, incrOutstandingGetDataCalls, initAfter, initDataChoice, initDataSelectionComponents, initFromXml, isPolling, loadFieldMask, loadFieldMask, loadLatestFile, logException, logException, makeDerivedDataChoices, makeSaveLocalActions, newFileFromPolling, notifyDataChange, putCache, putCache, reloadProperties, removeCache, removeDataChangeListener, removeDataChoice, removeProperty, replaceDataChoice, resetTmpState, saveDataToLocalDisk, saveDataToLocalDisk, selectTimesFromList, setAlias, setAskToUpdate, setCacheClearDelay, setCacheDataToDisk, setDataEditableStrings, setDataIsEditable, setDataIsRelative, setDataRelativeStrings, setDataSelection, setDateTimeSelection, 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, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ucar.unidata.data.DataSource
getUniqueId
 

Constructor Detail

GeotiffDataSource

public GeotiffDataSource()
Parameterless constructor for XML encoding.


GeotiffDataSource

public GeotiffDataSource(DataSourceDescriptor descriptor,
                         String filename,
                         Hashtable properties)
                  throws VisADException
Just pass through to the base class the ctor arguments.

Parameters:
descriptor - Describes this data source, has a label etc.
filename - This is the filename (or url) that points to the actual data source.
properties - General properties used in the base class
Throws:
VisADException
Method Detail

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

initAfterUnpersistence

public void initAfterUnpersistence()
Initialize if being unpersisted.

Specified by:
initAfterUnpersistence in interface DataSource
Overrides:
initAfterUnpersistence in class FilesDataSource

applyProperties

public boolean applyProperties()
Description copied from class: DataSourceImpl
Apply properties components

Overrides:
applyProperties in class DataSourceImpl
Returns:
false if something failed and we need to keep showing the dialog

getPropertiesComponents

public void getPropertiesComponents(List comps)
Description copied from class: DataSourceImpl
Add the gui components into the list for the properties dialog

Overrides:
getPropertiesComponents in class DataSourceImpl
Parameters:
comps - List of components

doMakeDataChoices

protected void doMakeDataChoices()
This method is called at initialization time and should create a set of DirectDataChoice-s and add them into the base class managed list of DataChoice-s with the method addDataChoice.

Overrides:
doMakeDataChoices in class DataSourceImpl

getFullDescription

public String getFullDescription()
_more_

Specified by:
getFullDescription in interface DataSource
Overrides:
getFullDescription in class FilesDataSource
Returns:
_more_

getDataInner

protected Data getDataInner(DataChoice dataChoice,
                            DataCategory category,
                            DataSelection dataSelection,
                            Hashtable requestProperties)
                     throws VisADException,
                            RemoteException
This method should create and return the visad.Data that is identified by the given DataChoice.

Overrides:
getDataInner in class DataSourceImpl
Parameters:
dataChoice - This is one of the DataChoice-s that was created in the doMakeDataChoices call above.
category - The specific DataCategory which the DisplayControl was instantiated with. Usually can be ignored.
dataSelection - This may contain a list of times which subsets the request.
requestProperties - extra request properties
Returns:
The Data object represented by the given dataChoice
Throws:
RemoteException
VisADException

doMakeDateTimes

protected List doMakeDateTimes()
You can also override the base class method to return the list of all date/times that this DataSource holds.

Overrides:
doMakeDateTimes in class DataSourceImpl
Returns:
This should be an List of DateTime objects.

setParamName

public void setParamName(String value)
Set the ParamName property.

Parameters:
value - The new value for ParamName

getParamName

public String getParamName()
Get the ParamName property.

Returns:
The ParamName

setUnit

public void setUnit(String value)
Set the Unit property.

Parameters:
value - The new value for Unit

getUnit

public String getUnit()
Get the Unit property.

Returns:
The Unit