Venice 0.751beta

nz.org.venice.chart.graph
Class PeriodGraphUI

java.lang.Object
  extended bynz.org.venice.chart.graph.PeriodGraphUI
All Implemented Interfaces:
GraphUI

public class PeriodGraphUI
extends java.lang.Object
implements GraphUI

A generic graph user interface that queries the user for a period. Since many of the graphs have only a single setting, the period, it makes sense for them to share a user interface.

Author:
Andrew Leppard

Field Summary
static int MINIMUM_PERIOD
           
 
Constructor Summary
PeriodGraphUI(java.util.HashMap settings)
          Create a new moving period user interface with the initial settings.
 
Method Summary
 java.lang.String checkSettings()
          Check the current settings displayed in the user interface.
 java.lang.String checkSettings(java.util.HashMap settings)
          Check previously set settings.
 javax.swing.JPanel getPanel()
          Return the user interface.
static int getPeriod(java.util.HashMap settings)
          Retrieve the period from the settings hashmap.
 java.util.HashMap getSettings()
          Return the current settings displayed in the user interface.
 void setSettings(java.util.HashMap settings)
          Display the given settings in the user interface.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MINIMUM_PERIOD

public static final int MINIMUM_PERIOD
See Also:
Constant Field Values
Constructor Detail

PeriodGraphUI

public PeriodGraphUI(java.util.HashMap settings)
Create a new moving period user interface with the initial settings.

Parameters:
settings - the initial settings
Method Detail

checkSettings

public java.lang.String checkSettings()
Description copied from interface: GraphUI
Check the current settings displayed in the user interface. Return an error message if the settings are invalid.

Specified by:
checkSettings in interface GraphUI
Returns:
the error message or null if the settings are valid

checkSettings

public java.lang.String checkSettings(java.util.HashMap settings)
Description copied from interface: GraphUI
Check previously set settings. Return an error message if the settings are invalid.

Specified by:
checkSettings in interface GraphUI
Parameters:
settings - Previously saved settings
Returns:
the error message or null if the settings are valid

getSettings

public java.util.HashMap getSettings()
Description copied from interface: GraphUI
Return the current settings displayed in the user interface.

Specified by:
getSettings in interface GraphUI
Returns:
current settings

setSettings

public void setSettings(java.util.HashMap settings)
Description copied from interface: GraphUI
Display the given settings in the user interface.

Specified by:
setSettings in interface GraphUI
Parameters:
settings - the new settings

getPanel

public javax.swing.JPanel getPanel()
Description copied from interface: GraphUI
Return the user interface.

Specified by:
getPanel in interface GraphUI
Returns:
the user interface

getPeriod

public static int getPeriod(java.util.HashMap settings)
Retrieve the period from the settings hashmap. If the hashmap is empty, then return the default period.

Parameters:
settings - the settings
Returns:
the period

Venice 0.751beta