Package ucar.unidata.data

Class DescriptorDataSource

java.lang.Object

ucar.unidata.collab.SharableImpl

ucar.unidata.data.DataSourceImpl

ucar.unidata.data.DescriptorDataSource

All Implemented Interfaces:

Sharable, DataSource, DataSourceFactory, XmlPersistable

public class DescriptorDataSource
extends DataSourceImpl

This simply holds a list of DerivedDataDescriptors It is used, for example, to represent a collection of end-user defined formulas (i.e., DerivedDataDescriptor)

Version:

$Revision: 1.23 $

Author:

Metapps development team

Field Summary

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	Description
DescriptorDataSource()	Default constructor.
DescriptorDataSource(String name, String description)	Construct a DatasourceDescriptor with the given name and description.
DescriptorDataSource(String name, String description, List descriptors)	Construct a DatasourceDescriptor with the given name and description and populate it with the initial list of descriptors.

Method Summary

Modifier and Type	Method	Description
void	addDescriptor(DerivedDataDescriptor descriptor)	Add a new descriptor to the list.
boolean	contains(DerivedDataDescriptor descriptor)	See if the descriptor is already in the list.
List	getDataChoices()	Get the list of DataChoice-s held by the descriptors of this object.
protected Data	getDataInner(DataChoice dataChoice, DataCategory category, DataSelection dataSelection, Hashtable requestProperties)	Override the superclass method to return null, since this does not have any data.
List	getDescriptors()	Get the descriptors held by this object.
void	removeDescriptor(DerivedDataDescriptor descriptor)	Remove a new descriptor to the list.
void	setDescriptors(List d)	Set the list of descriptors that this object holds.

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, doRemove, endWritingDataToLocalDisk, equals, expandIfNeeded, findDataChoice, findDataChoices, flushCache, getAbsoluteDateTimes, getActions, getAlias, getAllDateTimes, getAllDateTimes, getAllLevels, getAllLevels, getAllTimesForTimeDriver, getCache, getCache, getCacheClearDelay, getCacheDataToDisk, getCompositeDataChoices, getData, getData, getDataCachePath, getDataChangeListeners, getDataContext, getDataInner, getDataIsEditable, getDataPaths, getDataPrefix, getDataSelection, getDataSelectionComponents, getDataSource, getDateTimes, getDateTimeSelection, getDefaultSave, getDescription, getDescriptor, getErrorMessage, getEverChangedName, getExtraGeoSelectionComponent, getExtraTimesComponent, getFileFilterForPolling, getFullDescription, getid, getIdv, getInError, getLocalDirectory, getLocationForPolling, getLocationsForPolling, getMostRecentFiles, getName, getNameForDataSource, getNeedToShowErrorToUser, getNextId, getOutstandingGetDataCalls, getPartialDescription, 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, initAfterCreation, initAfterUnpersistence, initDataChoice, initDataSelectionComponents, initFromXml, isPolling, loadFieldMask, loadFieldMask, loadLatestFile, logException, logException, makeDerivedDataChoices, makeSaveLocalActions, newFileFromPolling, newFilesFromPolling, notifyDataChange, propertiesChanged, putCache, putCache, reloadData, reloadData, reloadProperties, removeCache, removeDataChangeListener, removeDataChoice, removeProperty, replaceDataChoice, resetTmpState, saveDataToLocalDisk, saveDataToLocalDisk, saveDataToLocalDisk, selectTimesFromList, setAlias, setAskToUpdate, setCacheClearDelay, setCacheDataToDisk, setDataEditableStrings, setDataIsEditable, setDataIsRelative, setDataRelativeStrings, setDataSelection, setDateTimeSelection, setDefaultSave, setDescription, setDescriptor, setDirectory, setEverChangedName, setInError, setInError, setInError, setName, setNewFiles, setObjectProperties, setObjectProperty, setPassword, setPollingInfo, setPollLocation, setProperties, setProperty, setProperty, setRelativePaths, setTemplateName, setTmpPaths, setUserName, shouldCache, shouldCache, showPasswordDialog, showPropertiesDialog, showPropertiesDialog, showPropertiesDialog, showWaitDialog, tick, toString, toStringTruncated, updateDetailsText, updateState, 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 Details

DescriptorDataSource

public DescriptorDataSource()

Default constructor.

DescriptorDataSource

public DescriptorDataSource(String name,
 String description)

Construct a DatasourceDescriptor with the given name and description.

Parameters:

name - name of this

description - description of what this is.

DescriptorDataSource

public DescriptorDataSource(String name,
 String description,
 List descriptors)

Construct a DatasourceDescriptor with the given name and description and populate it with the initial list of descriptors.

Parameters:

name - name of this

description - description of what this is.

descriptors - initial list of DerivedDataDescriptors.

Method Details

addDescriptor

public void addDescriptor(DerivedDataDescriptor descriptor)

Add a new descriptor to the list.

Parameters:

descriptor - object to add to the list

removeDescriptor

public void removeDescriptor(DerivedDataDescriptor descriptor)

Remove a new descriptor to the list.

Parameters:

descriptor - object to remove from the list

getDescriptors

public List getDescriptors()

Get the descriptors held by this object.

Returns:

the list of descriptors

setDescriptors

public void setDescriptors(List d)

Set the list of descriptors that this object holds.

Parameters:

d - list of descriptors. No check is made on whether this is a list of descriptors or not.

getDataInner

protected Data getDataInner(DataChoice dataChoice,
 DataCategory category,
 DataSelection dataSelection,
 Hashtable requestProperties)
                     throws VisADException,
RemoteException

Override the superclass method to return null, since this does not have any data.

Overrides:

getDataInner in class DataSourceImpl

Parameters:

dataChoice - The data choice that identifies the requested data.

category - The data category of the request.

dataSelection - Identifies any subsetting of the data.

requestProperties - Hashtable that holds any detailed request properties.

Returns:

null

Throws:

RemoteException - Java RMI problem

VisADException - VisAD problem

getDataChoices

public List getDataChoices()

Get the list of DataChoice-s held by the descriptors of this object.

Specified by:

getDataChoices in interface DataSource

Overrides:

getDataChoices in class DataSourceImpl

Returns:

list of DataChoice-s

contains

public boolean contains(DerivedDataDescriptor descriptor)

See if the descriptor is already in the list.

Parameters:

descriptor - descriptor in question.

Returns:

true if it exists in the list.