thredds.ui.catalog.query

Class QueryChooser

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

thredds.ui.catalog.query.QueryChooser

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class QueryChooser
extends JPanel

Choose datasets from a Dataset Query Capabilities (DQC) XML document. The user interface is built dynamically based on what is in the DQC.

When the user selects dataset, a PropertyChangeEvent is thrown, see addPropertyChangeListener for details.

Example:

 node = (prefs == null) ? null : (PreferencesExt) prefs.node("dqc");
 queryChooser = new QueryChooser(node);
 queryChooser.addPropertyChangeListener( new PropertyChangeListener() {
 public void propertyChange( PropertyChangeEvent e) {
 if (e.getPropertyName().equals("Dataset")) doSomething();
 }
 });
 queryChooser.setDataset( dqc_dataset);
 

Author:

John Caron

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, 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
QueryChooser(PreferencesExt prefs, boolean showCombo) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addButton(AbstractButton b) Add a button to the lower row of buttons.
void	addPropertyChangeListener(PropertyChangeListener l) Add a PropertyChangeEvent Listener.
CatalogChooser	getCatalogChooser() Get the component CatalogChooser
String	getCurrentURL() Get the current DQC URL from the comboBox.
static void	main(String[] args) test
JDialog	makeDialog(RootPaneContainer parent, String title, boolean modal) Convenience routine for making the QC into a dialog.
void	removePropertyChangeListener(PropertyChangeListener l) Remove a PropertyChangeEvent Listener.
void	save() save persistent state
boolean	setDataset(InvDataset ds) Set the DQC from a dataset with access type ServiceType.QC.
void	setDqcUrl(String urlString) Set the DQC from a URL string pointing to a DQC.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, 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, 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

QueryChooser

public QueryChooser(PreferencesExt prefs,
            boolean showCombo)

Constructor.

Parameters:

prefs - store persistent info

showCombo - add combobox, keep list of DQC URLs

Method Detail

setDataset

public boolean setDataset(InvDataset ds)

Set the DQC from a dataset with access type ServiceType.QC.

Parameters:

ds - InvDataset with an access of ServiceType.QC

Returns:

true if successful

setDqcUrl

public void setDqcUrl(String urlString)
               throws MalformedURLException,
                      IOException

Set the DQC from a URL string pointing to a DQC.

Parameters:

urlString - url of the qc document

Throws:

MalformedURLException - : if urlString is malformed.

IOException - : error reading qc

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Add a PropertyChangeEvent Listener. Throws a PropertyChangeEvent:

• propertyName = "Dataset", getNewValue() = an InvDataset chosen.

Overrides:

addPropertyChangeListener in class Container

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Remove a PropertyChangeEvent Listener.

Overrides:

removePropertyChangeListener in class Component

save

public void save()

save persistent state

getCurrentURL

public String getCurrentURL()

Get the current DQC URL from the comboBox.

getCatalogChooser

public CatalogChooser getCatalogChooser()

Get the component CatalogChooser

addButton

public void addButton(AbstractButton b)

Add a button to the lower row of buttons.

makeDialog

public JDialog makeDialog(RootPaneContainer parent,
                 String title,
                 boolean modal)

Convenience routine for making the QC into a dialog. Do not call before calling setDataset() or setQC(). Use dialog.show() and dialog.setVisible(true) to popup and hide.

Parameters:

parent - parent of the dialog, usually a JFrame

title - Dialog title; if null, use QC name

modal - is modal

Returns:

the JDialog

main

public static void main(String[] args)

test