ucar.unidata.data

Class ListDataSource

java.lang.Object

ucar.unidata.collab.SharableImpl

ucar.unidata.data.DataSourceImpl

ucar.unidata.data.ListDataSource

All Implemented Interfaces:

Sharable, DataSource, DataSourceFactory, XmlPersistable

public class ListDataSource
extends DataSourceImpl

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

Version:

$Revision: 1.30 $

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 and Description
ListDataSource() Default bean constructor; does nothing
ListDataSource(java.lang.String name, java.lang.String description) Create a ListDataSource

Method Summary

Modifier and Type	Method and Description
void	addDataChoice(DataChoice choice) Add a DataChoice.
boolean	contains(DataChoice choice) See if this contains the choice in question.
DataChoice	get(int i) Get the DataChoice at index i
java.util.List	getDataChoices() Get the DataChoices.
protected visad.Data	getDataInner(DataChoice dataChoice, DataCategory category, DataSelection dataSelection, java.util.Hashtable requestProperties) This should never get called.
void	removeDataChoice(DataChoice choice) Remove a DataChoice from the list.
void	setDataChoices(java.util.List l) Set the list of DataChoices
int	size() Return the number of choices in this data source

Methods inherited from class ucar.unidata.data.DataSourceImpl

addActions, addDataChangeListener, 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, 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 Detail

ListDataSource

public ListDataSource()

Default bean constructor; does nothing

ListDataSource

public ListDataSource(java.lang.String name,
                      java.lang.String description)

Create a ListDataSource

Parameters:

name - name of this DataSource

description - long name

Method Detail

getDataInner

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

This should never get called. We need to overwrite this to return null.

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:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - VisAD problem

getDataChoices

public java.util.List getDataChoices()

Get the DataChoices.

Specified by:

getDataChoices in interface DataSource

Overrides:

getDataChoices in class DataSourceImpl

Returns:

List of DataChoices.

setDataChoices

public void setDataChoices(java.util.List l)

Set the list of DataChoices

Parameters:

l - list of DataChoices

addDataChoice

public void addDataChoice(DataChoice choice)

Add a DataChoice.

Overrides:

addDataChoice in class DataSourceImpl

Parameters:

choice - choice to add

removeDataChoice

public void removeDataChoice(DataChoice choice)

Remove a DataChoice from the list.

Overrides:

removeDataChoice in class DataSourceImpl

Parameters:

choice - Choice to remove

contains

public boolean contains(DataChoice choice)

See if this contains the choice in question.

Parameters:

choice - choice to look for

Returns:

true if choice is in here

get

public DataChoice get(int i)

Get the DataChoice at index i

Parameters:

i - index

Returns:

the choice at i

size

public int size()

Return the number of choices in this data source

Returns:

number of choices