Venice 0.751beta

nz.org.venice.analyser
Class RulesPage

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.RulesPage
All Implemented Interfaces:
javax.accessibility.Accessible, AnalyserPage, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class RulesPage
extends Page
implements AnalyserPage

An analysis tool page that lets the user enter a buy and sell rule, or a family of related buy and sell rules. This page is used by the PaperTradeModule. The page contains the following user fields:

The buy and sell rules determine when a stock should be bought or sold respectively. The rule family option allows the user to embedd variables in the rules. This enables them to specify a family of simillar rules. For example, a buy rule might be avg(close, 15) > avg(close, 30). If the rule family is enabled, the user could enter avg(close, a) > avg(close, b). Then the paper trade would try each rule combination of [a, b].

Author:
Andrew Leppard
See Also:
PaperTradeModule, 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
 
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
RulesPage(javax.swing.JDesktopPane desktop)
          Construct a new rules page.
 
Method Summary
 int getARange()
          Return the A range parameter.
 int getBRange()
          Return the B range parameter.
 Expression getBuyRule()
          Return the parsed buy rule expression.
 javax.swing.JComponent getComponent()
          Return the page's graphical user interface.
 int getCRange()
          Return the C range parameter.
 Expression getSellRule()
          Return the parsed sell rule expression.
 java.lang.String getTitle()
          Return the title of this page.
 boolean isFamilyEnabled()
          Return if rule families have been selected.
 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
 

Constructor Detail

RulesPage

public RulesPage(javax.swing.JDesktopPane desktop)
Construct a new rules page.

Parameters:
desktop - the desktop
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

getBuyRule

public Expression getBuyRule()
Return the parsed buy rule expression.

Returns:
the buy rule

getSellRule

public Expression getSellRule()
Return the parsed sell rule expression.

Returns:
the sell rule

getARange

public int getARange()
Return the A range parameter.

Returns:
the maximum value of A

getBRange

public int getBRange()
Return the B range parameter.

Returns:
the maximum value of B

getCRange

public int getCRange()
Return the C range parameter.

Returns:
the maximum value of C

isFamilyEnabled

public boolean isFamilyEnabled()
Return if rule families have been selected.

Returns:
true if rule families are enabled, false otherwise

Venice 0.751beta