prajna.geoviz

Class TimerGeoCanvas

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

prajna.geo.GeoCanvas

prajna.geoviz.TimerGeoCanvas

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, GeoDisplay, TimeDisplay

public class TimerGeoCanvas
extends GeoCanvas
implements TimeDisplay

Implementation of a GeoCanvas which adds a layer for temporal overlays. This canvas includes functions to add geographic shapes with associated time spans, or to manipulate the time displayed. This allows for temporal-based animations, showing geographic events over a period of time.

Author:

Edward Swing

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

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

Constructors

Constructor and Description
TimerGeoCanvas() Instantiates a new TimerGeoCanvas.
TimerGeoCanvas(GeoCanvas baseCanvas) Instantiates a new TimerGeoCanvas, using the specified GeoCanvas as the geographic display.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayer(GeoLayer layer) Adds the layer.
void	addShape(GeoShape newShape) Adds a GeoShape.
void	addShapes(java.util.Collection<GeoShape> newShapes) Adds all shapes in the collection.
void	addSpan(GeoShape shape, TimeSpan span) Adds a shape with a specified TimeSpan.
void	addTimedShape(GeoShape shape, Sequential time) Adds the shape with the specified time sequence.
GeoLayer	findLayer(java.lang.String name) Find a named geographic layer.
java.util.Date	getDisplayTime() Get the currently displayed time
long	getFadeTime() Get the fade time for the temporal display.
GeoBounds	getGeoBounds() Get the current geographic bounds
java.util.List<GeoLayer>	getLayers() Get the list of layers.
Projection	getProjection() Get the current projection
long	getPurgeTime() Gets the purge time, which is used to remove stale temporal components.
RenderStyle	getRenderStyle() Set the render style, which is used to display the temporal components.
Sequential	getSequence(GeoShape shape) Gets the time sequence associated with a particular GeoShape
GeoShape	getShapeAt(java.awt.geom.Point2D pickPoint) Return the geographic shape at the picked point.
java.awt.Color	getWorldColor() Get the world color.
boolean	isRealTime() Return whether this display is in real time mode.
protected void	paintComponent(java.awt.Graphics g) Paint this component.
protected void	processComponentEvent(java.awt.event.ComponentEvent event) Processes any resize event.
void	purgeData() Purge any data which has exceeded the purgeTime.
void	setDisplayTime(java.util.Date time) Set the time currently displayed.
void	setFadeTime(long millis) Set the fade time.
void	setGeoBounds(GeoBounds geoBounds) Sets the geographic bounds.
void	setLayers(java.util.Collection<GeoLayer> layers) Sets the layers displayed.
void	setProjection(Projection proj) Sets the projection.
void	setPurgeTime(long millis) Set the purge time.
void	setRealTime(boolean realTimeFlag) Set the real time flag.
void	setRenderStyle(RenderStyle style) Get the render style, which is used to display the temporal components.
void	setWorldColor(java.awt.Color worldColor) Set the world color.

Methods inherited from class prajna.geo.GeoCanvas

clearShapes, getBackgroundImage, paintGeoLayers, setBackgroundImage

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, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimerGeoCanvas

public TimerGeoCanvas()

Instantiates a new TimerGeoCanvas.

TimerGeoCanvas

public TimerGeoCanvas(GeoCanvas baseCanvas)

Instantiates a new TimerGeoCanvas, using the specified GeoCanvas as the geographic display. The temporal components will be displayed over the specified GeoCanvas.

Parameters:

baseCanvas - the base canvas

Method Detail

addLayer

public void addLayer(GeoLayer layer)

Adds the layer. This adds the layer to the underlying GeoCanvas.

Specified by:

addLayer in interface GeoDisplay

Overrides:

addLayer in class GeoCanvas

Parameters:

layer - the layer

See Also:

GeoCanvas.addLayer(prajna.geo.GeoLayer)

addShape

public void addShape(GeoShape newShape)

Adds a GeoShape. If the GeoShape implements Sequential, it is added to the temporal overlay component. Otherwise, it is added to the underlying GeoCanvas.

Overrides:

addShape in class GeoCanvas

Parameters:

newShape - the new shape

See Also:

GeoCanvas.addShape(prajna.geo.GeoShape)

addShapes

public void addShapes(java.util.Collection<GeoShape> newShapes)

Adds all shapes in the collection. This simply invokes addShape on each shape in the collection. Any Sequential shapes are added to the temporal layer, and the rest are added to the underlying canvas.

Overrides:

addShapes in class GeoCanvas

Parameters:

newShapes - the new shapes

See Also:

GeoCanvas.addShapes(java.util.Collection)

addSpan

public void addSpan(GeoShape shape,
           TimeSpan span)

Adds a shape with a specified TimeSpan. This adds the shape to the temporal overlay layer with the specified span. If the shape is already in the temporal overlay layer, this adds an additional span to its active times, allowing a geographic entity to have multiple periods of activity or visibility.

Parameters:

shape - the GeoShape

span - the associated TimeSpan

addTimedShape

public void addTimedShape(GeoShape shape,
                 Sequential time)

Adds the shape with the specified time sequence. This adds the shape to the temporal overlays, overwriting any previous time sequence associated with the shape.

Parameters:

shape - the GeoShape

time - the time sequence

findLayer

public GeoLayer findLayer(java.lang.String name)

Find a named geographic layer. This simply delegates to the underlying GeoCanvas

Overrides:

findLayer in class GeoCanvas

Parameters:

name - The geographic layer name

Returns:

the geographic layer, or null if the layer is not found

getDisplayTime

public java.util.Date getDisplayTime()

Get the currently displayed time

Specified by:

getDisplayTime in interface TimeDisplay

Returns:

the currently displayed time.

See Also:

TimeDisplay.getDisplayTime()

getFadeTime

public long getFadeTime()

Get the fade time for the temporal display. The fade time is used for certain temporal dynamics

Specified by:

getFadeTime in interface TimeDisplay

Returns:

the fade time, in milliseconds.

See Also:

TimeDisplay.getFadeTime()

getGeoBounds

public GeoBounds getGeoBounds()

Get the current geographic bounds

Specified by:

getGeoBounds in interface GeoDisplay

Overrides:

getGeoBounds in class GeoCanvas

Returns:

the current geographic bounds

getLayers

public java.util.List<GeoLayer> getLayers()

Get the list of layers. The list is returned in the order that the layers are drawn, so the first layers in the list will be below later ones. This method returns the list of layers in its internal GeoCanvas.

Specified by:

getLayers in interface GeoDisplay

Overrides:

getLayers in class GeoCanvas

Returns:

the list of layers.

getProjection

public Projection getProjection()

Get the current projection

Specified by:

getProjection in interface GeoDisplay

Overrides:

getProjection in class GeoCanvas

Returns:

the current projection

getPurgeTime

public long getPurgeTime()

Gets the purge time, which is used to remove stale temporal components.

Specified by:

getPurgeTime in interface TimeDisplay

Returns:

the purgeTime

getRenderStyle

public RenderStyle getRenderStyle()

Set the render style, which is used to display the temporal components. Any temporal shape without its own render style will use the render style defined.

Returns:

the renderStyle

getSequence

public Sequential getSequence(GeoShape shape)

Gets the time sequence associated with a particular GeoShape

Parameters:

shape - the GeoShaoe

Returns:

the sequence for that shape, or null if there is no associated sequence

getShapeAt

public GeoShape getShapeAt(java.awt.geom.Point2D pickPoint)

Return the geographic shape at the picked point. This method checks the temporal layer to determine if any items are both at the pick point and active according to the displayed time. If there are no elements in the temporal layer, this checks the other geographic layers.

Overrides:

getShapeAt in class GeoCanvas

Parameters:

pickPoint - the point to use to query the geographic layers

Returns:

the highest shape which contains the pick point, or null if no shape contains the pick point.

getWorldColor

public java.awt.Color getWorldColor()

Get the world color. The world color is used to draw the background of the geographic display. Typically, this color is used to draw the oceans.

Overrides:

getWorldColor in class GeoCanvas

Returns:

the current world color, or null if the color has not been set.

isRealTime

public boolean isRealTime()

Return whether this display is in real time mode.

Specified by:

isRealTime in interface TimeDisplay

Returns:

true if this display is in real time mode, false otherwise.

See Also:

TimeDisplay.isRealTime()

paintComponent

protected void paintComponent(java.awt.Graphics g)

Paint this component. This method paints the underlying geographic display, and then draws all temporal components based upon the display time

Overrides:

paintComponent in class GeoCanvas

Parameters:

g - the graphics context

processComponentEvent

protected void processComponentEvent(java.awt.event.ComponentEvent event)

Processes any resize event. Makes sure that the image buffer is the same size as the actual canvas.

Overrides:

processComponentEvent in class java.awt.Component

Parameters:

event - the component event

purgeData

public void purgeData()

Purge any data which has exceeded the purgeTime. Any data associated with temporal sequences are checked against the current displayed time. If the data's most recent active time is older than the purge time, the data is removed. The purgeTime is ignored if it is negative, and no data will be purged.

Specified by:

purgeData in interface TimeDisplay

setDisplayTime

public void setDisplayTime(java.util.Date time)

Set the time currently displayed.

Specified by:

setDisplayTime in interface TimeDisplay

Parameters:

time - the new current time

See Also:

TimeDisplay.setDisplayTime(java.util.Date)

setFadeTime

public void setFadeTime(long millis)

Set the fade time. The fade time is used by certain temporal dynamics to indicate how long an object is visible before or after they are active. If the purge time is positive, it will be set to be at least as large as the fade time.

Specified by:

setFadeTime in interface TimeDisplay

Parameters:

millis - the fade time, in milliseconds.

See Also:

TimeDisplay.setFadeTime(long)

setGeoBounds

public void setGeoBounds(GeoBounds geoBounds)

Sets the geographic bounds.

Specified by:

setGeoBounds in interface GeoDisplay

Overrides:

setGeoBounds in class GeoCanvas

Parameters:

geoBounds - the geo bounds

See Also:

GeoCanvas.setGeoBounds(prajna.geo.GeoBounds)

setLayers

public void setLayers(java.util.Collection<GeoLayer> layers)

Sets the layers displayed. This sets the layers on the underlying geographic canvas, and has no effect on the temporal overlay layer

Specified by:

setLayers in interface GeoDisplay

Overrides:

setLayers in class GeoCanvas

Parameters:

layers - the geographic layers

See Also:

GeoCanvas.setLayers(java.util.Collection)

setProjection

public void setProjection(Projection proj)

Sets the projection.

Specified by:

setProjection in interface GeoDisplay

Overrides:

setProjection in class GeoCanvas

Parameters:

proj - the projection

See Also:

GeoCanvas.setProjection(prajna.geo.Projection)

setPurgeTime

public void setPurgeTime(long millis)

Set the purge time. The purge time determines how long temporal items are retained after their last active segment. If the purge time is negative, no pruning will be done. If the purge time is positive, it will be at least as large as the fadeTime. Data is only purged if the realTime flag has been set.

Specified by:

setPurgeTime in interface TimeDisplay

Parameters:

millis - the purgeTime in milliseconds

setRealTime

public void setRealTime(boolean realTimeFlag)

Set the real time flag. If the realTime flag is set, this class will start an automated timer thread which will continuously synchronize the display with the system time. The current display time will be automatically set to the actual time by the thread.

Specified by:

setRealTime in interface TimeDisplay

Parameters:

realTimeFlag - whether to display in realTime mode

See Also:

TimeDisplay.setRealTime(boolean)

setRenderStyle

public void setRenderStyle(RenderStyle style)

Get the render style, which is used to display the temporal components. Any temporal shape without its own render style will use the render style defined.

Parameters:

style - the renderStyle

setWorldColor

public void setWorldColor(java.awt.Color worldColor)

Set the world color. If worldColor is not null, the geographic extent of the world will be colored with the background color prior to drawing all geographic layers.

Overrides:

setWorldColor in class GeoCanvas

Parameters:

worldColor - the new world color

See Also:

GeoCanvas.setWorldColor(java.awt.Color)