ucar.unidata.data.gis

Class WmsDataSource

java.lang.Object

ucar.unidata.collab.SharableImpl

ucar.unidata.data.DataSourceImpl

ucar.unidata.data.gis.WmsDataSource

All Implemented Interfaces:

Sharable, DataSource, DataSourceFactory, XmlPersistable

public class WmsDataSource
extends DataSourceImpl

DataSource for Web Map Servers

Version:

$Revision: 1.33 $ $Date: 2007/05/04 22:23:20 $

Author:

IDV development team

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_BOUNDS request property
static java.lang.String	PROP_ICONPATH request property
static java.lang.String	PROP_IMAGEHEIGHT request property
static java.lang.String	PROP_IMAGEWIDTH request property
static java.lang.String	PROP_LAYER request property
static java.lang.String	PROP_LAYERS request property
static java.lang.String	PROP_RESOLUTION request property
static java.lang.String	PROP_WRITEFILE request property

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
WmsDataSource() Dummy constructor so this object can get unpersisted.
WmsDataSource(DataSourceDescriptor descriptor, java.util.List selections, java.util.Hashtable properties) Create a WmsDataSource from the specification given.
WmsDataSource(DataSourceDescriptor descriptor, java.lang.String filename, java.util.Hashtable properties)

Method Summary

Modifier and Type	Method and Description
boolean	applyProperties() _more_
protected void	doMakeDataChoices() Create the data choices associated with this source.
protected java.util.List	doMakeDateTimes() Create a list of times for this data source.
boolean	equals(java.lang.Object o) overwrite
protected visad.Data	getDataInner(DataChoice dataChoice, DataCategory category, DataSelection dataSelection, java.util.Hashtable requestProperties) Actually get the data identified by the given DataChoce.
java.lang.String	getFullDescription() Get the description.
java.util.List	getLayerList() _more_
boolean	getMaintainRatio() Get the MaintainRatio property.
void	getPropertiesComponents(java.util.List comps) _more_
java.util.List	getWmsSelections() Get the WmsSelections property.
void	initAfterUnpersistence() Initialize after we have been unpersisted
void	setMaintainRatio(boolean value) Set the MaintainRatio property.
void	setWmsSelections(java.util.List value) Set the WmsSelections property.
protected boolean	shouldCache(visad.Data data) See if this DataSource should cache or not

Methods inherited from class ucar.unidata.data.DataSourceImpl

addActions, addDataChangeListener, addDataChoice, addPropertiesTabs, addReloadTab, applyFieldMask, beginWritingDataToLocalDisk, canAddCurrentName, canCacheDataToDisk, canChangeData, canDoAllLevels, canDoFieldMask, canDoGeoSelection, canDoGeoSelectionMap, canDoGeoSelectionStride, canPoll, canSaveDataToLocalDisk, canShowParameter, checkForInitAfterUnPersistence, clearCachedData, clearFileCache, clearTimes, convertSourceFile, convertToFilesIfDirectory, createAutoDisplay, createCacheKey, createElement, decrOutstandingGetDataCalls, doDirectory, doMakeGeoSelectionPanel, doMakeGeoSelectionPanel, doMakeGeoSelectionPanel, doMakeGeoSubsetPropertiesComponent, doRemove, 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, getDataPaths, getDataPrefix, getDataSelection, getDataSelectionComponents, getDataSource, getDateTimes, getDateTimeSelection, getDefaultSave, getDescription, getDescriptor, getErrorMessage, getEverChangedName, getExtraGeoSelectionComponent, getExtraTimesComponent, getFileFilterForPolling, getid, getIdv, getInError, getLocalDirectory, getLocationForPolling, getLocationsForPolling, getMostRecentFiles, getName, getNameForDataSource, getNeedToShowErrorToUser, getNextId, getOutstandingGetDataCalls, getPartialDescription, 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, initAfterCreation, 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, 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

Field Detail

PROP_BOUNDS

public static final java.lang.String PROP_BOUNDS

request property

See Also:

Constant Field Values

PROP_ICONPATH

public static final java.lang.String PROP_ICONPATH

request property

See Also:

Constant Field Values

PROP_WRITEFILE

public static final java.lang.String PROP_WRITEFILE

request property

See Also:

Constant Field Values

PROP_RESOLUTION

public static final java.lang.String PROP_RESOLUTION

request property

See Also:

Constant Field Values

PROP_IMAGEWIDTH

public static final java.lang.String PROP_IMAGEWIDTH

request property

See Also:

Constant Field Values

PROP_IMAGEHEIGHT

public static final java.lang.String PROP_IMAGEHEIGHT

request property

See Also:

Constant Field Values

PROP_LAYER

public static final java.lang.String PROP_LAYER

request property

See Also:

Constant Field Values

PROP_LAYERS

public static final java.lang.String PROP_LAYERS

request property

See Also:

Constant Field Values

Constructor Detail

WmsDataSource

public WmsDataSource()

Dummy constructor so this object can get unpersisted.

WmsDataSource

public WmsDataSource(DataSourceDescriptor descriptor,
                     java.util.List selections,
                     java.util.Hashtable properties)
              throws visad.VisADException

Create a WmsDataSource from the specification given.

Parameters:

descriptor - descriptor for the data source

selections - The selections

properties - extra properties

Throws:

visad.VisADException - some problem occurred creating data

WmsDataSource

public WmsDataSource(DataSourceDescriptor descriptor,
                     java.lang.String filename,
                     java.util.Hashtable properties)
              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getLayerList

public java.util.List getLayerList()

_more_

Returns:

_more_

initAfterUnpersistence

public void initAfterUnpersistence()

Initialize after we have been unpersisted

Specified by:

initAfterUnpersistence in interface DataSource

Overrides:

initAfterUnpersistence in class DataSourceImpl

doMakeDataChoices

protected void doMakeDataChoices()

Create the data choices associated with this source.

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

Actually get the data identified by the given DataChoce. The default is to call the getDataInner that does not take the requestProperties. This allows other, non unidata.data DataSource-s (that follow the old API) to work.

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:

The visad.Data object

Throws:

java.rmi.RemoteException - Java RMI problem

visad.VisADException - VisAD problem

getPropertiesComponents

public void getPropertiesComponents(java.util.List comps)

_more_

Overrides:

getPropertiesComponents in class DataSourceImpl

Parameters:

comps - _more_

applyProperties

public boolean applyProperties()

_more_

Overrides:

applyProperties in class DataSourceImpl

Returns:

_more_

getFullDescription

public java.lang.String getFullDescription()

Get the description. This adds on the last url requested.

Specified by:

getFullDescription in interface DataSource

Overrides:

getFullDescription in class DataSourceImpl

Returns:

description

shouldCache

protected boolean shouldCache(visad.Data data)

See if this DataSource should cache or not

Overrides:

shouldCache in class DataSourceImpl

Parameters:

data - Data to cache

Returns:

false

doMakeDateTimes

protected java.util.List doMakeDateTimes()

Create a list of times for this data source. Since shapefiles don't have any times, return an empty List.

Overrides:

doMakeDateTimes in class DataSourceImpl

Returns:

an empty List

setWmsSelections

public void setWmsSelections(java.util.List value)

Set the WmsSelections property.

Parameters:

value - The new value for WmsSelections

getWmsSelections

public java.util.List getWmsSelections()

Get the WmsSelections property.

Returns:

The WmsSelections

equals

public boolean equals(java.lang.Object o)

overwrite

Overrides:

equals in class DataSourceImpl

Parameters:

o - object

Returns:

equals

setMaintainRatio

public void setMaintainRatio(boolean value)

Set the MaintainRatio property.

Parameters:

value - The new value for MaintainRatio

getMaintainRatio

public boolean getMaintainRatio()

Get the MaintainRatio property.

Returns:

The MaintainRatio