edu.ucla.stat.SOCR.util
Class Forest

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              edu.ucla.stat.SOCR.util.Forest

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener

public class Forest
extends javax.swing.JComponent
implements java.awt.event.MouseListener, java.awt.event.MouseMotionListener

This class models a forest as a rectangular lattice of trees. Each tree at any time is in one of three states: green, on fire, or burnt. If a tree is on fire at time t, then any of the four neighboring green trees can catch fire at time t + 1 with specified probabilities. Trees catch on fire independently. A tree on fire at time t is burnt at time t + 1. Once a tree is burnt, it remains burnt.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static int	BLACK
static int	DOWN
static int	GREEN
static int	LEFT
static int	RED
static int	RIGHT
static int	UP

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

Forest()
This default constructor creates a new forest with 100 rows, 50 columns and tree width 5.

Forest(int c, int r)
This special constructor creates a new forest with a specified number of rows and columns, and with default tree width 5.

Forest(int c, int r, int w)
This general constructor creates a new forest with a specified number of rows and columns and a specified tree width.

Method Summary

double	getProbability(int i) This method gets the fire spread probabilities.
int	getX() This method gets the x mouse coordinates.
int	getY() This method gets the y mouse coordinate.
void	mouseClicked(java.awt.event.MouseEvent event) This method handles the mouse click event.The selected tree is set to the currently specified state.
void	mouseDragged(java.awt.event.MouseEvent event)
void	mouseEntered(java.awt.event.MouseEvent event)
void	mouseExited(java.awt.event.MouseEvent event)
void	mouseMoved(java.awt.event.MouseEvent event) This method handles the mouse move event.
void	mousePressed(java.awt.event.MouseEvent event)
void	mouseReleased(java.awt.event.MouseEvent event)
void	paintComponent(java.awt.Graphics g) This method paints the forest.
void	reset() This method resets the forest to a completely green forest.
void	setEditState(int newState) This method sets the tree edit state.
void	setFire() This method sets the tree in the center of the forest on fire.
void	setParameters(int c, int r, int w) This method sets the parameters: the number of rows, the number of columns, and the tree width.
void	setProbabilities(double pl, double pr, double pd, double pu) This method sets the fire spread probabilities.
void	setState(int x, int y, int newState) This method sets the state of a specified tree.
int	treesBurnt() This method returns the number of burnt trees.
int	treesGreen() This method returns the number of green trees.
int	treesOnFire() This method returns the number of trees that are on fire.
void	update() This method updates the forest.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

GREEN

public static final int GREEN

See Also:

Constant Field Values

RED

public static final int RED

See Also:

Constant Field Values

BLACK

public static final int BLACK

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

See Also:

Constant Field Values

DOWN

public static final int DOWN

See Also:

Constant Field Values

UP

public static final int UP

See Also:

Constant Field Values

Constructor Detail

Forest

public Forest(int c,
              int r,
              int w)

This general constructor creates a new forest with a specified number of rows and columns and a specified tree width.

Forest

public Forest(int c,
              int r)

This special constructor creates a new forest with a specified number of rows and columns, and with default tree width 5.

Forest

public Forest()

This default constructor creates a new forest with 100 rows, 50 columns and tree width 5.

Method Detail

setParameters

public void setParameters(int c,
                          int r,
                          int w)

This method sets the parameters: the number of rows, the number of columns, and the tree width.

setProbabilities

public void setProbabilities(double pl,
                             double pr,
                             double pd,
                             double pu)

This method sets the fire spread probabilities.

getProbability

public double getProbability(int i)

This method gets the fire spread probabilities.

setEditState

public void setEditState(int newState)

This method sets the tree edit state. When a tree is clicked on, the state of the tree will change to the specified state.

setState

public void setState(int x,
                     int y,
                     int newState)

This method sets the state of a specified tree.

setFire

public void setFire()

This method sets the tree in the center of the forest on fire.

paintComponent

public void paintComponent(java.awt.Graphics g)

This method paints the forest.

Overrides:

paintComponent in class javax.swing.JComponent

update

public void update()

This method updates the forest.

reset

public void reset()

This method resets the forest to a completely green forest.

treesOnFire

public int treesOnFire()

This method returns the number of trees that are on fire.

treesBurnt

public int treesBurnt()

This method returns the number of burnt trees.

treesGreen

public int treesGreen()

This method returns the number of green trees.

getX

public int getX()

This method gets the x mouse coordinates.

Overrides:

getX in class javax.swing.JComponent

getY

public int getY()

This method gets the y mouse coordinate.

Overrides:

getY in class javax.swing.JComponent

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent event)

This method handles the mouse click event.The selected tree is set to the currently specified state.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent event)

This method handles the mouse move event. The mouse coordinates are tracked.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent event)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent event)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent event)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent event)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent event)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener