Package ucar.unidata.idv.control

Class StationLocationControl

java.lang.Object
ucar.unidata.collab.SharableImpl
ucar.unidata.idv.control.DisplayControlBase
ucar.unidata.idv.control.DisplayControlImpl
ucar.unidata.idv.control.ObsDisplayControl
ucar.unidata.idv.control.StationModelControl
ucar.unidata.idv.control.StationLocationControl
All Implemented Interfaces:
ActionListener, ItemListener, PropertyChangeListener, EventListener, HyperlinkListener, Sharable, DataChangeListener, DisplayControl, Prototypable, ControlListener, DisplayListener
Direct Known Subclasses:
TextProductControl, WorldWindControl, YahooLocationControl
public class StationLocationControl extends StationModelControl
Class to display a set of locations
Version:
$Revision: 1.112 $ $Date: 2007/06/08 20:00:51 $
Author:
MetApps Development Team

  • Constructor Details

    • StationLocationControl

      public StationLocationControl()
      Default cstr; sets attribute flags

  • Method Details

    • initAsPrototype

      public void initAsPrototype()
      Clear out the station table names
      Specified by:
      initAsPrototype in interface Prototypable
      Overrides:
      initAsPrototype in class DisplayControlImpl

    • init

      public boolean init(DataChoice dataChoice) throws VisADException, RemoteException
      Called to make this kind of Display Control; also calls code to made the Displayable. This method is called from inside DisplayControlImpl.init(several args). This implementation gets the list of stationTables to be used.
      Overrides:
      init in class StationModelControl
      Parameters:
      dataChoice - the DataChoice of the moment - not used yet by this implementation; can be null.
      Returns:
      true if successful
      Throws:
      VisADException - there was a VisAD error
      RemoteException - there was a remote error

    • isChartEnabled

      protected boolean isChartEnabled()
      Overwrite base class method so we don't show the chart
      Overrides:
      isChartEnabled in class StationModelControl
      Returns:
      false

    • getCursorReadoutInner

      protected List getCursorReadoutInner(EarthLocation el, Real animationValue, int animationStep, List<ReadoutInfo> samples) throws Exception
      _more_
      Overrides:
      getCursorReadoutInner in class DisplayControlImpl
      Parameters:
      el - _more_
      animationValue - _more_
      animationStep - _more_
      samples - _more_
      Returns:
      _more_
      Throws:
      Exception - _more_

    • getDataProjection

      public MapProjection getDataProjection()
      get MapProjection of data to display
      Specified by:
      getDataProjection in interface DisplayControl
      Overrides:
      getDataProjection in class StationModelControl
      Returns:
      The native projection of the data

    • hasMapProjection

      public boolean hasMapProjection()
      Do we have a map projection
      Overrides:
      hasMapProjection in class DisplayControlImpl
      Returns:
      true

    • getDataProjectionForMenu

      public MapProjection getDataProjectionForMenu()
      Get the MapProjection for this data; if have a single point data object make synthetic map projection for location
      Overrides:
      getDataProjectionForMenu in class DisplayControlImpl
      Returns:
      MapProjection for the data

    • reloadDataSource

      public void reloadDataSource() throws RemoteException, VisADException
      The data changed. Reload the display.
      Overrides:
      reloadDataSource in class DisplayControlImpl
      Throws:
      RemoteException - On badness
      VisADException - On badness

    • getDataProjectionLabel

      protected String getDataProjectionLabel()
      What label to use for the data projection
      Overrides:
      getDataProjectionLabel in class StationModelControl
      Returns:
      projection label

    • resetData

      protected void resetData() throws VisADException, RemoteException
      This gets called when the control has received notification of a dataChange event.
      Overrides:
      resetData in class StationModelControl
      Throws:
      RemoteException - Java RMI problem
      VisADException - VisAD problem

    • initDone

      public void initDone()
      Init is done
      Overrides:
      initDone in class StationModelControl

    • handleChangedStationModel

      protected void handleChangedStationModel(StationModel changedModel)
      Station model has changed.
      Overrides:
      handleChangedStationModel in class StationModelControl
      Parameters:
      changedModel - The changed model

    • createStationModelDisplayable

      protected StationModelDisplayable createStationModelDisplayable() throws VisADException, RemoteException
      Called by the init method to create the StationModelDisplayable used for this instance.
      Overrides:
      createStationModelDisplayable in class StationModelControl
      Returns:
      this instance's StationModelDisplayable
      Throws:
      VisADException - there was an error creating the Displayable.
      RemoteException - there was an error creating the Displayable

    • initDisplayable

      protected void initDisplayable(StationModelDisplayable myDisplay) throws VisADException, RemoteException
      _more_
      Overrides:
      initDisplayable in class StationModelControl
      Parameters:
      myDisplay - _more_
      Throws:
      RemoteException - _more_
      VisADException - _more_

    • setData

      protected boolean setData(DataChoice choice) throws VisADException, RemoteException
      Override the superclass method since currently, the DataChoice for this instance is null or not used.
      Overrides:
      setData in class StationModelControl
      Parameters:
      choice - DataChoice
      Returns:
      true if everything worked.
      Throws:
      VisADException - there was an error creating/setting the data.
      RemoteException - there was an error creating/setting the data for a remote object.
      See Also:

    • loadDataInAWhile

      protected void loadDataInAWhile()
      _more_
      Overrides:
      loadDataInAWhile in class StationModelControl

    • handleMousePressed

      protected void handleMousePressed(EarthLocation el, DisplayEvent event)
      Handle when the user clicks in the main display
      Overrides:
      handleMousePressed in class StationModelControl
      Parameters:
      el - The location
      event - The event

    • selectedStationsChanged

      protected void selectedStationsChanged(List selectionList) throws VisADException, RemoteException
      The list of stations that changed
      Parameters:
      selectionList - the list
      Throws:
      RemoteException - On badness
      VisADException - On badness

    • setSelectedStations

      protected void setSelectedStations(List<NamedStationImpl> stations) throws VisADException, RemoteException
      set the selected stations
      Parameters:
      stations - the selected stations
      Throws:
      RemoteException - On badness
      VisADException - On badness

    • setScaleOnDisplayable

      protected void setScaleOnDisplayable(float f) throws RemoteException, VisADException
      set the scale factor on the displayable
      Overrides:
      setScaleOnDisplayable in class StationModelControl
      Parameters:
      f - the scale
      Throws:
      RemoteException - On badness
      VisADException - On badness

    • getExtraLegendComponent

      protected JComponent getExtraLegendComponent(int legendType)
      Assume that any display controls that have a color table widget will want the color table to show up in the legend.
      Overrides:
      getExtraLegendComponent in class StationModelControl
      Parameters:
      legendType - type of legend
      Returns:
      The extra JComponent to use in legend

    • getLegendLabels

      public void getLegendLabels(List labels, int legendType)
      Get the extra label used for the legend.
      Overrides:
      getLegendLabels in class DisplayControlImpl
      Parameters:
      labels - labels to add to
      legendType - The type of legend, BOTTOM_LEGEND or SIDE_LEGEND

    • getMenuLabel

      public String getMenuLabel()
      Get the label used for the a menu.
      Specified by:
      getMenuLabel in interface DisplayControl
      Overrides:
      getMenuLabel in class DisplayControlImpl
      Returns:
      menu label.

    • doMakeDataInstance

      protected DataInstance doMakeDataInstance(DataChoice dataChoice) throws RemoteException, VisADException

      Creates and returns the DataInstance corresponding to a DataChoice. Returns null if the DataInstance was somehow invalid.

      This method is invoked by the overridable method setData(DataChoice).

      Overrides:
      doMakeDataInstance in class ObsDisplayControl
      Parameters:
      dataChoice - The DataChoice from which to create a DataInstance.
      Returns:
      for this instance, null.
      Throws:
      VisADException - if a VisAD Failure occurs.
      RemoteException - if a Java RMI failure occurs.

    • getFilterNames

      protected List getFilterNames()
      Return the list of names that shows up in the filter gui names combob box.
      Overrides:
      getFilterNames in class StationModelControl
      Returns:
      List of filter names

    • getDetailsContents

      protected String getDetailsContents()
      Get the contents of the details html
      Overrides:
      getDetailsContents in class DisplayControlImpl
      Returns:
      The contents of the details

    • loadData

      public void loadData()
      Loads the data into the StationModelDisplayable. Declutters the stations if necessary.
      Overrides:
      loadData in class StationModelControl
      See Also:

    • addSelectedToList

      protected void addSelectedToList(List listOfStations)
      add the selected stations to the given list
      Parameters:
      listOfStations - list to add to

    • getStationTableDescription

      protected String getStationTableDescription()
      Get the station table description.
      Returns:
      the station list

    • getStationList

      protected List getStationList()
      Get the station List.
      Returns:
      the station list

    • getMyStationModel

      public StationModel getMyStationModel()
      Get the current station model view.
      Returns:
      station model layout

    • setStationTableName

      public void setStationTableName(String value)
      Set the station table name for this instance. Used by persistence with set/get methods.
      Parameters:
      value - name of station table.

    • setStationTableNames

      public void setStationTableNames(List value)
      Set the StationTableNames property.
      Parameters:
      value - The new value for StationTableNames

    • getStationTableNames

      public List getStationTableNames()
      Get the StationTableNames property.
      Returns:
      The StationTableNames

    • doMakeContents

      protected Container doMakeContents() throws VisADException, RemoteException
      Called by the init method to create the contents of this DisplayControl's UI.
      Overrides:
      doMakeContents in class StationModelControl
      Returns:
      the container for the UI.
      Throws:
      RemoteException - Java RMI error
      VisADException - VisAD Error

    • doMakeTabs

      protected JTabbedPane doMakeTabs(boolean showDataSets, boolean showFilters) throws VisADException, RemoteException
      Make the main tabbed pane gui
      Parameters:
      showDataSets - show the datasets component
      showFilters - show the filters component
      Returns:
      the tabbed pane
      Throws:
      RemoteException - On badness
      VisADException - On badness

    • doMakeDisplayPanel

      protected JComponent doMakeDisplayPanel()
      Make the display gui panel
      Returns:
      display gui panel

    • doMakeStationListPanel

      protected JComponent doMakeStationListPanel()
      Make the list of stations panel
      Returns:
      The station list panel

    • buttonPressed

      public void buttonPressed(int index)
      The id or station button was pressed
      Parameters:
      index - which one

    • getSaveMenuItems

      protected void getSaveMenuItems(List items, boolean forMenuBar)
      Add the relevant file menu items into the list
      Overrides:
      getSaveMenuItems in class StationModelControl
      Parameters:
      items - List of menu items
      forMenuBar - Is this for the menu in the window's menu bar or for a popup menu in the legend

    • getViewMenuItems

      protected void getViewMenuItems(List items, boolean forMenuBar)
      _more_
      Overrides:
      getViewMenuItems in class StationModelControl
      Parameters:
      items - _more_
      forMenuBar - _more_

    • showFlythrough

      public void showFlythrough() throws Exception
      _more_
      Throws:
      Exception - _more_

    • exportLocations

      public void exportLocations()
      Write out the locations as an xml file

    • getEditMenuItems

      protected void getEditMenuItems(List items, boolean forMenuBar)
      Add the relevant edit menu items into the list
      Overrides:
      getEditMenuItems in class StationModelControl
      Parameters:
      items - List of menu items
      forMenuBar - Is this for the menu in the window's menu bar or for a popup menu in the legend

    • makeStationModelEditMenuItems

      protected void makeStationModelEditMenuItems(List items, boolean forMenuBar)
      Get edit menu items
      Overrides:
      makeStationModelEditMenuItems in class StationModelControl
      Parameters:
      items - list of menu items
      forMenuBar - true if for the menu bar

    • actionPerformed

      public void actionPerformed(ActionEvent ae)
      Only public as a result of this being an ActionListener.
      Specified by:
      actionPerformed in interface ActionListener
      Overrides:
      actionPerformed in class DisplayControlImpl
      Parameters:
      ae - action event to check

    • setSymbolType

      public void setSymbolType(int value)
      Set the symbol type for this instance. Used by persistence.
      Parameters:
      value - symbol type (e.g. StationLocationDisplayable.SYMBOL_PLUS)

    • getSymbolType

      public int getSymbolType()
      Get the symbol type for this instance.
      Returns:
      symbol type (e.g. StationLocationDisplayable.SYMBOL_PLUS)

    • setIdType

      public void setIdType(int value)
      Set the id type for this instance. Used by persistence.
      Parameters:
      value - id type (e.g. StationLocationDisplayable.ID_ID)

    • getIdType

      public int getIdType()
      Get the id type for this instance.
      Returns:
      id type (e.g. StationLocationDisplayable.ID_ID)

    • setShowSymbol

      public void setShowSymbol(boolean value)
      Set whether the symbol should be shown (visible). Used by persistence.
      Parameters:
      value - true to show the symbol.

    • getShowSymbol

      public boolean getShowSymbol()
      Get whether the symbol should be shown (visible).
      Returns:
      true if symbol should be visible.

    • setShowId

      public void setShowId(boolean value)
      Set whether the id should be shown (visible). Used by persistence.
      Parameters:
      value - true to show the id.

    • getShowId

      public boolean getShowId()
      Get whether the id should be shown (visible).
      Returns:
      true if id should be visible.

    • setEnabled

      public void setEnabled(boolean value)
      Set the Enabled property.
      Parameters:
      value - The new value for Enabled

    • getEnabled

      public boolean getEnabled()
      Get the Enabled property.
      Returns:
      The Enabled

    • setCenterOnClick

      public void setCenterOnClick(boolean value)
      Set the CenterOnClick property.
      Parameters:
      value - The new value for Center

    • getCenterOnClick

      public boolean getCenterOnClick()
      Get the CenterOnClick property.
      Returns:
      The Center

    • setUseStationModel

      public void setUseStationModel(boolean value)
      Set the UseStationModel property.
      Parameters:
      value - The new value for UseStationModel

    • getUseStationModel

      public boolean getUseStationModel()
      Get the UseStationModel property.
      Returns:
      The UseStationModel

    • setOnlyShowFiltered

      public void setOnlyShowFiltered(boolean value)
      Set the OnlyShowFiltered property.
      Overrides:
      setOnlyShowFiltered in class StationModelControl
      Parameters:
      value - The new value for OnlyShowFiltered

    • setDeclutter

      public void setDeclutter(boolean v)
      Override setDeclutter
      Overrides:
      setDeclutter in class StationModelControl
      Parameters:
      v - new value

    • setDetailsInLegend

      public void setDetailsInLegend(boolean value)
      Set the DetailsInLegend property.
      Parameters:
      value - The new value for DetailsInLegend

    • getDetailsInLegend

      public boolean getDetailsInLegend()
      Get the DetailsInLegend property.
      Returns:
      The DetailsInLegend