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 [7/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/MultiPageEditorContributor.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditorContributor.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/MultiPageEditorContributor.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditorContributor.java Sun Nov 13 16:13:16 2016
@@ -42,6 +42,7 @@ import org.apache.uima.taeconfigurator.P
import org.apache.uima.taeconfigurator.TAEConfiguratorPlugin;
import org.apache.uima.taeconfigurator.editors.xml.XMLEditor;
+// TODO: Auto-generated Javadoc
// import org.eclipse.jdt.launching.IVMRunner;
// import org.apache.uima.jcas.jcasgen.Prefs;
@@ -52,14 +53,20 @@ import org.apache.uima.taeconfigurator.e
* contributors for the individual editors in the multi-page editor.
*/
public class MultiPageEditorContributor extends MultiPageEditorActionBarContributor {
+
+ /** The active editor part. */
private IEditorPart activeEditorPart;
+ /** The auto J cas action. */
Action autoJCasAction;
+ /** The limit J cas gen to project. */
Action limitJCasGenToProject;
+ /** The qualified types action. */
Action qualifiedTypesAction;
+ /** The run J cas gen action. */
Action runJCasGenAction;
/**
@@ -72,7 +79,9 @@ public class MultiPageEditorContributor
/**
* Returns the action registed with the given text editor.
- *
+ *
+ * @param editor the editor
+ * @param actionID the action ID
* @return IAction or null if editor is null.
*/
protected IAction getAction(MultiPageEditorPart editor, String actionID) {
@@ -80,6 +89,13 @@ public class MultiPageEditorContributor
return (txtEditor == null ? null : txtEditor.getAction(actionID));
}
+ /**
+ * Gets the action 1.
+ *
+ * @param editor the editor
+ * @param actionID the action ID
+ * @return the action 1
+ */
protected IAction getAction1(ITextEditor editor, String actionID) {
return (editor == null ? null : editor.getAction(actionID));
}
@@ -88,6 +104,10 @@ public class MultiPageEditorContributor
* (non-JavaDoc) Method declared in AbstractMultiPageEditorActionBarContributor.
*/
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.part.MultiPageEditorActionBarContributor#setActiveEditor(org.eclipse.ui.IEditorPart)
+ */
+ @Override
public void setActiveEditor(IEditorPart part) {
if (activeEditorPart == part)
return;
@@ -128,6 +148,7 @@ public class MultiPageEditorContributor
*
* @see org.eclipse.ui.part.MultiPageEditorActionBarContributor#setActivePage(org.eclipse.ui.IEditorPart)
*/
+ @Override
public void setActivePage(IEditorPart part) {
IActionBars actionBars = getActionBars();
@@ -157,33 +178,39 @@ public class MultiPageEditorContributor
}
}
+ /**
+ * Creates the actions.
+ */
private void createActions() {
autoJCasAction = new Action() {
// The run action is simply to toggle the setting in the prefs page, and
// to update the checked status to correspond to that
+ @Override
public void run() {
TAEConfiguratorPlugin plugin = TAEConfiguratorPlugin.getDefault();
Preferences prefs = plugin.getPluginPreferences();
- boolean bAutoJCasGen = !prefs.getBoolean(PreferencePage.P_JCAS); //$NON-NLS-1$
+ boolean bAutoJCasGen = !prefs.getBoolean(PreferencePage.P_JCAS);
autoJCasAction.setChecked(bAutoJCasGen);
- prefs.setValue(PreferencePage.P_JCAS, bAutoJCasGen); //$NON-NLS-1$
+ prefs.setValue(PreferencePage.P_JCAS, bAutoJCasGen);
}
};
limitJCasGenToProject = new Action () {
// The run action is simply to toggle the setting in the prefs page, and
// to update the checked status to correspond to that
+ @Override
public void run() {
TAEConfiguratorPlugin plugin = TAEConfiguratorPlugin.getDefault();
Preferences prefs = plugin.getPluginPreferences();
- boolean bJCasLimit = !prefs.getBoolean(PreferencePage.P_JCAS_LIMIT_TO_PROJECT_SCOPE); //$NON-NLS-1$
+ boolean bJCasLimit = !prefs.getBoolean(PreferencePage.P_JCAS_LIMIT_TO_PROJECT_SCOPE);
limitJCasGenToProject.setChecked(bJCasLimit);
- prefs.setValue(PreferencePage.P_JCAS_LIMIT_TO_PROJECT_SCOPE, bJCasLimit); //$NON-NLS-1$
+ prefs.setValue(PreferencePage.P_JCAS_LIMIT_TO_PROJECT_SCOPE, bJCasLimit);
}
};
runJCasGenAction = new Action() {
+ @Override
public void run() {
((MultiPageEditor) activeEditorPart).doJCasGenChkSrc(null); // don't know how to get
// progress monitor
@@ -191,13 +218,14 @@ public class MultiPageEditorContributor
};
qualifiedTypesAction = new Action() {
+ @Override
public void run() {
TAEConfiguratorPlugin plugin = TAEConfiguratorPlugin.getDefault();
Preferences prefs = plugin.getPluginPreferences();
boolean bFullyQualifiedTypeNames = !prefs
- .getBoolean(PreferencePage.P_SHOW_FULLY_QUALIFIED_NAMES); //$NON-NLS-1$
+ .getBoolean(PreferencePage.P_SHOW_FULLY_QUALIFIED_NAMES);
qualifiedTypesAction.setChecked(bFullyQualifiedTypeNames);
- prefs.setValue(PreferencePage.P_SHOW_FULLY_QUALIFIED_NAMES, bFullyQualifiedTypeNames); //$NON-NLS-1$
+ prefs.setValue(PreferencePage.P_SHOW_FULLY_QUALIFIED_NAMES, bFullyQualifiedTypeNames);
// mark all pages as stale for all editors, since this is a global setting
IWorkbenchPage[] pages = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getPages();
@@ -214,17 +242,21 @@ public class MultiPageEditorContributor
};
autoJCasAction.setText(Messages.getString("MultiPageEditorContributor.autoGenJCas")); //$NON-NLS-1$
- autoJCasAction.setChecked(getAutoJCasGen()); //$NON-NLS-1$
+ autoJCasAction.setChecked(getAutoJCasGen());
limitJCasGenToProject.setText(Messages.getString("MultiPageEditorContributor.limitJCasGenToProjectScope"));
limitJCasGenToProject.setChecked(getLimitJCasGenToProjectScope());
qualifiedTypesAction.setText(Messages.getString("MultiPageEditorContributor.showFullNames")); //$NON-NLS-1$
- qualifiedTypesAction.setChecked(getUseQualifiedTypes()); //$NON-NLS-1$
+ qualifiedTypesAction.setChecked(getUseQualifiedTypes());
runJCasGenAction.setText("Run JCasGen");
}
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.part.EditorActionBarContributor#contributeToMenu(org.eclipse.jface.action.IMenuManager)
+ */
+ @Override
public void contributeToMenu(IMenuManager manager) {
IMenuManager menu = new MenuManager("&UIMA"); //$NON-NLS-1$
@@ -237,46 +269,99 @@ public class MultiPageEditorContributor
settingsMenu.add(limitJCasGenToProject);
}
+ /**
+ * Gets the auto J cas gen.
+ *
+ * @return the auto J cas gen
+ */
public static boolean getAutoJCasGen() {
return getUimaPrefBoolean(PreferencePage.P_JCAS, false); // Jira UIMA-1177
}
+ /**
+ * Gets the use qualified types.
+ *
+ * @return the use qualified types
+ */
public static boolean getUseQualifiedTypes() {
return getUimaPrefBoolean(PreferencePage.P_SHOW_FULLY_QUALIFIED_NAMES, true);
}
+ /**
+ * Gets the limit J cas gen to project scope.
+ *
+ * @return the limit J cas gen to project scope
+ */
public static boolean getLimitJCasGenToProjectScope() {
return getUimaPrefBoolean(PreferencePage.P_JCAS_LIMIT_TO_PROJECT_SCOPE, false);
}
+ /**
+ * Gets the XM lindent.
+ *
+ * @return the XM lindent
+ */
public static int getXMLindent() {
return getUimaPrefInt(PreferencePage.P_XML_TAB_SPACES, 2);
}
+ /**
+ * Gets the CDE vns host.
+ *
+ * @return the CDE vns host
+ */
public static String getCDEVnsHost() {
return getUimaPrefString(PreferencePage.P_VNS_HOST, "localhost");
}
+ /**
+ * Gets the CDE vns port.
+ *
+ * @return the CDE vns port
+ */
public static String getCDEVnsPort() {
return getUimaPrefString(PreferencePage.P_VNS_PORT, "9000");
}
+ /**
+ * Sets the vns host.
+ *
+ * @param v the new vns host
+ */
public static void setVnsHost(String v) {
System.setProperty("VNS_HOST", v);
}
+ /**
+ * Sets the vns port.
+ *
+ * @param v the new vns port
+ */
public static void setVnsPort(String v) {
System.setProperty("VNS_PORT", v);
}
+ /**
+ * Sets the vns host.
+ */
public static void setVnsHost() {
setVnsHost(getCDEVnsHost());
}
+ /**
+ * Sets the vns port.
+ */
public static void setVnsPort() {
setVnsPort(getCDEVnsPort());
}
+ /**
+ * Gets the uima pref string.
+ *
+ * @param key the key
+ * @param defaultValue the default value
+ * @return the uima pref string
+ */
private static String getUimaPrefString(String key, String defaultValue) {
TAEConfiguratorPlugin plugin = TAEConfiguratorPlugin.getDefault();
Preferences prefs = plugin.getPluginPreferences();
@@ -286,6 +371,13 @@ public class MultiPageEditorContributor
return prefs.getString(key);
}
+ /**
+ * Gets the uima pref boolean.
+ *
+ * @param key the key
+ * @param defaultValue the default value
+ * @return the uima pref boolean
+ */
private static boolean getUimaPrefBoolean(String key, boolean defaultValue) {
TAEConfiguratorPlugin plugin = TAEConfiguratorPlugin.getDefault();
Preferences prefs = plugin.getPluginPreferences();
@@ -295,6 +387,13 @@ public class MultiPageEditorContributor
return prefs.getBoolean(key);
}
+ /**
+ * Gets the uima pref int.
+ *
+ * @param key the key
+ * @param defaultValue the default value
+ * @return the uima pref int
+ */
private static int getUimaPrefInt(String key, int defaultValue) {
TAEConfiguratorPlugin plugin = TAEConfiguratorPlugin.getDefault();
Preferences prefs = plugin.getPluginPreferences();
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaEditorExtension.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaEditorExtension.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/point/IUimaEditorExtension.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaEditorExtension.java Sun Nov 13 16:13:16 2016
@@ -24,9 +24,9 @@ import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorSite;
import org.eclipse.ui.PartInitException;
+// TODO: Auto-generated Javadoc
/**
- * The interface implemented by an external editor
- *
+ * The interface implemented by an external editor.
*/
public interface IUimaEditorExtension {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaMultiPageEditor.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaMultiPageEditor.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/point/IUimaMultiPageEditor.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaMultiPageEditor.java Sun Nov 13 16:13:16 2016
@@ -21,19 +21,35 @@ package org.apache.uima.taeconfigurator.
import org.eclipse.core.runtime.IProgressMonitor;
+// TODO: Auto-generated Javadoc
/**
* This interface is used to redirect the editing functions from CDE
- * to the external editor for a new type of Resource Specifier
- *
+ * to the external editor for a new type of Resource Specifier.
*/
public interface IUimaMultiPageEditor {
+ /**
+ * Adds the pages for current editor.
+ */
public void addPagesForCurrentEditor();
+ /**
+ * Page change for current editor.
+ *
+ * @param newPageIndex the new page index
+ */
public void pageChangeForCurrentEditor(int newPageIndex);
+ /**
+ * Do save for current editor.
+ *
+ * @param monitor the monitor
+ */
public void doSaveForCurrentEditor(IProgressMonitor monitor);
+ /**
+ * Do save as for current editor.
+ */
public void doSaveAsForCurrentEditor();
}
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractImportablePartSection.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/AbstractImportablePartSection.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/AbstractImportablePartSection.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractImportablePartSection.java Sun Nov 13 16:13:16 2016
@@ -28,13 +28,19 @@ import org.apache.uima.taeconfigurator.m
import org.eclipse.swt.custom.TableTreeItem;
import org.eclipse.swt.widgets.Composite;
+// TODO: Auto-generated Javadoc
+/**
+ * The Class AbstractImportablePartSection.
+ */
public abstract class AbstractImportablePartSection extends AbstractSection {
/**
- * @param aEditor
- * @param parent
- * @param headerText
- * @param description
+ * Instantiates a new abstract importable part section.
+ *
+ * @param aEditor the a editor
+ * @param parent the parent
+ * @param headerText the header text
+ * @param description the description
*/
public AbstractImportablePartSection(MultiPageEditor aEditor, Composite parent,
String headerText, String description) {
@@ -43,6 +49,12 @@ public abstract class AbstractImportable
// ********************************
// * GUI methods
+ /**
+ * Checks if is local item.
+ *
+ * @param item the item
+ * @return true, if is local item
+ */
// ********************************
protected boolean isLocalItem(TableTreeItem item) {
return !item.getForeground().equals(editor.getFadeColor());
@@ -52,10 +64,11 @@ public abstract class AbstractImportable
// * Universal Getters
// ********************************
/**
- * returns null if no feature by this name
- *
- * @param name
- * @param td
+ * returns null if no feature by this name.
+ *
+ * @param name the name
+ * @param td the td
+ * @return the feature from type description
*/
public FeatureDescription getFeatureFromTypeDescription(String name, TypeDescription td) {
FeatureDescription[] fds = td.getFeatures();
@@ -68,6 +81,13 @@ public abstract class AbstractImportable
return null;
}
+ /**
+ * Gets the allowed value.
+ *
+ * @param value the value
+ * @param td the td
+ * @return the allowed value
+ */
public AllowedValue getAllowedValue(String value, TypeDescription td) {
AllowedValue[] avs = td.getAllowedValues();
if (null == avs)
@@ -83,6 +103,12 @@ public abstract class AbstractImportable
// * Local Getters
// ********************************
+ /**
+ * Gets the local type definition.
+ *
+ * @param td the td
+ * @return the local type definition
+ */
protected TypeDescription getLocalTypeDefinition(TypeDescription td) {
TypeSystemDescription tsdLocal = getTypeSystemDescription();
if (null == tsdLocal)
@@ -90,10 +116,24 @@ public abstract class AbstractImportable
return tsdLocal.getType(td.getName());
}
+ /**
+ * Gets the local feature definition.
+ *
+ * @param td the td
+ * @param fd the fd
+ * @return the local feature definition
+ */
protected FeatureDescription getLocalFeatureDefinition(TypeDescription td, FeatureDescription fd) {
return getLocalFeatureDefinition(td, fd.getName());
}
+ /**
+ * Gets the local feature definition.
+ *
+ * @param td the td
+ * @param featureName the feature name
+ * @return the local feature definition
+ */
protected FeatureDescription getLocalFeatureDefinition(TypeDescription td, String featureName) {
TypeDescription localTd = getLocalTypeDefinition(td);
if (null == localTd)
@@ -101,6 +141,13 @@ public abstract class AbstractImportable
return getFeatureFromTypeDescription(featureName, localTd);
}
+ /**
+ * Gets the local allowed value.
+ *
+ * @param td the td
+ * @param unchangedAv the unchanged av
+ * @return the local allowed value
+ */
protected AllowedValue getLocalAllowedValue(TypeDescription td, AllowedValue unchangedAv) {
TypeDescription localTd = getLocalTypeDefinition(td);
if (null == localTd)
@@ -111,6 +158,12 @@ public abstract class AbstractImportable
// ********************************
// * Built-in Getters
// * used to do GUI "merge" with built-in things
+ /**
+ * Gets the built in type description.
+ *
+ * @param td the td
+ * @return the built in type description
+ */
// ********************************
public TypeDescription getBuiltInTypeDescription(TypeDescription td) {
return (TypeDescription) BuiltInTypes.typeDescriptions.get(td.getName());
@@ -118,19 +171,45 @@ public abstract class AbstractImportable
// ********************************
// * Local Testers
+ /**
+ * Checks if is local type.
+ *
+ * @param td the td
+ * @return true, if is local type
+ */
// ********************************
protected boolean isLocalType(TypeDescription td) {
return (null != getLocalTypeDefinition(td));
}
+ /**
+ * Checks if is local type.
+ *
+ * @param typeName the type name
+ * @return true, if is local type
+ */
protected boolean isLocalType(String typeName) {
return null != editor.getTypeSystemDescription().getType(typeName);
}
+ /**
+ * Checks if is local feature.
+ *
+ * @param featureName the feature name
+ * @param td the td
+ * @return true, if is local feature
+ */
protected boolean isLocalFeature(String featureName, TypeDescription td) {
return (null != getLocalFeatureDefinition(td, featureName));
}
+ /**
+ * Checks if is local allowed value.
+ *
+ * @param avString the av string
+ * @param td the td
+ * @return true, if is local allowed value
+ */
protected boolean isLocalAllowedValue(String avString, TypeDescription td) {
TypeDescription localTd = getLocalTypeDefinition(td);
if (null == localTd)
@@ -142,14 +221,33 @@ public abstract class AbstractImportable
// * Imported Testers
// ********************************
+ /**
+ * Checks if is imported type.
+ *
+ * @param typeName the type name
+ * @return true, if is imported type
+ */
public boolean isImportedType(String typeName) {
return null != editor.getImportedTypeSystemDesription().getType(typeName);
}
+ /**
+ * Checks if is imported type.
+ *
+ * @param td the td
+ * @return true, if is imported type
+ */
protected boolean isImportedType(TypeDescription td) {
return null != editor.getImportedTypeSystemDesription().getType(td.getName());
}
+ /**
+ * Checks if is imported feature.
+ *
+ * @param name the name
+ * @param td the td
+ * @return true, if is imported feature
+ */
protected boolean isImportedFeature(String name, TypeDescription td) {
TypeDescription importedTd = editor.getImportedTypeSystemDesription().getType(td.getName());
if (null == importedTd)
@@ -157,6 +255,13 @@ public abstract class AbstractImportable
return null != getFeatureFromTypeDescription(name, importedTd);
}
+ /**
+ * Checks if is imported allowed value.
+ *
+ * @param td the td
+ * @param av the av
+ * @return true, if is imported allowed value
+ */
protected boolean isImportedAllowedValue(TypeDescription td, AllowedValue av) {
TypeDescription importedTd = editor.getImportedTypeSystemDesription().getType(td.getName());
if (null == importedTd)
@@ -166,15 +271,34 @@ public abstract class AbstractImportable
// ********************************
// * Built-in Testers
+ /**
+ * Checks if is built in type.
+ *
+ * @param td the td
+ * @return true, if is built in type
+ */
// ********************************
protected boolean isBuiltInType(TypeDescription td) {
return null != getBuiltInTypeDescription(td);
}
+ /**
+ * Checks if is built in type.
+ *
+ * @param typeName the type name
+ * @return true, if is built in type
+ */
protected boolean isBuiltInType(String typeName) {
return null != BuiltInTypes.typeDescriptions.get(typeName);
}
+ /**
+ * Checks if is built in feature.
+ *
+ * @param name the name
+ * @param td the td
+ * @return true, if is built in feature
+ */
protected boolean isBuiltInFeature(String name, TypeDescription td) {
TypeDescription builtInTd = (TypeDescription) BuiltInTypes.typeDescriptions.get(td.getName());
if (null == builtInTd)
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.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/AbstractSection.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/AbstractSection.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java Sun Nov 13 16:13:16 2016
@@ -118,57 +118,94 @@ import org.eclipse.ui.forms.widgets.Expa
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.Section;
+// TODO: Auto-generated Javadoc
+/**
+ * The Class AbstractSection.
+ */
public abstract class AbstractSection extends SectionPart /* extends FormSection */
implements Listener, StandardStrings {
+ /** The toolkit. */
protected FormToolkit toolkit;
+ /** The editor. */
public MultiPageEditor editor;
+ /**
+ * Gets the toolkit.
+ *
+ * @return the toolkit
+ */
public FormToolkit getToolkit() {
return toolkit;
}
+ /** The Constant IMPORTABLE_PART_CONTEXT. */
public final static String IMPORTABLE_PART_CONTEXT = "ipc";
+ /** The Constant PLUGIN_ID. */
public final static String PLUGIN_ID = "org.apache.uima.desceditor";
+ /** The Constant SELECTED. */
public final static boolean SELECTED = true;
+ /** The Constant NOT_SELECTED. */
public final static boolean NOT_SELECTED = false;
+ /** The Constant ENABLED. */
public final static boolean ENABLED = true;
+ /** The Constant EQUAL_WIDTH. */
public final static boolean EQUAL_WIDTH = true;
+ /** The Constant treeItemArray0. */
public final static TreeItem[] treeItemArray0 = new TreeItem[0];
+ /** The Constant configurationGroup0. */
public final static ConfigurationGroup[] configurationGroup0 = new ConfigurationGroup[0];
+ /** The Constant configurationParameter0. */
public final static ConfigurationParameter[] configurationParameter0 = new ConfigurationParameter[0];
+ /** The Constant capabilityArray0. */
public final static Capability[] capabilityArray0 = new Capability[0];
+ /** The Constant featureDescriptionArray0. */
public final static FeatureDescription[] featureDescriptionArray0 = new FeatureDescription[0];
+ /** The Constant sofaMapping0. */
public final static SofaMapping[] sofaMapping0 = new SofaMapping[0];
+ /** The Constant fsIndexDescription0. */
public final static FsIndexDescription[] fsIndexDescription0 = new FsIndexDescription[0];
+ /** The Constant externalResourceBinding0. */
public final static ExternalResourceBinding[] externalResourceBinding0 = new ExternalResourceBinding[0];
+ /** The Constant externalResourceDescription0. */
public final static ExternalResourceDescription[] externalResourceDescription0 = new ExternalResourceDescription[0];
+ /** The Constant typeDescription0. */
public final static TypeDescription[] typeDescription0 = new TypeDescription[0];
+ /** The Constant typePriorityList0. */
public final static TypePriorityList[] typePriorityList0 = new TypePriorityList[0];
+ /** The initial form width. */
protected int initialFormWidth; // width of the form before putting controls in it
+ /**
+ * Instantiates a new abstract section.
+ *
+ * @param aEditor the a editor
+ * @param parent the parent
+ * @param headerText the header text
+ * @param description the description
+ */
public AbstractSection(MultiPageEditor aEditor, Composite parent, String headerText,
String description) {
super(parent, aEditor.getToolkit(), ((null != description) ? Section.DESCRIPTION : 0)
- | Section.TWISTIE | Section.EXPANDED);
+ | ExpandableComposite.TWISTIE | ExpandableComposite.EXPANDED);
toolkit = aEditor.getToolkit();
getSection().setText(headerText);
getSection().setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
@@ -178,6 +215,10 @@ implements Listener, StandardStrings {
editor = aEditor;
}
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.forms.AbstractFormPart#initialize(org.eclipse.ui.forms.IManagedForm)
+ */
+ @Override
public void initialize(IManagedForm form) {
super.initialize(form);
getSection().setLayoutData(new GridData(GridData.FILL_BOTH));
@@ -187,10 +228,16 @@ implements Listener, StandardStrings {
// * Subclasses need to implement these methods
// **************************************************
+ /**
+ * Enable.
+ */
public abstract void enable();
// **************************************************
// * convenience methods
+ /**
+ * Sets the file dirty.
+ */
// **************************************************
protected void setFileDirty() {
editor.setFileDirty();
@@ -198,23 +245,54 @@ implements Listener, StandardStrings {
// **************************************************
// * Creating Composites
+ /**
+ * New composite.
+ *
+ * @param parent the parent
+ * @return the composite
+ */
// **************************************************
public Composite newComposite(Composite parent) {
return newNcolumnComposite(parent, 1);
}
+ /**
+ * New 2 column composite.
+ *
+ * @param parent the parent
+ * @return the composite
+ */
public Composite new2ColumnComposite(Composite parent) {
return newNcolumnComposite(parent, 2);
}
+ /**
+ * New 3 column composite.
+ *
+ * @param parent the parent
+ * @return the composite
+ */
public Composite new3ColumnComposite(Composite parent) {
return newNcolumnComposite(parent, 3);
}
+ /**
+ * New 4 column composite.
+ *
+ * @param parent the parent
+ * @return the composite
+ */
public Composite new4ColumnComposite(Composite parent) {
return newNcolumnComposite(parent, 4);
}
+ /**
+ * New ncolumn composite.
+ *
+ * @param parent the parent
+ * @param cols the cols
+ * @return the composite
+ */
public Composite newNcolumnComposite(Composite parent, int cols) {
Composite composite = toolkit.createComposite(parent);
if (parent instanceof ExpandableComposite)
@@ -227,12 +305,24 @@ implements Listener, StandardStrings {
return composite;
}
+ /**
+ * Sets the margins.
+ *
+ * @param composite the composite
+ * @param height the height
+ * @param width the width
+ */
public void setMargins(Composite composite, int height, int width) {
GridLayout g = (GridLayout) composite.getLayout();
g.marginHeight = height;
g.marginWidth = width;
}
+ /**
+ * Enable borders.
+ *
+ * @param composite the composite
+ */
public void enableBorders(Composite composite) {
GridLayout g = (GridLayout) composite.getLayout();
if (g.marginHeight < 2)
@@ -243,15 +333,31 @@ implements Listener, StandardStrings {
// **************************************************
// * Special Composites to hold buttons
+ /** The Constant VERTICAL_BUTTONS. */
// **************************************************
final static public int VERTICAL_BUTTONS = 1;
+ /** The Constant HORIZONTAL_BUTTONS. */
final static public int HORIZONTAL_BUTTONS = 2;
+ /**
+ * New button container.
+ *
+ * @param parent the parent
+ * @return the composite
+ */
public Composite newButtonContainer(Composite parent) {
return newButtonContainer(parent, VERTICAL_BUTTONS, 0);
}
+ /**
+ * New button container.
+ *
+ * @param parent the parent
+ * @param style the style
+ * @param widthMin the width min
+ * @return the composite
+ */
public Composite newButtonContainer(Composite parent, int style, int widthMin) {
Composite buttonContainer = toolkit.createComposite(parent);
GridLayout gl = new GridLayout();
@@ -297,10 +403,27 @@ implements Listener, StandardStrings {
// * Widgets
// **************************************************
+ /**
+ * New labeled text field.
+ *
+ * @param parent the parent
+ * @param label the label
+ * @param tip the tip
+ * @return the text
+ */
protected Text newLabeledTextField(Composite parent, String label, String tip) {
return newLabeledTextField(parent, label, tip, SWT.NONE);
}
+ /**
+ * New labeled text field.
+ *
+ * @param parent the parent
+ * @param labelKey the label key
+ * @param textToolTip the text tool tip
+ * @param style the style
+ * @return the text
+ */
protected Text newLabeledTextField(Composite parent, String labelKey, String textToolTip,
int style) {
enableBorders(parent);
@@ -312,10 +435,27 @@ implements Listener, StandardStrings {
return newTextWithTip(parent, "", style, textToolTip); //$NON-NLS-1$
}
+ /**
+ * New text with tip.
+ *
+ * @param parent the parent
+ * @param initialTxt the initial txt
+ * @param tip the tip
+ * @return the text
+ */
protected Text newTextWithTip(Composite parent, String initialTxt, String tip) {
return newTextWithTip(parent, initialTxt, SWT.NONE, tip);
}
+ /**
+ * New text with tip.
+ *
+ * @param parent the parent
+ * @param text the text
+ * @param style the style
+ * @param tip the tip
+ * @return the text
+ */
protected Text newTextWithTip(Composite parent, String text, int style, String tip) {
Text t = toolkit.createText(parent, text, style);
t.setToolTipText(tip);
@@ -328,20 +468,52 @@ implements Listener, StandardStrings {
return t;
}
+ /**
+ * New label with data.
+ *
+ * @param parent the parent
+ * @param text the text
+ * @return the label
+ */
public Label newLabelWithData(Composite parent, String text) {
return newLabelWithTip(parent, text, ""); //$NON-NLS-1$
}
+ /**
+ * New label with tip.
+ *
+ * @param parent the parent
+ * @param text the text
+ * @param tip the tip
+ * @return the label
+ */
public Label newLabelWithTip(Composite parent, String text, String tip) {
return newLabelWithTip(parent, text, tip, SWT.NULL);
}
+ /**
+ * New un updatable text with tip.
+ *
+ * @param parent the parent
+ * @param text the text
+ * @param tip the tip
+ * @return the label
+ */
public Label newUnUpdatableTextWithTip(Composite parent, String text, String tip) {
Label label = newLabelWithTip(parent, text, tip, SWT.BORDER);
label.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
return label;
}
+ /**
+ * New label with tip.
+ *
+ * @param parent the parent
+ * @param text the text
+ * @param tip the tip
+ * @param style the style
+ * @return the label
+ */
public Label newLabelWithTip(Composite parent, String text, String tip, int style) {
Label t = toolkit.createLabel(parent, text, style);
if ((tip != null) && (tip.length()) > 0)
@@ -349,11 +521,26 @@ implements Listener, StandardStrings {
return t;
}
+ /**
+ * New labeled C combo with tip.
+ *
+ * @param parent the parent
+ * @param labelKey the label key
+ * @param tip the tip
+ * @return the c combo
+ */
protected CCombo newLabeledCComboWithTip(Composite parent, String labelKey, String tip) {
newLabelWithTip(parent, labelKey, tip);
return newCComboWithTip(parent, tip);
}
+ /**
+ * New C combo with tip.
+ *
+ * @param parent the parent
+ * @param tip the tip
+ * @return the c combo
+ */
protected CCombo newCComboWithTip(Composite parent, String tip) {
CCombo ccombo = new CCombo(parent, SWT.FLAT | SWT.READ_ONLY);
toolkit.adapt(ccombo, false, false);
@@ -367,12 +554,28 @@ implements Listener, StandardStrings {
return ccombo;
}
+ /**
+ * New description text box.
+ *
+ * @param parent the parent
+ * @param tip the tip
+ * @return the text
+ */
protected Text newDescriptionTextBox(Composite parent, String tip) {
return newLabeledTextField(parent, S_DESCRIPTION, tip, SWT.MULTI | SWT.WRAP | SWT.V_SCROLL);
}
// **************************************************
// * Widgets Buttons
+ /**
+ * New radio button.
+ *
+ * @param parent the parent
+ * @param label the label
+ * @param toolTip the tool tip
+ * @param selected the selected
+ * @return the button
+ */
// **************************************************
public Button newRadioButton(Composite parent, String label, String toolTip, boolean selected) {
Button button = toolkit.createButton(parent, label, SWT.RADIO);
@@ -383,11 +586,11 @@ implements Listener, StandardStrings {
}
/**
- * add pushbutton to container, set enabled, add listener for it
- *
- * @param parent
- * @param label
- * @param tip
+ * add pushbutton to container, set enabled, add listener for it.
+ *
+ * @param parent the parent
+ * @param label the label
+ * @param tip the tip
* @return the push button
*/
public Button newPushButton(Composite parent, String label, String tip) {
@@ -395,17 +598,28 @@ implements Listener, StandardStrings {
}
/**
- * Add a push button to a container, add a listener for it too
- *
- * @param parent
- * @param label
- * @param enabled
+ * Add a push button to a container, add a listener for it too.
+ *
+ * @param parent the parent
+ * @param label the label
+ * @param tip the tip
+ * @param enabled the enabled
* @return the pushbutton
*/
public Button newPushButton(Composite parent, String label, String tip, boolean enabled) {
return newPushButton(parent, label, tip, enabled, 0);
}
+ /**
+ * New push button.
+ *
+ * @param parent the parent
+ * @param label the label
+ * @param tip the tip
+ * @param enabled the enabled
+ * @param style the style
+ * @return the button
+ */
public Button newPushButton(Composite parent, String label, String tip, boolean enabled, int style) {
Button button = toolkit.createButton(parent, label, SWT.PUSH | style);
GridData gd = new GridData(GridData.VERTICAL_ALIGN_BEGINNING | GridData.FILL_HORIZONTAL);
@@ -420,6 +634,14 @@ implements Listener, StandardStrings {
return button;
}
+ /**
+ * New check box.
+ *
+ * @param parent the parent
+ * @param label the label
+ * @param tip the tip
+ * @return the button
+ */
public Button newCheckBox(Composite parent, String label, String tip) {
Button button = toolkit.createButton(parent, label, SWT.CHECK);
button.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING
@@ -430,6 +652,11 @@ implements Listener, StandardStrings {
return button;
}
+ /**
+ * Spacer.
+ *
+ * @param container the container
+ */
public static void spacer(Composite container) {
Label label = new Label(container, SWT.NONE);
label.setVisible(false);
@@ -438,26 +665,54 @@ implements Listener, StandardStrings {
// **************************************************
// * Tables
+ /** The Constant NO_MIN_HEIGHT. */
// **************************************************
final public static int NO_MIN_HEIGHT = -1;
+ /** The Constant NOTHING_SELECTED. */
final public static int NOTHING_SELECTED = -1;
+ /** The Constant LINES_VISIBLE. */
// these flags can be or-ed together
final public static int LINES_VISIBLE = 1;
+ /** The Constant HEADER_VISIBLE. */
final public static int HEADER_VISIBLE = 2;
+ /** The Constant WIDTH_NOT_SPECIFIED. */
final public static int WIDTH_NOT_SPECIFIED = 0;
+ /**
+ * New table.
+ *
+ * @param parent the parent
+ * @return the table
+ */
protected Table newTable(Composite parent) {
return newTable(parent, SWT.FULL_SELECTION, NO_MIN_HEIGHT, 0);
}
+ /**
+ * New table.
+ *
+ * @param parent the parent
+ * @param style the style
+ * @param minHeight the min height
+ * @return the table
+ */
protected Table newTable(Composite parent, int style, int minHeight) {
return newTable(parent, style, minHeight, 0);
}
+ /**
+ * New table.
+ *
+ * @param parent the parent
+ * @param style the style
+ * @param minHeight the min height
+ * @param flags the flags
+ * @return the table
+ */
protected Table newTable(Composite parent, int style, int minHeight, int flags) {
Table table = toolkit.createTable(parent, style);
GridData gd = new GridData(GridData.FILL_BOTH);
@@ -472,6 +727,12 @@ implements Listener, StandardStrings {
return table;
}
+ /**
+ * New tree.
+ *
+ * @param parent the parent
+ * @return the tree
+ */
protected Tree newTree(Composite parent) {
Tree tree = toolkit.createTree(parent, SWT.SINGLE);
tree.setLayoutData(new GridData(GridData.FILL_BOTH));
@@ -480,6 +741,13 @@ implements Listener, StandardStrings {
return tree;
}
+ /**
+ * Gets the previous selection.
+ *
+ * @param items the items
+ * @param nextItem the next item
+ * @return the previous selection
+ */
protected TreeItem getPreviousSelection(TreeItem[] items, TreeItem nextItem) {
TreeItem prevItem = nextItem.getParentItem();
for (int i = 0; i < items.length; i++) {
@@ -490,6 +758,13 @@ implements Listener, StandardStrings {
return prevItem;
}
+ /**
+ * Gets the item index.
+ *
+ * @param items the items
+ * @param item the item
+ * @return the item index
+ */
protected int getItemIndex(TreeItem[] items, TreeItem item) {
for (int i = 0; i < items.length; i++) {
if (items[i] == item)
@@ -499,9 +774,10 @@ implements Listener, StandardStrings {
}
/**
- * @param parent
- * @param style
- * SWT.SINGLE SWT.MULTI SWT.CHECK SWT.FULL_SELECTION
+ * New table tree.
+ *
+ * @param parent the parent
+ * @param style SWT.SINGLE SWT.MULTI SWT.CHECK SWT.FULL_SELECTION
* @return the TableTree
*/
protected TableTree newTableTree(Composite parent, int style) {
@@ -520,6 +796,11 @@ implements Listener, StandardStrings {
return tt;
}
+ /**
+ * Pack table.
+ *
+ * @param table the table
+ */
public void packTable(Table table) {
TableColumn[] columns = table.getColumns();
for (int i = 0; i < columns.length; i++) {
@@ -527,6 +808,12 @@ implements Listener, StandardStrings {
}
}
+ /**
+ * Gets the index.
+ *
+ * @param item the item
+ * @return the index
+ */
public static int getIndex(TableItem item) {
Table parent = item.getParent();
TableItem[] items = parent.getItems();
@@ -537,6 +824,12 @@ implements Listener, StandardStrings {
throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
}
+ /**
+ * Gets the index.
+ *
+ * @param item the item
+ * @return the index
+ */
public static int getIndex(TableTreeItem item) {
TableTreeItem parent = item.getParentItem();
TableTreeItem[] items = (null == parent) ? item.getParent().getItems() : parent.getItems();
@@ -547,6 +840,11 @@ implements Listener, StandardStrings {
throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
}
+ /**
+ * Removes the children.
+ *
+ * @param item the item
+ */
protected void removeChildren(TableTreeItem item) {
TableTreeItem[] items = item.getItems();
if (null != items)
@@ -555,6 +853,11 @@ implements Listener, StandardStrings {
}
}
+ /**
+ * Removes the children.
+ *
+ * @param item the item
+ */
protected void removeChildren(TreeItem item) {
TreeItem[] items = item.getItems();
if (null != items)
@@ -565,15 +868,37 @@ implements Listener, StandardStrings {
// **********************************
// * Table Column with header setting
+ /**
+ * New table column.
+ *
+ * @param table the table
+ * @return the table column
+ */
// **********************************
protected TableColumn newTableColumn(Table table) {
return newTableColumn(table, ""); //$NON-NLS-1$
}
+ /**
+ * New table column.
+ *
+ * @param container the container
+ * @param header the header
+ * @return the table column
+ */
protected TableColumn newTableColumn(Table container, String header) {
return newTableColumn(container, 50, SWT.LEFT, header);
}
+ /**
+ * New table column.
+ *
+ * @param container the container
+ * @param width the width
+ * @param alignment the alignment
+ * @param header the header
+ * @return the table column
+ */
protected TableColumn newTableColumn(Table container, int width, int alignment, String header) {
TableColumn tc = new TableColumn(container, alignment);
if (header != null && (!header.equals(""))) { //$NON-NLS-1$
@@ -583,6 +908,13 @@ implements Listener, StandardStrings {
return tc;
}
+ /**
+ * New table column.
+ *
+ * @param container the container
+ * @param width the width
+ * @return the table column
+ */
protected TableColumn newTableColumn(Table container, int width) {
return newTableColumn(container, width, SWT.LEFT, Messages.getString("AbstractSection.0")); //$NON-NLS-1$
}
@@ -591,84 +923,185 @@ implements Listener, StandardStrings {
// * Model Access
// **************************************************
+ /**
+ * Checks if is primitive.
+ *
+ * @return true, if is primitive
+ */
public boolean isPrimitive() {
return editor.isPrimitive();
}
+ /**
+ * Checks if is aggregate.
+ *
+ * @return true, if is aggregate
+ */
public boolean isAggregate() {
return editor.isAggregate();
}
+ /**
+ * Checks if is ae descriptor.
+ *
+ * @return true, if is ae descriptor
+ */
public boolean isAeDescriptor() {
return editor.isAeDescriptor();
}
+ /**
+ * Checks if is type system descriptor.
+ *
+ * @return true, if is type system descriptor
+ */
public boolean isTypeSystemDescriptor() {
return editor.isTypeSystemDescriptor();
}
+ /**
+ * Checks if is index descriptor.
+ *
+ * @return true, if is index descriptor
+ */
public boolean isIndexDescriptor() {
return editor.isFsIndexCollection();
}
+ /**
+ * Checks if is type priority descriptor.
+ *
+ * @return true, if is type priority descriptor
+ */
public boolean isTypePriorityDescriptor() {
return editor.isTypePriorityDescriptor();
}
+ /**
+ * Checks if is ext res and bindings descriptor.
+ *
+ * @return true, if is ext res and bindings descriptor
+ */
public boolean isExtResAndBindingsDescriptor() {
return editor.isExtResAndBindingsDescriptor();
}
+ /**
+ * Checks if is collection reader descriptor.
+ *
+ * @return true, if is collection reader descriptor
+ */
public boolean isCollectionReaderDescriptor() {
return editor.isCollectionReaderDescriptor();
}
+ /**
+ * Checks if is cas initializer descriptor.
+ *
+ * @return true, if is cas initializer descriptor
+ */
public boolean isCasInitializerDescriptor() {
return editor.isCasInitializerDescriptor();
}
+ /**
+ * Checks if is cas consumer descriptor.
+ *
+ * @return true, if is cas consumer descriptor
+ */
public boolean isCasConsumerDescriptor() {
return editor.isCasConsumerDescriptor();
}
+ /**
+ * Checks if is flow controller descriptor.
+ *
+ * @return true, if is flow controller descriptor
+ */
public boolean isFlowControllerDescriptor() {
return editor.isFlowControllerDescriptor();
}
+ /**
+ * Checks if is local processing descriptor.
+ *
+ * @return true, if is local processing descriptor
+ */
public boolean isLocalProcessingDescriptor() {
return editor.isLocalProcessingDescriptor();
}
+ /**
+ * Gets the analysis engine meta data.
+ *
+ * @return the analysis engine meta data
+ */
public AnalysisEngineMetaData getAnalysisEngineMetaData() {
return editor.getAeDescription().getAnalysisEngineMetaData();
}
+ /**
+ * Gets the flow controller declaration.
+ *
+ * @return the flow controller declaration
+ */
public FlowControllerDeclaration getFlowControllerDeclaration() {
return editor.getAeDescription().getFlowControllerDeclaration();
}
+ /**
+ * Sets the flow controller declaration.
+ *
+ * @param fcd the new flow controller declaration
+ */
public void setFlowControllerDeclaration(FlowControllerDeclaration fcd) {
editor.getAeDescription().setFlowControllerDeclaration(fcd);
}
+ /**
+ * Gets the operational properties.
+ *
+ * @return the operational properties
+ */
public OperationalProperties getOperationalProperties() {
return editor.getAeDescription().getAnalysisEngineMetaData().getOperationalProperties();
}
+ /**
+ * Gets the sofa mappings.
+ *
+ * @return the sofa mappings
+ */
public SofaMapping[] getSofaMappings() {
SofaMapping[] sofaMappings = editor.getAeDescription().getSofaMappings();
return null == sofaMappings ? sofaMapping0 : sofaMappings;
}
+ /**
+ * Gets the sofa mappings.
+ *
+ * @param pEditor the editor
+ * @return the sofa mappings
+ */
public static SofaMapping[] getSofaMappings(MultiPageEditor pEditor) {
SofaMapping[] sofaMappings = pEditor.getAeDescription().getSofaMappings();
return null == sofaMappings ? sofaMapping0 : sofaMappings;
}
+ /**
+ * Gets the delegate analysis engine specifiers with imports.
+ *
+ * @return the delegate analysis engine specifiers with imports
+ */
public Map getDelegateAnalysisEngineSpecifiersWithImports() {
return editor.getAeDescription().getDelegateAnalysisEngineSpecifiersWithImports();
}
+ /**
+ * Gets the capabilities.
+ *
+ * @return the capabilities
+ */
public Capability[] getCapabilities() {
Capability[] c = getAnalysisEngineMetaData().getCapabilities();
if (null == c)
@@ -676,14 +1109,29 @@ implements Listener, StandardStrings {
return c;
}
+ /**
+ * Gets the merged type system description.
+ *
+ * @return the merged type system description
+ */
protected TypeSystemDescription getMergedTypeSystemDescription() {
return editor.getMergedTypeSystemDescription();
}
+ /**
+ * Gets the type system description.
+ *
+ * @return the type system description
+ */
protected TypeSystemDescription getTypeSystemDescription() {
return editor.getTypeSystemDescription();
}
+ /**
+ * Gets the type priorities.
+ *
+ * @return the type priorities
+ */
protected TypePriorities getTypePriorities() {
TypePriorities tps = getAnalysisEngineMetaData().getTypePriorities();
if (null == tps) {
@@ -693,14 +1141,24 @@ implements Listener, StandardStrings {
return tps;
}
+ /** The Constant stringArray0. */
public final static String[] stringArray0 = new String[0];
+ /** The Constant configurationParameterArray0. */
public final static ConfigurationParameter[] configurationParameterArray0 = new ConfigurationParameter[0];
+ /** The Constant configurationGroupArray0. */
public final static ConfigurationGroup[] configurationGroupArray0 = new ConfigurationGroup[0];
+ /** The Constant nameValuePairArray0. */
public final static NameValuePair[] nameValuePairArray0 = new NameValuePair[0];
+ /**
+ * Gets the available type names.
+ *
+ * @param excluded the excluded
+ * @return the available type names
+ */
public String[] getAvailableTypeNames(Set excluded) {
Map allTypes = editor.allTypes.get();
Collection availableTypes = new ArrayList();
@@ -715,6 +1173,11 @@ implements Listener, StandardStrings {
// ************
// * Parameters
+ /**
+ * Checks if is parm group.
+ *
+ * @return true, if is parm group
+ */
// ************
public boolean isParmGroup() {
ConfigurationParameterDeclarations lcpd = getAnalysisEngineMetaData()
@@ -723,6 +1186,11 @@ implements Listener, StandardStrings {
|| (lcpd.getConfigurationGroups() != null && lcpd.getConfigurationGroups().length > 0);
}
+ /**
+ * Gets the configuration parameter declarations.
+ *
+ * @return the configuration parameter declarations
+ */
public ConfigurationParameterDeclarations getConfigurationParameterDeclarations() {
return editor.getAeDescription().getAnalysisEngineMetaData()
.getConfigurationParameterDeclarations();
@@ -732,6 +1200,11 @@ implements Listener, StandardStrings {
// * Common GUI state access
// **************************************************
+ /**
+ * Gets the resource manager configuration.
+ *
+ * @return the resource manager configuration
+ */
public ResourceManagerConfiguration getResourceManagerConfiguration() {
ResourceManagerConfiguration rmc = editor.getAeDescription().getResourceManagerConfiguration();
if (null == rmc) {
@@ -741,6 +1214,11 @@ implements Listener, StandardStrings {
return rmc;
}
+ /**
+ * Gets the external resource dependencies.
+ *
+ * @return the external resource dependencies
+ */
public ExternalResourceDependency[] getExternalResourceDependencies() {
ExternalResourceDependency[] erd = editor.getAeDescription().getExternalResourceDependencies();
if (null == erd) {
@@ -749,6 +1227,11 @@ implements Listener, StandardStrings {
return erd;
}
+ /**
+ * Gets the external resource bindings.
+ *
+ * @return the external resource bindings
+ */
public ExternalResourceBinding[] getExternalResourceBindings() {
ExternalResourceBinding[] erb = getResourceManagerConfiguration().getExternalResourceBindings();
if (null == erb)
@@ -757,6 +1240,11 @@ implements Listener, StandardStrings {
return erb;
}
+ /**
+ * Gets the external resources.
+ *
+ * @return the external resources
+ */
public ExternalResourceDescription[] getExternalResources() {
ExternalResourceDescription[] erd = getResourceManagerConfiguration().getExternalResources();
if (null == erd)
@@ -767,6 +1255,11 @@ implements Listener, StandardStrings {
// **************************************************
// * Common Listener things
+ /**
+ * Adds the listener for pastable widget.
+ *
+ * @param w the w
+ */
// **************************************************
protected void addListenerForPastableWidget(Widget w) {
w.addListener(SWT.KeyUp, this);
@@ -777,8 +1270,16 @@ implements Listener, StandardStrings {
// * Common Actions in Handlers
// **************************************************
+ /** The value changed. */
protected boolean valueChanged;
+ /**
+ * Sets the value changed.
+ *
+ * @param newValue the new value
+ * @param oldValue the old value
+ * @return the string
+ */
protected String setValueChanged(String newValue, String oldValue) {
if (null == newValue)
valueChanged = valueChanged || (null != oldValue);
@@ -787,18 +1288,39 @@ implements Listener, StandardStrings {
return newValue;
}
+ /**
+ * Sets the value changed int.
+ *
+ * @param newValue the new value
+ * @param oldValue the old value
+ * @return the int
+ */
protected int setValueChangedInt(int newValue, int oldValue) {
if (newValue != oldValue)
valueChanged = true;
return newValue;
}
+ /**
+ * Sets the value changed boolean.
+ *
+ * @param newValue the new value
+ * @param oldValue the old value
+ * @return true, if successful
+ */
protected boolean setValueChangedBoolean(boolean newValue, boolean oldValue) {
if (newValue != oldValue)
valueChanged = true;
return newValue;
}
+ /**
+ * Sets the value changed capital boolean.
+ *
+ * @param newValue the new value
+ * @param oldValue the old value
+ * @return the boolean
+ */
protected Boolean setValueChangedCapitalBoolean(Boolean newValue, Boolean oldValue) {
if (null == newValue) {
valueChanged |= null != oldValue;
@@ -809,6 +1331,13 @@ implements Listener, StandardStrings {
return newValue;
}
+ /**
+ * Sets the value changed keys.
+ *
+ * @param newKeys the new keys
+ * @param oldKeys the old keys
+ * @return the fs index key description[]
+ */
protected FsIndexKeyDescription[] setValueChangedKeys(FsIndexKeyDescription[] newKeys,
FsIndexKeyDescription[] oldKeys) {
if (valueChanged) {
@@ -822,12 +1351,22 @@ implements Listener, StandardStrings {
return newKeys;
}
+ /**
+ * Checks if is valid ae.
+ *
+ * @return true, if is valid ae
+ */
protected boolean isValidAe() {
if (editor.isValidAE(editor.getAeDescription()))
return true;
return false;
}
+ /**
+ * Revert type system.
+ *
+ * @param tsd the tsd
+ */
protected void revertTypeSystem(TypeSystemDescription tsd) {
try {
editor.setTypeSystemDescription(tsd);
@@ -835,6 +1374,13 @@ implements Listener, StandardStrings {
}
}
+ /**
+ * Revert msg.
+ *
+ * @param msgTitle the msg title
+ * @param msgTxt the msg txt
+ * @param exceptionMessage the exception message
+ */
protected void revertMsg(String msgTitle, String msgTxt, String exceptionMessage) {
Utility.popMessage(msgTitle, msgTxt + "\r\n" + exceptionMessage, //$NON-NLS-1$
MessageDialog.ERROR);
@@ -842,9 +1388,10 @@ implements Listener, StandardStrings {
}
/**
- *
- * @param msg
- * @param msgDetails
+ * Revert or continue.
+ *
+ * @param msg the msg
+ * @param msgDetails the msg details
* @return true to revert, false to continue
*/
public static boolean revertOrContinue(String msg, String msgDetails) {
@@ -855,11 +1402,22 @@ implements Listener, StandardStrings {
return false;
}
+ /**
+ * Mark stale.
+ *
+ * @param section the section
+ */
public void markStale(IFormPart section) {
if (section != null)
((AbstractFormPart) section).markStale();
}
+ /**
+ * Mark rest of page stale.
+ *
+ * @param mform the mform
+ * @param section the section
+ */
protected void markRestOfPageStale(IManagedForm mform, AbstractSection section) {
if (null == mform)
return;
@@ -869,20 +1427,37 @@ implements Listener, StandardStrings {
}
}
+ /**
+ * Mark stale if different.
+ *
+ * @param thisOne the this one
+ * @param otherOne the other one
+ */
protected void markStaleIfDifferent(IFormPart thisOne, IFormPart otherOne) {
if (thisOne != otherOne)
markStale(otherOne);
}
+ /**
+ * Multi line fix.
+ *
+ * @param s the s
+ * @return the string
+ */
protected String multiLineFix(String s) {
if (null == s)
return null;
return s.replaceAll("\\r\\n", "\n"); //$NON-NLS-1$ //$NON-NLS-2$
}
- /*************************************************************************************************
+ /**
+ * ***********************************************************************************************
* Augment arrays (make new array, add one item to it at end
- * *********************************************************
+ * *********************************************************.
+ *
+ * @param a the a
+ * @param s the s
+ * @return the string[]
*/
public String[] stringArrayAdd(String[] a, String s) {
@@ -895,6 +1470,13 @@ implements Listener, StandardStrings {
return newA;
}
+ /**
+ * String array remove.
+ *
+ * @param a the a
+ * @param s the s
+ * @return the string[]
+ */
public String[] stringArrayRemove(String[] a, String s) {
String[] result = new String[a.length - 1];
for (int i = 0, j = 0; i < a.length; i++) {
@@ -904,6 +1486,13 @@ implements Listener, StandardStrings {
return result;
}
+ /**
+ * Type or feature array add.
+ *
+ * @param a the a
+ * @param item the item
+ * @return the type or feature[]
+ */
public TypeOrFeature[] typeOrFeatureArrayAdd(TypeOrFeature[] a, TypeOrFeature item) {
if (null == a)
return new TypeOrFeature[] { item };
@@ -914,6 +1503,13 @@ implements Listener, StandardStrings {
return result;
}
+ /**
+ * Type or feature array remove.
+ *
+ * @param a the a
+ * @param item the item
+ * @return the type or feature[]
+ */
public TypeOrFeature[] typeOrFeatureArrayRemove(TypeOrFeature[] a, TypeOrFeature item) {
TypeOrFeature[] result = new TypeOrFeature[a.length - 1];
for (int i = 0, j = 0; i < a.length; i++) {
@@ -923,6 +1519,13 @@ implements Listener, StandardStrings {
return result;
}
+ /**
+ * Type or feature array remove.
+ *
+ * @param a the a
+ * @param s the s
+ * @return the type or feature[]
+ */
public TypeOrFeature[] typeOrFeatureArrayRemove(TypeOrFeature[] a, String s) {
TypeOrFeature[] result = new TypeOrFeature[a.length - 1];
for (int i = 0, j = 0; i < a.length; i++) {
@@ -936,6 +1539,13 @@ implements Listener, StandardStrings {
return result;
}
+ /**
+ * Gets the type or feature.
+ *
+ * @param a the a
+ * @param name the name
+ * @return the type or feature
+ */
public static TypeOrFeature getTypeOrFeature(TypeOrFeature[] a, String name) {
if (null == a)
return null;
@@ -946,6 +1556,12 @@ implements Listener, StandardStrings {
return null;
}
+ /**
+ * Parses the to fit in tool tips.
+ *
+ * @param text the text
+ * @return the string
+ */
// tool tips seem to require no blanks following /n on Windows.
protected static String parseToFitInToolTips(String text) {
if (null == text)
@@ -970,6 +1586,12 @@ implements Listener, StandardStrings {
return new String(buffer);
}
+ /**
+ * Format name.
+ *
+ * @param name the name
+ * @return the string
+ */
public String formatName(String name) {
if (null == name)
return ""; //$NON-NLS-1$
@@ -978,6 +1600,12 @@ implements Listener, StandardStrings {
return getShortName(name);
}
+ /**
+ * Gets the short name.
+ *
+ * @param name the name
+ * @return the short name
+ */
public static String getShortName(String name) {
if (null == name)
return ""; //$NON-NLS-1$
@@ -987,14 +1615,32 @@ implements Listener, StandardStrings {
return name.substring(i + 1);
}
+ /**
+ * Gets the short feature name.
+ *
+ * @param name the name
+ * @return the short feature name
+ */
public static String getShortFeatureName(String name) {
return (name.substring(name.indexOf(':') + 1));
}
+ /**
+ * Gets the type from full feature name.
+ *
+ * @param name the name
+ * @return the type from full feature name
+ */
public static String getTypeFromFullFeatureName(String name) {
return (name.substring(0, name.indexOf(':')));
}
+ /**
+ * Gets the name space.
+ *
+ * @param name the name
+ * @return the name space
+ */
public static String getNameSpace(String name) {
int i = name.lastIndexOf('.');
if (i < 0)
@@ -1004,9 +1650,9 @@ implements Listener, StandardStrings {
/**
* gets a feature description for a type, including supertypes.
- *
- * @param td
- * @param featureName
+ *
+ * @param td the td
+ * @param featureName the feature name
* @return a feature description for a type, including supertypes
*/
public FeatureDescription getFeature(TypeDescription td, String featureName) {
@@ -1018,7 +1664,7 @@ implements Listener, StandardStrings {
return features[i];
}
if (null != (supertypeName = td.getSupertypeName()))
- if (!CAS.TYPE_NAME_TOP.equals(supertypeName)) { //$NON-NLS-1$
+ if (!CAS.TYPE_NAME_TOP.equals(supertypeName)) {
TypeDescription supertype = getMergedTypeSystemDescription().getType(supertypeName);
if (null == supertype)
supertype = (TypeDescription) BuiltInTypes.typeDescriptions.get(supertypeName);
@@ -1027,6 +1673,12 @@ implements Listener, StandardStrings {
return null;
}
+ /**
+ * Checks if is indexable range.
+ *
+ * @param rangeName the range name
+ * @return true, if is indexable range
+ */
// means is this range allowed in the UIMA Index Spec as a Key
public static boolean isIndexableRange(String rangeName) {
return CAS.TYPE_NAME_BYTE.equals(rangeName) || CAS.TYPE_NAME_SHORT.equals(rangeName)
@@ -1035,11 +1687,23 @@ implements Listener, StandardStrings {
|| CAS.TYPE_NAME_STRING.equals(rangeName);
}
+ /**
+ * Sets the tool tip text.
+ *
+ * @param w the w
+ * @param text the text
+ */
public static void setToolTipText(Control w, String text) {
if (null != text)
w.setToolTipText(parseToFitInToolTips(text));
}
+ /**
+ * Maybe shorten file name.
+ *
+ * @param filePathName the file path name
+ * @return the string
+ */
public static String maybeShortenFileName(String filePathName) {
if (filePathName.length() > 65) {
String pathName = filePathName.replace('\\', '/');
@@ -1050,6 +1714,12 @@ implements Listener, StandardStrings {
return filePathName;
}
+ /**
+ * Swap table tree items.
+ *
+ * @param itemBelow the item below
+ * @param newSelection the new selection
+ */
public static void swapTableTreeItems(TableTreeItem itemBelow, int newSelection) {
TableTreeItem parent = itemBelow.getParentItem();
if (null == parent)
@@ -1065,6 +1735,12 @@ implements Listener, StandardStrings {
parent.getParent().setSelection(new TableTreeItem[] { parent.getItems()[newSelection] });
}
+ /**
+ * Copy table tree item.
+ *
+ * @param target the target
+ * @param source the source
+ */
public static void copyTableTreeItem(TableTreeItem target, TableTreeItem source) {
int columnCount = target.getParent().getTable().getColumnCount();
for (int i = 0; i < columnCount; i++) {
@@ -1075,6 +1751,12 @@ implements Listener, StandardStrings {
target.setData(source.getData());
}
+ /**
+ * Swap index keys.
+ *
+ * @param itemBelow the item below
+ * @param newSelection the new selection
+ */
public static void swapIndexKeys(TableTreeItem itemBelow, int newSelection) {
TableTreeItem parent = itemBelow.getParentItem();
FsIndexDescription fsid = getFsIndexDescriptionFromTableTreeItem(parent);
@@ -1088,6 +1770,12 @@ implements Listener, StandardStrings {
swapTableTreeItems(itemBelow, newSelection);
}
+ /**
+ * Swap table items.
+ *
+ * @param itemBelow the item below
+ * @param newSelection the new selection
+ */
public static void swapTableItems(TableItem itemBelow, int newSelection) {
Table parent = itemBelow.getParent();
int i = getIndex(itemBelow);
@@ -1101,6 +1789,12 @@ implements Listener, StandardStrings {
parent.setSelection(newSelection);
}
+ /**
+ * Copy table item.
+ *
+ * @param target the target
+ * @param source the source
+ */
public static void copyTableItem(TableItem target, TableItem source) {
int columnCount = target.getParent().getColumnCount();
for (int i = 0; i < columnCount; i++) {
@@ -1111,10 +1805,21 @@ implements Listener, StandardStrings {
target.setData(source.getData());
}
+ /**
+ * Gets the fs index description from table tree item.
+ *
+ * @param item the item
+ * @return the fs index description from table tree item
+ */
public static FsIndexDescription getFsIndexDescriptionFromTableTreeItem(TableTreeItem item) {
return (FsIndexDescription) item.getData();
}
+ /**
+ * Gets the capability sofa names.
+ *
+ * @return the capability sofa names
+ */
public String[][] getCapabilitySofaNames() {
Set[] inOut = getCapabilitySofaNames(editor.getAeDescription(), null);
@@ -1126,6 +1831,12 @@ implements Listener, StandardStrings {
return new String[][] { inputSofas, outputSofas };
}
+ /**
+ * Gets the capabilities.
+ *
+ * @param rs the rs
+ * @return the capabilities
+ */
public static Capability[] getCapabilities(ResourceSpecifier rs) {
if (rs instanceof ResourceCreationSpecifier)
return ((ProcessingResourceMetaData) ((ResourceCreationSpecifier) rs).getMetaData())
@@ -1133,6 +1844,13 @@ implements Listener, StandardStrings {
return null;
}
+ /**
+ * Gets the capability sofa names.
+ *
+ * @param rs the rs
+ * @param componentKey the component key
+ * @return the capability sofa names
+ */
protected static Set[] getCapabilitySofaNames(ResourceCreationSpecifier rs, String componentKey) {
Capability[] cs = getCapabilities(rs);
Set inputSofasSet = new TreeSet();
@@ -1145,6 +1863,13 @@ implements Listener, StandardStrings {
return new Set[] { inputSofasSet, outputSofasSet };
}
+ /**
+ * Merge sofa names.
+ *
+ * @param set the set
+ * @param items the items
+ * @param componentKey the component key
+ */
private static void mergeSofaNames(Set set, String[] items, String componentKey) {
if (null != items) {
for (int i = 0; i < items.length; i++) {
@@ -1157,6 +1882,11 @@ implements Listener, StandardStrings {
set.add(componentKey);
}
+ /**
+ * Adds the capability set.
+ *
+ * @return the capability
+ */
protected Capability addCapabilitySet() {
Capability newCset = UIMAFramework.getResourceSpecifierFactory().createCapability();
// update the model
@@ -1202,11 +1932,22 @@ implements Listener, StandardStrings {
throw new InternalErrorCDE("invalid call");
}
+ /**
+ * Sets the vns host and port.
+ *
+ * @param vnsHost the vns host
+ * @param vnsPort the vns port
+ */
public static void setVnsHostAndPort(String vnsHost, String vnsPort) {
MultiPageEditorContributor.setVnsHost(vnsHost);
MultiPageEditorContributor.setVnsPort(vnsPort);
}
+ /**
+ * Sets the vns host and port.
+ *
+ * @param descriptor the new vns host and port
+ */
public static void setVnsHostAndPort(Object descriptor) {
String vnsHost = MultiPageEditorContributor.getCDEVnsHost();
String vnsPort = MultiPageEditorContributor.getCDEVnsPort();
@@ -1228,6 +1969,13 @@ implements Listener, StandardStrings {
setVnsHostAndPort(vnsHost, vnsPort);
}
+ /**
+ * Request pop up over import.
+ *
+ * @param importItem the import item
+ * @param control the control
+ * @param event the event
+ */
protected void requestPopUpOverImport(Import importItem, Control control, Event event) {
String path = editor.getAbsolutePathFromImport(importItem);
IPath iPath = new Path(path);
@@ -1265,12 +2013,26 @@ implements Listener, StandardStrings {
}
}
+ /**
+ * Checks if is jms descriptor.
+ *
+ * @param inputDescription the input description
+ * @return true, if is jms descriptor
+ */
protected boolean isJmsDescriptor (XMLizable inputDescription) {
return (inputDescription instanceof CustomResourceSpecifier) &&
("org.apache.uima.aae.jms_adapter.JmsAnalysisEngineServiceAdapter".equals(
((CustomResourceSpecifier)inputDescription).getResourceClassName()));
}
+ /**
+ * Gets the absolute location.
+ *
+ * @param control the control
+ * @param x the x
+ * @param y the y
+ * @return the absolute location
+ */
private Point getAbsoluteLocation(Control control, int x, int y) {
Point point = new Point(x, y);
Composite composite = control.getParent();
@@ -1282,12 +2044,25 @@ implements Listener, StandardStrings {
return point;
}
+ /**
+ * Convert null.
+ *
+ * @param s the s
+ * @return the string
+ */
public static String convertNull(String s) {
if (null == s)
return "";
return s;
}
+ /**
+ * Creates the import.
+ *
+ * @param fileName the file name
+ * @param isByName the is by name
+ * @return the import
+ */
public Import createImport(String fileName, boolean isByName) {
if (isByName) {
return createByNameImport(fileName);
@@ -1300,7 +2075,9 @@ implements Listener, StandardStrings {
}
/**
- * @param location
+ * Creates the location import.
+ *
+ * @param location the location
* @return a location import
* @throws MalformedURLException -
*/
@@ -1327,6 +2104,12 @@ implements Listener, StandardStrings {
return imp;
}
+ /**
+ * Creates the by name import.
+ *
+ * @param fileName the file name
+ * @return the import
+ */
public Import createByNameImport(String fileName) {
if (fileName.endsWith(".xml"))
fileName = fileName.substring(0, fileName.length() - 4);
@@ -1356,12 +2139,24 @@ implements Listener, StandardStrings {
}
}
+ /**
+ * Checks if is FS array or list type.
+ *
+ * @param type the type
+ * @return true, if is FS array or list type
+ */
// subtype of FSLists should not match
public static boolean isFSArrayOrListType(String type) {
return (null != type)
&& (type.equals(CAS.TYPE_NAME_FS_ARRAY) || type.equals(CAS.TYPE_NAME_FS_LIST));
}
+ /**
+ * Checks if is array or list type.
+ *
+ * @param type the type
+ * @return true, if is array or list type
+ */
public static boolean isArrayOrListType(String type) {
return (null != type)
&& (type.equals(CAS.TYPE_NAME_FS_ARRAY) || type.equals(CAS.TYPE_NAME_FS_LIST)
@@ -1379,12 +2174,13 @@ implements Listener, StandardStrings {
.equals(CAS.TYPE_NAME_DOUBLE_ARRAY));
}
+ /** The Constant RIDICULOUSLY_LARGE. */
private final static int RIDICULOUSLY_LARGE = 10000;
/**
- * Produce Unique key for a newly added descriptor file
- *
- * @param fileName
+ * Produce Unique key for a newly added descriptor file.
+ *
+ * @param fileName the file name
* @return Unique key for a newly added descriptor file
*/
protected String produceUniqueComponentKey(String fileName) {
@@ -1413,6 +2209,7 @@ implements Listener, StandardStrings {
return null;
}
+ /** The url for resource specifier schema. */
private static URL urlForResourceSpecifierSchema;
static {
try {
@@ -1422,10 +2219,25 @@ implements Listener, StandardStrings {
}
}
+ /**
+ * Parses the descriptor.
+ *
+ * @param input the input
+ * @return the XM lizable
+ * @throws InvalidXMLException the invalid XML exception
+ */
public static XMLizable parseDescriptor(XMLInputSource input) throws InvalidXMLException {
return parseDescriptor(input, false);
}
+ /**
+ * Parses the descriptor.
+ *
+ * @param input the input
+ * @param preserveComments the preserve comments
+ * @return the XM lizable
+ * @throws InvalidXMLException the invalid XML exception
+ */
public static XMLizable parseDescriptor(XMLInputSource input, boolean preserveComments) throws InvalidXMLException {
// turn off environment variable expansion
XMLParser.ParsingOptions parsingOptions = new XMLParser.ParsingOptions(false);
@@ -1437,6 +2249,11 @@ implements Listener, StandardStrings {
urlForResourceSpecifierSchema, parsingOptions);
}
+ /**
+ * Show exception reading imported descriptor.
+ *
+ * @param e the e
+ */
protected void showExceptionReadingImportedDescriptor(Exception e) {
StringBuffer msg = new StringBuffer(1000);
msg
@@ -1447,8 +2264,8 @@ implements Listener, StandardStrings {
}
/**
- * Update the model while checking for validity If invalid - ask if want to continue or not
- *
+ * Update the model while checking for validity If invalid - ask if want to continue or not.
+ *
* @return validity state
*/
protected boolean isValidAggregateChange() {
@@ -1488,6 +2305,9 @@ implements Listener, StandardStrings {
return true;
}
+ /**
+ * Finish aggregate change action.
+ */
protected void finishAggregateChangeAction() {
editor.setFileDirty();
@@ -1500,6 +2320,14 @@ implements Listener, StandardStrings {
editor.getResourcesPage().markStale();
}
+ /**
+ * Read import.
+ *
+ * @param imp the imp
+ * @param fileName the file name
+ * @param isImportByName the is import by name
+ * @return the XM lizable
+ */
protected XMLizable readImport(Import imp, String fileName, boolean isImportByName) {
URL byNameURL;
XMLInputSource input;
@@ -1536,11 +2364,23 @@ implements Listener, StandardStrings {
return inputDescription;
}
+ /**
+ * Enable ctrl.
+ *
+ * @param c the c
+ * @param enabled the enabled
+ */
protected static void enableCtrl(Control c, boolean enabled) {
if (null != c)
c.setEnabled(enabled);
}
+ /**
+ * Sets the button selection.
+ *
+ * @param c the c
+ * @param selected the selected
+ */
protected static void setButtonSelection(Button c, boolean selected) {
if (null != c)
c.setSelection(selected);
@@ -1549,18 +2389,26 @@ implements Listener, StandardStrings {
/**
* Return a String made from the description of a given resource specifier. If the specifier is
* for a remote, try and connect to the remote and get its info.
- *
- * @param fileRef
- * @param rs
+ *
*/
private ResourceSpecifier lastResourceForDescription = null;
+ /** The last description from descriptor. */
private String lastDescriptionFromDescriptor = "";
+ /** The last time description requested. */
private long lastTimeDescriptionRequested = 0;
+ /** The Constant TABLE_HOVER_REQUERY_TIME. */
private static final long TABLE_HOVER_REQUERY_TIME = 15000;
+ /**
+ * Gets the description for descriptor.
+ *
+ * @param fileRef the file ref
+ * @param rs the rs
+ * @return the description for descriptor
+ */
protected String getDescriptionForDescriptor(String fileRef, ResourceSpecifier rs) {
if (null == fileRef || "".equals(fileRef) || null == rs)
return "";
@@ -1592,6 +2440,12 @@ implements Listener, StandardStrings {
return sDesc;
}
+ /**
+ * Setup to print file.
+ *
+ * @param filePath the file path
+ * @return the prints the writer
+ */
protected PrintWriter setupToPrintFile(String filePath) {
if (new File(filePath).exists())
if (Window.CANCEL == Utility.popOkCancel("File exists, OK to replace?", MessageFormat.format(
@@ -1608,6 +2462,11 @@ implements Listener, StandardStrings {
}
}
+ /**
+ * Gets the fs index collection.
+ *
+ * @return the fs index collection
+ */
protected FsIndexCollection getFsIndexCollection() {
FsIndexCollection fsic = getAnalysisEngineMetaData().getFsIndexCollection();
if (null == fsic)
@@ -1616,6 +2475,12 @@ implements Listener, StandardStrings {
return fsic;
}
+ /**
+ * Handle default index kind.
+ *
+ * @param indexKind the index kind
+ * @return the string
+ */
public static String handleDefaultIndexKind(String indexKind) {
if (null == indexKind)
return "sorted";