ucar.unidata.data.grid

Class GridDataSource

java.lang.Object

ucar.unidata.collab.SharableImpl

ucar.unidata.data.DataSourceImpl

ucar.unidata.data.FilesDataSource

ucar.unidata.data.grid.GridDataSource

All Implemented Interfaces:

Sharable, DataSource, DataSourceFactory, XmlPersistable

Direct Known Subclasses:

GeoGridDataSource, GridCoverageDataSource, Vis5DDataSource

public abstract class GridDataSource
extends FilesDataSource

An abstract class that provides a list of 2d and 3d DataCategory objects for grid data sources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_EAST east attribute
static java.lang.String	ATTR_NORTH North attribute
static java.lang.String	ATTR_SOUTH south attribute
static java.lang.String	ATTR_WEST west attribute
static java.lang.String	ATTR_X x attribute
static java.lang.String	ATTR_Y y attribute
static java.lang.String	ATTR_Z z attribute
static java.lang.String	PROP_ENSEMBLEMEMBERS grid ensemble members

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_TIMESTRIDE, PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
GridDataSource() Default constructor; initializes data categories
GridDataSource(DataSourceDescriptor descriptor) Create a GridDataSource from the descriptor
GridDataSource(DataSourceDescriptor descriptor, java.util.List sources, java.lang.String name, java.util.Hashtable properties) Create a GridDataSource from the specification given.
GridDataSource(DataSourceDescriptor descriptor, java.lang.String source, java.lang.String name, java.util.Hashtable properties) Create a GridDataSource from the specification given.

Method Summary

Modifier and Type	Method and Description
DataCategory	getEnsDCategory() Get the ensemble data categories
java.util.List<java.lang.Integer>	getEnsembleSelection() Get the ensemble selection
java.util.List	getThreeDCategories() Get the 3D data categories
java.util.List	getThreeDEnsTimeSeriesCategories() Get the list of 3D time series ensemble categories
java.util.List	getThreeDTimeSeriesCategories() Get the list of 3D time series categories
java.util.List	getTwoDCategories() Get the 2D data categories
java.util.List	getTwoDEnsTimeSeriesCategories() Get the list of 2D time series ensemble categories
java.util.List	getTwoDTimeSeriesCategories() Get the list of 2D time series categories
void	initCategories() Initialize the data categories
void	setEnsembleSelection(java.util.List<java.lang.Integer> ensMembers) Set the ensemble selection

Methods inherited from class ucar.unidata.data.FilesDataSource

doRemove, equals, getDataFileExtension, getDataPaths, getFilePath, getFullDescription, getInputStreams, getLocationsForPolling, getPartialDescription, getSource, getSources, haveSources, initAfterCreation, initAfterUnpersistence, 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, applyProperties, beginWritingDataToLocalDisk, canAddCurrentName, canCacheDataToDisk, canChangeData, canDoAllLevels, canDoFieldMask, canDoGeoSelection, canDoGeoSelectionMap, canDoGeoSelectionStride, canPoll, canSaveDataToLocalDisk, canShowParameter, checkForInitAfterUnPersistence, clearCachedData, clearFileCache, clearTimes, convertSourceFile, convertToFilesIfDirectory, createAutoDisplay, createCacheKey, createElement, decrOutstandingGetDataCalls, doDirectory, doMakeDataChoices, doMakeDateTimes, 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, 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, getPassword, getPathsThatCanBeRelative, getPollingInfo, getProperties, getPropertiesComponents, 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, 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, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.unidata.data.DataSource

getUniqueId

Field Detail

ATTR_NORTH

public static final java.lang.String ATTR_NORTH

North attribute

See Also:

Constant Field Values

ATTR_SOUTH

public static final java.lang.String ATTR_SOUTH

south attribute

See Also:

Constant Field Values

ATTR_EAST

public static final java.lang.String ATTR_EAST

east attribute

See Also:

Constant Field Values

ATTR_WEST

public static final java.lang.String ATTR_WEST

west attribute

See Also:

Constant Field Values

ATTR_X

public static final java.lang.String ATTR_X

x attribute

See Also:

Constant Field Values

ATTR_Y

public static final java.lang.String ATTR_Y

y attribute

See Also:

Constant Field Values

ATTR_Z

public static final java.lang.String ATTR_Z

z attribute

See Also:

Constant Field Values

PROP_ENSEMBLEMEMBERS

public static final java.lang.String PROP_ENSEMBLEMEMBERS

grid ensemble members

See Also:

Constant Field Values

Constructor Detail

GridDataSource

public GridDataSource()

Default constructor; initializes data categories

GridDataSource

public GridDataSource(DataSourceDescriptor descriptor)

Create a GridDataSource from the descriptor

Parameters:

descriptor - the descriptor

GridDataSource

public GridDataSource(DataSourceDescriptor descriptor,
                      java.lang.String source,
                      java.lang.String name,
                      java.util.Hashtable properties)

Create a GridDataSource from the specification given.

Parameters:

descriptor - data source descriptor

source - of file filename or URL

name - name of this data source

properties - extra initialization properties

GridDataSource

public GridDataSource(DataSourceDescriptor descriptor,
                      java.util.List sources,
                      java.lang.String name,
                      java.util.Hashtable properties)

Create a GridDataSource from the specification given.

Parameters:

descriptor - data source descriptor

sources - List of files or URLS

name - name of this data source

properties - extra initialization properties

Method Detail

initCategories

public void initCategories()

Initialize the data categories

getEnsDCategory

public DataCategory getEnsDCategory()

Get the ensemble data categories

Returns:

list of categories

getTwoDCategories

public java.util.List getTwoDCategories()

Get the 2D data categories

Returns:

list of categories

getThreeDCategories

public java.util.List getThreeDCategories()

Get the 3D data categories

Returns:

list of categories

getTwoDTimeSeriesCategories

public java.util.List getTwoDTimeSeriesCategories()

Get the list of 2D time series categories

Returns:

list of categories

getTwoDEnsTimeSeriesCategories

public java.util.List getTwoDEnsTimeSeriesCategories()

Get the list of 2D time series ensemble categories

Returns:

list of categories

getThreeDTimeSeriesCategories

public java.util.List getThreeDTimeSeriesCategories()

Get the list of 3D time series categories

Returns:

list of categories

getThreeDEnsTimeSeriesCategories

public java.util.List getThreeDEnsTimeSeriesCategories()

Get the list of 3D time series ensemble categories

Returns:

list of categories

setEnsembleSelection

public void setEnsembleSelection(java.util.List<java.lang.Integer> ensMembers)

Set the ensemble selection

Parameters:

ensMembers - the ensemble memeber selection for this datasource

getEnsembleSelection

public java.util.List<java.lang.Integer> getEnsembleSelection()

Get the ensemble selection

Returns:

the ensemble selection for this datasource or null