net.sourceforge.nite.search
Class GUI

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      net.sourceforge.nite.search.GUI

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Runnable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.CaretListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants, QueryHandler

public class GUI
extends javax.swing.JFrame
implements java.awt.event.WindowListener, java.awt.event.ActionListener, javax.swing.event.CaretListener, java.awt.event.KeyListener, java.lang.Runnable, QueryHandler

Simple grahic user interface for Engine. GUI offers a window with a text form to type in the query, a submit button, a result panel and some other functions.

Author:

Holger Voormann, Halyna Seniv

See Also:

Serialized Form

Field Summary

boolean	showTime
static java.lang.String	TITLE

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

GUI(SearchableCorpus nom)
Sets up a search window as a slave where we have already loaded a corpus.

GUI(java.lang.String installDir)
Opens a new Search window

Method Summary

void	actionPerformed(java.awt.event.ActionEvent event) Set of actions started by the menus or bottons.
void	caretUpdate(javax.swing.event.CaretEvent e) If query input is being changed deactivate result panel.
void	close() Closes window.
void	closeCorpus()
void	deregisterHandler(SimpleQueryResultHandler handler)
void	deregisterResultHandler(QueryResultHandler display) remove an interface element that will be informed of results
void	exit() Closes window and exits program.
Engine	getEngine() Returns the serch engine.
java.util.List	getLayers() Returns all layers of the loaded corpus as a list of Strings.
int	getNumberOfSublayers(java.lang.String layer) Returns how many sublayers there are in the specified layer.
int	getSublayer(NOMElement element) Returns the number of the sublayer of the specified element, where 0 is the root sublayer.
boolean	isCorpusLoaded()
void	keyPressed(java.awt.event.KeyEvent event)
void	keyReleased(java.awt.event.KeyEvent event) Subit query if CTRL+RETURN is typed.
void	keyTyped(java.awt.event.KeyEvent event)
void	loadCorpus()
void	loadCorpus(java.lang.String corpusPath)
static void	main(java.lang.String[] args) Creats a new #GUI().
void	notifyFullResultList() Forces a notify of the full resultslist to all resulthandlers.
void	performQuery(java.lang.String newQuery) Perform the query and display the results on-screen
void	popupSearchWindow()
void	querySubmitted(java.lang.String query)
void	registerHandler(SimpleQueryResultHandler handler)
void	registerResultHandler(QueryResultHandler display) add an interface element that will be informed of results.
void	run() New query will be executed by a new thread.
void	savePreferences()
void	windowActivated(java.awt.event.WindowEvent event) NOP (methode needed for implementing WindowListener).
void	windowClosed(java.awt.event.WindowEvent event) NOP (methode needed for implementing WindowListener).
void	windowClosing(java.awt.event.WindowEvent event) Processes exit().
void	windowDeactivated(java.awt.event.WindowEvent event) NOP (methode needed for implementing WindowListener).
void	windowDeiconified(java.awt.event.WindowEvent event) NOP (methode needed for implementing WindowListener).
void	windowIconified(java.awt.event.WindowEvent event) NOP (methode needed for implementing WindowListener).
void	windowOpened(java.awt.event.WindowEvent event) NOP (methode needed for implementing WindowListener).

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

TITLE

public static final java.lang.String TITLE

See Also:

Constant Field Values

showTime

public boolean showTime

Constructor Detail

GUI

public GUI(SearchableCorpus nom)

Sets up a search window as a slave where we have already loaded a corpus. Doesn't open a window (use popupSearchWindow to do that). Added by Jonathan Kilgour 23/1/04.

GUI

public GUI(java.lang.String installDir)

Opens a new Search window

Method Detail

main

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

Creats a new #GUI().

Parameters:

args - parameter isn't used

windowActivated

public void windowActivated(java.awt.event.WindowEvent event)

NOP (methode needed for implementing WindowListener).

Specified by:

windowActivated in interface java.awt.event.WindowListener

Parameters:

event - parameter isn't used

windowClosed

public void windowClosed(java.awt.event.WindowEvent event)

NOP (methode needed for implementing WindowListener).

Specified by:

windowClosed in interface java.awt.event.WindowListener

Parameters:

event - parameter isn't used

windowClosing

public void windowClosing(java.awt.event.WindowEvent event)

Processes exit().

Specified by:

windowClosing in interface java.awt.event.WindowListener

Parameters:

event - parameter isn't used

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent event)

NOP (methode needed for implementing WindowListener).

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

Parameters:

event - parameter isn't used

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent event)

NOP (methode needed for implementing WindowListener).

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

Parameters:

event - parameter isn't used

windowIconified

public void windowIconified(java.awt.event.WindowEvent event)

NOP (methode needed for implementing WindowListener).

Specified by:

windowIconified in interface java.awt.event.WindowListener

Parameters:

event - parameter isn't used

windowOpened

public void windowOpened(java.awt.event.WindowEvent event)

NOP (methode needed for implementing WindowListener).

Specified by:

windowOpened in interface java.awt.event.WindowListener

Parameters:

event - parameter isn't used

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Set of actions started by the menus or bottons.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

event - event.getActionCommand() is used to know which action has to execute

isCorpusLoaded

public boolean isCorpusLoaded()

loadCorpus

public void loadCorpus()

closeCorpus

public void closeCorpus()

loadCorpus

public void loadCorpus(java.lang.String corpusPath)

caretUpdate

public void caretUpdate(javax.swing.event.CaretEvent e)

If query input is being changed deactivate result panel.

Specified by:

caretUpdate in interface javax.swing.event.CaretListener

Parameters:

e - parameter isn't used

keyTyped

public void keyTyped(java.awt.event.KeyEvent event)

Specified by:

keyTyped in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent event)

Subit query if CTRL+RETURN is typed.

Specified by:

keyReleased in interface java.awt.event.KeyListener

Parameters:

event - the keyevent

keyPressed

public void keyPressed(java.awt.event.KeyEvent event)

Specified by:

keyPressed in interface java.awt.event.KeyListener

exit

public void exit()

Closes window and exits program.

close

public void close()

Closes window.

run

public void run()

New query will be executed by a new thread.

Specified by:

run in interface java.lang.Runnable

savePreferences

public void savePreferences()

getLayers

public java.util.List getLayers()

Returns all layers of the loaded corpus as a list of Strings.

Returns:

all layers of the loaded corpus as a list of Strings

getNumberOfSublayers

public int getNumberOfSublayers(java.lang.String layer)

Returns how many sublayers there are in the specified layer.

Parameters:

layer - the layer containing the sublayers

Returns:

how many sublayers there are in the specified layer

getSublayer

public int getSublayer(NOMElement element)

Returns the number of the sublayer of the specified element, where 0 is the root sublayer. All elements of a flat layer are sublayer 0.

Parameters:

element - the element in the sublayer

Returns:

the number of the sublayer of the specified element

getEngine

public Engine getEngine()

Returns the serch engine.

Returns:

the serch engine

querySubmitted

public void querySubmitted(java.lang.String query)

registerResultHandler

public void registerResultHandler(QueryResultHandler display)

add an interface element that will be informed of results.

Specified by:

registerResultHandler in interface QueryHandler

deregisterResultHandler

public void deregisterResultHandler(QueryResultHandler display)

remove an interface element that will be informed of results

Specified by:

deregisterResultHandler in interface QueryHandler

performQuery

public void performQuery(java.lang.String newQuery)

Perform the query and display the results on-screen

Specified by:

performQuery in interface QueryHandler

popupSearchWindow

public void popupSearchWindow()

Specified by:

popupSearchWindow in interface QueryHandler

notifyFullResultList

public void notifyFullResultList()

Forces a notify of the full resultslist to all resulthandlers. Added Dennis Reidsma 22-11-2006

registerHandler

public void registerHandler(SimpleQueryResultHandler handler)

deregisterHandler

public void deregisterHandler(SimpleQueryResultHandler handler)