DataSourceHolder (Unidata IDV API v6.2u2)

java.lang.Object
- ucar.unidata.idv.ui.DataSourceHolder

Direct Known Subclasses:

DataSelector, DataTree
```
public abstract class DataSourceHolder
extends java.lang.Object
```
A base class for those components that show a set of DataSources. For now these are the DataTree and DataSelector. This class provides basic facilities to manage the list of data sources, create the window, etc.

Author:

IDV development team

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.awt.Dimension`	`defaultDimension` The size of the window
`protected DataSource`	`formulaDataSource` The formula data source, i.e., the one that holds the end-user formulas
`protected IdvWindow`	`frame` The window this gui is in
`protected IntegratedDataViewer`	`idv` The IDV
`protected boolean`	`treatFormulaDataSourceSpecial` If true then we don't remove the formula data source

Constructor Summary

Constructors
Constructor and Description
`DataSourceHolder(IntegratedDataViewer idv, DataSource formulaDataSource, java.awt.Dimension defaultDimension)` Create this object

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDataSource(DataSource dataSource)` Add the given `DataSource`
`void`	`addDisplayControl(DisplayControl control)` Adds the given `DisplayControl`
`void`	`addDisplayControl(DisplayControl control, DataChoice choice)` A no-op that can be overrode by a derived class
`void`	`dataSourceChanged(DataSource source)` Be notified that the given `DataSource` has changed.
`void`	`dataSourceTimeChanged(DataSource source)` Be notified that the tim selection on the given `DataSource` has changed.
`void`	`displayTemplatesChanged()` A hook to notify that the list of favorites has changed
`void`	`dispose()` Remove all references to anything we may have.
`void`	`doClose()` Remove this holder from the IDV and dispose of the window
`IdvWindow`	`doMakeFrame()` Make the IdvWindow.
`javax.swing.JComponent`	`getButtons()` Hook for derived classes to provide their own dialog buttons
`abstract javax.swing.JComponent`	`getContents()` Needs to be overrode by derived classes to return the GUI
`java.util.List`	`getDataSources()` Return the list of `DataSource`s
`static javax.swing.ImageIcon`	`getDerivedIcon()` Utility method to create, if needed, and return the ImageIcon to be used to show `DerivedDataChoice`s
`IdvWindow`	`getFrame()` Get our window.
`IntegratedDataViewer`	`getIdv()` Return the IDV member.
`java.awt.Point`	`getLocationOnScreen()` Utility to determine the location on the screen.
`protected java.lang.String`	`getName()` Get the name of this data source holder.
`void`	`removeAllDataSources()` Remove all data sources
`void`	`removeDataSource(DataSource dataSource)` Remove the given `DataSource` only if it is not the formulaDataSource.
`protected boolean`	`removeDataSourceInner(DataSource dataSource)` Remove the specified data source only if it is not the formulaDataSource.
`void`	`removeDisplayControl(DisplayControl control)` Remove the given `DisplayControl`
`void`	`setDefaultSize(java.awt.Dimension d)` Set the default window size to be used by this component
`void`	`setFrame(IdvWindow f)` Set our window
`void`	`show()` Show the window if it is non-null

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - idv
```
protected IntegratedDataViewer idv
```
    The IDV
  - frame
```
protected IdvWindow frame
```
    The window this gui is in
  - formulaDataSource
```
protected DataSource formulaDataSource
```
    The formula data source, i.e., the one that holds the end-user formulas
  - treatFormulaDataSourceSpecial
```
protected boolean treatFormulaDataSourceSpecial
```
    If true then we don't remove the formula data source
  - defaultDimension
```
protected java.awt.Dimension defaultDimension
```
    The size of the window
- Constructor Detail
  - DataSourceHolder
```
public DataSourceHolder(IntegratedDataViewer idv,
                        DataSource formulaDataSource,
                        java.awt.Dimension defaultDimension)
```
    Create this object
    
    Parameters:
    
    idv - The IDV
    
    formulaDataSource - The singleton formula data source. We treat this special.
    
    defaultDimension - How big is the window.
- Method Detail
  - doMakeFrame
```
public IdvWindow doMakeFrame()
```
    Make the IdvWindow. Add event handlers for adding new data sources and closing the window.
    
    Returns:
    
    The window to put the gui in
  - getIdv
```
public IntegratedDataViewer getIdv()
```
    Return the IDV member.
    
    Returns:
    
    The IDV
  - getName
```
protected java.lang.String getName()
```
    Get the name of this data source holder. Can be overrode by derived classes to provide their own name.
    
    Returns:
    
    The name
  - doClose
```
public void doClose()
```
    Remove this holder from the IDV and dispose of the window
  - show
```
public void show()
```
    Show the window if it is non-null
  - setFrame
```
public void setFrame(IdvWindow f)
```
    Set our window
    
    Parameters:
    
    f - The window
  - getFrame
```
public IdvWindow getFrame()
```
    Get our window.
    
    Returns:
    
    The window
  - getContents
```
public abstract javax.swing.JComponent getContents()
```
    Needs to be overrode by derived classes to return the GUI
    
    Returns:
    
    The GUI
  - getLocationOnScreen
```
public java.awt.Point getLocationOnScreen()
```
    Utility to determine the location on the screen.
    
    Returns:
    
    Screen location
  - getButtons
```
public javax.swing.JComponent getButtons()
```
    Hook for derived classes to provide their own dialog buttons
    
    Returns:
    
    This returns null but is meant to return dialog buttons
  - getDataSources
```
public java.util.List getDataSources()
```
    Return the list of DataSources
    
    Returns:
    
    List of data sources
  - getDerivedIcon
```
public static javax.swing.ImageIcon getDerivedIcon()
```
    Utility method to create, if needed, and return the ImageIcon to be used to show DerivedDataChoices
    
    Returns:
    
    The icon for derived data choices
  - setDefaultSize
```
public void setDefaultSize(java.awt.Dimension d)
```
    Set the default window size to be used by this component
    
    Parameters:
    
    d - The default size
  - addDisplayControl
```
public void addDisplayControl(DisplayControl control,
                              DataChoice choice)
```
    A no-op that can be overrode by a derived class
    
    Parameters:
    
    control - The new display control
    
    choice - The data choice
  - removeDisplayControl
```
public void removeDisplayControl(DisplayControl control)
```
    Remove the given DisplayControl
    
    Parameters:
    
    control - The removed display control
  - addDisplayControl
```
public void addDisplayControl(DisplayControl control)
```
    Adds the given DisplayControl
    
    Parameters:
    
    control - The new display control
  - dispose
```
public void dispose()
```
    Remove all references to anything we may have. We do this because (stupid) Swing seems to keep around lots of different references to thei component and/or it's frame. So when we do a window.dispose () this DataSourceHolder does not get gc'ed.
  - removeAllDataSources
```
public void removeAllDataSources()
```
    Remove all data sources
  - addDataSource
```
public void addDataSource(DataSource dataSource)
```
    Add the given DataSource
    
    Parameters:
    
    dataSource - The new data source
  - removeDataSource
```
public void removeDataSource(DataSource dataSource)
```
    Remove the given DataSource only if it is not the formulaDataSource.
    
    Parameters:
    
    dataSource - The data source to be removed
  - removeDataSourceInner
```
protected boolean removeDataSourceInner(DataSource dataSource)
```
    Remove the specified data source only if it is not the formulaDataSource.
    
    Parameters:
    
    dataSource - The data source to be removed
    
    Returns:
    
    Was this actually removed
  - dataSourceChanged
```
public void dataSourceChanged(DataSource source)
```
    Be notified that the given DataSource has changed.
    
    Parameters:
    
    source - The data source that changed
  - dataSourceTimeChanged
```
public void dataSourceTimeChanged(DataSource source)
```
    Be notified that the tim selection on the given DataSource has changed.
    
    Parameters:
    
    source - The data source whose time has changed
  - displayTemplatesChanged
```
public void displayTemplatesChanged()
```
    A hook to notify that the list of favorites has changed

Class DataSourceHolder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

idv

frame

formulaDataSource

treatFormulaDataSourceSpecial

defaultDimension

Constructor Detail

DataSourceHolder

Method Detail

doMakeFrame

getIdv

getName

doClose

show

setFrame

getFrame

getContents

getLocationOnScreen

getButtons

getDataSources

getDerivedIcon

setDefaultSize

addDisplayControl

removeDisplayControl

addDisplayControl

dispose

removeAllDataSources

addDataSource

removeDataSource

removeDataSourceInner

dataSourceChanged

dataSourceTimeChanged

displayTemplatesChanged