You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2016/11/13 16:13:18 UTC
svn commit: r1769512 [8/15] - in /uima/uimaj/branches/experiment-v3-jcas:
uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/
uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/
uimaj-ep-cas-editor/src/main/java/org/apache/uim...
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSectionParm.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSectionParm.java?rev=1769512&r1=1769511&r2=1769512&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSectionParm.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSectionParm.java Sun Nov 13 16:13:16 2016
@@ -44,31 +44,41 @@ import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
+// TODO: Auto-generated Javadoc
/**
+ * The Class AbstractSectionParm.
*/
public abstract class AbstractSectionParm extends AbstractSection {
+ /** The Constant NOT_IN_ANY_GROUP. */
public final static String NOT_IN_ANY_GROUP = Messages
.getString("AbstractSectionParm.notInAnyGroup"); //$NON-NLS-1$
+ /** The Constant COMMON_GROUP. */
public final static String COMMON_GROUP = Messages.getString("AbstractSectionParm.common"); //$NON-NLS-1$
// maintainers note: names below have extra trailing blanks to get them to approximately line up
+ /** The Constant DELEGATE_HEADER. */
// where possible
protected final static String DELEGATE_HEADER = Messages
.getString("AbstractSectionParm.delegateKeyName"); //$NON-NLS-1$
+ /** The Constant FLOWCTLR_HEADER. */
protected final static String FLOWCTLR_HEADER = "Flow Controller Key Name: ";
+ /** The Constant GROUP_HEADER. */
protected final static String GROUP_HEADER = Messages
.getString("AbstractSectionParm.headerGroupNames"); //$NON-NLS-1$
+ /** The Constant COMMON_GROUP_HEADER. */
protected final static String COMMON_GROUP_HEADER = Messages
.getString("AbstractSectionParm.headerCommon"); //$NON-NLS-1$
+ /** The Constant NOT_IN_ANY_GROUP_HEADER. */
protected final static String NOT_IN_ANY_GROUP_HEADER = Messages
.getString("AbstractSectionParm.headerNotInAnyGroup"); //$NON-NLS-1$
+ /** The override header. */
protected final String OVERRIDE_HEADER = Messages.getString("AbstractSectionParm.overrides"); // nonstatic
// for
@@ -78,58 +88,82 @@ public abstract class AbstractSectionPar
// subclass
// //$NON-NLS-1$
+ /** The Constant MULTI_VALUE_INDICATOR. */
protected final static String MULTI_VALUE_INDICATOR = "Multi "; //$NON-NLS-1$
+ /** The Constant SINGLE_VALUE_INDICATOR. */
protected final static String SINGLE_VALUE_INDICATOR = "Single "; //$NON-NLS-1$
+ /** The Constant OPTIONAL_INDICATOR. */
protected final static String OPTIONAL_INDICATOR = "Opt "; //$NON-NLS-1$
+ /** The Constant REQUIRED_INDICATOR. */
protected final static String REQUIRED_INDICATOR = "Req "; //$NON-NLS-1$
+ /** The Constant EXTERNAL_OVERRIDE_INDICATOR. */
protected final static String EXTERNAL_OVERRIDE_INDICATOR = "XO "; //$NON-NLS-1$
+ /** The Constant NO_EXTERNAL_OVERRIDE_INDICATOR. */
protected final static String NO_EXTERNAL_OVERRIDE_INDICATOR = " ";
+ /** The name header. */
protected final String nameHeader = " Name: "; //$NON-NLS-1$
+ /** The Constant typeNamesW. */
protected final static Map<String,String> typeNamesW = new HashMap<String,String>(4);
static { // map extra spaces to get these to take the same
typeNamesW.put("Boolean", "Boolean "); //$NON-NLS-1$ //$NON-NLS-2$
typeNamesW.put("Float", "Float "); //$NON-NLS-1$ //$NON-NLS-2$
typeNamesW.put(Messages.getString("AbstractSectionParm.16"),
- "Integer "); //$NON-NLS-1$ //$NON-NLS-2$
+ "Integer "); //$NON-NLS-1$
typeNamesW.put("String", "String "); //$NON-NLS-1$ //$NON-NLS-2$
}
+ /** The tree. */
protected Tree tree;
+ /** The parameter section tree. */
protected Tree parameterSectionTree = null;
+ /** The show overrides. */
protected boolean showOverrides;
+ /** The split group names. */
protected boolean splitGroupNames;
+ /** The common parms. */
protected ConfigurationParameter[] commonParms;
+ /** The group parms. */
protected Map groupParms;
+ /** The cpd. */
protected ConfigurationParameterDeclarations cpd;
+ /** The settings. */
// settings set by other page when it is created
protected ParameterSettingsSection settings = null;
+ /** The settings tree. */
protected Tree settingsTree = null;
+ /**
+ * Sets the settings.
+ *
+ * @param v the new settings
+ */
public void setSettings(ParameterSettingsSection v) {
settings = v;
settingsTree = v.getTree();
}
/**
- * @param aEditor
- * @param parent
- * @param header
- * @param description
+ * Instantiates a new abstract section parm.
+ *
+ * @param aEditor the a editor
+ * @param parent the parent
+ * @param header the header
+ * @param description the description
*/
public AbstractSectionParm(MultiPageEditor aEditor, Composite parent, String header,
String description) {
@@ -141,6 +175,7 @@ public abstract class AbstractSectionPar
*
* @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
*/
+ @Override
public void enable() {
}
@@ -149,15 +184,18 @@ public abstract class AbstractSectionPar
*
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
+ @Override
public abstract void handleEvent(Event event);
- /*************************************************************************************************
- * methods shared with multiple param pages ****************************************
- */
-
+ /* ***********************************************************************************************
+ * methods shared with multiple param pages
+ *************************************************************************************************/
+
/**
+ *
* Two modes: settingsDisplayMode - if true, shows groups one name at a time, and puts all
* <common> parms in other groups
+ * @param usingGroups the using groups
*/
protected void clearAndRefillTree(boolean usingGroups) {
cpd = getConfigurationParameterDeclarations();
@@ -209,6 +247,11 @@ public abstract class AbstractSectionPar
}
}
+ /**
+ * Expand all items.
+ *
+ * @param items the items
+ */
private void expandAllItems(TreeItem[] items) {
TreeItem[] containedItems;
for (int i = 0; i < items.length; i++) {
@@ -220,7 +263,11 @@ public abstract class AbstractSectionPar
}
/**
- * Called by refresh; add a normal named group and a set of parmaters
+ * Called by refresh; add a normal named group and a set of parmaters.
+ *
+ * @param parms the parms
+ * @param names the names
+ * @param modelCG the model CG
*/
private void fillGroup(ConfigurationParameter[] parms, String[] names, ConfigurationGroup modelCG) {
fillGroup(parms, groupNameArrayToString(names), modelCG);
@@ -229,9 +276,10 @@ public abstract class AbstractSectionPar
/**
* called by refresh() for <Common> and refresh() for named, via another path with names as array
* first converted to concatenated string.
- *
- * @param parms
- * @param names
+ *
+ * @param parms the parms
+ * @param names the names
+ * @param modelCG the model CG
*/
private void fillGroup(ConfigurationParameter[] parms, String names, ConfigurationGroup modelCG) {
if (splitGroupNames) {
@@ -260,6 +308,9 @@ public abstract class AbstractSectionPar
}
}
+ /**
+ * Fill groups from group parms.
+ */
private void fillGroupsFromGroupParms() {
for (Iterator grpInfo = groupParms.entrySet().iterator(); grpInfo.hasNext();) {
Map.Entry entry = (Map.Entry) grpInfo.next();
@@ -276,11 +327,10 @@ public abstract class AbstractSectionPar
}
/**
- * called by refresh() when no groups, just plain parm sets, also for group case
- *
- * @param parms
- * @param group
- * <Not in any group> if not in a group, otherwise the group tree item
+ * called by refresh() when no groups, just plain parm sets, also for group case.
+ *
+ * @param parms the parms
+ * @param group <Not in any group> if not in a group, otherwise the group tree item
*/
protected void fill(ConfigurationParameter[] parms, TreeItem group) {
if (parms == null)
@@ -290,6 +340,12 @@ public abstract class AbstractSectionPar
}
}
+ /**
+ * Group name array to string.
+ *
+ * @param strings the strings
+ * @return the string
+ */
public static String groupNameArrayToString(String[] strings) {
StringBuffer b = new StringBuffer();
for (int i = 0; i < strings.length; i++) {
@@ -300,6 +356,12 @@ public abstract class AbstractSectionPar
return b.toString();
}
+ /**
+ * Group names to array.
+ *
+ * @param names the names
+ * @return the string[]
+ */
protected String[] groupNamesToArray(String names) {
if (names.equals(NOT_IN_ANY_GROUP))
return new String[] { names };
@@ -329,9 +391,9 @@ public abstract class AbstractSectionPar
* Takes an existing model parm and fills a pre-allocated treeItem. 3 callers:
* addNewConfigurationParameter, alterExistingConfigurationParamater (editing), fill (bulk update
* from refresh)
- *
- * @param item
- * @param parm
+ *
+ * @param item the item
+ * @param parm the parm
*/
protected void fillParmItem(TreeItem item, ConfigurationParameter parm) {
item.setText(parmGuiString(parm));
@@ -342,14 +404,26 @@ public abstract class AbstractSectionPar
item.setData(parm);
}
+ /**
+ * Parm gui string.
+ *
+ * @param parm the parm
+ * @return the string
+ */
protected String parmGuiString(ConfigurationParameter parm) {
return ((parm.isMultiValued()) ? MULTI_VALUE_INDICATOR : SINGLE_VALUE_INDICATOR)
+ ((parm.isMandatory()) ? REQUIRED_INDICATOR : OPTIONAL_INDICATOR)
+ typeNamesW.get(parm.getType())
+ ((parm.getExternalOverrideName()==null) ? NO_EXTERNAL_OVERRIDE_INDICATOR : EXTERNAL_OVERRIDE_INDICATOR)
- + nameHeader + parm.getName(); //$NON-NLS-1$
+ + nameHeader + parm.getName();
}
+ /**
+ * Sets the group text.
+ *
+ * @param groupItem the group item
+ * @param names the names
+ */
protected void setGroupText(TreeItem groupItem, String names) {
if (names.equals(COMMON_GROUP))
groupItem.setText(COMMON_GROUP_HEADER);
@@ -361,6 +435,13 @@ public abstract class AbstractSectionPar
groupItem.setText(GROUP_HEADER + groupNameArrayToString(groupNamesToArray(names)));
}
+ /**
+ * Adds the group to GUI.
+ *
+ * @param names the names
+ * @param cg the cg
+ * @return the tree item
+ */
protected TreeItem addGroupToGUI(String names, ConfigurationGroup cg) {
TreeItem groupItem = new TreeItem(tree, SWT.NONE);
setGroupText(groupItem, names);
@@ -387,6 +468,13 @@ public abstract class AbstractSectionPar
return groupItem;
}
+ /**
+ * Contains group.
+ *
+ * @param groupName the group name
+ * @param settingsItems the settings items
+ * @return true, if successful
+ */
private boolean containsGroup(String groupName, final TreeItem[] settingsItems) {
for (int i = 0; i < settingsItems.length; i++) {
if (groupName.equals(getName(settingsItems[i])))
@@ -396,9 +484,9 @@ public abstract class AbstractSectionPar
}
/**
- * This is called sometimes with Settings group
- *
- * @param newCP
+ * This is called sometimes with Settings group.
+ *
+ * @param newCP the new CP
* @param group -
* is never null. May be <Not in any group>, indicate no groups; may be the
* "<Common>" group; or may be a regular group with a set of group names
@@ -434,20 +522,44 @@ public abstract class AbstractSectionPar
}
// this is overriden where needed
+ /**
+ * Fill overrides.
+ *
+ * @param parent the parent
+ * @param modelCP the model CP
+ */
// here just make above fn compile OK
protected void fillOverrides(TreeItem parent, ConfigurationParameter modelCP) {
}
+ /**
+ * Checks if is override.
+ *
+ * @param item the item
+ * @return true, if is override
+ */
protected boolean isOverride(TreeItem item) {
return (item.getText().startsWith(OVERRIDE_HEADER));
}
+ /**
+ * Checks if is parameter.
+ *
+ * @param item the item
+ * @return true, if is parameter
+ */
protected boolean isParameter(TreeItem item) {
String s = item.getText();
return (!isGroup(item) && !s.startsWith(DELEGATE_HEADER) && !s.startsWith(FLOWCTLR_HEADER) && !item
.getText().startsWith(OVERRIDE_HEADER));
}
+ /**
+ * Checks if is group.
+ *
+ * @param item the item
+ * @return true, if is group
+ */
// Note: rest of code considers NOT_IN_ANY_GROUP to be a kind of group
protected boolean isGroup(TreeItem item) {
String s = item.getText();
@@ -455,38 +567,88 @@ public abstract class AbstractSectionPar
|| s.startsWith(NOT_IN_ANY_GROUP_HEADER);
}
+ /**
+ * Checks if is not in any group.
+ *
+ * @param item the item
+ * @return true, if is not in any group
+ */
protected boolean isNOT_IN_ANY_GROUP(TreeItem item) {
return item.getText().startsWith(NOT_IN_ANY_GROUP_HEADER);
}
+ /**
+ * Checks if is common group.
+ *
+ * @param item the item
+ * @return true, if is common group
+ */
protected boolean isCommonGroup(TreeItem item) {
return item.getText().startsWith(COMMON_GROUP_HEADER);
}
+ /**
+ * Checks if is delegate.
+ *
+ * @param item the item
+ * @return true, if is delegate
+ */
protected boolean isDelegate(TreeItem item) {
return item.getText().startsWith(DELEGATE_HEADER) || item.getText().startsWith(FLOWCTLR_HEADER);
}
+ /**
+ * Checks if is group selection.
+ *
+ * @return true, if is group selection
+ */
protected boolean isGroupSelection() {
return isGroup(tree.getSelection()[0]);
}
+ /**
+ * Checks if is common group selection.
+ *
+ * @return true, if is common group selection
+ */
protected boolean isCommonGroupSelection() {
return isCommonGroup(tree.getSelection()[0]);
}
+ /**
+ * Checks if is override selection.
+ *
+ * @return true, if is override selection
+ */
protected boolean isOverrideSelection() {
return isOverride(tree.getSelection()[0]);
}
+ /**
+ * Checks if is parm selection.
+ *
+ * @return true, if is parm selection
+ */
protected boolean isParmSelection() {
return isParameter(tree.getSelection()[0]);
}
+ /**
+ * Gets the name.
+ *
+ * @param item the item
+ * @return the name
+ */
protected String getName(TreeItem item) {
return getName(item.getText());
}
+ /**
+ * Gets the name.
+ *
+ * @param s the s
+ * @return the name
+ */
protected String getName(String s) {
if (s.startsWith(NOT_IN_ANY_GROUP_HEADER))
@@ -502,10 +664,24 @@ public abstract class AbstractSectionPar
return s.substring(s.indexOf(nameHeader) + nameHeader.length());
}
+ /**
+ * Gets the item index.
+ *
+ * @param parent the parent
+ * @param child the child
+ * @return the item index
+ */
protected int getItemIndex(TreeItem parent, TreeItem child) {
return getItemIndex(parent.getItems(), child);
}
+ /**
+ * Gets the item index.
+ *
+ * @param parent the parent
+ * @param child the child
+ * @return the item index
+ */
protected int getItemIndex(Tree parent, TreeItem child) {
return getItemIndex(parent.getItems(), child);
}
@@ -513,10 +689,10 @@ public abstract class AbstractSectionPar
/**
* Works between parameter tree and settings tree We don't use any relative index offsets.
* Instead, we search for the item with the same parameter name.
- *
- *
- * @param containingGroup
- * in parm section; if null = means all groups (common parms)
+ *
+ * @param containingGroup in parm section; if null = means all groups (common parms)
+ * @param sourceItemName the source item name
+ * @return the settings parameter
*/
protected TreeItem[] getSettingsParameter(TreeItem containingGroup, String sourceItemName) {
if (null == settingsTree)
@@ -544,6 +720,13 @@ public abstract class AbstractSectionPar
return results;
}
+ /**
+ * Find matching parm.
+ *
+ * @param group the group
+ * @param name the name
+ * @return the tree item
+ */
private TreeItem findMatchingParm(TreeItem group, String name) {
final TreeItem[] items = group.getItems();
for (int i = 0; i < items.length; i++) {
@@ -554,9 +737,9 @@ public abstract class AbstractSectionPar
}
/**
- * get set of settings group from settingsTree that correspond to parmsection group
- *
- * @param group
+ * get set of settings group from settingsTree that correspond to parmsection group.
+ *
+ * @param group the group
* @return set of settings group from settingsTree that correspond to parm-section group
*/
protected TreeItem[] getSettingsGroups(TreeItem group) {
@@ -589,9 +772,9 @@ public abstract class AbstractSectionPar
}
/**
- * find settings tree item for group name
- *
- * @param name
+ * find settings tree item for group name.
+ *
+ * @param name the name
* @return settings tree item for group name
*/
protected TreeItem getSettingsGroupTreeItemByName(String name) {
@@ -603,26 +786,46 @@ public abstract class AbstractSectionPar
throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
}
+ /**
+ * Gets the corresponding model parm.
+ *
+ * @param item the item
+ * @return the corresponding model parm
+ */
protected ConfigurationParameter getCorrespondingModelParm(TreeItem item) {
if (!isParameter(item))
throw new InternalErrorCDE("invalid argument"); //$NON-NLS-1$
return (ConfigurationParameter) item.getData();
}
+ /**
+ * Gets the corresponding model group.
+ *
+ * @param item the item
+ * @return the corresponding model group
+ */
protected ConfigGroup getCorrespondingModelGroup(TreeItem item) {
if (!isGroup(item))
throw new InternalErrorCDE("invalid argument"); //$NON-NLS-1$
return (ConfigGroup) item.getData();
}
+ /**
+ * Gets the configuration parameter settings.
+ *
+ * @return the configuration parameter settings
+ */
public ConfigurationParameterSettings getConfigurationParameterSettings() {
return editor.getAeDescription().getMetaData().getConfigurationParameterSettings();
}
- /*************************************************************************************************
+ /**
+ * ***********************************************************************************************
* * methods affecting the parameter settings. * These run whether or not the settings page has
* been instantiated. * If the settings page is instantiated, that GUI is also updated.
* *******************************************************************
+ *
+ * @return the model settings
*/
public ConfigurationParameterSettings getModelSettings() {
@@ -632,10 +835,9 @@ public abstract class AbstractSectionPar
/**
* Remove a parameter from all groups it lives in the Settings. If settings page is shown, also
* update the GUI.
- *
- * @param parmItem
- * in ParameterSection of parameter belonging to (multiple) groups
- * @param removeFromGUI
+ *
+ * @param parmItem in ParameterSection of parameter belonging to (multiple) groups
+ * @param removeFromGUI the remove from GUI
*/
public void removeParmSettingFromMultipleGroups(TreeItem parmItem, boolean removeFromGUI) {
if (!isParameter(parmItem))
@@ -668,6 +870,13 @@ public abstract class AbstractSectionPar
}
}
+ /**
+ * Update parm in settings GUI.
+ *
+ * @param existingCP the existing CP
+ * @param existingTreeItem the existing tree item
+ * @param prevName the prev name
+ */
public void updateParmInSettingsGUI(ConfigurationParameter existingCP, TreeItem existingTreeItem,
String prevName) {
if (null != settings) {
@@ -679,13 +888,19 @@ public abstract class AbstractSectionPar
}
}
+ /**
+ * Gets the all group names.
+ *
+ * @return the all group names
+ */
protected String[] getAllGroupNames() {
return getAllGroupNames(cpd);
}
/**
- *
- * @param aCpd
+ * Gets the all group names.
+ *
+ * @param aCpd the a cpd
* @return all named groups, excludes <Common> and <Not in any group>
*/
protected String[] getAllGroupNames(ConfigurationParameterDeclarations aCpd) {
@@ -700,6 +915,9 @@ public abstract class AbstractSectionPar
return (String[]) results.toArray(stringArray0);
}
+ /**
+ * Removes the common parm settings from multiple groups.
+ */
public void removeCommonParmSettingsFromMultipleGroups() {
ConfigurationParameterSettings modelSettings = getModelSettings();
String[] allGroupNames = getAllGroupNames();
@@ -737,9 +955,9 @@ public abstract class AbstractSectionPar
* Method: for the group-set, get the parms. Remove just those parms from all groups. Remove the
* group on the settings page (together with common parms for it) if no other group-set has this
* group name Remove the group-set.
- *
- * @param groupNames
- * @param cps
+ *
+ * @param groupNames the group names
+ * @param cps the cps
*/
public void removeIncludedParmSettingsFromMultipleGroups(String[] groupNames,
ConfigurationParameter[] cps) {
@@ -749,10 +967,10 @@ public abstract class AbstractSectionPar
}
/**
- *
- * @param groupName
- * @param cps
- * in ParameterSection of items an array of tree items to remove Can be all items under a
+ * Removes the included parm settings from single group.
+ *
+ * @param groupName the group name
+ * @param cps in ParameterSection of items an array of tree items to remove Can be all items under a
* particular group, or a set of items from different groups
*/
public void removeIncludedParmSettingsFromSingleGroup(String groupName,
@@ -787,6 +1005,11 @@ public abstract class AbstractSectionPar
}
}
+ /**
+ * Dispose all child items.
+ *
+ * @param parent the parent
+ */
public void disposeAllChildItems(TreeItem parent) {
TreeItem[] items = parent.getItems();
for (int j = 0; j < items.length; j++) {
@@ -794,6 +1017,11 @@ public abstract class AbstractSectionPar
}
}
+ /**
+ * Show description as tool tip.
+ *
+ * @param event the event
+ */
protected void showDescriptionAsToolTip(Event event) {
TreeItem item = tree.getItem(new Point(event.x, event.y));
String text = null;
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregatePage.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregatePage.java?rev=1769512&r1=1769511&r2=1769512&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregatePage.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregatePage.java Sun Nov 13 16:13:16 2016
@@ -23,17 +23,33 @@ import org.apache.uima.taeconfigurator.e
import org.apache.uima.taeconfigurator.editors.MultiPageEditor;
import org.eclipse.ui.forms.IManagedForm;
+// TODO: Auto-generated Javadoc
+/**
+ * The Class AggregatePage.
+ */
public class AggregatePage extends HeaderPageWithSash {
+ /** The flow section. */
private FlowSection flowSection;
+ /** The aggregate section. */
private AggregateSection aggregateSection;
+ /**
+ * Instantiates a new aggregate page.
+ *
+ * @param aEditor the a editor
+ */
public AggregatePage(MultiPageEditor aEditor) {
super(aEditor, "Aggregate Component Settings");
}
- /** Called by the framework to fill in the contents */
+ /**
+ * Called by the framework to fill in the contents.
+ *
+ * @param managedForm the managed form
+ */
+ @Override
protected void createFormContent(IManagedForm managedForm) {
final Form2Panel form = setup2ColumnLayout(managedForm, !EQUAL_WIDTH);
@@ -44,10 +60,20 @@ public class AggregatePage extends Heade
createToolBarActions(managedForm);
}
+ /**
+ * Gets the flow section.
+ *
+ * @return the flow section
+ */
public FlowSection getFlowSection() {
return flowSection;
}
+ /**
+ * Gets the aggregate section.
+ *
+ * @return the aggregate section
+ */
public AggregateSection getAggregateSection() {
return aggregateSection;
}
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregateSection.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregateSection.java?rev=1769512&r1=1769511&r2=1769512&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregateSection.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregateSection.java Sun Nov 13 16:13:16 2016
@@ -56,35 +56,50 @@ import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.ui.forms.IManagedForm;
+// TODO: Auto-generated Javadoc
+/**
+ * The Class AggregateSection.
+ */
public class AggregateSection extends AbstractSection {
+ /** The files table. */
private Table filesTable;
+ /** The add button. */
private Button addButton;
+ /** The add remote button. */
private Button addRemoteButton;
+ /** The find analysis engine button. */
private Button findAnalysisEngineButton;
+ /** The remove button. */
private Button removeButton;
+ /** The add to flow button. */
private Button addToFlowButton;
+ /** The remove from flow button. */
private Button removeFromFlowButton;
+ /**
+ * Gets the removes the from flow button.
+ *
+ * @return the removes the from flow button
+ */
public Button getRemoveFromFlowButton() {
return removeFromFlowButton;
}
+ /** The b disable tool tip help. */
private boolean bDisableToolTipHelp = false;
/**
- * Creates a section for aggregate specifiers to add their delegates
- *
- * @param aEditor
- * backpointer to the main multipage editor
- * @param parent
- * the Composite where this section lives
+ * Creates a section for aggregate specifiers to add their delegates.
+ *
+ * @param aEditor backpointer to the main multipage editor
+ * @param parent the Composite where this section lives
*/
public AggregateSection(MultiPageEditor aEditor, Composite parent) {
super(aEditor, parent, "Component Engines",
@@ -97,6 +112,7 @@ public class AggregateSection extends Ab
*
* @see org.eclipse.ui.forms.IFormPart#initialize(org.eclipse.ui.forms.IManagedForm)
*/
+ @Override
public void initialize(IManagedForm form) {
super.initialize(form);
@@ -157,6 +173,7 @@ public class AggregateSection extends Ab
*
* @see org.eclipse.ui.forms.IFormPart#refresh()
*/
+ @Override
public void refresh() {
super.refresh();
@@ -213,6 +230,7 @@ public class AggregateSection extends Ab
*
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
+ @Override
public void handleEvent(Event event) {
if (event.widget == addButton)
handleAdd();
@@ -250,6 +268,9 @@ public class AggregateSection extends Ab
}
}
+ /**
+ * Handle add.
+ */
private void handleAdd() {
MultiResourceSelectionDialogWithFlowOption dialog = new MultiResourceSelectionDialogWithFlowOption(
@@ -271,6 +292,14 @@ public class AggregateSection extends Ab
}
}
+ /**
+ * Produce key add delegate.
+ *
+ * @param shortName the short name
+ * @param fullPathFileName the full path file name
+ * @param addToFlow the add to flow
+ * @param isImportByName the is import by name
+ */
private void produceKeyAddDelegate(String shortName, String fullPathFileName, boolean addToFlow,
boolean isImportByName) {
boolean bSuccess = false;
@@ -293,6 +322,9 @@ public class AggregateSection extends Ab
}
}
+ /**
+ * Handle remove.
+ */
private void handleRemove() {
// get the keyName to remove
int nSelectionIndex = filesTable.getSelectionIndex();
@@ -375,6 +407,9 @@ public class AggregateSection extends Ab
// removed delegate (if params dont appear elsewhere)
}
+ /**
+ * Handle add to flow.
+ */
private void handleAddToFlow() {
String node = filesTable.getSelection()[0].getText(1);
addNodeToFlow(node);
@@ -387,7 +422,9 @@ public class AggregateSection extends Ab
}
/**
- * @param node
+ * Adds the node to flow.
+ *
+ * @param node the node
*/
private void addNodeToFlow(String node) {
FlowSection fs = editor.getAggregatePage().getFlowSection();
@@ -395,6 +432,9 @@ public class AggregateSection extends Ab
// fs.refresh(); // the fs.addNode does a refresh
}
+ /**
+ * Handle remove from flow.
+ */
private void handleRemoveFromFlow() {
FlowSection fs = editor.getAggregatePage().getFlowSection();
String selectedKey = fs.getFlowList().getSelection()[0].getText();
@@ -410,6 +450,7 @@ public class AggregateSection extends Ab
}
}
+ /** The Constant REMOTE_TEMPLATE. */
private final static String REMOTE_TEMPLATE = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"
+ "<uriSpecifier xmlns=\"http://uima.apache.org/resourceSpecifier\">\n"
+ " <resourceType>{0}</resourceType>\n" + // AnalysisEngine CasConsumer
@@ -418,6 +459,7 @@ public class AggregateSection extends Ab
" <timeout>{3}</timeout>" + " {4}" + // <parameters> for VNS </parameters>
"\n</uriSpecifier>";
+ /** The Constant REMOTE_JMS_TEMPLATE. */
private final static String REMOTE_JMS_TEMPLATE = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"
+ "<customResourceSpecifier xmlns=\"http://uima.apache.org/resourceSpecifier\">\n"
+ " <resourceClassName>org.apache.uima.aae.jms_adapter.JmsAnalysisEngineServiceAdapter</resourceClassName>\n"
@@ -428,11 +470,14 @@ public class AggregateSection extends Ab
+ " </parameters>\n"
+ "</customResourceSpecifier>";
+ /**
+ * Handle add remote.
+ */
private void handleAddRemote() {
String sDescriptorPath = editor.getFile().getParent().getLocation().toString() + '/';
AddRemoteServiceDialog dialog = new AddRemoteServiceDialog(this, sDescriptorPath);
dialog.open();
- if (dialog.getReturnCode() == InputDialog.CANCEL)
+ if (dialog.getReturnCode() == Window.CANCEL)
return;
String sServiceType = dialog.getSelectedServiceTypeName();
@@ -497,6 +542,14 @@ public class AggregateSection extends Ab
}
}
+ /**
+ * Adds the param.
+ *
+ * @param sb the sb
+ * @param name the name
+ * @param value the value
+ * @return the string builder
+ */
private StringBuilder addParam(StringBuilder sb, String name, String value) {
if (value != null && value.length() > 0) {
sb = sb.append(" <parameter name=\"").append(name).append("\" value=\"").append(value).append("\"/>\n");
@@ -504,9 +557,13 @@ public class AggregateSection extends Ab
return sb;
}
+ /** The Constant delegateComponentStringHeadersLC. */
private static final String[] delegateComponentStringHeadersLC = new String[] {
"<analysisenginedescription", "<casconsumerdescription", "<taedescription" };
+ /**
+ * Handle find analysis engine.
+ */
private void handleFindAnalysisEngine() {
FindComponentDialog dialog1 = new FindComponentDialog(
this,
@@ -555,6 +612,11 @@ public class AggregateSection extends Ab
finishAggregateChangeAction();
}
+ /**
+ * Handle table context menu request.
+ *
+ * @param event the event
+ */
private void handleTableContextMenuRequest(Event event) {
TableItem item = filesTable.getItem(new Point(event.x, event.y));
if (null == item) {
@@ -569,6 +631,11 @@ public class AggregateSection extends Ab
bDisableToolTipHelp = false;
}
+ /**
+ * Handle table hover help.
+ *
+ * @param event the event
+ */
private void handleTableHoverHelp(Event event) {
TableItem item = filesTable.getItem(new Point(event.x, event.y));
String sDesc = "";
@@ -582,6 +649,15 @@ public class AggregateSection extends Ab
filesTable.setToolTipText(sDesc);
}
+ /**
+ * Adds the delegate.
+ *
+ * @param fileName the file name
+ * @param shortName the short name
+ * @param keyName the key name
+ * @param isImportByName the is import by name
+ * @return true, if successful
+ */
private boolean addDelegate(String fileName, String shortName, String keyName,
boolean isImportByName) {
Import imp;
@@ -632,6 +708,12 @@ public class AggregateSection extends Ab
return true;
}
+ /**
+ * Checks if is new key.
+ *
+ * @param keyName the key name
+ * @return true, if is new key
+ */
private boolean isNewKey(String keyName) {
for (int i = 0; i < filesTable.getItemCount(); i++) {
if (filesTable.getItem(i).getText(1).equals(keyName)) {
@@ -641,6 +723,11 @@ public class AggregateSection extends Ab
return true;
}
+ /**
+ * Adds the parameters for delegate.
+ *
+ * @param tae the tae
+ */
public void addParametersForDelegate(AnalysisEngineDescription tae) {
ConfigurationParameter[] candidateNewParams = tae.getAnalysisEngineMetaData()
.getConfigurationParameterDeclarations().getConfigurationParameters();
@@ -719,6 +806,10 @@ public class AggregateSection extends Ab
}
}
+ /* (non-Javadoc)
+ * @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
+ */
+ @Override
public void enable() {
boolean isPrimitive = isPrimitive();
boolean bEnable = (filesTable.getSelectionIndex() > -1);
@@ -731,10 +822,10 @@ public class AggregateSection extends Ab
}
/**
- * adds a tableItem to the table
- *
- * @param fileName
- * @param keyName
+ * adds a tableItem to the table.
+ *
+ * @param o the o
+ * @param keyName the key name
*/
private void addFile(Object o, String keyName) {
Import impItem = (Import) o;
@@ -748,6 +839,11 @@ public class AggregateSection extends Ab
item.setText(1, keyName);
}
+ /**
+ * Gets the table.
+ *
+ * @return the table
+ */
public Table getTable() {
return filesTable;
}
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilityPage.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilityPage.java?rev=1769512&r1=1769511&r2=1769512&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilityPage.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilityPage.java Sun Nov 13 16:13:16 2016
@@ -24,17 +24,30 @@ import org.apache.uima.taeconfigurator.e
import org.eclipse.swt.SWT;
import org.eclipse.ui.forms.IManagedForm;
+// TODO: Auto-generated Javadoc
+/**
+ * The Class CapabilityPage.
+ */
public class CapabilityPage extends HeaderPageWithSash {
+ /** The sofa map section. */
private SofaMapSection sofaMapSection;
+ /**
+ * Instantiates a new capability page.
+ *
+ * @param aEditor the a editor
+ */
public CapabilityPage(MultiPageEditor aEditor) {
super(aEditor, "Capabilities");
}
/**
- * Called by the framework to fill in the contents
+ * Called by the framework to fill in the contents.
+ *
+ * @param managedForm the managed form
*/
+ @Override
protected void createFormContent(IManagedForm managedForm) {
final Form2Panel form2Panel = setup2ColumnLayout(managedForm, editor.isAggregate() ? 50 : 90,
editor.isAggregate() ? 50 : 10);
@@ -48,6 +61,11 @@ public class CapabilityPage extends Head
managedForm.getForm().reflow(true);
}
+ /**
+ * Gets the sofa map section.
+ *
+ * @return the sofa map section
+ */
public SofaMapSection getSofaMapSection() {
return sofaMapSection;
}
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilitySection.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilitySection.java?rev=1769512&r1=1769511&r2=1769512&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilitySection.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilitySection.java Sun Nov 13 16:13:16 2016
@@ -50,76 +50,120 @@ import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.ui.forms.IManagedForm;
+// TODO: Auto-generated Javadoc
+/**
+ * The Class CapabilitySection.
+ */
public class CapabilitySection extends AbstractSection {
+ /** The Constant CAPABILITY_SET. */
private final static String CAPABILITY_SET = "Set";
+ /** The Constant INPUT. */
private final static String INPUT = "Input";
+ /** The Constant OUTPUT. */
private final static String OUTPUT = "Output";
+ /** The Constant ALL_FEATURES. */
public final static String ALL_FEATURES = "<all features>";
+ /** The Constant TYPE_TITLE. */
private final static String TYPE_TITLE = "Type:";
+ /** The Constant FEAT_TITLE. */
private final static String FEAT_TITLE = "F:"; // not shown, in data field
+ /** The Constant NAME_TITLE. */
private final static String NAME_TITLE = "Name ";
+ /** The Constant NAMESPACE_TITLE. */
private final static String NAMESPACE_TITLE = "Name Space";
+ /** The Constant LANGS_TITLE. */
private final static String LANGS_TITLE = "Languages";
+ /** The Constant LANG_TITLE. */
private final static String LANG_TITLE = "L:"; // not shown, in datafield
+ /** The Constant SOFAS_TITLE. */
private final static String SOFAS_TITLE = "Sofas";
+ /** The Constant SOFA_TITLE. */
private final static String SOFA_TITLE = "S:"; // not shown, in data field
+ /** The Constant CS. */
private final static int CS = 1;
+ /** The Constant TYPE. */
private final static int TYPE = 1 << 1;
+ /** The Constant FEAT. */
private final static int FEAT = 1 << 2;
+ /** The Constant LANG. */
private final static int LANG = 1 << 3;
+ /** The Constant LANG_ITEM. */
private final static int LANG_ITEM = 1 << 4;
+ /** The Constant SOFA. */
private final static int SOFA = 1 << 5;
+ /** The Constant SOFA_ITEM. */
private final static int SOFA_ITEM = 1 << 6;
+ /** The Constant TITLE_COL. */
public final static int TITLE_COL = 0;
+ /** The Constant NAME_COL. */
public final static int NAME_COL = 1;
+ /** The Constant INPUT_COL. */
public final static int INPUT_COL = 2;
+ /** The Constant OUTPUT_COL. */
public final static int OUTPUT_COL = 3;
+ /** The Constant NAMESPACE_COL. */
public final static int NAMESPACE_COL = 4;
+ /** The tt. */
TableTree tt; // for inner class access
+ /** The add capability button. */
private Button addCapabilityButton;
+ /** The add lang button. */
private Button addLangButton;
+ /** The add type button. */
private Button addTypeButton;
+ /** The add sofa button. */
private Button addSofaButton;
+ /** The add edit feature button. */
private Button addEditFeatureButton;
+ /** The edit button. */
private Button editButton;
+ /** The remove button. */
private Button removeButton;
+ /** The type info. */
private Map typeInfo;
+ /** The sofa map section. */
private SofaMapSection sofaMapSection;
+ /**
+ * Instantiates a new capability section.
+ *
+ * @param aEditor the a editor
+ * @param parent the parent
+ */
public CapabilitySection(MultiPageEditor aEditor, Composite parent) {
super(
aEditor,
@@ -128,6 +172,10 @@ public class CapabilitySection extends A
"This section describes the languages handled, and the inputs needed and outputs provided in terms of the Types and Features.");
}
+ /* (non-Javadoc)
+ * @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#initialize(org.eclipse.ui.forms.IManagedForm)
+ */
+ @Override
public void initialize(IManagedForm form) {
super.initialize(form);
@@ -173,6 +221,7 @@ public class CapabilitySection extends A
*
* @see org.eclipse.ui.forms.IFormPart#refresh()
*/
+ @Override
public void refresh() {
super.refresh();
sofaMapSection = editor.getCapabilityPage().getSofaMapSection();
@@ -203,24 +252,41 @@ public class CapabilitySection extends A
}
/**
- * value of hash table keyed on type name
+ * value of hash table keyed on type name.
*/
private static class TypeCapability {
+
+ /** The is input type. */
boolean isInputType; // true if mentioned in <type>
+ /** The is output type. */
boolean isOutputType; // true if mentioned in <type>
+ /** The features. */
Map features = new TreeMap();
}
+ /**
+ * The Class FeatureCapability.
+ */
private static class FeatureCapability {
+
+ /** The is input feature. */
boolean isInputFeature = false;
+ /** The is output type. */
boolean isOutputType = false;
+ /** The is output update. */
boolean isOutputUpdate = false;
}
+ /**
+ * Creates the language header gui.
+ *
+ * @param parent the parent
+ * @return the table tree item
+ */
private TableTreeItem createLanguageHeaderGui(TableTreeItem parent) {
TableTreeItem langHdr = new TableTreeItem(parent, SWT.NONE);
langHdr.setText(TITLE_COL, LANGS_TITLE);
@@ -228,6 +294,12 @@ public class CapabilitySection extends A
return langHdr;
}
+ /**
+ * Creates the sofa header gui.
+ *
+ * @param parent the parent
+ * @return the table tree item
+ */
private TableTreeItem createSofaHeaderGui(TableTreeItem parent) {
TableTreeItem sofaHdr = new TableTreeItem(parent, SWT.NONE);
sofaHdr.setText(TITLE_COL, SOFAS_TITLE);
@@ -235,6 +307,12 @@ public class CapabilitySection extends A
return sofaHdr;
}
+ /**
+ * Fill capability.
+ *
+ * @param parent the parent
+ * @param c the c
+ */
private void fillCapability(TableTreeItem parent, Capability c) {
// first output language capabilities
TableTreeItem langHdr = createLanguageHeaderGui(parent);
@@ -340,12 +418,25 @@ public class CapabilitySection extends A
}
}
+ /**
+ * Sets the gui type name.
+ *
+ * @param item the item
+ * @param typeName the type name
+ */
private void setGuiTypeName(TableTreeItem item, String typeName) {
item.setText(TITLE_COL, TYPE_TITLE);
item.setText(NAME_COL, getShortName(typeName));
item.setText(NAMESPACE_COL, getNameSpace(typeName));
}
+ /**
+ * Sets the gui sofa name.
+ *
+ * @param item the item
+ * @param sofaName the sofa name
+ * @param isInput the is input
+ */
private void setGuiSofaName(TableTreeItem item, String sofaName, boolean isInput) {
item.setData(SOFA_TITLE);
item.setText(NAME_COL, sofaName);
@@ -358,6 +449,12 @@ public class CapabilitySection extends A
}
}
+ /**
+ * Gets the type capability.
+ *
+ * @param typeName the type name
+ * @return the type capability
+ */
private TypeCapability getTypeCapability(String typeName) {
TypeCapability typeCapability = (TypeCapability) typeInfo.get(typeName);
if (null == typeCapability) {
@@ -366,6 +463,13 @@ public class CapabilitySection extends A
return typeCapability;
}
+ /**
+ * Gets the feature capability.
+ *
+ * @param tc the tc
+ * @param featureShortName the feature short name
+ * @return the feature capability
+ */
private FeatureCapability getFeatureCapability(TypeCapability tc, String featureShortName) {
FeatureCapability fc = (FeatureCapability) tc.features.get(featureShortName);
if (null == fc) {
@@ -374,6 +478,12 @@ public class CapabilitySection extends A
return fc;
}
+ /**
+ * Gets the type name from full feature name.
+ *
+ * @param name the name
+ * @return the type name from full feature name
+ */
public String getTypeNameFromFullFeatureName(String name) {
return (name.substring(0, name.indexOf(":")));
}
@@ -383,6 +493,7 @@ public class CapabilitySection extends A
*
* @see org.apache.uima.taeconfigurator.editors.ui.AbstractTableSection#handleEvent(org.eclipse.swt.widgets.Event)
*/
+ @Override
public void handleEvent(Event event) {
if (event.type == SWT.Expand || event.type == SWT.Collapse) {
pack04();
@@ -415,6 +526,9 @@ public class CapabilitySection extends A
enable();
}
+ /**
+ * Handle add capability.
+ */
private void handleAddCapability() {
Capability newCset = addCapabilitySet();
@@ -432,6 +546,14 @@ public class CapabilitySection extends A
finishAction();
}
+ /**
+ * Gets the or create all feat item.
+ *
+ * @param editItem the edit item
+ * @param column the column
+ * @param inOrOut the in or out
+ * @return the or create all feat item
+ */
private void getOrCreateAllFeatItem(TableTreeItem editItem, int column, String inOrOut) {
TableTreeItem allFeatItem = getAllFeatItem(editItem);
if (null == allFeatItem) {
@@ -442,6 +564,12 @@ public class CapabilitySection extends A
allFeatItem.setText(column, inOrOut);
}
+ /**
+ * Gets the all feat item.
+ *
+ * @param editItem the edit item
+ * @return the all feat item
+ */
private TableTreeItem getAllFeatItem(TableTreeItem editItem) {
TableTreeItem[] subItems = editItem.getItems();
if (null == subItems || subItems.length == 0)
@@ -452,6 +580,12 @@ public class CapabilitySection extends A
return null;
}
+ /**
+ * Removes the all feat item gui.
+ *
+ * @param editItem the edit item
+ * @param column the column
+ */
private void removeAllFeatItemGui(TableTreeItem editItem, int column) {
TableTreeItem allFeatItem = getAllFeatItem(editItem);
if (null == allFeatItem)
@@ -463,6 +597,12 @@ public class CapabilitySection extends A
allFeatItem.dispose();
}
+ /**
+ * Handle edit.
+ *
+ * @param editItem the edit item
+ * @param itemKind the item kind
+ */
private void handleEdit(TableTreeItem editItem, int itemKind) {
Capability c = getCapability(editItem);
switch (itemKind) {
@@ -602,6 +742,13 @@ public class CapabilitySection extends A
}
}
+ /**
+ * Any capability set declares sofa.
+ *
+ * @param name the name
+ * @param isInput the is input
+ * @return true, if successful
+ */
private boolean anyCapabilitySetDeclaresSofa(String name, boolean isInput) {
final Capability[] cSets = getAnalysisEngineMetaData().getCapabilities();
for (int i = 0; i < cSets.length; i++) {
@@ -614,6 +761,12 @@ public class CapabilitySection extends A
return false;
}
+ /**
+ * Handle remove.
+ *
+ * @param removeItem the remove item
+ * @param itemKind the item kind
+ */
private void handleRemove(TableTreeItem removeItem, int itemKind) {
Table table = tt.getTable();
int previousSelection = table.getSelectionIndex() - 1;
@@ -657,6 +810,7 @@ public class CapabilitySection extends A
if (!anyCapabilitySetDeclaresSofa(sofaName, isInput)) {
Comparator comparator = new Comparator() {
+ @Override
public int compare(Object o1, Object o2) {
String name = (String) o1;
SofaMapping sofaMapping = (SofaMapping) o2;
@@ -706,6 +860,11 @@ public class CapabilitySection extends A
finishAction();
}
+ /**
+ * Removes the capability set.
+ *
+ * @param c the c
+ */
private void removeCapabilitySet(Capability c) {
Capability[] cs = getAnalysisEngineMetaData().getCapabilities();
Capability[] newCs = new Capability[cs.length - 1];
@@ -716,22 +875,54 @@ public class CapabilitySection extends A
getAnalysisEngineMetaData().setCapabilities(newCs);
}
+ /**
+ * Checks if is input.
+ *
+ * @param item the item
+ * @return true, if is input
+ */
private boolean isInput(TableTreeItem item) {
return INPUT.equals(item.getText(INPUT_COL)); // works if getText() returns null
}
+ /**
+ * Checks if is output.
+ *
+ * @param item the item
+ * @return true, if is output
+ */
private boolean isOutput(TableTreeItem item) {
return OUTPUT.equals(item.getText(OUTPUT_COL));
}
+ /**
+ * Checks if is input.
+ *
+ * @param fullFeatureName the full feature name
+ * @param c the c
+ * @return true, if is input
+ */
public static boolean isInput(String fullFeatureName, Capability c) {
return null != getTypeOrFeature(c.getInputs(), fullFeatureName);
}
+ /**
+ * Checks if is output.
+ *
+ * @param fullFeatureName the full feature name
+ * @param c the c
+ * @return true, if is output
+ */
public static boolean isOutput(String fullFeatureName, Capability c) {
return null != getTypeOrFeature(c.getOutputs(), fullFeatureName);
}
+ /**
+ * Removes the feature.
+ *
+ * @param c the c
+ * @param removeItem the remove item
+ */
private void removeFeature(Capability c, TableTreeItem removeItem) {
String shortFeatureName = removeItem.getText(NAME_COL);
if (shortFeatureName.equals(ALL_FEATURES)) {
@@ -756,10 +947,22 @@ public class CapabilitySection extends A
removeItem.dispose();
}
+ /**
+ * Gets the capability from table tree item.
+ *
+ * @param item the item
+ * @return the capability from table tree item
+ */
public Capability getCapabilityFromTableTreeItem(TableTreeItem item) {
return (Capability) item.getData();
}
+ /**
+ * Handle add lang.
+ *
+ * @param selItem the sel item
+ * @param itemKind the item kind
+ */
private void handleAddLang(TableTreeItem selItem, int itemKind) {
if (itemKind == CS)
selItem = selItem.getItems()[0]; // lang is 1st item in capability set
@@ -789,6 +992,12 @@ public class CapabilitySection extends A
finishAction();
}
+ /**
+ * Handle add type.
+ *
+ * @param selItem the sel item
+ * @param itemKind the item kind
+ */
private void handleAddType(TableTreeItem selItem, int itemKind) {
if (itemKind == LANG || itemKind == TYPE || itemKind == SOFA)
selItem = selItem.getParentItem();
@@ -825,6 +1034,12 @@ public class CapabilitySection extends A
finishAction();
}
+ /**
+ * Handle add sofa.
+ *
+ * @param selItem the sel item
+ * @param itemKind the item kind
+ */
private void handleAddSofa(TableTreeItem selItem, int itemKind) {
if (itemKind == CS)
selItem = selItem.getItems()[1];
@@ -853,6 +1068,12 @@ public class CapabilitySection extends A
finishAction();
}
+ /**
+ * Handle add edit feature.
+ *
+ * @param selItem the sel item
+ * @param itemKind the item kind
+ */
private void handleAddEditFeature(TableTreeItem selItem, int itemKind) {
if (itemKind == FEAT)
selItem = selItem.getParentItem();
@@ -870,6 +1091,14 @@ public class CapabilitySection extends A
addOrEditFeature(dialog, typeName, selItem, c);
}
+ /**
+ * Adds the or edit feature.
+ *
+ * @param dialog the dialog
+ * @param typeName the type name
+ * @param parentItem the parent item
+ * @param c the c
+ */
private void addOrEditFeature(AddCapabilityFeatureDialog dialog, String typeName, // fully
// qualified
TableTreeItem parentItem, Capability c) {
@@ -936,6 +1165,12 @@ public class CapabilitySection extends A
finishAction();
}
+ /**
+ * New feature.
+ *
+ * @param name the name
+ * @return the type or feature
+ */
private TypeOrFeature newFeature(String name) {
TypeOrFeature result = new TypeOrFeature_impl();
result.setType(false);
@@ -943,12 +1178,25 @@ public class CapabilitySection extends A
return result;
}
+ /**
+ * Gets the fully qualified name.
+ *
+ * @param item the item
+ * @return the fully qualified name
+ */
public String getFullyQualifiedName(TableTreeItem item) {
String namespace = item.getText(NAMESPACE_COL);
String name = item.getText(NAME_COL);
return "".equals(namespace) ? name : namespace + "." + name;
}
+ /**
+ * Gets the fully qualified name.
+ *
+ * @param namespace the namespace
+ * @param name the name
+ * @return the fully qualified name
+ */
// used by dialog table -has different columns
public String getFullyQualifiedName(String namespace, String name) {
return (null == namespace || "".equals(namespace)) ? name : namespace + "." + name;
@@ -957,13 +1205,13 @@ public class CapabilitySection extends A
/**
* Given a current list of inputs/ outputs, made up of "Types" and "features", make a new list
* keeping all the types, and keeping all the features that belong to other types, and adding the
- * features that are passed in for one particular type in the "features" parameter
- *
- * @param items
- * @param type
- * A string representing the fully qualified type name
+ * features that are passed in for one particular type in the "features" parameter.
+ *
+ * @param items the items
+ * @param typeName the type name
* @param features -
* associated with the type
+ * @return the type or feature[]
*/
private TypeOrFeature[] replaceFeaturesKeepingTypes(TypeOrFeature[] items, String typeName,
List features) {
@@ -982,12 +1230,12 @@ public class CapabilitySection extends A
}
/**
- *
- * @param items
- * Existing array of TypeOrFeature items (input or output)
- * @param typeName
- * @param isAllFeatures
- * AllFeatures value
+ * Sets the all features.
+ *
+ * @param items Existing array of TypeOrFeature items (input or output)
+ * @param typeName the type name
+ * @param isAllFeatures AllFeatures value
+ * @return the type or feature[]
*/
private TypeOrFeature[] setAllFeatures(TypeOrFeature[] items, String typeName,
boolean isAllFeatures) {
@@ -1007,16 +1255,28 @@ public class CapabilitySection extends A
return items;
}
+ /**
+ * Finish action.
+ */
private void finishAction() {
setFileDirty();
}
+ /**
+ * Pack 04.
+ */
private void pack04() {
tt.getTable().getColumn(TITLE_COL).pack();
tt.getTable().getColumn(NAME_COL).pack();
tt.getTable().getColumn(NAMESPACE_COL).pack();
}
+ /**
+ * Gets the item kind.
+ *
+ * @param item the item
+ * @return the item kind
+ */
private int getItemKind(TableTreeItem item) {
String itemID = item.getText(TITLE_COL);
@@ -1038,6 +1298,10 @@ public class CapabilitySection extends A
throw new InternalErrorCDE("invalid state");
}
+ /* (non-Javadoc)
+ * @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
+ */
+ @Override
public void enable() {
addCapabilityButton.setEnabled(true);
@@ -1053,6 +1317,13 @@ public class CapabilitySection extends A
removeButton.setEnabled((kind & (CS + SOFA_ITEM + LANG_ITEM + FEAT + TYPE)) > 0);
}
+ /**
+ * Dialog for language.
+ *
+ * @param c the c
+ * @param dialog the dialog
+ * @return the int
+ */
private int dialogForLanguage(Capability c, CommonInputDialog dialog) {
for (;;) {
if (dialog.open() == Window.CANCEL)
@@ -1077,6 +1348,12 @@ public class CapabilitySection extends A
return Window.OK;
}
+ /**
+ * Gets the capability.
+ *
+ * @param item the item
+ * @return the capability
+ */
private Capability getCapability(TableTreeItem item) {
while (null != item.getParentItem())
item = item.getParentItem();
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ExtnlResBindSection.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ExtnlResBindSection.java?rev=1769512&r1=1769511&r2=1769512&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ExtnlResBindSection.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ExtnlResBindSection.java Sun Nov 13 16:13:16 2016
@@ -43,29 +43,48 @@ import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.ui.forms.IManagedForm;
+// TODO: Auto-generated Javadoc
/**
+ * The Class ExtnlResBindSection.
*/
public class ExtnlResBindSection extends AbstractSection {
+
+ /** The Constant boundHeader. */
private final static String boundHeader = "Bound to: ";
+ /** The section client. */
private Composite sectionClient;
+ /** The tree. */
private Tree tree;
+ /** The add button. */
private Button addButton;
+ /** The edit button. */
private Button editButton;
+ /** The remove button. */
private Button removeButton;
+ /** The bind button. */
private Button bindButton;
+ /** The export button. */
private Button exportButton;
+ /** The resource dependency section. */
private ResourceDependencySection resourceDependencySection;
+ /** The res bind import section. */
private ImportResBindSection resBindImportSection;
+ /**
+ * Instantiates a new extnl res bind section.
+ *
+ * @param aEditor the a editor
+ * @param parent the parent
+ */
public ExtnlResBindSection(MultiPageEditor aEditor, Composite parent) {
super(
aEditor,
@@ -74,6 +93,10 @@ public class ExtnlResBindSection extends
"Specify External Resources; Bind them to dependencies on the right panel by selecting the corresponding dependency and clicking Bind.");
}
+ /* (non-Javadoc)
+ * @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#initialize(org.eclipse.ui.forms.IManagedForm)
+ */
+ @Override
public void initialize(IManagedForm form) {
super.initialize(form);
// set up Composite to hold widgets in the section
@@ -105,6 +128,10 @@ public class ExtnlResBindSection extends
tree.addListener(SWT.MouseDoubleClick, this);
}
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.forms.AbstractFormPart#refresh()
+ */
+ @Override
public void refresh() {
if (null == resBindImportSection)
resBindImportSection = editor.getResourcesPage().getResBindImportSection();
@@ -121,6 +148,12 @@ public class ExtnlResBindSection extends
enable();
}
+ /**
+ * Adds the external resource description to GUI.
+ *
+ * @param xrd the xrd
+ * @param bindings the bindings
+ */
private void addExternalResourceDescriptionToGUI(ExternalResourceDescription xrd,
ExternalResourceBinding[] bindings) {
TreeItem item = new TreeItem(tree, SWT.NONE);
@@ -129,6 +162,12 @@ public class ExtnlResBindSection extends
item.setExpanded(true);
}
+ /**
+ * Fill xrd item.
+ *
+ * @param item the item
+ * @param xrd the xrd
+ */
private void fillXrdItem(TreeItem item, ExternalResourceDescription xrd) {
StringBuffer text = new StringBuffer();
text.append(xrd.getName());
@@ -151,6 +190,13 @@ public class ExtnlResBindSection extends
item.setData(xrd);
}
+ /**
+ * Fill bindings.
+ *
+ * @param parent the parent
+ * @param xrd the xrd
+ * @param bindings the bindings
+ */
private void fillBindings(TreeItem parent, ExternalResourceDescription xrd,
ExternalResourceBinding[] bindings) {
if (null != bindings) {
@@ -162,6 +208,13 @@ public class ExtnlResBindSection extends
}
}
+ /**
+ * Adds the binding to GUI.
+ *
+ * @param parent the parent
+ * @param key the key
+ * @param xrb the xrb
+ */
private void addBindingToGUI(TreeItem parent, String key, ExternalResourceBinding xrb) {
TreeItem item = new TreeItem(parent, SWT.NONE);
item.setText(boundHeader + key);
@@ -173,6 +226,7 @@ public class ExtnlResBindSection extends
*
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
+ @Override
public void handleEvent(Event event) {
if (event.widget == addButton)
handleAdd();
@@ -195,6 +249,12 @@ public class ExtnlResBindSection extends
enable();
}
+ /**
+ * Gets the XR description from tree item.
+ *
+ * @param item the item
+ * @return the XR description from tree item
+ */
public ExternalResourceDescription getXRDescriptionFromTreeItem(TreeItem item) {
return (ExternalResourceDescription) item.getData();
}
@@ -227,8 +287,7 @@ public class ExtnlResBindSection extends
}
/**
- * Add new external resource, with no bindings
- *
+ * Add new external resource, with no bindings.
*/
private void handleAdd() {
AddExternalResourceDialog dialog = new AddExternalResourceDialog(this);
@@ -241,6 +300,13 @@ public class ExtnlResBindSection extends
getResourceManagerConfiguration().addExternalResource(xrd);
}
+ /**
+ * Alter existing XRD.
+ *
+ * @param dialog the dialog
+ * @param xrd the xrd
+ * @param item the item
+ */
private void alterExistingXRD(AddExternalResourceDialog dialog, ExternalResourceDescription xrd,
TreeItem item) {
valueChanged = false;
@@ -278,7 +344,7 @@ public class ExtnlResBindSection extends
/**
* Bind button - enabled only when one dependency is selected, and one External Resource, not
- * already bound to this key, is selected
+ * already bound to this key, is selected.
*/
private void handleBind() {
TreeItem xrItem = tree.getSelection()[0];
@@ -323,10 +389,21 @@ public class ExtnlResBindSection extends
}
}
+ /**
+ * Gets the XR binding from tree item.
+ *
+ * @param item the item
+ * @return the XR binding from tree item
+ */
public ExternalResourceBinding getXRBindingFromTreeItem(TreeItem item) {
return (ExternalResourceBinding) item.getData();
}
+ /**
+ * Removes the binding.
+ *
+ * @param item the item
+ */
private void removeBinding(TreeItem item) {
ExternalResourceBinding xrb = getXRBindingFromTreeItem(item);
getResourceManagerConfiguration().removeExternalResourceBinding(xrb);
@@ -335,6 +412,11 @@ public class ExtnlResBindSection extends
setFileDirty();
}
+ /**
+ * Removes the bound flag in dependency section.
+ *
+ * @param xrb the xrb
+ */
private void removeBoundFlagInDependencySection(ExternalResourceBinding xrb) {
String key = xrb.getKey();
TableItem[] items = resourceDependencySection.getTable().getItems();
@@ -344,6 +426,11 @@ public class ExtnlResBindSection extends
}
}
+ /**
+ * Removes the all bindings.
+ *
+ * @param item the item
+ */
private void removeAllBindings(TreeItem item) {
TreeItem[] items = item.getItems();
for (int i = items.length - 1; i >= 0; i--) {
@@ -351,6 +438,11 @@ public class ExtnlResBindSection extends
}
}
+ /**
+ * Removes the resource.
+ *
+ * @param item the item
+ */
private void removeResource(TreeItem item) {
ExternalResourceDescription xrd = getXRDescriptionFromTreeItem(item);
getResourceManagerConfiguration().removeExternalResource(xrd);
@@ -358,6 +450,10 @@ public class ExtnlResBindSection extends
setFileDirty();
}
+ /* (non-Javadoc)
+ * @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
+ */
+ @Override
public void enable() {
// bind enabled when one item in tree and one in table is selected
bindButton.setEnabled(tree.getSelectionCount() == 1
@@ -370,10 +466,22 @@ public class ExtnlResBindSection extends
exportButton.setEnabled(tree.getItemCount() > 0);
}
+ /**
+ * Checks if is bound spec.
+ *
+ * @param item the item
+ * @return true, if is bound spec
+ */
private boolean isBoundSpec(TreeItem item) {
return item.getText().startsWith(boundHeader);
}
+ /**
+ * Resource name already defined.
+ *
+ * @param name the name
+ * @return true, if successful
+ */
public boolean resourceNameAlreadyDefined(String name) {
ExternalResourceDescription[] xrds = getExternalResources();
if (xrds != null) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FileAndShortName.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FileAndShortName.java?rev=1769512&r1=1769511&r2=1769512&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FileAndShortName.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FileAndShortName.java Sun Nov 13 16:13:16 2016
@@ -22,11 +22,23 @@ package org.apache.uima.taeconfigurator.
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.IPath;
+// TODO: Auto-generated Javadoc
+/**
+ * The Class FileAndShortName.
+ */
public class FileAndShortName {
+
+ /** The file name. */
public String fileName;
+ /** The short name. */
public String shortName;
+ /**
+ * Instantiates a new file and short name.
+ *
+ * @param o the o
+ */
public FileAndShortName(Object o) {
if (o instanceof IFile) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FlowSection.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FlowSection.java?rev=1769512&r1=1769511&r2=1769512&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FlowSection.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FlowSection.java Sun Nov 13 16:13:16 2016
@@ -53,45 +53,63 @@ import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.ui.forms.IManagedForm;
+// TODO: Auto-generated Javadoc
+/**
+ * The Class FlowSection.
+ */
public class FlowSection extends AbstractSection {
+ /** The Constant FIXED_FLOW. */
public static final String FIXED_FLOW = "Fixed Flow"; //$NON-NLS-1$
+ /** The Constant CAPABILITY_LANGUAGE_FLOW. */
public static final String CAPABILITY_LANGUAGE_FLOW = "Capability Language Flow"; //$NON-NLS-1$
+ /** The Constant USER_DEFINED_FLOW. */
public static final String USER_DEFINED_FLOW = "User-defined Flow";
+ /** The flow controller choice. */
private CCombo flowControllerChoice;
+ /** The flow list. */
Table flowList; // need access from inner class
+ /** The up button. */
private Button upButton;
+ /** The down button. */
private Button downButton;
+ /** The flow controller GUI. */
private Label flowControllerGUI;
+ /** The specify flow controller import button. */
private Button specifyFlowControllerImportButton;
+ /** The find flow controller descriptor button. */
private Button findFlowControllerDescriptorButton;
+ /** The flow controller label. */
private Label flowControllerLabel;
+ /** The flow controller key label. */
private Label flowControllerKeyLabel;
+ /** The flow controller key GUI. */
private Label flowControllerKeyGUI;
+ /** The flow choice label. */
// private Label flowControllerSpecifierLabel;
private Label flowChoiceLabel;
+ /** The b disable tool tip help. */
private boolean bDisableToolTipHelp;
/**
- * creates a section only for aggregate specifiers to define the flow of their delegates
- *
- * @param aEditor
- * the referenced multipage editor
- * @param parent
+ * creates a section only for aggregate specifiers to define the flow of their delegates.
+ *
+ * @param aEditor the referenced multipage editor
+ * @param parent the parent
*/
public FlowSection(MultiPageEditor aEditor, Composite parent) {
super(aEditor, parent, Messages.getString("FlowSection.ComponentEngineFlowTitle"), //$NON-NLS-1$
@@ -104,6 +122,7 @@ public class FlowSection extends Abstrac
*
* @see org.eclipse.ui.forms.IFormPart#initialize(org.eclipse.ui.forms.IManagedForm)
*/
+ @Override
public void initialize(IManagedForm form) {
super.initialize(form);
@@ -178,6 +197,7 @@ public class FlowSection extends Abstrac
*
* @see org.eclipse.ui.forms.IFormPart#refresh()
*/
+ @Override
public void refresh() {
super.refresh();
@@ -199,7 +219,7 @@ public class FlowSection extends Abstrac
// add them to the list
for (int i = 0; i < nodes.length; i++) {
TableItem item = new TableItem(flowList, SWT.NONE);
- item.setImage(TAEConfiguratorPlugin.getImage(TAEConfiguratorPlugin.IMAGE_ANNOTATOR) //$NON-NLS-1$
+ item.setImage(TAEConfiguratorPlugin.getImage(TAEConfiguratorPlugin.IMAGE_ANNOTATOR)
);
item.setText(0, nodes[i]);
}
@@ -229,6 +249,11 @@ public class FlowSection extends Abstrac
enable();
}
+ /**
+ * Refresh fcd.
+ *
+ * @param fcd the fcd
+ */
private void refreshFcd(FlowControllerDeclaration fcd) {
enableFlowControllerGUI(true);
String keyName;
@@ -256,6 +281,11 @@ public class FlowSection extends Abstrac
flowControllerGUI.getParent().redraw();
}
+ /**
+ * Enable flow controller GUI.
+ *
+ * @param enableState the enable state
+ */
private void enableFlowControllerGUI(boolean enableState) {
flowControllerLabel.setEnabled(enableState);
flowControllerGUI.setEnabled(enableState);
@@ -271,6 +301,8 @@ public class FlowSection extends Abstrac
}
/**
+ * Gets the model flow.
+ *
* @return the flow constraints
*/
private FlowConstraints getModelFlow() {
@@ -282,6 +314,7 @@ public class FlowSection extends Abstrac
*
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
+ @Override
public void handleEvent(Event event) {
if (event.widget == flowControllerChoice) {
String flowTypeGUI = flowControllerChoice.getText();
@@ -385,6 +418,11 @@ public class FlowSection extends Abstrac
}
}
+ /**
+ * Handle hover help.
+ *
+ * @param event the event
+ */
private void handleHoverHelp(Event event) {
String sDesc = "";
FlowControllerDeclaration fcd = editor.getResolvedFlowControllerDeclaration();
@@ -395,6 +433,11 @@ public class FlowSection extends Abstrac
flowControllerGUI.setToolTipText(sDesc);
}
+ /**
+ * Handle context menu request.
+ *
+ * @param event the event
+ */
private void handleContextMenuRequest(Event event) {
Import imp = getFlowControllerDeclaration().getImport();
@@ -403,11 +446,17 @@ public class FlowSection extends Abstrac
bDisableToolTipHelp = false;
}
+ /**
+ * Finish flow action.
+ */
private void finishFlowAction() {
setFileDirty();
refresh(); // calls enable
}
+ /**
+ * Handle remove.
+ */
public void handleRemove() {
// get node to remove
int removedItemIndex = flowList.getSelectionIndex();
@@ -431,10 +480,9 @@ public class FlowSection extends Abstrac
}
/**
- * Adds a node to the flowList
- *
- * @param node
- * the key of the delegate
+ * Adds a node to the flowList.
+ *
+ * @param node the key of the delegate
*/
public void addNode(String node) {
FlowConstraints flowConstraints = getModelFlow();
@@ -465,6 +513,7 @@ public class FlowSection extends Abstrac
* Enables and disables section, enables and disables buttons after content.
*
*/
+ @Override
public void enable() {
// if annotator is primitive disable whole section
@@ -499,9 +548,9 @@ public class FlowSection extends Abstrac
}
/**
- * Proofs if a node is contained in the list of nodes
- *
- * @param node
+ * Proofs if a node is contained in the list of nodes.
+ *
+ * @param node the node
* @return whether the node is in the list or not
*/
public boolean containsNode(String node) {
@@ -517,6 +566,8 @@ public class FlowSection extends Abstrac
}
/**
+ * Gets the down button.
+ *
* @return the down button
*/
public Button getDownButton() {
@@ -524,6 +575,8 @@ public class FlowSection extends Abstrac
}
/**
+ * Gets the flow list.
+ *
* @return the flow list
*/
public Table getFlowList() {
@@ -531,12 +584,17 @@ public class FlowSection extends Abstrac
}
/**
+ * Gets the up button.
+ *
* @return the up button
*/
public Button getUpButton() {
return upButton;
}
+ /**
+ * Removes the all.
+ */
public void removeAll() {
FlowConstraints flow = getModelFlow();
if (flow != null) {
@@ -546,6 +604,7 @@ public class FlowSection extends Abstrac
}
}
+ /** The Constant flowControllerHeadersLC. */
private static final String[] flowControllerHeadersLC = new String[] { "<flowcontrollerdescription" }; // don't
// end
@@ -557,6 +616,9 @@ public class FlowSection extends Abstrac
// a
// cr/lf
+ /**
+ * Handle find flow controller.
+ */
private void handleFindFlowController() {
FindComponentDialog dialog1 = new FindComponentDialog(this, "Find a Flow Controller",
"Specify a name pattern and/or other constraints, and then push the Search button",
@@ -599,6 +661,13 @@ public class FlowSection extends Abstrac
}
}
+ /**
+ * Produce key add flow controller.
+ *
+ * @param shortName the short name
+ * @param fullPathFileName the full path file name
+ * @param isImportByName the is import by name
+ */
private void produceKeyAddFlowController(String shortName, String fullPathFileName,
boolean isImportByName) {
Import imp = createImport(fullPathFileName, isImportByName);
@@ -645,6 +714,9 @@ public class FlowSection extends Abstrac
refresh(); // refresh every time to capture the order of items added
}
+ /**
+ * Handle specify flow controller.
+ */
private void handleSpecifyFlowController() {
MultiResourceSelectionDialog dialog = new MultiResourceSelectionDialog(getSection().getShell(),
editor.getFile().getProject().getParent(), "Flow Controller Selection", editor
@@ -662,6 +734,12 @@ public class FlowSection extends Abstrac
}
}
+ /**
+ * Check for one selection.
+ *
+ * @param numberSelected the number selected
+ * @return true, if successful
+ */
private boolean checkForOneSelection(int numberSelected) {
if (numberSelected > 1) {
Utility.popMessage("Error - Multiple selection",
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/GeneralSection.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/GeneralSection.java?rev=1769512&r1=1769511&r2=1769512&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/GeneralSection.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/GeneralSection.java Sun Nov 13 16:13:16 2016
@@ -40,25 +40,36 @@ import org.eclipse.swt.widgets.Composite
import org.eclipse.swt.widgets.Event;
import org.eclipse.ui.forms.IManagedForm;
+// TODO: Auto-generated Javadoc
+/**
+ * The Class GeneralSection.
+ */
public class GeneralSection extends AbstractSection {
+ /* (non-Javadoc)
+ * @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
+ */
+ @Override
public void enable() {
}
+ /** The cpp button. */
private Button cppButton;
+ /** The java button. */
private Button javaButton;
+ /** The primitive button. */
private Button primitiveButton;
+ /** The aggregate button. */
private Button aggregateButton;
/**
- * Creates a section to edit general information like primitive or aggregate and C++ or Java
- *
- * @param aEditor
- * the referenced multipage editor
- * @param parent
+ * Creates a section to edit general information like primitive or aggregate and C++ or Java.
+ *
+ * @param aEditor the referenced multipage editor
+ * @param parent the parent
*/
public GeneralSection(MultiPageEditor aEditor, Composite parent) {
super(aEditor, parent, "Implementation Details", null);
@@ -69,6 +80,7 @@ public class GeneralSection extends Abst
*
* @see org.eclipse.ui.forms.IFormPart#initialize(org.eclipse.ui.forms.IManagedForm)
*/
+ @Override
public void initialize(IManagedForm form) {
super.initialize(form);
((GridData) this.getSection().getLayoutData()).grabExcessVerticalSpace = false;
@@ -99,6 +111,7 @@ public class GeneralSection extends Abst
*
* @see org.eclipse.ui.forms.IFormPart#refresh()
*/
+ @Override
public void refresh() {
super.refresh();
boolean isPrimitive = isPrimitive();
@@ -119,6 +132,7 @@ public class GeneralSection extends Abst
*
* @see org.eclipse.swt.widgets.Listener#handleEvent(org.eclipse.swt.widgets.Event)
*/
+ @Override
public void handleEvent(Event event) {
if (event.widget == primitiveButton || event.widget == aggregateButton) {
boolean isPrimitive = primitiveButton.getSelection();
@@ -216,6 +230,9 @@ public class GeneralSection extends Abst
setFileDirty();
}
+ /**
+ * Common resets.
+ */
private void commonResets() {
// clear the delegates
getDelegateAnalysisEngineSpecifiersWithImports().clear();