Venice 0.751beta

nz.org.venice.analyser
Class QuoteRangePage

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bynz.org.venice.analyser.Page
                      extended bynz.org.venice.analyser.QuoteRangePage
All Implemented Interfaces:
javax.accessibility.Accessible, AnalyserPage, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class QuoteRangePage
extends Page
implements AnalyserPage

An analysis tool page that lets the user enter data about which quotes to work with (a quote range). This page is used by both the PaperTradeModule and GPModule. The page contains the following fields:

The date range denotes the date range of the quotes to work with. The optional period parameter allows this page to let the user specify multiple date ranges, the date ranges aren't specified explicitly here but are created from the given period option. The symbols denotes the symbols to work with. The order denotes the preferred order in working with the symbols.

Author:
Andrew Leppard
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static int FOUR_MONTHS
          Four month period.
static int FOUR_YEARS
          Four year period.
static int NO_PERIOD
          No period.
static int ONE_MONTH
          One month period.
static int ONE_WEEK
          One week period.
static int ONE_YEAR
          One year period.
static int SIX_MONTHS
          Six month period.
static int THREE_MONTHS
          Three month period.
static int THREE_YEARS
          Three year period.
static int TWO_MONTHS
          Two month period.
static int TWO_WEEKS
          Two week period.
static int TWO_YEARS
          Two year period.
 
Fields inherited from class nz.org.venice.analyser.Page
desktop
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
QuoteRangePage(javax.swing.JDesktopPane desktop)
          Construct a new quote range page.
QuoteRangePage(javax.swing.JDesktopPane desktop, boolean allowMultipleDateRanges)
          Construct a new quote range page.
 
Method Summary
 javax.swing.JComponent getComponent()
          Return the page's graphical user interface.
 int getDateRangePeriod()
          Return the period.
 TradingDate getEndDate()
          Return the seelected end date.
 OrderComparator getOrderComparator(EODQuoteBundle quoteBundle)
          Create a new order comparator to order the stocks in the given quote bundle according to the user's selected symbol order.
 EODQuoteRange getQuoteRange()
          Return the quote range representation of the user's selection.
 TradingDate getStartDate()
          Return the selected start date.
 java.lang.String getTitle()
          Return the title of this page.
 void load(java.lang.String key)
          Load the user interface values from preferences.
 boolean parse()
          Parse the values the user has entered into the GUI.
 void save(java.lang.String key)
          Save the user interface values to preferences.
 
Methods inherited from class nz.org.venice.analyser.Page
showErrorMessage
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NO_PERIOD

public static final int NO_PERIOD
No period.

See Also:
Constant Field Values

ONE_WEEK

public static final int ONE_WEEK
One week period.

See Also:
Constant Field Values

TWO_WEEKS

public static final int TWO_WEEKS
Two week period.

See Also:
Constant Field Values

ONE_MONTH

public static final int ONE_MONTH
One month period.

See Also:
Constant Field Values

TWO_MONTHS

public static final int TWO_MONTHS
Two month period.

See Also:
Constant Field Values

THREE_MONTHS

public static final int THREE_MONTHS
Three month period.

See Also:
Constant Field Values

FOUR_MONTHS

public static final int FOUR_MONTHS
Four month period.

See Also:
Constant Field Values

SIX_MONTHS

public static final int SIX_MONTHS
Six month period.

See Also:
Constant Field Values

ONE_YEAR

public static final int ONE_YEAR
One year period.

See Also:
Constant Field Values

TWO_YEARS

public static final int TWO_YEARS
Two year period.

See Also:
Constant Field Values

THREE_YEARS

public static final int THREE_YEARS
Three year period.

See Also:
Constant Field Values

FOUR_YEARS

public static final int FOUR_YEARS
Four year period.

See Also:
Constant Field Values
Constructor Detail

QuoteRangePage

public QuoteRangePage(javax.swing.JDesktopPane desktop)
Construct a new quote range page. The period setting will not be shown.

Parameters:
desktop - the desktop.

QuoteRangePage

public QuoteRangePage(javax.swing.JDesktopPane desktop,
                      boolean allowMultipleDateRanges)
Construct a new quote range page.

Parameters:
desktop - the desktop.
allowMultipleDateRanges - if set the period setting will be available.
Method Detail

load

public void load(java.lang.String key)
Description copied from interface: AnalyserPage
Load the user interface values from preferences.

Specified by:
load in interface AnalyserPage
Parameters:
key - a key which uniquely identifies the analysis tool using this page

save

public void save(java.lang.String key)
Description copied from interface: AnalyserPage
Save the user interface values to preferences.

Specified by:
save in interface AnalyserPage
Parameters:
key - a key which uniquely identifies the analysis tool using this page

parse

public boolean parse()
Description copied from interface: AnalyserPage
Parse the values the user has entered into the GUI. If any of the values are invalid, the page will display an option pane describing the error, and the function will return false.

Specified by:
parse in interface AnalyserPage
Returns:
true if the user's values are valid, false otherwise.

getComponent

public javax.swing.JComponent getComponent()
Description copied from interface: AnalyserPage
Return the page's graphical user interface.

Specified by:
getComponent in interface AnalyserPage
Returns:
the GUI

getTitle

public java.lang.String getTitle()
Description copied from interface: AnalyserPage
Return the title of this page.

Specified by:
getTitle in interface AnalyserPage
Returns:
the page's title

getQuoteRange

public EODQuoteRange getQuoteRange()
Return the quote range representation of the user's selection.

Returns:
the quote range representation.

getStartDate

public TradingDate getStartDate()
Return the selected start date.

Returns:
the start date.

getEndDate

public TradingDate getEndDate()
Return the seelected end date.

Returns:
the end date.

getDateRangePeriod

public int getDateRangePeriod()
Return the period. Only call this function if you selected multiple date ranges.

Returns:
the period.

getOrderComparator

public OrderComparator getOrderComparator(EODQuoteBundle quoteBundle)
Create a new order comparator to order the stocks in the given quote bundle according to the user's selected symbol order.

Parameters:
quoteBundle - the quote bundle
Returns:
a new order comparator.

Venice 0.751beta