gate.gui

Class SerialControllerEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

gate.creole.AbstractVisualResource

gate.gui.SerialControllerEditor

All Implemented Interfaces:

ControllerListener, CreoleListener, ActionsPublisher, Resource, FeatureBearer, NameBearer, VisualResource, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

@CreoleResource(name="Serial Application Editor",
                guiType=LARGE,
                resourceDisplayed="gate.creole.SerialController",
                mainViewer=true)
public class SerialControllerEditor
extends AbstractVisualResource
implements CreoleListener, ControllerListener, ActionsPublisher

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SerialControllerEditor.CorporaComboModel A model for a combobox containing the loaded corpora in the system
protected class	SerialControllerEditor.InternalProgressListener A simple progress listener used to forward the events upstream.
protected class	SerialControllerEditor.InternalStatusListener A simple status listener used to forward the events upstream.

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

Modifier and Type	Field and Description
protected List<Action>	actionList The list of actions provided by this editor
protected JButton	addButton Adds one or more PR(s) to the controller
protected boolean	analyserMode Is the controller displayed an analyser controller?
protected JRadioButton	conditional_RunRBtn Button for conditional run.
protected boolean	conditionalMode Is the controller displayed conditional?
protected SerialController	controller The controller this editor edits
protected JComboBox	corpusCombo A combobox that allows selection of a corpus from the list of loaded corpora.
protected SerialControllerEditor.CorporaComboModel	corpusComboModel
protected boolean	corpusControllerMode Is the controller displayed a CorpusController?
protected JTextField	featureNameTextField Text field for the feature name for conditional run.
protected JTextField	featureValueTextField Text field for the feature value for conditional run.
protected XJTable	loadedPRsTable Contains all the PRs loaded in the sytem that are not already part of the serial controller
protected gate.gui.SerialControllerEditor.LoadedPRsTableModel	loadedPRsTableModel model for the loadedPRsTable JTable.
protected XJTable	memberPRsTable Displays the PRs in the controller
protected gate.gui.SerialControllerEditor.MemberPRsTableModel	memberPRsTableModel model for memberPRsTable
protected JButton	moveDownButton Moves the module down in the controller list
protected JButton	moveUpButton Moves the module up in the controller list
protected JRadioButton	no_RunRBtn Button for never run.
protected TitledBorder	parametersBorder A border for the parametersPanel
protected ResourceParametersEditor	parametersEditor A component for editing the parameters of the currently selected PR
protected JPanel	parametersPanel A JPanel containing the parametersEditor
protected JButton	removeButton Removes one or more PR(s) from the controller
protected gate.gui.SerialControllerEditor.RunAction	runAction Action that runs the application
protected ButtonGroup	runBtnGrp The group for run strategy buttons;
protected ProcessingResource	selectedPR The PR currently selected (having its parameters set)
protected RunningStrategy	selectedPRRunStrategy The running strategy for the selected PR.
protected TitledBorder	strategyBorder A border for the running strategy options box
protected JPanel	strategyPanel A JPanel containing the running strategy options
protected JRadioButton	yes_RunRBtn Button for run always.

Fields inherited from class gate.creole.AbstractVisualResource

features, handle

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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
SerialControllerEditor()

Method Summary

Modifier and Type	Method and Description
void	addProgressListener(ProgressListener l)
void	addStatusListener(StatusListener l)
void	cleanup() Cleans the internal data and prepares this object to be collected
static void	clearAllSelections() Forces all open controller editors to refresh the list of selected PRs.
void	datastoreClosed(CreoleEvent e) Called when a DataStore has been closed
void	datastoreCreated(CreoleEvent e) Called when a DataStore has been created
void	datastoreOpened(CreoleEvent e) Called when a DataStore has been opened
protected void	fireProcessFinished()
protected void	fireProgressChanged(int e)
protected void	fireStatusChanged(String e)
List<Action>	getActions() Returns a list of Action objects.
Resource	init() Initialise this resource, and return it.
protected void	initGuiComponents()
protected void	initListeners()
protected void	initLocalData()
void	removeProgressListener(ProgressListener l)
void	removeStatusListener(StatusListener l)
void	resourceAdded(ControllerEvent evt) Called by the controller when a new PR has been added.
void	resourceLoaded(CreoleEvent e) Called when a new Resource has been loaded into the system
void	resourceRemoved(ControllerEvent evt) Called by the controller when a new PR has been removed.
void	resourceRenamed(Resource resource, String oldName, String newName) Called when the creole register has renamed a resource.1
void	resourceUnloaded(CreoleEvent e) Called when a Resource has been removed from the system
protected void	selectPR(int index) Called when a PR has been selected in the member PRs table;
void	setHandle(Handle handle) Used by the main GUI to tell this VR what handle created it.
void	setTarget(Object target) Called by the GUI when this viewer/editor has to initialise itself for a specific object.

Methods inherited from class gate.creole.AbstractVisualResource

getFeatures, getInitParameterValues, getParameterValue, setFeatures, setParameterValue, setParameterValues

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, 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, 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

Methods inherited from interface gate.VisualResource

targetReinitialised

Methods inherited from interface gate.util.NameBearer

getName, setName

Field Detail

controller

protected SerialController controller

The controller this editor edits

actionList

protected List<Action> actionList

The list of actions provided by this editor

loadedPRsTable

protected XJTable loadedPRsTable

Contains all the PRs loaded in the sytem that are not already part of the serial controller

loadedPRsTableModel

protected gate.gui.SerialControllerEditor.LoadedPRsTableModel loadedPRsTableModel

model for the loadedPRsTable JTable.

memberPRsTable

protected XJTable memberPRsTable

Displays the PRs in the controller

memberPRsTableModel

protected gate.gui.SerialControllerEditor.MemberPRsTableModel memberPRsTableModel

model for memberPRsTable

addButton

protected JButton addButton

Adds one or more PR(s) to the controller

removeButton

protected JButton removeButton

Removes one or more PR(s) from the controller

moveUpButton

protected JButton moveUpButton

Moves the module up in the controller list

moveDownButton

protected JButton moveDownButton

Moves the module down in the controller list

parametersEditor

protected ResourceParametersEditor parametersEditor

A component for editing the parameters of the currently selected PR

parametersPanel

protected JPanel parametersPanel

A JPanel containing the parametersEditor

parametersBorder

protected TitledBorder parametersBorder

A border for the parametersPanel

strategyPanel

protected JPanel strategyPanel

A JPanel containing the running strategy options

strategyBorder

protected TitledBorder strategyBorder

A border for the running strategy options box

yes_RunRBtn

protected JRadioButton yes_RunRBtn

Button for run always.

no_RunRBtn

protected JRadioButton no_RunRBtn

Button for never run.

conditional_RunRBtn

protected JRadioButton conditional_RunRBtn

Button for conditional run.

runBtnGrp

protected ButtonGroup runBtnGrp

The group for run strategy buttons;

featureNameTextField

protected JTextField featureNameTextField

Text field for the feature name for conditional run.

featureValueTextField

protected JTextField featureValueTextField

Text field for the feature value for conditional run.

corpusCombo

protected JComboBox corpusCombo

A combobox that allows selection of a corpus from the list of loaded corpora.

corpusComboModel

protected SerialControllerEditor.CorporaComboModel corpusComboModel

runAction

protected gate.gui.SerialControllerEditor.RunAction runAction

Action that runs the application

corpusControllerMode

protected boolean corpusControllerMode

Is the controller displayed a CorpusController?

analyserMode

protected boolean analyserMode

Is the controller displayed an analyser controller?

conditionalMode

protected boolean conditionalMode

Is the controller displayed conditional?

selectedPR

protected ProcessingResource selectedPR

The PR currently selected (having its parameters set)

selectedPRRunStrategy

protected RunningStrategy selectedPRRunStrategy

The running strategy for the selected PR.

Constructor Detail

SerialControllerEditor

public SerialControllerEditor()

Method Detail

clearAllSelections

public static void clearAllSelections()

Forces all open controller editors to refresh the list of selected PRs. This should be called before any other code attempts to update a runtime parameter to ensure that the PR being edited isn't selected so that changes in it's parameters are correctly stored and not overwritten by subsequent GUI actions

setTarget

public void setTarget(Object target)

Description copied from class: AbstractVisualResource

Called by the GUI when this viewer/editor has to initialise itself for a specific object.

Specified by:

setTarget in interface VisualResource

Overrides:

setTarget in class AbstractVisualResource

Parameters:

target - the object (be it a Resource, DataStore or whatever) this viewer has to display

setHandle

public void setHandle(Handle handle)

Description copied from class: AbstractVisualResource

Used by the main GUI to tell this VR what handle created it. The VRs can use this information e.g. to add items to the popup for the resource.

Specified by:

setHandle in interface VisualResource

Overrides:

setHandle in class AbstractVisualResource

init

public Resource init()
              throws ResourceInstantiationException

Description copied from class: AbstractVisualResource

Initialise this resource, and return it.

Specified by:

init in interface Resource

Overrides:

init in class AbstractVisualResource

Throws:

ResourceInstantiationException

initLocalData

protected void initLocalData()

initGuiComponents

protected void initGuiComponents()

initListeners

protected void initListeners()

getActions

public List<Action> getActions()

Description copied from interface: ActionsPublisher

Returns a list of Action objects. This method will be called everytime a menu for this resource needs to be built, thus allowing for dynamic updates to the list of actions. A null value in this list will cause a separator to be created.

Specified by:

getActions in interface ActionsPublisher

Returns:

a List of Actions.

cleanup

public void cleanup()

Cleans the internal data and prepares this object to be collected

Specified by:

cleanup in interface Resource

Overrides:

cleanup in class AbstractVisualResource

selectPR

protected void selectPR(int index)

Called when a PR has been selected in the member PRs table;

Parameters:

index - row index in memberPRsTable (or -1 if no PR is currently selected)

resourceLoaded

public void resourceLoaded(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a new Resource has been loaded into the system

Specified by:

resourceLoaded in interface CreoleListener

resourceUnloaded

public void resourceUnloaded(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a Resource has been removed from the system

Specified by:

resourceUnloaded in interface CreoleListener

resourceRenamed

public void resourceRenamed(Resource resource,
                            String oldName,
                            String newName)

Description copied from interface: CreoleListener

Called when the creole register has renamed a resource.1

Specified by:

resourceRenamed in interface CreoleListener

datastoreOpened

public void datastoreOpened(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a DataStore has been opened

Specified by:

datastoreOpened in interface CreoleListener

datastoreCreated

public void datastoreCreated(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a DataStore has been created

Specified by:

datastoreCreated in interface CreoleListener

datastoreClosed

public void datastoreClosed(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a DataStore has been closed

Specified by:

datastoreClosed in interface CreoleListener

removeStatusListener

public void removeStatusListener(StatusListener l)

resourceAdded

public void resourceAdded(ControllerEvent evt)

Description copied from interface: ControllerListener

Called by the controller when a new PR has been added.

Specified by:

resourceAdded in interface ControllerListener

Parameters:

evt - the event.

resourceRemoved

public void resourceRemoved(ControllerEvent evt)

Description copied from interface: ControllerListener

Called by the controller when a new PR has been removed.

Specified by:

resourceRemoved in interface ControllerListener

Parameters:

evt - the event.

addStatusListener

public void addStatusListener(StatusListener l)

fireStatusChanged

protected void fireStatusChanged(String e)

removeProgressListener

public void removeProgressListener(ProgressListener l)

addProgressListener

public void addProgressListener(ProgressListener l)

fireProgressChanged

protected void fireProgressChanged(int e)

fireProcessFinished

protected void fireProcessFinished()