edu.wisc.ssec.mcidas.adde

Class GetAreaGUI

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

edu.wisc.ssec.mcidas.adde.GetAreaGUI

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class GetAreaGUI
extends javax.swing.JPanel

A GUI wrapper for whatever class/method tries to get image data via ADDE, but needs a way to let the user explore the availability of data. Possible defaults are written into the GetAreaGUI.properties file, and when the user indicates "use my defaults", these are employed when ever the correct combo of server/group/descr are chosen.

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.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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
GetAreaGUI(java.awt.Frame owner, boolean modal, java.lang.String s, boolean multi, boolean coa)
GetAreaGUI(java.awt.Frame owner, boolean modal, java.lang.String s, boolean multi, boolean coa, boolean dodialog)
GetAreaGUI(java.lang.String s)
GetAreaGUI(java.lang.String s, boolean multi)
GetAreaGUI(java.lang.String s, boolean multi, boolean coa)
GetAreaGUI(java.lang.String s, boolean multi, boolean coa, boolean modal)

Method Summary

Modifier and Type	Method and Description
void	addActionListener(java.awt.event.ActionListener o)
java.lang.String	getBand() fetch the current band number
java.lang.String	getCal() fetch the current Calibration type
java.lang.String	getCoordType() fetch the current coordinate type
java.lang.String	getDay() return the day of the selected image
java.lang.String	getDay(int index)
java.lang.String	getDescr() fetch the name (abreviation) of the currently selected dataset (descr)
java.lang.String	getDoc() fetch the state of the doc request switch
int	getEleMag() get the Element magnification
java.lang.String	getGroup() fetch the name of the currently selected ADDE group
java.util.List	getImageList()
int	getLinMag() fetch the current line magnification factor
java.lang.String	getLocationString() fetch the current locatoin string
java.lang.String	getMag() get the magnification factors (line element)
java.lang.String	getNumLinesEles() fetch the number of lines and elements defined
java.lang.String	getProjectNumber() fetch the currently defined project number
java.lang.String	getServer() fetch the name of the currently selected ADDE server
java.lang.String	getTime() get the time of the selected image
java.lang.String	getTime(int index) get the time of the index-th selected image
java.lang.String	getUnit() fetch the name of the units defined
java.lang.String	getUserName() fetch the currently defined user name
static void	main(java.lang.String[] args)
void	removeActionListener(java.awt.event.ActionListener o)
void	setBand(java.lang.String c) define the satellite band number to use
void	setCal(java.lang.String c) define the calibration type to use (e.g., "VISSR")
void	setCoordType(java.lang.String c) define the coodinate type for the centered location values
void	setDateTime(java.lang.String d, java.lang.String t)
void	setDay(java.lang.String d) set the day
void	setDescr(java.lang.String s) force the selection of a particular ADDE Descr (dataset).
void	setDoc(java.lang.String v) define whether the "documentation block" will be returned with the data.
void	setEleMag(int m) set the element magnification factor.
void	setGroup(java.lang.String s) force a particular ADDE Group to be selected.
void	setLineMag(int m) define the value of the line maginfication (-50 thru +50).
void	setLocationString(java.lang.String c) define the location(s) for the coodinate type.
void	setMag(java.lang.String m) set the maginification (line element) factors
void	setNumLinesEles(java.lang.String c) define the size of the image to get
void	setProjectNumber(java.lang.String c) define a project number, which is required by some ADDE servers
void	setServer(java.lang.String s) define the name of the ADDE server to select
void	setTime(java.lang.String t) set the time
void	setUnit(java.lang.String c) define the units of the data to get
void	setUserName(java.lang.String c) define a user name (required by some ADDE servers for accounting).
void	show()
void	status(java.lang.String m)
java.lang.String	toString()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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, 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, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GetAreaGUI

public GetAreaGUI(java.lang.String s)

Parameters:

s - is the label for the action button

GetAreaGUI

public GetAreaGUI(java.lang.String s,
                  boolean multi)

Parameters:

s - is the label for the action button

multi - is true if multiple selection mode is to be used (this does not work yet!!)

GetAreaGUI

public GetAreaGUI(java.lang.String s,
                  boolean multi,
                  boolean coa)

Parameters:

s - is the label for the action button

multi - is true if multiple selection mode is to be used (this does not work yet!!)

coa - is true if the Dialog should close the window after the actionPerformed is done.

GetAreaGUI

public GetAreaGUI(java.lang.String s,
                  boolean multi,
                  boolean coa,
                  boolean modal)

Parameters:

s - is the label for the action button

multi - is true if multiple selection mode is to be used (this does not work yet!!)

coa - is true if the Dialog should close the window after the actionPerformed is done.

modal - is true if this should be a modal dialog

GetAreaGUI

public GetAreaGUI(java.awt.Frame owner,
                  boolean modal,
                  java.lang.String s,
                  boolean multi,
                  boolean coa)

Parameters:

owner - is the top-level Frame that owns this

modal - is true if this should be a modal dialog

s - is the label for the action button

multi - is true if multiple selection mode is to be used (this does not work yet!!)

coa - is true if the Dialog should close the window after the actionPerformed is done.

GetAreaGUI

public GetAreaGUI(java.awt.Frame owner,
                  boolean modal,
                  java.lang.String s,
                  boolean multi,
                  boolean coa,
                  boolean dodialog)

Parameters:

owner - is the top-level Frame that owns this

modal - is true if this should be a modal dialog

s - is the label for the action button

multi - is true if multiple selection mode is to be used (this does not work yet!!)

coa - is true if the Dialog should close the window after the actionPerformed is done.

dodialog - is true if this should pop up a Dialog interface box. If this is false, then owner and modal may be null.

Method Detail

show

public void show()

Overrides:

show in class java.awt.Component

setServer

public void setServer(java.lang.String s)

define the name of the ADDE server to select

Parameters:

s - - The ADDE server hostname.

getServer

public java.lang.String getServer()

fetch the name of the currently selected ADDE server

Returns:

The ADDE server (host) name

setGroup

public void setGroup(java.lang.String s)

force a particular ADDE Group to be selected. If this is done, then then you must also select the Dataset (aka Descr).

Parameters:

s - The name of the ADDE data group

getGroup

public java.lang.String getGroup()

fetch the name of the currently selected ADDE group

Returns:

the ADDE group name (abreviation)

setDescr

public void setDescr(java.lang.String s)

force the selection of a particular ADDE Descr (dataset). This will trigger fetch from the server of available times/days.

Parameters:

s - The name (abreviation) of the dataset (aka 'descr')

getDescr

public java.lang.String getDescr()

fetch the name (abreviation) of the currently selected dataset (descr)

Returns:

The name (abreviation) of the selected dataset/descr

setMag

public void setMag(java.lang.String m)

set the maginification (line element) factors

getMag

public java.lang.String getMag()

get the magnification factors (line element)

Returns:

string of line & element magnification, separated by a space

setLineMag

public void setLineMag(int m)

define the value of the line maginfication (-50 thru +50). Calling this also forces the Element Magnification to be set to this value. You may set it separately, as needed.

Parameters:

m - The value of the line magnification (-50 thru +50). Values of -1, 0, and 1 will be treated as 1.

getLinMag

public int getLinMag()

fetch the current line magnification factor

Returns:

the line magnification factor

setEleMag

public void setEleMag(int m)

set the element magnification factor. This call should be made after a call to setLineMag()

Parameters:

m - The element magnification factor (-50 thru +50). Values of -1, 0, and 1 are treated as 1.

getEleMag

public int getEleMag()

get the Element magnification

Returns:

element magnification factor

setCoordType

public void setCoordType(java.lang.String c)

define the coodinate type for the centered location values

Parameters:

c - coordinate = "E" for earth, "I" for image, "S" for radar station

getCoordType

public java.lang.String getCoordType()

fetch the current coordinate type

Returns:

coordinate type value ("E", "I", or "S")

setLocationString

public void setLocationString(java.lang.String c)

define the location(s) for the coodinate type. It is assumed that you will call setCoordType() and then setLocationString() with consistent values.

Parameters:

c - The coordinate locations. If two values, separate by one of more blanks. For Earth coordinate, the latitude and longitude (e.g., "43.1234 -89.2313"); for Image coordinates, the line and element (e.g., "12345 23412"), and for Radar Stations, the station name (e.g., "KMKX").

getLocationString

public java.lang.String getLocationString()

fetch the current locatoin string

Returns:

The value of the location string(s) as a single string with one blank space between values (if more than one)

setBand

public void setBand(java.lang.String c)

define the satellite band number to use

Parameters:

c - the band number (as a String)

getBand

public java.lang.String getBand()

fetch the current band number

Returns:

the currently selected band number

setNumLinesEles

public void setNumLinesEles(java.lang.String c)

define the size of the image to get

Parameters:

c - The number of lines and number of elements, in a string with one or more blank spaces between (e.g., "480 640")

getNumLinesEles

public java.lang.String getNumLinesEles()

fetch the number of lines and elements defined

Returns:

the number of lines and elements, as a String with one blank between values (e.g., "480 640")

getDay

public java.lang.String getDay(int index)

getDay

public java.lang.String getDay()

return the day of the selected image

Returns:

the day in the format: yyyy-mm-dd

setDay

public void setDay(java.lang.String d)

set the day

Parameters:

d - the day in the form: yyyy-mm-dd

getTime

public java.lang.String getTime(int index)

get the time of the index-th selected image

getTime

public java.lang.String getTime()

get the time of the selected image

Returns:

the time in the format: hh:mm:ss

setTime

public void setTime(java.lang.String t)

set the time

Parameters:

t - is the time in the format: hh:mm:ss

setDateTime

public void setDateTime(java.lang.String d,
                        java.lang.String t)

setUnit

public void setUnit(java.lang.String c)

define the units of the data to get

Parameters:

c - the name of the Units (e.g., "BRIT")

getUnit

public java.lang.String getUnit()

fetch the name of the units defined

Returns:

the name of the units

setCal

public void setCal(java.lang.String c)

define the calibration type to use (e.g., "VISSR")

Parameters:

c - the calibration type

getCal

public java.lang.String getCal()

fetch the current Calibration type

Returns:

the current calibration type

setDoc

public void setDoc(java.lang.String v)

define whether the "documentation block" will be returned with the data.

Parameters:

v - set to 'true' to return the history documentation.

getDoc

public java.lang.String getDoc()

fetch the state of the doc request switch

Returns:

the state of the doc request switch

setUserName

public void setUserName(java.lang.String c)

define a user name (required by some ADDE servers for accounting). If given, this will be included in all requests generated by GetAreaGUI.

Parameters:

c - The user's ADDE identifier (e.g., "jack")

getUserName

public java.lang.String getUserName()

fetch the currently defined user name

Returns:

the currently defined user name

setProjectNumber

public void setProjectNumber(java.lang.String c)

define a project number, which is required by some ADDE servers

Parameters:

c - The project number to use (e.g., "12345")

getProjectNumber

public java.lang.String getProjectNumber()

fetch the currently defined project number

Returns:

the project number value

status

public void status(java.lang.String m)

addActionListener

public void addActionListener(java.awt.event.ActionListener o)

removeActionListener

public void removeActionListener(java.awt.event.ActionListener o)

getImageList

public java.util.List getImageList()

toString

public java.lang.String toString()

Overrides:

toString in class java.awt.Component

main

public static void main(java.lang.String[] args)

Parameters:

args - the command line arguments