Package org.apache.uima.taeconfigurator.editors.ui

Class ParameterSection

java.lang.Object

org.eclipse.ui.forms.AbstractFormPart

org.eclipse.ui.forms.SectionPart

org.apache.uima.taeconfigurator.editors.ui.AbstractSection

org.apache.uima.taeconfigurator.editors.ui.AbstractSectionParm

org.apache.uima.taeconfigurator.editors.ui.ParameterSection

All Implemented Interfaces:

StandardStrings, org.eclipse.swt.widgets.Listener, org.eclipse.ui.forms.IFormPart

public class ParameterSection
extends AbstractSectionParm

The Class ParameterSection.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	GIVE_WARNING_MESSAGE	The Constant GIVE_WARNING_MESSAGE.
static final int	NEW_OVERRIDE	The Constant NEW_OVERRIDE.
static final boolean	REMOVE_FROM_GUI	The Constant REMOVE_FROM_GUI.

Fields inherited from class org.apache.uima.taeconfigurator.editors.ui.AbstractSectionParm

COMMON_GROUP, COMMON_GROUP_HEADER, commonParms, cpd, DELEGATE_HEADER, EXTERNAL_OVERRIDE_INDICATOR, FLOWCTLR_HEADER, GROUP_HEADER, groupParms, MULTI_VALUE_INDICATOR, nameHeader, NO_EXTERNAL_OVERRIDE_INDICATOR, NOT_IN_ANY_GROUP, NOT_IN_ANY_GROUP_HEADER, OPTIONAL_INDICATOR, OVERRIDE_HEADER, parameterSectionTree, REQUIRED_INDICATOR, settings, settingsTree, showOverrides, SINGLE_VALUE_INDICATOR, splitGroupNames, tree, typeNamesW

Fields inherited from class org.apache.uima.taeconfigurator.editors.ui.AbstractSection

capabilityArray0, configurationGroup0, configurationGroupArray0, configurationParameter0, configurationParameterArray0, editor, ENABLED, EQUAL_WIDTH, externalResourceBinding0, externalResourceDescription0, featureDescriptionArray0, fsIndexDescription0, HEADER_VISIBLE, HORIZONTAL_BUTTONS, IMPORTABLE_PART_CONTEXT, initialFormWidth, LINES_VISIBLE, nameValuePairArray0, NO_MIN_HEIGHT, NOT_SELECTED, NOTHING_SELECTED, PLUGIN_ID, SELECTED, sofaMapping0, stringArray0, toolkit, treeItemArray0, typeDescription0, typePriorityList0, valueChanged, VERTICAL_BUTTONS, WIDTH_NOT_SPECIFIED

Fields inherited from interface org.apache.uima.taeconfigurator.StandardStrings

S_, S_ADD, S_DESCRIPTION, S_DOWN, S_DOWN_TIP, S_EDIT, S_EDIT_TIP, S_EXPORT, S_EXPORT_TIP, S_REMOVE, S_REMOVE_TIP, S_UP, S_UP_TIP

Constructor Summary

Constructors

Constructor	Description
ParameterSection(MultiPageEditor editor, org.eclipse.swt.widgets.Composite parent)	Creates a section to show a list of all parameters.

Method Summary

Modifier and Type	Method	Description
ConfigGroup	addGroup(ConfigGroup group)	Called to add group to aggregate parm decl based on delegate group.
void	addOverride(ConfigurationParameter parmInGroup, String override)	Called from ParameterDelegatesSection to add an override.
void	addParm(String name, ConfigurationParameter modelParm, ConfigGroup group, String override)	Adds the parm.
void	enable()	Enable.
protected void	fillOverrides(org.eclipse.swt.widgets.TreeItem parent, ConfigurationParameter modelCP)	Called by addNewConfigurationParameter, and fill (via refresh) to add overrides to the tree list.
org.eclipse.swt.widgets.Tree	getTree()	Gets the tree.
void	handleEvent(org.eclipse.swt.widgets.Event event)
static boolean	haveSharedGroup(String[] set1, String[] set2)	Have shared group.
void	initialize(org.eclipse.ui.forms.IManagedForm form)
boolean	parameterNameAlreadyDefined(String name, ConfigGroup cgset)	Parameter name already defined.
static boolean	parameterNameAlreadyDefinedNoMsg(String name, ConfigurationParameterDeclarations pCpd)	Parameter name already defined no msg.
boolean	parameterNameAlreadyDefinedNoMsg(String name, ConfigGroup cgset)	Check if safe to add a parameter to a group-set.
void	refresh()

Methods inherited from class org.apache.uima.taeconfigurator.editors.ui.AbstractSectionParm

addGroupToGUI, addNewConfigurationParameterToGUI, clearAndRefillTree, disposeAllChildItems, fill, fillParmItem, getAllGroupNames, getAllGroupNames, getConfigurationParameterSettings, getCorrespondingModelGroup, getCorrespondingModelParm, getItemIndex, getItemIndex, getModelSettings, getName, getName, getSettingsGroups, getSettingsGroupTreeItemByName, getSettingsParameter, groupNameArrayToString, groupNamesToArray, isCommonGroup, isCommonGroupSelection, isDelegate, isGroup, isGroupSelection, isNOT_IN_ANY_GROUP, isOverride, isOverrideSelection, isParameter, isParmSelection, parmGuiString, removeCommonParmSettingsFromMultipleGroups, removeIncludedParmSettingsFromMultipleGroups, removeIncludedParmSettingsFromSingleGroup, removeParmSettingFromMultipleGroups, setGroupText, setSettings, showDescriptionAsToolTip, updateParmInSettingsGUI

Methods inherited from class org.apache.uima.taeconfigurator.editors.ui.AbstractSection

addCapabilitySet, addListenerForPastableWidget, convertNull, copyTableItem, copyTreeItem, createByNameImport, createImport, createLocationImport, enableBorders, enableCtrl, finishAggregateChangeAction, formatName, getAnalysisEngineMetaData, getAvailableTypeNames, getCapabilities, getCapabilities, getCapabilitySofaNames, getCapabilitySofaNames, getConfigurationParameterDeclarations, getDelegateAnalysisEngineSpecifiersWithImports, getDescriptionForDescriptor, getExternalResourceBindings, getExternalResourceDependencies, getExternalResources, getFeature, getFlowControllerDeclaration, getFsIndexCollection, getFsIndexDescriptionFromTableTreeItem, getIndex, getIndex, getItemIndex, getMergedTypeSystemDescription, getMetaDataFromDescription, getNameSpace, getOperationalProperties, getPreviousSelection, getResourceManagerConfiguration, getShortFeatureName, getShortName, getSofaMappings, getSofaMappings, getToolkit, getTypeFromFullFeatureName, getTypeOrFeature, getTypePriorities, getTypeSystemDescription, handleDefaultIndexKind, isAeDescriptor, isAggregate, isArrayOrListType, isCasConsumerDescriptor, isCasInitializerDescriptor, isCollectionReaderDescriptor, isExtResAndBindingsDescriptor, isFlowControllerDescriptor, isFSArrayOrListType, isIndexableRange, isIndexDescriptor, isJmsDescriptor, isLocalProcessingDescriptor, isParmGroup, isPrimitive, isTypePriorityDescriptor, isTypeSystemDescriptor, isValidAe, isValidAggregateChange, markRestOfPageStale, markStale, markStaleIfDifferent, maybeSetSelection, maybeShortenFileName, multiLineFix, new2ColumnComposite, new3ColumnComposite, new4ColumnComposite, newButtonContainer, newButtonContainer, newCComboWithTip, newCheckBox, newComposite, newDescriptionTextBox, newLabeledCComboWithTip, newLabeledTextField, newLabeledTextField, newLabelWithData, newLabelWithTip, newLabelWithTip, newNcolumnComposite, newPushButton, newPushButton, newPushButton, newRadioButton, newTable, newTable, newTable, newTableColumn, newTableColumn, newTableColumn, newTableColumn, newTextWithTip, newTextWithTip, newTree, newTree, newTreeColumn, newTreeColumn, newTreeColumn, newTreeColumn, newUnUpdatableTextWithTip, packTable, packTree, parseDescriptor, parseDescriptor, parseToFitInToolTips, produceUniqueComponentKey, readImport, removeChildren, requestPopUpOverImport, revertMsg, revertOrContinue, revertTypeSystem, setButtonSelection, setFileDirty, setFlowControllerDeclaration, setMargins, setSelectionOneUp, setToolTipText, setupToPrintFile, setValueChanged, setValueChangedBoolean, setValueChangedCapitalBoolean, setValueChangedInt, setValueChangedKeys, setVnsHostAndPort, setVnsHostAndPort, showExceptionReadingImportedDescriptor, spacer, stringArrayAdd, stringArrayRemove, swapIndexKeys, swapTableItems, swapTreeItems, typeOrFeatureArrayAdd, typeOrFeatureArrayRemove, typeOrFeatureArrayRemove

Methods inherited from class org.eclipse.ui.forms.SectionPart

expansionStateChanged, expansionStateChanging, getSection, hookListeners, setFocus

Methods inherited from class org.eclipse.ui.forms.AbstractFormPart

commit, dispose, getManagedForm, isDirty, isStale, markDirty, markStale, setFormInput

Methods inherited from class java.lang.Object

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

Field Details

NEW_OVERRIDE

public static final int NEW_OVERRIDE

The Constant NEW_OVERRIDE.

See Also:

• Constant Field Values

REMOVE_FROM_GUI

public static final boolean REMOVE_FROM_GUI

The Constant REMOVE_FROM_GUI.

See Also:

• Constant Field Values

GIVE_WARNING_MESSAGE

public static final boolean GIVE_WARNING_MESSAGE

The Constant GIVE_WARNING_MESSAGE.

See Also:

• Constant Field Values

Constructor Details

ParameterSection

public ParameterSection(MultiPageEditor editor,
 org.eclipse.swt.widgets.Composite parent)

Creates a section to show a list of all parameters.

Parameters:

editor - backpointer to the main multipage editor

parent - the Composite where this section lives

Method Details

initialize

public void initialize(org.eclipse.ui.forms.IManagedForm form)

Specified by:

initialize in interface org.eclipse.ui.forms.IFormPart

Overrides:

initialize in class AbstractSection

refresh

public void refresh()

Specified by:

refresh in interface org.eclipse.ui.forms.IFormPart

Overrides:

refresh in class org.eclipse.ui.forms.AbstractFormPart

handleEvent

public void handleEvent(org.eclipse.swt.widgets.Event event)

Specified by:

handleEvent in interface org.eclipse.swt.widgets.Listener

Specified by:

handleEvent in class AbstractSectionParm

addParm

public void addParm(String name,
 ConfigurationParameter modelParm,
 ConfigGroup group,
 String override)

Adds the parm.

Parameters:

name - the name

modelParm - the model parm

group - the group

override - the override

addGroup

public ConfigGroup addGroup(ConfigGroup group)

Called to add group to aggregate parm decl based on delegate group.

Parameters:

group - the delegate group needing to be added to the aggregate

Returns:

the config group

addOverride

public void addOverride(ConfigurationParameter parmInGroup,
 String override)

Called from ParameterDelegatesSection to add an override.

Parameters:

parmInGroup - the parm in group

override - the override

fillOverrides

protected void fillOverrides(org.eclipse.swt.widgets.TreeItem parent,
 ConfigurationParameter modelCP)

Called by addNewConfigurationParameter, and fill (via refresh) to add overrides to the tree list.

Overrides:

fillOverrides in class AbstractSectionParm

Parameters:

parent - the parent

modelCP - the model CP

parameterNameAlreadyDefinedNoMsg

public static boolean parameterNameAlreadyDefinedNoMsg(String name,
 ConfigurationParameterDeclarations pCpd)

Parameter name already defined no msg.

Parameters:

name - the name

pCpd - the cpd

Returns:

true, if successful

parameterNameAlreadyDefinedNoMsg

public boolean parameterNameAlreadyDefinedNoMsg(String name,
 ConfigGroup cgset)

Check if safe to add a parameter to a group-set. If in the no-name set check just it. If in the COMMON set check it and all of the named group-sets If in a named group-set check if in the COMMON group, and also if in any other group-set that has a group name in common

Parameters:

name - - Parameter name

cgset - - Group-set (may be not-in-any, common, or a named set)

Returns:

true, if successful

haveSharedGroup

public static boolean haveSharedGroup(String[] set1,
 String[] set2)

Have shared group.

Parameters:

set1 - the set 1

set2 - the set 2

Returns:

true, if successful

parameterNameAlreadyDefined

public boolean parameterNameAlreadyDefined(String name,
 ConfigGroup cgset)

Parameter name already defined.

Parameters:

name - the name

cgset - the cgset

Returns:

true, if successful

enable

public void enable()

Description copied from class: AbstractSection

Enable.

Overrides:

enable in class AbstractSectionParm

getTree

public org.eclipse.swt.widgets.Tree getTree()

Gets the tree.

Returns:

the tree