You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2022/02/10 14:37:07 UTC
[uima-uimaj] branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase updated (daa7e79 -> 98207e6)
This is an automated email from the ASF dual-hosted git repository.
rec pushed a change to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git.
from daa7e79 [UIMA-6373] Format UIMA Core Java SDK codebase
new bc5668e [UIMA-6373] Format UIMA Core Java SDK codebase
new 4ea1cae [UIMA-6373] Format UIMA Core Java SDK codebase
new f30abaa [UIMA-6373] Format UIMA Core Java SDK codebase
new de6c1f5 [UIMA-6373] Format UIMA Core Java SDK codebase
new 2950fa0 [UIMA-6373] Format UIMA Core Java SDK codebase
new e3c6476 [UIMA-6373] Format UIMA Core Java SDK codebase
new c4cce1e [UIMA-6373] Format UIMA Core Java SDK codebase
new fe58341 [UIMA-6373] Format UIMA Core Java SDK codebase
new 154a0bf [UIMA-6373] Format UIMA Core Java SDK codebase
new 242371e [UIMA-6373] Format UIMA Core Java SDK codebase
new 585a8fe [UIMA-6373] Format UIMA Core Java SDK codebase
new 87ac952 [UIMA-6373] Format UIMA Core Java SDK codebase
new 695bccd [UIMA-6373] Format UIMA Core Java SDK codebase
new ce516fb [UIMA-6373] Format UIMA Core Java SDK codebase
new 98207e6 [UIMA-6373] Format UIMA Core Java SDK codebase
The 15 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../apache/uima/pear/tools/PearPackagingMojo.java | 522 ++-
.../main/java/org/apache/vinci/debug/Debug.java | 11 +-
.../org/apache/vinci/debug/FatalException.java | 2 +-
.../org/apache/vinci/transport/BaseClient.java | 246 +-
.../org/apache/vinci/transport/BaseServer.java | 26 +-
.../apache/vinci/transport/BaseServerRunnable.java | 7 +-
.../java/org/apache/vinci/transport/Frame.java | 34 +-
.../org/apache/vinci/transport/FrameComponent.java | 4 +-
.../java/org/apache/vinci/transport/FrameLeaf.java | 29 +-
.../apache/vinci/transport/FrameTransporter.java | 9 +-
.../org/apache/vinci/transport/KeyValuePair.java | 6 +-
.../apache/vinci/transport/LeafCastException.java | 2 +-
.../apache/vinci/transport/PooledVinciClient.java | 84 +-
.../vinci/transport/ServiceDownException.java | 2 +-
.../vinci/transport/SimpleTransportable.java | 3 +-
.../org/apache/vinci/transport/Transportable.java | 6 +-
.../org/apache/vinci/transport/VNSException.java | 2 +-
.../org/apache/vinci/transport/VinciClient.java | 262 +-
.../org/apache/vinci/transport/VinciFrame.java | 64 +-
.../org/apache/vinci/transport/VinciServer.java | 99 +-
.../apache/vinci/transport/XTalkTransporter.java | 205 +-
.../vinci/transport/context/VinciContext.java | 206 +-
.../apache/vinci/transport/document/AFrame.java | 127 +-
.../vinci/transport/document/XMLToVinci.java | 16 +-
.../vinci/transport/document/XMLToXTalk.java | 36 +-
.../vinci/transport/document/XTalkToSAX.java | 11 +-
.../vinci/transport/util/Base64Converter.java | 54 +-
.../vinci/transport/util/StreamMaterializer.java | 6 +-
.../apache/vinci/transport/util/UTFConverter.java | 53 +-
.../apache/vinci/transport/util/XMLConverter.java | 28 +-
.../vinci/transport/vns/client/ResolveResult.java | 16 +-
.../vinci/transport/vns/client/ServeonResult.java | 27 +-
.../vinci/transport/vns/client/VNSConfig.java | 14 +-
.../vinci/transport/vns/service/NameClient.java | 24 +-
.../vinci/transport/vns/service/ServiceAlias.java | 4 +-
.../transport/vns/service/ServiceRegistry.java | 9 +-
.../apache/vinci/transport/vns/service/VNS.java | 30 +-
.../uima/tools/jcasgen/maven/JCasGenMojo.java | 19 +-
.../uima/tools/jcasgen/maven/JCasGenMojoTest.java | 50 +-
.../soap/AxisAnalysisEngineServiceStub.java | 27 +-
.../soap/AxisAnalysisEngineService_impl.java | 16 +-
.../adapter/soap/AxisResourceServiceManager.java | 13 +-
.../uima/adapter/soap/AxisResourceServiceStub.java | 4 +-
.../uima/adapter/soap/BinaryDeserializer.java | 57 +-
.../adapter/soap/BinaryDeserializerFactory.java | 9 +-
.../apache/uima/adapter/soap/BinarySerializer.java | 36 +-
.../uima/adapter/soap/BinarySerializerFactory.java | 12 +-
.../soap/SoapAnalysisEngineServiceAdapter.java | 26 +-
.../apache/uima/adapter/soap/XmlDeserializer.java | 67 +-
.../uima/adapter/soap/XmlDeserializerFactory.java | 9 +-
.../apache/uima/adapter/soap/XmlSerializer.java | 77 +-
.../uima/adapter/soap/XmlSerializerFactory.java | 9 +-
.../soap/axis11/BinaryDeserializer_Axis11.java | 56 +-
.../soap/axis11/BinarySerializer_Axis11.java | 35 +-
.../soap/axis11/XmlDeserializer_Axis11.java | 66 +-
.../adapter/soap/axis11/XmlSerializer_Axis11.java | 76 +-
.../uima/adapter/vinci/CASTransportable.java | 188 +-
.../vinci/VinciAnalysisEngineServiceAdapter.java | 22 +-
.../vinci/VinciAnalysisEngineServiceStub.java | 126 +-
.../vinci/VinciAnalysisEngineService_impl.java | 80 +-
.../VinciBinaryAnalysisEngineServiceStub.java | 93 +-
.../VinciBinaryAnalysisEngineService_impl.java | 75 +-
.../apache/uima/adapter/vinci/util/Constants.java | 2 +-
.../apache/uima/adapter/vinci/util/Descriptor.java | 42 +-
.../adapter/vinci/util/SaxVinciFrameBuilder.java | 51 +-
.../apache/uima/adapter/vinci/util/Shutdown.java | 3 +-
.../vinci/util/UimaSaxVinciFrameBuilder.java | 20 +-
.../uima/adapter/vinci/util/VinciSaxParser.java | 24 +-
.../uima/adapter/vinci/util/VinciTAEClient.java | 3 +-
.../VinciAnalysisEngineServiceAdapterTest.java | 56 +-
.../org/apache/uima/bootstrap/UimaBootstrap.java | 207 +-
.../test/junit_extension/AnnotationWriter.java | 678 ++--
.../AnnotatorPerformanceTester.java | 41 +-
.../uima/test/junit_extension/AnnotatorTester.java | 676 ++--
.../junit_extension/PerformanceTestResult.java | 20 +-
.../junit_extension/PerformanceTestResultImpl.java | 148 +-
.../apache/uima/jcas/tcas/DocumentAnnotation.java | 26 +-
.../java/org/apache/uima/jcas/tcas/DocMeta.java | 406 ++-
.../uima/jcas/tcas/DocumentAnnotationTest.java | 88 +-
.../uima/caseditor/ide/CasEditorIdePlugin.java | 172 +-
.../ide/CasEditorIdePreferenceConstants.java | 11 +-
.../ide/CasEditorIdePreferenceInitializer.java | 20 +-
.../caseditor/ide/CasEditorIdePreferencePage.java | 7 +-
.../caseditor/ide/CasEditorPerspectiveFactory.java | 32 +-
.../caseditor/ide/CasEditorPreferencePage.java | 8 +-
.../caseditor/ide/DefaultCasDocumentProvider.java | 74 +-
.../org/apache/uima/caseditor/ide/NlpProject.java | 4 +-
.../ide/TypeSystemLocationPropertyPage.java | 92 +-
.../caseditor/ide/WorkspaceResourceDialog.java | 100 +-
.../TypeSystemSearchStrategyFactory.java | 4 +-
.../ide/wizards/ContainerElementFilter.java | 2 +-
.../wizards/DocumentImportStructureProvider.java | 3 +-
.../ide/wizards/ImportDocumentWizard.java | 60 +-
.../ide/wizards/ImportDocumentWizardPage.java | 236 +-
.../uima/caseditor/ide/wizards/OverwriteQuery.java | 28 +-
.../org/apache/uima/caseditor/CasEditorPlugin.java | 46 +-
.../java/org/apache/uima/caseditor/Images.java | 5 +-
.../org/apache/uima/caseditor/core/TaeError.java | 10 +-
.../uima/caseditor/core/model/DefaultColors.java | 97 +-
.../caseditor/core/model/dotcorpus/DotCorpus.java | 45 +-
.../core/model/dotcorpus/DotCorpusSerializer.java | 65 +-
.../editor/AbstractAnnotationDocumentListener.java | 22 +-
.../uima/caseditor/editor/AbstractDocument.java | 72 +-
.../caseditor/editor/AbstractDocumentListener.java | 17 +-
.../uima/caseditor/editor/AnnotationDocument.java | 45 +-
.../uima/caseditor/editor/AnnotationEditor.java | 768 ++---
.../editor/AnnotationEditorActionContributor.java | 7 +-
.../AnnotationEditorPreferenceConstants.java | 10 +-
.../AnnotationEditorPreferenceInitializer.java | 3 +-
.../editor/AnnotationEditorPreferencePage.java | 31 +-
.../editor/AnnotationEditorSelection.java | 14 +-
.../caseditor/editor/AnnotationEditorView.java | 13 +-
.../editor/AnnotationInformationProvider.java | 24 +-
.../editor/AnnotationSelectionListener.java | 6 +-
.../uima/caseditor/editor/AnnotationStyle.java | 163 +-
.../editor/AnnotationStyleChangeListener.java | 11 +-
.../apache/uima/caseditor/editor/ArrayValue.java | 15 +-
.../uima/caseditor/editor/CasDocumentProvider.java | 78 +-
.../editor/CasDocumentProviderFactory.java | 34 +-
.../uima/caseditor/editor/CasEditorError.java | 11 +-
.../uima/caseditor/editor/CasEditorView.java | 122 +-
.../uima/caseditor/editor/CasEditorViewPage.java | 80 +-
.../uima/caseditor/editor/ChangeModeAction.java | 10 +-
.../caseditor/editor/CustomInformationControl.java | 15 +-
.../uima/caseditor/editor/DocumentUimaImpl.java | 90 +-
.../editor/FeatureStructureSelection.java | 12 +-
.../editor/FeatureStructureSelectionIterator.java | 7 +-
.../editor/FeatureStructureSelectionProvider.java | 19 +-
.../apache/uima/caseditor/editor/FeatureValue.java | 18 +-
.../uima/caseditor/editor/FindAnnotateAction.java | 12 +-
.../uima/caseditor/editor/FindAnnotateDialog.java | 195 +-
.../editor/IAnnotationEditorModifyListener.java | 19 +-
.../caseditor/editor/IAnnotationStyleListener.java | 18 +-
.../apache/uima/caseditor/editor/ICasDocument.java | 25 +-
.../caseditor/editor/ICasDocumentListener.java | 14 +-
.../apache/uima/caseditor/editor/ICasEditor.java | 27 +-
.../caseditor/editor/ICasEditorInputListener.java | 37 +-
.../ICustomInformationControlContentHandler.java | 9 +-
.../caseditor/editor/IEditorSelectionListener.java | 13 +-
.../caseditor/editor/ModelFeatureStructure.java | 42 +-
.../caseditor/editor/QuickTypeSelectionDialog.java | 37 +-
.../apache/uima/caseditor/editor/SubPageSite.java | 23 +-
.../caseditor/editor/TextDocumentProvider.java | 52 +-
.../action/DeleteFeatureStructureAction.java | 14 +-
.../action/LowerLeftAnnotationSideAction.java | 17 +-
.../action/LowerRightAnnotationSideAction.java | 23 +-
.../editor/action/MergeAnnotationAction.java | 15 +-
.../action/WideLeftAnnotationSideAction.java | 22 +-
.../action/WideRightAnnotationSideAction.java | 21 +-
.../annotation/BackgroundDrawingStrategy.java | 114 +-
.../editor/annotation/BoxDrawingStrategy.java | 36 +-
.../editor/annotation/BracketDrawingStrategy.java | 33 +-
.../caseditor/editor/annotation/DrawingStyle.java | 22 +-
.../editor/annotation/EclipseAnnotationPeer.java | 17 +-
.../editor/annotation/TagDrawingStrategy.java | 117 +-
.../annotation/TextColorDrawingStrategy.java | 4 +-
.../editor/annotation/TokenDrawingStrategy.java | 20 +-
.../annotation/UnderlineDrawingStrategy.java | 19 +-
.../editor/context/AnnotationEditingControl.java | 7 +-
.../context/AnnotationEditingControlCreator.java | 9 +-
.../editor/contextmenu/IModeMenuListener.java | 27 +-
.../contextmenu/IShowAnnotationsListener.java | 30 +-
.../caseditor/editor/contextmenu/ModeMenu.java | 35 +-
.../editor/contextmenu/ShowAnnotationsMenu.java | 318 +-
.../caseditor/editor/contextmenu/TypeMenu.java | 153 +-
.../editview/CreateFeatureStructureDialog.java | 23 +-
.../uima/caseditor/editor/editview/EditView.java | 5 +-
.../caseditor/editor/editview/EditViewPage.java | 258 +-
.../editview/FeatureColumnLabelProvider.java | 7 +-
.../editview/FeatureStructureContentProvider.java | 28 +-
.../editor/editview/ValueColumnLabelProvider.java | 20 +-
.../validator/ByteCellEditorValidator.java | 7 +-
.../validator/CellEditorValidatorFacotory.java | 6 +-
.../validator/FloatCellEditorValidator.java | 6 +-
.../validator/IntegerCellEditorValidator.java | 6 +-
.../validator/LongCellEditorValidator.java | 7 +-
.../validator/ShortCellEditorValidator.java | 5 +-
.../editor/fsview/FeatureStructureBrowserView.java | 5 +-
.../fsview/FeatureStructureBrowserViewPage.java | 69 +-
.../fsview/FeatureStructureLabelProvider.java | 13 +-
.../caseditor/editor/fsview/ITypePaneListener.java | 6 +-
.../uima/caseditor/editor/fsview/TypeCombo.java | 61 +-
.../editor/outline/AnnotationOutline.java | 167 +-
.../editor/outline/AnnotationTreeNode.java | 32 +-
.../editor/outline/AnnotationTreeNodeList.java | 25 +-
.../editor/outline/AnnotationTypeTreeNode.java | 40 +-
.../outline/ModeSensitiveContentProvider.java | 54 +-
.../editor/outline/OutlineContentProviderBase.java | 163 +-
.../editor/outline/OutlineLabelProvider.java | 12 +-
.../caseditor/editor/outline/OutlinePageBook.java | 16 +-
.../caseditor/editor/outline/OutlineStyles.java | 11 +-
.../editor/outline/OutlineTableSorter.java | 19 +-
.../editor/outline/SwitchStyleAction.java | 62 +-
.../editor/outline/TypeGroupedContentProvider.java | 274 +-
.../editor/styleview/AnnotationStyleView.java | 3 +-
.../editor/styleview/AnnotationStyleViewPage.java | 198 +-
.../editor/styleview/AnnotationTypeNode.java | 32 +-
.../editor/util/AnnotationComparator.java | 11 +-
.../caseditor/editor/util/AnnotationSelection.java | 16 +-
.../editor/util/ContainingConstraint.java | 20 +-
.../editor/util/FeatureStructureTransfer.java | 54 +-
.../uima/caseditor/editor/util/IDGenerator.java | 11 +-
.../uima/caseditor/editor/util/ObjectTransfer.java | 14 +-
.../uima/caseditor/editor/util/Primitives.java | 103 +-
.../apache/uima/caseditor/editor/util/Span.java | 27 +-
.../editor/util/StrictTypeConstraint.java | 9 +-
.../uima/caseditor/editor/util/UimaUtil.java | 6 +-
.../ui/property/AnnotationPropertyPage.java | 252 +-
.../ui/property/EditorAnnotationPropertyPage.java | 10 +-
.../core/model/dotcorpus/AnnotationStyleTest.java | 28 +-
.../model/dotcorpus/DotCorpusSerializerTest.java | 7 +-
.../apache/uima/caseditor/core/util/SpanTest.java | 48 +-
.../uima/caseditor/editor/AnnotationStyleTest.java | 24 +-
.../uima/caseditor/editor/util/SpanTest.java | 52 +-
.../uima/taeconfigurator/CDEpropertyPage.java | 57 +-
.../uima/taeconfigurator/InternalErrorCDE.java | 13 +-
.../org/apache/uima/taeconfigurator/Messages.java | 12 +-
.../uima/taeconfigurator/PreferencePage.java | 17 +-
.../uima/taeconfigurator/StandardStrings.java | 3 +-
.../taeconfigurator/TAEConfiguratorPlugin.java | 35 +-
.../uima/taeconfigurator/editors/Form2Panel.java | 10 +-
.../taeconfigurator/editors/MultiPageEditor.java | 1337 ++++----
.../editors/MultiPageEditorContributor.java | 169 +-
.../editors/point/IUimaEditorExtension.java | 47 +-
.../editors/point/IUimaMultiPageEditor.java | 20 +-
.../editors/ui/AbstractImportablePartSection.java | 107 +-
.../editors/ui/AbstractSection.java | 992 +++---
.../editors/ui/AbstractSectionParm.java | 362 ++-
.../taeconfigurator/editors/ui/AggregatePage.java | 9 +-
.../editors/ui/AggregateSection.java | 165 +-
.../taeconfigurator/editors/ui/CapabilityPage.java | 7 +-
.../editors/ui/CapabilitySection.java | 300 +-
.../editors/ui/ExtnlResBindSection.java | 111 +-
.../editors/ui/FileAndShortName.java | 14 +-
.../taeconfigurator/editors/ui/FlowSection.java | 131 +-
.../taeconfigurator/editors/ui/GeneralSection.java | 42 +-
.../taeconfigurator/editors/ui/HeaderPage.java | 90 +-
.../editors/ui/HeaderPageWithSash.java | 34 +-
.../editors/ui/ImportResBindSection.java | 48 +-
.../taeconfigurator/editors/ui/ImportSection.java | 123 +-
.../editors/ui/IndexImportSection.java | 51 +-
.../taeconfigurator/editors/ui/IndexSection.java | 93 +-
.../taeconfigurator/editors/ui/IndexesPage.java | 11 +-
.../editors/ui/MetaDataSection.java | 23 +-
.../taeconfigurator/editors/ui/OverviewPage.java | 14 +-
.../editors/ui/ParameterDelegatesSection.java | 167 +-
.../taeconfigurator/editors/ui/ParameterPage.java | 11 +-
.../editors/ui/ParameterSection.java | 332 +-
.../editors/ui/ParameterSettingsSection.java | 14 +-
.../editors/ui/PrimitiveSection.java | 40 +-
.../editors/ui/PriorityListSection.java | 44 +-
.../editors/ui/ResourceDependencySection.java | 102 +-
.../taeconfigurator/editors/ui/ResourcesPage.java | 11 +-
.../taeconfigurator/editors/ui/SettingsPage.java | 11 +-
.../taeconfigurator/editors/ui/SofaMapSection.java | 137 +-
.../editors/ui/TypeImportSection.java | 42 +-
.../uima/taeconfigurator/editors/ui/TypePage.java | 7 +-
.../editors/ui/TypePriorityImportSection.java | 51 +-
.../taeconfigurator/editors/ui/TypeSection.java | 451 +--
.../uima/taeconfigurator/editors/ui/Utility.java | 211 +-
.../taeconfigurator/editors/ui/ValueSection.java | 59 +-
.../editors/ui/dialogs/AbstractDialog.java | 390 ++-
.../ui/dialogs/AbstractDialogKeyVerify.java | 32 +-
.../dialogs/AbstractDialogKeyVerifyJavaNames.java | 31 +-
.../ui/dialogs/AbstractDialogMultiColTable.java | 78 +-
.../editors/ui/dialogs/AddAllowedValueDialog.java | 31 +-
.../ui/dialogs/AddCapabilityFeatureDialog.java | 44 +-
.../ui/dialogs/AddCapabilityTypeDialog.java | 72 +-
.../AddExternalResourceDependencyDialog.java | 41 +-
.../ui/dialogs/AddExternalResourceDialog.java | 49 +-
.../editors/ui/dialogs/AddFeatureDialog.java | 87 +-
.../editors/ui/dialogs/AddIndexDialog.java | 92 +-
.../editors/ui/dialogs/AddIndexKeyDialog.java | 59 +-
.../editors/ui/dialogs/AddParameterDialog.java | 53 +-
.../editors/ui/dialogs/AddRemoteServiceDialog.java | 182 +-
.../editors/ui/dialogs/AddSofaDialog.java | 91 +-
.../editors/ui/dialogs/AddTypeDialog.java | 39 +-
.../ui/dialogs/AddTypeToPriorityListDialog.java | 33 +-
.../editors/ui/dialogs/CommonInputDialog.java | 56 +-
.../editors/ui/dialogs/ContentAssistField32.java | 20 +-
.../editors/ui/dialogs/EditSofaBindingsDialog.java | 28 +-
.../ui/dialogs/ExportImportablePartDialog.java | 58 +-
.../editors/ui/dialogs/FindComponentDialog.java | 46 +-
.../editors/ui/dialogs/PickTaeForTypesDialog.java | 76 +-
.../editors/ui/dialogs/ResourcePickerDialog.java | 118 +-
.../editors/ui/dialogs/SearchMonitoringThread.java | 13 +-
.../editors/ui/dialogs/SearchThread.java | 91 +-
.../editors/ui/dialogs/SelectTypeDialog.java | 105 +-
.../editors/ui/dialogs/TypesWithNameSpaces.java | 8 +-
.../editors/ui/dialogs/TypesWithNameSpaces32.java | 114 +-
.../taeconfigurator/editors/xml/ColorManager.java | 4 +-
.../editors/xml/IXMLColorConstants.java | 3 +-
.../editors/xml/NonRuleBasedDamagerRepairer.java | 40 +-
.../uima/taeconfigurator/editors/xml/TagRule.java | 14 +-
.../editors/xml/XMLConfiguration.java | 60 +-
.../editors/xml/XMLDocumentProvider.java | 5 +-
.../editors/xml/XMLDoubleClickStrategy.java | 22 +-
.../taeconfigurator/editors/xml/XMLEditor.java | 34 +-
.../editors/xml/XMLPartitionScanner.java | 3 +-
.../taeconfigurator/editors/xml/XMLScanner.java | 7 +-
.../taeconfigurator/editors/xml/XMLTagScanner.java | 4 +-
.../editors/xml/XMLWhitespaceDetector.java | 5 +-
.../files/ContextForPartDialog.java | 158 +-
.../files/MultiResourceSelectionDialog.java | 232 +-
...MultiResourceSelectionDialogWithFlowOption.java | 35 +-
.../files/PickOverrideKeysAndParmName.java | 438 ++-
.../taeconfigurator/model/AbstractModelPart.java | 4 +-
.../uima/taeconfigurator/model/AllTypes.java | 4 +-
.../uima/taeconfigurator/model/BuiltInTypes.java | 1 -
.../uima/taeconfigurator/model/ConfigGroup.java | 16 +-
.../model/DefinedTypesWithSupers.java | 4 +-
.../taeconfigurator/model/DescriptorMetaData.java | 16 +-
.../uima/taeconfigurator/model/DescriptorTCAS.java | 13 +-
.../uima/taeconfigurator/model/FlowNodes.java | 9 +-
.../taeconfigurator/wizards/AbstractNewWizard.java | 117 +-
.../wizards/AbstractNewWizardPage.java | 27 +-
.../wizards/CasConsumerNewWizard.java | 61 +-
.../wizards/CasConsumerNewWizardPage.java | 4 +-
.../wizards/CasInitializerNewWizard.java | 63 +-
.../wizards/CasInitializerNewWizardPage.java | 4 +-
.../wizards/CollectionReaderNewWizard.java | 63 +-
.../wizards/CollectionReaderNewWizardPage.java | 4 +-
.../wizards/FlowControllerNewWizard.java | 65 +-
.../wizards/FlowControllerNewWizardPage.java | 4 +-
.../wizards/FsIndexCollectionNewWizard.java | 54 +-
.../wizards/FsIndexCollectionNewWizardPage.java | 4 +-
.../ResourceManagerConfigurationNewWizard.java | 54 +-
.../ResourceManagerConfigurationNewWizardPage.java | 8 +-
.../wizards/TAEConfiguratorNewWizard.java | 65 +-
.../wizards/TAEConfiguratorNewWizardPage.java | 4 +-
.../wizards/TypePrioritiesNewWizard.java | 52 +-
.../wizards/TypePrioritiesNewWizardPage.java | 4 +-
.../wizards/TypeSystemNewWizard.java | 41 +-
.../wizards/TypeSystemNewWizardPage.java | 4 +-
.../java/org/apache/uima/ep_debug/DebugPlugin.java | 70 +-
.../apache/uima/ep_debug/DebugPluginStartup.java | 24 +-
.../uima/jcas/jcasgenp/EP_LogThrowErrorImpl.java | 2 +-
.../org/apache/uima/jcas/jcasgenp/JgPlugin.java | 4 +-
.../apache/uima/jcas/jcasgenp/JgPluginRunner.java | 4 +-
.../org/apache/uima/jcas/jcasgenp/MergerImpl.java | 10 +-
.../uima/jcas/jcasgenp/ProgressMonitorImpl.java | 30 +-
.../src/main/java/example/PersonTitle.java | 202 +-
.../apache/uima/examples/ExampleApplication.java | 4 +-
.../org/apache/uima/examples/PrintAnnotations.java | 37 +-
.../main/java/org/apache/uima/examples/RunAE.java | 64 +-
.../uima/examples/SofaExampleApplication.java | 81 +-
.../uima/examples/SourceDocumentInformation.java | 270 +-
.../java/org/apache/uima/examples/XmlDetagger.java | 28 +-
.../uima/examples/cas/PersonTitleAnnotator.java | 68 +-
.../apache/uima/examples/cas/RegExAnnotator.java | 51 +-
.../CasMultiplierExampleApplication.java | 2 +-
.../examples/casMultiplier/SimpleTextMerger.java | 11 +-
.../casMultiplier/SimpleTextSegmenter.java | 3 +-
.../uima/examples/cpe/AnnotationPrinter.java | 21 +-
.../examples/cpe/FileSystemCollectionReader.java | 40 +-
.../uima/examples/cpe/InlineXmlCasConsumer.java | 5 +-
.../cpe/PersonTitleDBWriterCasConsumer.java | 52 +-
.../org/apache/uima/examples/cpe/SimpleRunCPE.java | 28 +-
.../org/apache/uima/examples/cpe/SimpleRunCPM.java | 42 +-
.../uima/examples/cpe/XCasWriterCasConsumer.java | 17 +-
.../examples/flow/AdvancedFixedFlowController.java | 100 +-
.../examples/flow/WhiteboardFlowController.java | 15 +-
.../examples/flow/WhiteboardFlowController2.java | 18 +-
.../apache/uima/examples/tokenizer/Sentence.java | 120 +-
.../tokenizer/SimpleTokenAndSentenceAnnotator.java | 29 +-
.../org/apache/uima/examples/tokenizer/Token.java | 120 +-
.../uima/examples/xmi/Ecore2UimaTypeSystem.java | 113 +-
.../uima/examples/xmi/UimaTypeSystem2Ecore.java | 93 +-
.../uima/examples/xmi/XmiCollectionReader.java | 16 +-
.../uima/examples/xmi/XmiEcoreCasConsumer.java | 28 +-
.../uima/examples/xmi/XmiWriterCasConsumer.java | 14 +-
.../java/org/apache/uima/tutorial/DateAnnot.java | 154 +-
.../org/apache/uima/tutorial/DateTimeAnnot.java | 216 +-
.../java/org/apache/uima/tutorial/Meeting.java | 402 +--
.../java/org/apache/uima/tutorial/RoomNumber.java | 217 +-
.../org/apache/uima/tutorial/SentenceAnnot.java | 143 +-
.../java/org/apache/uima/tutorial/TimeAnnot.java | 154 +-
.../java/org/apache/uima/tutorial/UimaAcronym.java | 244 +-
.../java/org/apache/uima/tutorial/UimaMeeting.java | 190 +-
.../java/org/apache/uima/tutorial/WordAnnot.java | 143 +-
.../uima/tutorial/ex2/RoomNumberAnnotator.java | 2 +-
.../apache/uima/tutorial/ex3/TutorialDateTime.java | 30 +-
.../apache/uima/tutorial/ex4/MeetingAnnotator.java | 18 +-
.../uima/tutorial/ex6/UimaMeetingAnnotator.java | 5 +-
.../uima/tools/AnnotationFeaturesViewer.java | 17 +-
.../apache/uima/tools/AnnotationViewerMain.java | 67 +-
.../src/main/java/org/apache/uima/tools/RunAE.java | 65 +-
.../org/apache/uima/tools/ValidateDescriptor.java | 7 +-
.../org/apache/uima/tools/annot_view/Gladis.java | 8 +-
.../components/FileSystemCollectionReader.java | 25 +-
.../tools/components/InlineXmlCasConsumer.java | 15 +-
.../tools/components/XCasWriterCasConsumer.java | 7 +-
.../tools/components/XmiWriterCasConsumer.java | 23 +-
.../apache/uima/tools/components/XmlDetagger.java | 29 +-
.../apache/uima/tools/cpm/AnalysisEnginePanel.java | 28 +-
.../org/apache/uima/tools/cpm/ConfigField.java | 18 +-
.../org/apache/uima/tools/cpm/ConsumerPanel.java | 31 +-
.../java/org/apache/uima/tools/cpm/CpmFrame.java | 28 +-
.../java/org/apache/uima/tools/cpm/CpmPanel.java | 468 +--
.../uima/tools/cpm/ElapsedTimeFormatter.java | 6 +-
.../uima/tools/cpm/JTabbedPaneWithCloseIcons.java | 45 +-
.../org/apache/uima/tools/cpm/MetaDataPanel.java | 29 +-
.../uima/tools/cpm/PerformanceReportDialog.java | 41 +-
.../apache/uima/tools/cpm/TabClosedListener.java | 9 +-
.../cvd/AnnotationDisplayCustomizationFrame.java | 124 +-
.../apache/uima/tools/cvd/AnnotationExtent.java | 11 +-
.../java/org/apache/uima/tools/cvd/ArrayNode.java | 22 +-
.../org/apache/uima/tools/cvd/AutoFoldingMenu.java | 14 +-
.../main/java/org/apache/uima/tools/cvd/CVD.java | 24 +-
.../java/org/apache/uima/tools/cvd/ColorIcon.java | 8 +-
.../java/org/apache/uima/tools/cvd/FSNode.java | 329 +-
.../org/apache/uima/tools/cvd/FSTreeModel.java | 163 +-
.../java/org/apache/uima/tools/cvd/FSTreeNode.java | 5 +-
.../org/apache/uima/tools/cvd/IndexTreeNode.java | 22 +-
.../org/apache/uima/tools/cvd/LogFileViewer.java | 284 +-
.../java/org/apache/uima/tools/cvd/MainFrame.java | 378 ++-
.../org/apache/uima/tools/cvd/MarkupExtent.java | 11 +-
.../uima/tools/cvd/MultiAnnotViewerFrame.java | 40 +-
.../org/apache/uima/tools/cvd/MultiMarkup.java | 37 +-
.../org/apache/uima/tools/cvd/RecentFilesList.java | 27 +-
.../uima/tools/cvd/StringFsPopupEventAdapter.java | 57 +-
.../org/apache/uima/tools/cvd/TypeTreeNode.java | 14 +-
.../uima/tools/cvd/control/AboutHandler.java | 20 +-
.../uima/tools/cvd/control/AboutUimaHandler.java | 9 +-
.../uima/tools/cvd/control/AddLanguageHandler.java | 9 +-
.../cvd/control/AnnotatorOpenEventHandler.java | 8 +-
.../cvd/control/AnnotatorRerunEventHandler.java | 8 +-
.../cvd/control/AnnotatorRunCPCEventHandler.java | 8 +-
.../cvd/control/AnnotatorRunOnCasEventHandler.java | 8 +-
.../uima/tools/cvd/control/CaretChangeHandler.java | 8 +-
.../cvd/control/CloseAnnotationViewHandler.java | 14 +-
.../tools/cvd/control/CloseLogViewHandler.java | 15 +-
.../tools/cvd/control/CloseTypeSystemHandler.java | 12 +-
.../tools/cvd/control/ColorPrefsOpenHandler.java | 8 +-
.../tools/cvd/control/ColorPrefsSaveHandler.java | 8 +-
.../tools/cvd/control/FSTreeSelectionListener.java | 9 +-
.../tools/cvd/control/FileOpenEventHandler.java | 10 +-
.../tools/cvd/control/FileSaveAsEventHandler.java | 9 +-
.../tools/cvd/control/FileSaveEventHandler.java | 9 +-
.../uima/tools/cvd/control/FocusFSAction.java | 9 +-
.../uima/tools/cvd/control/FocusIRAction.java | 9 +-
.../uima/tools/cvd/control/FocusTextAction.java | 9 +-
.../apache/uima/tools/cvd/control/HelpHandler.java | 13 +-
.../uima/tools/cvd/control/IndexPopupListener.java | 32 +-
.../cvd/control/IndexTreeSelectionListener.java | 15 +-
.../control/LoadRecentDescFileEventHandler.java | 14 +-
.../control/LoadRecentTextFileEventHandler.java | 14 +-
.../uima/tools/cvd/control/MainFrameClosing.java | 12 +-
.../uima/tools/cvd/control/ManualHandler.java | 27 +-
.../tools/cvd/control/NewTextEventHandler.java | 9 +-
.../uima/tools/cvd/control/PopupHandler.java | 13 +-
.../uima/tools/cvd/control/PopupListener.java | 17 +-
.../tools/cvd/control/RemoveLanguageHandler.java | 9 +-
.../cvd/control/RestoreLangDefaultsHandler.java | 9 +-
.../uima/tools/cvd/control/SetCodePageHandler.java | 9 +-
.../uima/tools/cvd/control/SetDataPathHandler.java | 11 +-
.../uima/tools/cvd/control/SetLanguageHandler.java | 9 +-
.../tools/cvd/control/SetLogConfigHandler.java | 5 +-
.../cvd/control/ShowAnnotatedTextHandler.java | 12 +-
.../control/ShowAnnotationCustomizerHandler.java | 11 +-
.../tools/cvd/control/ShowTypesystemHandler.java | 9 +-
.../tools/cvd/control/SofaSelectionListener.java | 21 +-
.../uima/tools/cvd/control/SystemExitHandler.java | 9 +-
.../tools/cvd/control/TextChangedListener.java | 14 +-
.../tools/cvd/control/TextContextMenuAction.java | 8 +-
.../uima/tools/cvd/control/TextFocusHandler.java | 4 +-
.../uima/tools/cvd/control/TreeFocusHandler.java | 13 +-
.../control/TypeSystemFileOpenEventHandler.java | 16 +-
.../org/apache/uima/tools/cvd/control/UndoMgr.java | 17 +-
.../cvd/control/XCASFileOpenEventHandler.java | 12 +-
.../uima/tools/cvd/control/XCASSaveHandler.java | 8 +-
.../uima/tools/cvd/control/XCASSaveTSHandler.java | 8 +-
.../tools/cvd/control/XmiCasFileOpenHandler.java | 12 +-
.../uima/tools/cvd/control/XmiCasSaveHandler.java | 15 +-
.../uima/tools/cvd/tsview/FeatureTableModel.java | 16 +-
.../apache/uima/tools/cvd/tsview/MainFrame.java | 48 +-
.../tools/docanalyzer/AnnotationViewerDialog.java | 200 +-
.../uima/tools/docanalyzer/DocumentAnalyzer.java | 315 +-
.../uima/tools/docanalyzer/FileSelector.java | 59 +-
.../tools/docanalyzer/FileSelectorListener.java | 22 +-
.../uima/tools/docanalyzer/PrefsMediator.java | 71 +-
.../uima/tools/docanalyzer/TfDocumentListener.java | 8 +-
.../tools/docanalyzer/TfFileSelectorListener.java | 8 +-
.../uima/tools/docanalyzer/TfFocusListener.java | 8 +-
.../java/org/apache/uima/tools/jcasgen/GUI.java | 31 +-
.../apache/uima/tools/jcasgen/GuiErrorImpl.java | 7 +-
.../uima/tools/jcasgen/GuiProgressMonitor.java | 26 +-
.../java/org/apache/uima/tools/jcasgen/IError.java | 12 +-
.../java/org/apache/uima/tools/jcasgen/IMerge.java | 27 +-
.../uima/tools/jcasgen/IProgressMonitor.java | 15 +-
.../uima/tools/jcasgen/JCasTypeTemplate.java | 329 +-
.../java/org/apache/uima/tools/jcasgen/Jg.java | 810 +++--
.../uima/tools/jcasgen/LogThrowErrorImpl.java | 3 +-
.../java/org/apache/uima/tools/jcasgen/Prefs.java | 17 +-
.../org/apache/uima/tools/jcasgen/TypeInfo.java | 16 +-
.../tools/jcasgen/UimaLoggerProgressMonitor.java | 26 +-
.../java/org/apache/uima/tools/jcasgen/Waiter.java | 3 +-
.../uima/tools/pear/install/InstallPear.java | 33 +-
.../uima/tools/pear/install/InstallPearCli.java | 79 +-
.../uima/tools/pear/merger/PMController.java | 27 +-
.../uima/tools/pear/merger/PMControllerHelper.java | 8 +-
.../apache/uima/tools/pear/merger/PMUimaAgent.java | 38 +-
.../uima/tools/pear/packager/PearPackager.java | 41 +-
.../apache/uima/tools/stylemap/AnTreeListener.java | 12 +-
.../tools/stylemap/AnnotationFeaturesViewer.java | 42 +-
.../apache/uima/tools/stylemap/ColorEditor.java | 21 +-
.../apache/uima/tools/stylemap/ColorParser.java | 27 +-
.../apache/uima/tools/stylemap/ColorRenderer.java | 11 +-
.../uima/tools/stylemap/LabelCellEditor.java | 10 +-
.../apache/uima/tools/stylemap/MyCellRenderer.java | 24 +-
.../apache/uima/tools/stylemap/StyleConstants.java | 3 +-
.../apache/uima/tools/stylemap/StyleMapEditor.java | 93 +-
.../apache/uima/tools/stylemap/StyleMapEntry.java | 26 +-
.../apache/uima/tools/stylemap/StyleMapTable.java | 19 +-
.../uima/tools/stylemap/StyleMapTableModel.java | 49 +-
.../uima/tools/stylemap/StyleMapXmlParser.java | 24 +-
.../uima/tools/stylemap/TableDropAdapter.java | 13 +-
.../uima/tools/stylemap/TableGUIMediator.java | 21 +-
.../tools/stylemap/TableSelectionListener.java | 21 +-
.../apache/uima/tools/util/gui/AboutDialog.java | 27 +-
.../org/apache/uima/tools/util/gui/Caption.java | 6 +-
.../tools/util/gui/FileChooserBugWorkarounds.java | 5 +-
.../apache/uima/tools/util/gui/FileSelector.java | 118 +-
.../uima/tools/util/gui/FileSelectorListener.java | 22 +-
.../org/apache/uima/tools/util/gui/FormPanel.java | 17 +-
.../apache/uima/tools/util/gui/ImageButton.java | 10 +-
.../apache/uima/tools/util/gui/IntegerField.java | 12 +-
.../apache/uima/tools/util/gui/ListSelector.java | 28 +-
.../apache/uima/tools/util/gui/SliderField.java | 27 +-
.../uima/tools/util/gui/SpringUtilities.java | 82 +-
.../tools/util/gui/TransportControlListener.java | 15 +-
.../uima/tools/util/gui/TransportControlPanel.java | 32 +-
.../apache/uima/tools/util/gui/XMLFileFilter.java | 14 +-
.../util/htmlview/AnnotationViewGenerator.java | 68 +-
.../uima/tools/viewer/CasAnnotationViewer.java | 853 ++---
.../tools/viewer/CasAnnotationViewerApplet.java | 11 +-
.../apache/uima/tools/viewer/CasTreeViewer.java | 52 +-
.../uima/tools/viewer/CasTreeViewerApplet.java | 9 +-
.../apache/uima/tools/viewer/EntityResolver.java | 48 +-
.../uima/tools/pear/merger/PearMergerTest.java | 29 +-
.../uima/tools/viewer/CasAnnotationViewerTest.java | 127 +-
.../apache/uima/migratev3/jcas/MigrateJCas.java | 3404 +++++++++++---------
542 files changed, 20886 insertions(+), 16643 deletions(-)
[uima-uimaj] 01/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit bc5668e87e069ae0d04bf9cff40d65470597a5a5
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 14:56:22 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../org/apache/uima/bootstrap/UimaBootstrap.java | 207 +++++++++++----------
1 file changed, 105 insertions(+), 102 deletions(-)
diff --git a/uimaj-bootstrap/src/main/java/org/apache/uima/bootstrap/UimaBootstrap.java b/uimaj-bootstrap/src/main/java/org/apache/uima/bootstrap/UimaBootstrap.java
index 7865d6b..5ceb496 100644
--- a/uimaj-bootstrap/src/main/java/org/apache/uima/bootstrap/UimaBootstrap.java
+++ b/uimaj-bootstrap/src/main/java/org/apache/uima/bootstrap/UimaBootstrap.java
@@ -31,62 +31,65 @@ import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.List;
-
/**
- * Run an arbitrary "main" method in a class, after adding classes to the classpath
- * that are specified as libraries, or as jar files
+ * Run an arbitrary "main" method in a class, after adding classes to the classpath that are
+ * specified as libraries, or as jar files
+ *
+ * Uses arguments: -Dorg.apache.uima.jarpath=XXXX where XXXX is a string of file paths to
+ * directories connected using File.pathSeparator; each directory's contained JARs will be added to
+ * the class path. If the directory has no Jars, then it is put in the class path directly.
+ *
+ * The paths can also contain jar files.
+ *
+ * The paths added are added in an arbitrary order. The normal parent-first delegation is done
*
- * Uses arguments:
- * -Dorg.apache.uima.jarpath=XXXX where XXXX is
- * a string of file paths to directories connected using File.pathSeparator; each
- * directory's contained JARs will be added to the class path.
- * If the directory has no Jars, then it is put in the class path directly.
- *
- * The paths can also contain jar files.
- *
- * The paths added are added in an arbitrary order.
- * The normal parent-first delegation is done
- *
- * The first argument is taken to be the name of the class to launch;
- * that is passed the rest of the arguments.
+ * The first argument is taken to be the name of the class to launch; that is passed the rest of the
+ * arguments.
*
*/
public class UimaBootstrap {
private static boolean suppressClassPathDisplay;
- public static void main(String[] args) throws SecurityException, NoSuchMethodException, IllegalArgumentException, IllegalAccessException, InvocationTargetException, MalformedURLException, IOException, URISyntaxException {
+ public static void main(String[] args) throws SecurityException, NoSuchMethodException,
+ IllegalArgumentException, IllegalAccessException, InvocationTargetException,
+ MalformedURLException, IOException, URISyntaxException {
if (args == null || args.length == 0) {
System.err.println("Usage: specify -Dorg.apache.uima.jarpath=XXXX, where");
- System.err.println(" XXXX is a string of file paths to directories or jar files, separated using the proper path separator character.");
- System.err.println(" For directories, all of the JARs found in these directories will be added to the classpath.");
- System.err.println(" If the directory has no Jars, then it is put in the class path directly.");
+ System.err.println(
+ " XXXX is a string of file paths to directories or jar files, separated using the proper path separator character.");
+ System.err.println(
+ " For directories, all of the JARs found in these directories will be added to the classpath.");
+ System.err.println(
+ " If the directory has no Jars, then it is put in the class path directly.");
System.err.println(" Normal \"parent-first\" delegation is done.");
- System.err.println(" The first argument is taken to be the name of the class whose \"main\" method will be called and passed the rest of the arguments.");
- System.err.println(" Set -DUimaBootstrapSuppressClassPathDisplay to suppress the display of the resulting classpath");
-
+ System.err.println(
+ " The first argument is taken to be the name of the class whose \"main\" method will be called and passed the rest of the arguments.");
+ System.err.println(
+ " Set -DUimaBootstrapSuppressClassPathDisplay to suppress the display of the resulting classpath");
+
System.exit(1);
- }
+ }
suppressClassPathDisplay = System.getProperty("UimaBootstrapSuppressClassPathDisplay") != null;
URL[] urls = getUrls();
-// URLClassLoader cl = new ParentFirstWithResourceClassLoader(urls);
-// Thread.currentThread().setContextClassLoader(cl);
+ // URLClassLoader cl = new ParentFirstWithResourceClassLoader(urls);
+ // Thread.currentThread().setContextClassLoader(cl);
ClassLoader myClassLoader = addUrlsToSystemLoader(urls);
-
+
Class<?> classToLaunch = null;
try {
classToLaunch = myClassLoader.loadClass(args[0]);
} catch (ClassNotFoundException e) {
- System.err.println("Cannot find class to launch");
- System.exit(1);
- }
+ System.err.println("Cannot find class to launch");
+ System.exit(1);
+ }
Method mainMethod = classToLaunch.getMethod("main", String[].class);
int args2length = args.length - 1;
- String [] args2 = new String[args2length];
+ String[] args2 = new String[args2length];
System.arraycopy(args, 1, args2, 0, args2length);
- mainMethod.invoke(null, (Object)args2);
+ mainMethod.invoke(null, (Object) args2);
}
-
+
private static URL[] getUrls() throws MalformedURLException, IOException, URISyntaxException {
String jps = System.getProperty("org.apache.uima.jarpath");
if (null == jps) {
@@ -111,9 +114,10 @@ public class UimaBootstrap {
return (name.endsWith(".jar"));
}
};
-
- private static void addUrlsFromPath(String p, List<URL> urls) throws MalformedURLException, IOException, URISyntaxException {
- // handle case where the path part is written x/y/z/* by dropping the /* at the end
+
+ private static void addUrlsFromPath(String p, List<URL> urls)
+ throws MalformedURLException, IOException, URISyntaxException {
+ // handle case where the path part is written x/y/z/* by dropping the /* at the end
// This is the form used by Java itself for classpath
if (p.endsWith("*") && p.length() > 2 && p.charAt(p.length() - 2) == File.separatorChar) {
p = p.substring(0, p.length() - 2);
@@ -124,86 +128,85 @@ public class UimaBootstrap {
if (jars.length == 0) {
// this is the case where the user wants to include
// a directory containing non-jar'd .class files
- add(urls, pf);
+ add(urls, pf);
} else {
- for (File f : jars) {
- add(urls, f);
- }
+ for (File f : jars) {
+ add(urls, f);
+ }
}
} else if (p.toLowerCase().endsWith(".jar")) {
add(urls, pf);
}
}
-
+
private static void add(List<URL> urls, File cp) throws MalformedURLException {
URL url = cp.toURI().toURL();
if (!suppressClassPathDisplay) {
- System.out.format( " %s%n", url.toString());
+ System.out.format(" %s%n", url.toString());
}
urls.add(url);
}
private static ClassLoader addUrlsToSystemLoader(URL[] urls) throws IOException {
return new URLClassLoader(urls, ClassLoader.getSystemClassLoader());
-
-// URLClassLoader systemClassLoader = (URLClassLoader) ClassLoader.getSystemClassLoader();
-// try {
-// Method method = URLClassLoader.class.getDeclaredMethod("addURL", new Class[]{URL.class});
-// method.setAccessible(true); // is normally "protected"
-// for (URL url : urls) {
-// method.invoke(systemClassLoader, new Object[]{url});
-// }
-// } catch (Throwable t) {
-// t.printStackTrace();
-// throw new IOException("Error, could not add URL to system classloader");
-// }
+
+ // URLClassLoader systemClassLoader = (URLClassLoader) ClassLoader.getSystemClassLoader();
+ // try {
+ // Method method = URLClassLoader.class.getDeclaredMethod("addURL", new Class[]{URL.class});
+ // method.setAccessible(true); // is normally "protected"
+ // for (URL url : urls) {
+ // method.invoke(systemClassLoader, new Object[]{url});
+ // }
+ // } catch (Throwable t) {
+ // t.printStackTrace();
+ // throw new IOException("Error, could not add URL to system classloader");
+ // }
}
-
-
-// private static class ParentFirstWithResourceClassLoader extends URLClassLoader {
-//
-// /**
-// * Creates a new ParentFirstWithResourceClassLoader
-// *
-// * @param urls
-// * an array of URLs representing JAR files
-// *
-// * @throws MalformedURLException
-// * if a malformed URL has occurred in the classpath string.
-// */
-// public ParentFirstWithResourceClassLoader(URL[] urls) {
-// super(urls);
-// }
-//
-//
-// @SuppressWarnings("unchecked")
-// protected synchronized Class loadClass(String name, boolean resolve)
-// throws ClassNotFoundException {
-// // First, check if the class has already been loaded
-// Class c = findLoadedClass(name);
-// if (c == null) {
-// // delegate class loading for class
-// try {
-// c = super.loadClass(name, false);
-// } catch (ClassNotFoundException e) {
-// // try to load class
-// c = findClass(name);
-// }
-// }
-// if (resolve) {
-// resolveClass(c);
-// }
-// return c;
-// }
-//
-// // make sure resources are looked up first in this loader
-// // ASSUMES that getResourceAsStream calls getResource
-//// @Override
-//// public URL getResource(String resName) {
-//// URL r = findResource(resName);
-//// if (r != null)
-//// return r;
-//// return super.getResource(resName);
-//// }
-// }
+
+ // private static class ParentFirstWithResourceClassLoader extends URLClassLoader {
+ //
+ // /**
+ // * Creates a new ParentFirstWithResourceClassLoader
+ // *
+ // * @param urls
+ // * an array of URLs representing JAR files
+ // *
+ // * @throws MalformedURLException
+ // * if a malformed URL has occurred in the classpath string.
+ // */
+ // public ParentFirstWithResourceClassLoader(URL[] urls) {
+ // super(urls);
+ // }
+ //
+ //
+ // @SuppressWarnings("unchecked")
+ // protected synchronized Class loadClass(String name, boolean resolve)
+ // throws ClassNotFoundException {
+ // // First, check if the class has already been loaded
+ // Class c = findLoadedClass(name);
+ // if (c == null) {
+ // // delegate class loading for class
+ // try {
+ // c = super.loadClass(name, false);
+ // } catch (ClassNotFoundException e) {
+ // // try to load class
+ // c = findClass(name);
+ // }
+ // }
+ // if (resolve) {
+ // resolveClass(c);
+ // }
+ // return c;
+ // }
+ //
+ // // make sure resources are looked up first in this loader
+ // // ASSUMES that getResourceAsStream calls getResource
+ //// @Override
+ //// public URL getResource(String resName) {
+ //// URL r = findResource(resName);
+ //// if (r != null)
+ //// return r;
+ //// return super.getResource(resName);
+ //// }
+ // }
}
[uima-uimaj] 15/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit 98207e608ef8a1e8f36b12b5dcb53c516f6ce3a3
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:36:22 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../main/java/org/apache/vinci/debug/Debug.java | 11 +-
.../org/apache/vinci/debug/FatalException.java | 2 +-
.../org/apache/vinci/transport/BaseClient.java | 246 ++++++++++++-------
.../org/apache/vinci/transport/BaseServer.java | 26 +-
.../apache/vinci/transport/BaseServerRunnable.java | 7 +-
.../java/org/apache/vinci/transport/Frame.java | 34 ++-
.../org/apache/vinci/transport/FrameComponent.java | 4 +-
.../java/org/apache/vinci/transport/FrameLeaf.java | 29 ++-
.../apache/vinci/transport/FrameTransporter.java | 9 +-
.../org/apache/vinci/transport/KeyValuePair.java | 6 +-
.../apache/vinci/transport/LeafCastException.java | 2 +-
.../apache/vinci/transport/PooledVinciClient.java | 84 +++++--
.../vinci/transport/ServiceDownException.java | 2 +-
.../vinci/transport/SimpleTransportable.java | 3 +-
.../org/apache/vinci/transport/Transportable.java | 6 +-
.../org/apache/vinci/transport/VNSException.java | 2 +-
.../org/apache/vinci/transport/VinciClient.java | 262 +++++++++++++--------
.../org/apache/vinci/transport/VinciFrame.java | 64 +++--
.../org/apache/vinci/transport/VinciServer.java | 99 +++++---
.../apache/vinci/transport/XTalkTransporter.java | 205 ++++++++++------
.../vinci/transport/context/VinciContext.java | 206 ++++++++++------
.../apache/vinci/transport/document/AFrame.java | 127 ++++++----
.../vinci/transport/document/XMLToVinci.java | 16 +-
.../vinci/transport/document/XMLToXTalk.java | 36 ++-
.../vinci/transport/document/XTalkToSAX.java | 11 +-
.../vinci/transport/util/Base64Converter.java | 54 +++--
.../vinci/transport/util/StreamMaterializer.java | 6 +-
.../apache/vinci/transport/util/UTFConverter.java | 53 +++--
.../apache/vinci/transport/util/XMLConverter.java | 28 ++-
.../vinci/transport/vns/client/ResolveResult.java | 16 +-
.../vinci/transport/vns/client/ServeonResult.java | 27 ++-
.../vinci/transport/vns/client/VNSConfig.java | 14 +-
.../vinci/transport/vns/service/NameClient.java | 24 +-
.../vinci/transport/vns/service/ServiceAlias.java | 4 +-
.../transport/vns/service/ServiceRegistry.java | 9 +-
.../apache/vinci/transport/vns/service/VNS.java | 30 +--
.../uima/tools/jcasgen/maven/JCasGenMojo.java | 19 +-
.../uima/tools/jcasgen/maven/JCasGenMojoTest.java | 50 ++--
38 files changed, 1178 insertions(+), 655 deletions(-)
diff --git a/jVinci/src/main/java/org/apache/vinci/debug/Debug.java b/jVinci/src/main/java/org/apache/vinci/debug/Debug.java
index 49a61cf..7109fa1 100644
--- a/jVinci/src/main/java/org/apache/vinci/debug/Debug.java
+++ b/jVinci/src/main/java/org/apache/vinci/debug/Debug.java
@@ -206,7 +206,9 @@ public class Debug {
/**
* Same function as {@link #printDebuggingMessage(String)} but easier to type.
- * @param message -
+ *
+ * @param message
+ * -
* @return -
*/
static public String p(String message) {
@@ -215,8 +217,11 @@ public class Debug {
/**
* Same function as {@link #printDebuggingMessage(String,String)} but easier to type.
- * @param location -
- * @param message -
+ *
+ * @param location
+ * -
+ * @param message
+ * -
*/
static public void p(String location, String message) {
printDebuggingMessage(location, message);
diff --git a/jVinci/src/main/java/org/apache/vinci/debug/FatalException.java b/jVinci/src/main/java/org/apache/vinci/debug/FatalException.java
index 5e5ebdc..cfdf473 100644
--- a/jVinci/src/main/java/org/apache/vinci/debug/FatalException.java
+++ b/jVinci/src/main/java/org/apache/vinci/debug/FatalException.java
@@ -25,7 +25,7 @@ package org.apache.vinci.debug;
*
*/
public class FatalException extends RuntimeException {
-
+
private static final long serialVersionUID = -8889142805115637932L;
private Throwable original_exception;
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/BaseClient.java b/jVinci/src/main/java/org/apache/vinci/transport/BaseClient.java
index 0a078e7..67cc349 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/BaseClient.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/BaseClient.java
@@ -197,6 +197,7 @@ public class BaseClient {
/**
* Get the hostname/ip address to which this client is connected.
+ *
* @return -
*/
public String getHost() {
@@ -209,6 +210,7 @@ public class BaseClient {
/**
* Get the socket used for the connection.
+ *
* @return -
*/
protected Socket getSocket() {
@@ -218,6 +220,7 @@ public class BaseClient {
/**
* Get the default timeout value for the socket (0 indicates never timeout, which is the default,
* but generally NOT a good setting).
+ *
* @return -
*/
public int getSocketTimeout() {
@@ -238,7 +241,9 @@ public class BaseClient {
/**
* Set the transportable factory used by this client.
- * @param f -
+ *
+ * @param f
+ * -
*/
public void setTransportableFactory(TransportableFactory f) {
factory = f;
@@ -302,8 +307,8 @@ public class BaseClient {
*
* @pre getHost() != null
*/
- public Transportable sendAndReceive(Transportable in, int timeout) throws IOException,
- ServiceException {
+ public Transportable sendAndReceive(Transportable in, int timeout)
+ throws IOException, ServiceException {
try {
try {
if (!isOpen()) {
@@ -337,15 +342,18 @@ public class BaseClient {
* @pre in != null
*
* @pre getHost() != null
- * @param in -
+ * @param in
+ * -
* @param f
* The factory to used to create the return document.
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
- public Transportable sendAndReceive(Transportable in, TransportableFactory f) throws IOException,
- ServiceException {
+ public Transportable sendAndReceive(Transportable in, TransportableFactory f)
+ throws IOException, ServiceException {
try {
try {
if (!isOpen()) {
@@ -374,12 +382,17 @@ public class BaseClient {
* Same as sendAndReceive(Transportable, timeout) except the provided factory is used to create
* the return document in place of the default factory.
*
- * @param in -
- * @param f The factory to used to create the return document.
- * @param timeout -
+ * @param in
+ * -
+ * @param f
+ * The factory to used to create the return document.
+ * @param timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
* @pre in != null
* @pre f != null
* @pre getHost() != null
@@ -417,10 +430,13 @@ public class BaseClient {
*
* @pre query != null
* @pre getHost() != null
- * @param query -
+ * @param query
+ * -
* @return A VinciFrame representing the service result.
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
public VinciFrame rpc(Transportable query) throws IOException, ServiceException {
return (VinciFrame) sendAndReceive(query);
@@ -430,11 +446,16 @@ public class BaseClient {
* Same as sendAndReceive(Transportable, timeout) except for return type. Syntactic sugar method
* for the case where return result is known to be VinciFrame (eliminates the need for casting in
* the typical usage case).
- * @param query -
- * @param timeout -
+ *
+ * @param query
+ * -
+ * @param timeout
+ * -
* @return A VinciFrame representing the service result.
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*
* @pre query != null
* @pre getHost() != null
@@ -532,7 +553,9 @@ public class BaseClient {
* Set connection restablishment on IOException to on/off, default is ON. This way, by default,
* BaseClient attempts to reopen a connection at most once if it receives an IOException which can
* happen, for example, from the connection timing out.
- * @param to -
+ *
+ * @param to
+ * -
*/
public void setRetry(boolean to) {
retry = to;
@@ -540,6 +563,7 @@ public class BaseClient {
/**
* Fetch the header of the last Transportable received.
+ *
* @return -
*/
public KeyValuePair getHeader() {
@@ -553,13 +577,19 @@ public class BaseClient {
* @pre f != null
* @pre p ≥ 0
* @pre p < 65536
- * @param in -
- * @param host_name -
- * @param p -
- * @param f -
+ * @param in
+ * -
+ * @param host_name
+ * -
+ * @param p
+ * -
+ * @param f
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
static public Transportable sendAndReceive(Transportable in, String host_name, int p,
TransportableFactory f) throws IOException, ServiceException {
@@ -580,14 +610,21 @@ public class BaseClient {
* @pre f != null
* @pre p ≥ 0
* @pre p < 65536
- * @param in -
- * @param host_name -
- * @param p -
- * @param f -
- * @param socket_timeout -
+ * @param in
+ * -
+ * @param host_name
+ * -
+ * @param p
+ * -
+ * @param f
+ * -
+ * @param socket_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
static public Transportable sendAndReceive(Transportable in, String host_name, int p,
TransportableFactory f, int socket_timeout) throws IOException, ServiceException {
@@ -602,7 +639,7 @@ public class BaseClient {
}
/**
- * Convenience method for "one-shot" or "single-query" connections with socket timeout support
+ * Convenience method for "one-shot" or "single-query" connections with socket timeout support
* & connect timeout support.
*
* @pre in != null
@@ -610,19 +647,27 @@ public class BaseClient {
* @pre f != null
* @pre p ≥ 0
* @pre p < 65536
- * @param in -
- * @param host_name -
- * @param p -
- * @param f -
- * @param socket_timeout -
- * @param connect_timeout -
+ * @param in
+ * -
+ * @param host_name
+ * -
+ * @param p
+ * -
+ * @param f
+ * -
+ * @param socket_timeout
+ * -
+ * @param connect_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
static public Transportable sendAndReceive(Transportable in, String host_name, int p,
- TransportableFactory f, int socket_timeout, int connect_timeout) throws IOException,
- ServiceException {
+ TransportableFactory f, int socket_timeout, int connect_timeout)
+ throws IOException, ServiceException {
BaseClient tempClient = new BaseClient(host_name, p, f, connect_timeout);
tempClient.setSocketTimeout(socket_timeout);
tempClient.setRetry(false);
@@ -641,15 +686,20 @@ public class BaseClient {
* @pre host_name != null
* @pre p ≥ 0
* @pre p < 65536
- * @param in -
- * @param host_name -
- * @param p -
+ * @param in
+ * -
+ * @param host_name
+ * -
+ * @param p
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
- static public VinciFrame rpc(Transportable in, String host_name, int p) throws IOException,
- ServiceException {
+ static public VinciFrame rpc(Transportable in, String host_name, int p)
+ throws IOException, ServiceException {
return (VinciFrame) sendAndReceive(in, host_name, p, VinciFrame.getVinciFrameFactory());
}
@@ -661,13 +711,19 @@ public class BaseClient {
* @pre in != null
* @pre p ≥ 0
* @pre p < 65536
- * @param in -
- * @param host_name -
- * @param p -
- * @param socket_timeout -
+ * @param in
+ * -
+ * @param host_name
+ * -
+ * @param p
+ * -
+ * @param socket_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
static public VinciFrame rpc(Transportable in, String host_name, int p, int socket_timeout)
throws IOException, ServiceException {
@@ -683,14 +739,21 @@ public class BaseClient {
* @pre in != null
* @pre p ≥ 0
* @pre p < 65536
- * @param in -
- * @param host_name -
- * @param p -
- * @param socket_timeout -
- * @param connect_timeout -
+ * @param in
+ * -
+ * @param host_name
+ * -
+ * @param p
+ * -
+ * @param socket_timeout
+ * -
+ * @param connect_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
static public VinciFrame rpc(Transportable in, String host_name, int p, int socket_timeout,
int connect_timeout) throws IOException, ServiceException {
@@ -704,11 +767,15 @@ public class BaseClient {
* @pre getHost() != null
* @pre os != null
* @pre is != null
- * @param in -
- * @param f -
+ * @param in
+ * -
+ * @param f
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
protected Transportable sendAndReceiveWork(Transportable in, TransportableFactory f)
throws IOException, ServiceException {
@@ -726,12 +793,17 @@ public class BaseClient {
* @pre in != null
* @pre f != null
* @pre socket != null
- * @param in -
- * @param f -
- * @param timeout -
+ * @param in
+ * -
+ * @param f
+ * -
+ * @param timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
protected Transportable sendAndReceiveWork(Transportable in, TransportableFactory f, int timeout)
throws IOException, ServiceException {
@@ -747,8 +819,10 @@ public class BaseClient {
/**
* @pre e != null
* @pre getHost() != null
- * @param e -
- * @throws IOException -
+ * @param e
+ * -
+ * @throws IOException
+ * -
*/
protected void reopen(Exception e) throws IOException {
Debug.p("Trying to reopen connection due to exception: " + e.getMessage());
@@ -794,7 +868,7 @@ public class BaseClient {
socket.connect(socketAddress, connectTimeout);
socket.setTcpNoDelay(true); // needed to avoid delays with Linux/loopback
socket.setSoTimeout(socketTimeout);
- socket.setKeepAlive(isSocketKeepAliveEnabled());
+ socket.setKeepAlive(isSocketKeepAliveEnabled());
is = new BufferedInputStream(socket.getInputStream());
os = new BufferedOutputStream(socket.getOutputStream());
}
@@ -816,15 +890,18 @@ public class BaseClient {
setRetry(false);
socket = use_me;
socket.setSoTimeout(socketTimeout);
- socket.setKeepAlive(isSocketKeepAliveEnabled());
+ socket.setKeepAlive(isSocketKeepAliveEnabled());
is = new BufferedInputStream(socket.getInputStream());
os = new BufferedOutputStream(socket.getOutputStream());
}
/**
* Set the timeout value used by the underlying socket. Default is 2 minutes.
- * @param millis -
- * @throws IOException -
+ *
+ * @param millis
+ * -
+ * @throws IOException
+ * -
*/
public void setSocketTimeout(int millis) throws IOException {
if (socket != null) {
@@ -832,13 +909,12 @@ public class BaseClient {
}
socketTimeout = millis;
}
-
+
/**
- * Gets whether keepAlive should be turned on for client sockets.
- * Always returns true for BaseClient. Can be overridden in
- * subclasses.
+ * Gets whether keepAlive should be turned on for client sockets. Always returns true for
+ * BaseClient. Can be overridden in subclasses.
*
- *@return whether socket keepAlive should be turned on
+ * @return whether socket keepAlive should be turned on
*/
protected boolean isSocketKeepAliveEnabled() {
return true;
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/BaseServer.java b/jVinci/src/main/java/org/apache/vinci/transport/BaseServer.java
index c537924..6690308 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/BaseServer.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/BaseServer.java
@@ -161,6 +161,7 @@ public class BaseServer {
/**
* Get the servable object being used by this server.
+ *
* @return -
*/
public VinciServable getServable() {
@@ -175,7 +176,8 @@ public class BaseServer {
*
* @param millis
* The socket timeout value in milliseconds.
- * @throws IOException -
+ * @throws IOException
+ * -
*/
public void setSocketTimeout(int millis) throws IOException {
socketTimeout = millis;
@@ -220,8 +222,11 @@ public class BaseServer {
/**
* Set the intitial and maximum size of the threadpool used by this server. This should be called
* before serving starts otherwise it has no effect.
- * @param initial -
- * @param max -
+ *
+ * @param initial
+ * -
+ * @param max
+ * -
*/
public void setThreadPoolSize(int initial, int max) {
Debug.Assert(!isServing);
@@ -318,7 +323,8 @@ public class BaseServer {
* @return The server socket to be used by this server for accepting requests.
* @param port
* The port which is to be listened to by the created socket.
- * @throws IOException -
+ * @throws IOException
+ * -
* @pre port ≥ 0
* @pre port < 65536
*/
@@ -385,7 +391,8 @@ public class BaseServer {
* Get a runnable object to run within a pooled thread that will handle the request.
*
* @pre client != null
- * @param client -
+ * @param client
+ * -
* @return -
*/
protected Runnable getRunnable(Socket client) {
@@ -397,7 +404,8 @@ public class BaseServer {
*
* @pre client != null
* @pre threadPool != null
- * @param client -
+ * @param client
+ * -
*/
protected void handleRequest(Socket client) {
try {
@@ -451,8 +459,10 @@ public class BaseServer {
* the appropriate VinciServable.
*
* @pre in != null
- * @param in -
- * @param header -
+ * @param in
+ * -
+ * @param header
+ * -
* @return -
*/
public Transportable eval(Transportable in, KeyValuePair header) {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/BaseServerRunnable.java b/jVinci/src/main/java/org/apache/vinci/transport/BaseServerRunnable.java
index bf7b645..9568f56 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/BaseServerRunnable.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/BaseServerRunnable.java
@@ -42,6 +42,7 @@ public class BaseServerRunnable implements Runnable {
/**
* Allows anyone in the calling chain of the 'run' method to get access to the socket being used
* in the Vinci connection via the ThreadLocal variable.
+ *
* @return -
*/
public static Socket getSocket() {
@@ -51,8 +52,10 @@ public class BaseServerRunnable implements Runnable {
/**
* @pre c != null
* @pre p != null
- * @param c -
- * @param p -
+ * @param c
+ * -
+ * @param p
+ * -
*/
public BaseServerRunnable(Socket c, BaseServer p) {
socket = c;
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/Frame.java b/jVinci/src/main/java/org/apache/vinci/transport/Frame.java
index 1abe917..4b03fe9 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/Frame.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/Frame.java
@@ -94,7 +94,8 @@ public abstract class Frame extends FrameComponent implements Transportable {
* The tag name with which to associate the value.
* @param val
* The (Frame | FrameLeaf) value to associate with the tag.
- * @throws UnsupportedOperationException not implemented
+ * @throws UnsupportedOperationException
+ * not implemented
*/
/* abstract */public void add(String tag, FrameComponent val) {
throw new UnsupportedOperationException("not implemented");
@@ -111,7 +112,8 @@ public abstract class Frame extends FrameComponent implements Transportable {
*
* @param which
* The index of the KeyValuePair to retrieve.
- * @throws UnsupportedOperationException not implemented
+ * @throws UnsupportedOperationException
+ * not implemented
* @return The requested KeyValuePair.
*/
/* abstract */public KeyValuePair getKeyValuePair(int which) {
@@ -126,7 +128,8 @@ public abstract class Frame extends FrameComponent implements Transportable {
* define it in cases where alternative getters are provided for querying the document, and the
* object is never marshalled to a stream.
*
- * @throws UnsupportedOperationException not implemented
+ * @throws UnsupportedOperationException
+ * not implemented
* @return The total number of key/value pairs in this frame.
*/
/* abstract */public int getKeyValuePairCount() {
@@ -281,7 +284,8 @@ public abstract class Frame extends FrameComponent implements Transportable {
* Factory method used by fromStream when it needs to create a frame leaf. Default implementation
* creates a regular FrameLeaf.
*
- * @param array -
+ * @param array
+ * -
* @return the created FrameLeaf.
*
* @pre array != null
@@ -293,8 +297,11 @@ public abstract class Frame extends FrameComponent implements Transportable {
/**
* Factory method used by fromStream when it needs to create a sub-frame. Default implementation
* creates a subframe of the same type as the current frame.
- * @param tag_name -
- * @param initialCapacity -
+ *
+ * @param tag_name
+ * -
+ * @param initialCapacity
+ * -
* @return the created sub-frame.
* @throws UnsupportedOperationException
* if the getClass().newInstance() call on this object results in an exception.
@@ -341,8 +348,10 @@ public abstract class Frame extends FrameComponent implements Transportable {
*
* @pre rval != null
* @pre offset ≥ 0
- * @param rval -
- * @param offset -
+ * @param rval
+ * -
+ * @param offset
+ * -
*/
protected void toXML(StringBuffer rval, int offset) {
KeyValuePair keyVal = null;
@@ -383,7 +392,8 @@ public abstract class Frame extends FrameComponent implements Transportable {
*
* @param key
* The key to be associated with the value.
- * @param val -
+ * @param val
+ * -
* @return This frame
* @throws UnsupportedOperationException
* if this document model doesn't support key addition.
@@ -400,7 +410,8 @@ public abstract class Frame extends FrameComponent implements Transportable {
*
* @param key
* The key to be associated with the value.
- * @param val -
+ * @param val
+ * -
* @return This frame
* @throws UnsupportedOperationException
* if this document model doesn't support key addition.
@@ -419,7 +430,8 @@ public abstract class Frame extends FrameComponent implements Transportable {
*
* @param key
* The key to be associated with the value.
- * @param val -
+ * @param val
+ * -
* @throws UnsupportedOperationException
* if this document model doesn't support key addition.
* @return This frame
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/FrameComponent.java b/jVinci/src/main/java/org/apache/vinci/transport/FrameComponent.java
index a5189f3..d7b4f6b 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/FrameComponent.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/FrameComponent.java
@@ -29,7 +29,9 @@ public class FrameComponent {
/**
* Set the attributes (replacing any previous ones) assocated with this Frame component. Default
* implementation does nothing since attributes are not supported by default.
- * @param s -
+ *
+ * @param s
+ * -
*/
public void setAttributes(Attributes s) {
Debug.p("WARNING: Attempt to set attributes of FrameComponent "
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/FrameLeaf.java b/jVinci/src/main/java/org/apache/vinci/transport/FrameLeaf.java
index 30663cc..e96ad1b 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/FrameLeaf.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/FrameLeaf.java
@@ -53,8 +53,10 @@ public class FrameLeaf extends FrameComponent {
* cannot be modified by external code.
*
* @pre mydata != null
- * @param mydata -
- * @param encode -
+ * @param mydata
+ * -
+ * @param encode
+ * -
*/
public FrameLeaf(byte[] mydata, boolean encode) {
if (encode) {
@@ -67,7 +69,8 @@ public class FrameLeaf extends FrameComponent {
/**
* @pre mydata != null
- * @param mydata -
+ * @param mydata
+ * -
*/
public FrameLeaf(String mydata) {
this.data = UTFConverter.convertStringToUTF(mydata);
@@ -77,9 +80,10 @@ public class FrameLeaf extends FrameComponent {
* This method does NOT support null values in the array.
*
* @pre mystring != null
- * @pre { for (int i = 0; i < mystring.length; i++) $assert(mystring[i] != null, "array elements
- * are non-null"); }
- * @param mystring -
+ * @pre { for (int i = 0; i < mystring.length; i++) $assert(mystring[i] != null, "array
+ * elements are non-null"); }
+ * @param mystring
+ * -
*/
public FrameLeaf(String[] mystring) {
String separator = "#";
@@ -109,7 +113,8 @@ public class FrameLeaf extends FrameComponent {
/**
* @pre myfloat != null
- * @param myfloat -
+ * @param myfloat
+ * -
*/
public FrameLeaf(float[] myfloat) {
StringBuffer add_me = new StringBuffer();
@@ -128,7 +133,8 @@ public class FrameLeaf extends FrameComponent {
/**
* @pre mydouble != null
- * @param mydouble -
+ * @param mydouble
+ * -
*/
public FrameLeaf(double[] mydouble) {
StringBuffer add_me = new StringBuffer();
@@ -148,7 +154,8 @@ public class FrameLeaf extends FrameComponent {
/**
* @pre myint != null
- * @param myint -
+ * @param myint
+ * -
*/
public FrameLeaf(int[] myint) {
StringBuffer add_me = new StringBuffer();
@@ -168,7 +175,8 @@ public class FrameLeaf extends FrameComponent {
/**
* @pre mylong != null
- * @param mylong -
+ * @param mylong
+ * -
*/
public FrameLeaf(long[] mylong) {
StringBuffer add_me = new StringBuffer();
@@ -250,6 +258,7 @@ public class FrameLeaf extends FrameComponent {
/**
* Get the raw (usually UTF-8) frame data.
+ *
* @return -
*/
public byte[] getData() {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/FrameTransporter.java b/jVinci/src/main/java/org/apache/vinci/transport/FrameTransporter.java
index 5475b9e..6fc5d16 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/FrameTransporter.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/FrameTransporter.java
@@ -39,8 +39,10 @@ public interface FrameTransporter {
* @param f
* The Frame to be marshalled.
* @return -
- * @throws IOException -
- * @throws EOFException -
+ * @throws IOException
+ * -
+ * @throws EOFException
+ * -
*/
KeyValuePair fromStream(InputStream is, Frame f) throws IOException, EOFException;
@@ -51,7 +53,8 @@ public interface FrameTransporter {
* The stream from where the data is read.
* @param f
* The Frame to be populated from the stream.
- * @throws IOException -
+ * @throws IOException
+ * -
*/
void toStream(OutputStream os, Frame f) throws IOException;
}
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/KeyValuePair.java b/jVinci/src/main/java/org/apache/vinci/transport/KeyValuePair.java
index c6efa1f..6337c69 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/KeyValuePair.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/KeyValuePair.java
@@ -38,8 +38,10 @@ public final class KeyValuePair {
/**
* @pre mykey != null
* @pre myvalue != null
- * @param mykey -
- * @param myvalue -
+ * @param mykey
+ * -
+ * @param myvalue
+ * -
*/
public KeyValuePair(String mykey, FrameComponent myvalue) {
this.key = mykey;
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/LeafCastException.java b/jVinci/src/main/java/org/apache/vinci/transport/LeafCastException.java
index 65f7c3f..9ac4611 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/LeafCastException.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/LeafCastException.java
@@ -24,7 +24,7 @@ package org.apache.vinci.transport;
* errors.
*/
public class LeafCastException extends IllegalArgumentException {
-
+
private static final long serialVersionUID = 2167774897716144428L;
public LeafCastException() {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/PooledVinciClient.java b/jVinci/src/main/java/org/apache/vinci/transport/PooledVinciClient.java
index 030760e..c93ae13 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/PooledVinciClient.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/PooledVinciClient.java
@@ -53,8 +53,11 @@ public class PooledVinciClient {
/**
* Create a PooledVinciClient that will establish at most maxPoolSize connections to the
* designated service.
- * @param serviceName -
- * @param maxPoolSize -
+ *
+ * @param serviceName
+ * -
+ * @param maxPoolSize
+ * -
*/
public PooledVinciClient(String serviceName, int maxPoolSize) {
this.serviceName = serviceName;
@@ -67,7 +70,9 @@ public class PooledVinciClient {
/**
* Set a VinciContext that will be used by this PooledVinciClient instead of the default global
* context.
- * @param context -
+ *
+ * @param context
+ * -
*/
public void setContext(VinciContext context) {
this.context = context;
@@ -75,7 +80,9 @@ public class PooledVinciClient {
/**
* Set a connect timeout that will be used in place of BaseClient.DEFAULT_CONNECT_TIMEOUT
- * @param connectTimeoutMillis -
+ *
+ * @param connectTimeoutMillis
+ * -
*/
public void setConnectTimeout(int connectTimeoutMillis) {
this.connectTimeout = connectTimeoutMillis;
@@ -83,7 +90,9 @@ public class PooledVinciClient {
/**
* Set a socket timeout that will be used in place of BaseClient.DEFAULT_SOCKET_TIMEOUT
- * @param socketTimeoutMillis -
+ *
+ * @param socketTimeoutMillis
+ * -
*/
public void setSocketTimeout(int socketTimeoutMillis) {
this.socketTimeout = socketTimeoutMillis;
@@ -91,7 +100,9 @@ public class PooledVinciClient {
/**
* Set a transportable factory that will be used in place of the VinciFrame factory.
- * @param factory -
+ *
+ * @param factory
+ * -
*/
public void setTransportableFactory(TransportableFactory factory) {
this.factory = factory;
@@ -99,6 +110,7 @@ public class PooledVinciClient {
/**
* Get the service name to which this client connects.
+ *
* @return -
*/
public String getServiceName() {
@@ -107,10 +119,14 @@ public class PooledVinciClient {
/**
* Send a request to the service and receive the response. This method is tread safe.
- * @param in -
+ *
+ * @param in
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
public Transportable sendAndReceive(Transportable in) throws IOException, ServiceException {
VinciClient c = getClientFromPool();
@@ -124,14 +140,19 @@ public class PooledVinciClient {
/**
* Send a request to the service and receive the response, using the provided transportable
* factory in place of the client-provided one. This method is tread safe.
- * @param in -
- * @param f -
+ *
+ * @param in
+ * -
+ * @param f
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
- public Transportable sendAndReceive(Transportable in, TransportableFactory f) throws IOException,
- ServiceException {
+ public Transportable sendAndReceive(Transportable in, TransportableFactory f)
+ throws IOException, ServiceException {
VinciClient c = getClientFromPool();
try {
return c.sendAndReceive(in, f);
@@ -143,12 +164,18 @@ public class PooledVinciClient {
/**
* Send a request to the service and receive the response, using the provided transportable
* factory and socketTimeout in place of the client-provided ones. This method is tread safe.
- * @param in -
- * @param f -
- * @param socketTimeout -
+ *
+ * @param in
+ * -
+ * @param f
+ * -
+ * @param socketTimeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
public Transportable sendAndReceive(Transportable in, TransportableFactory f, int socketTimeout)
throws IOException, ServiceException {
@@ -163,14 +190,19 @@ public class PooledVinciClient {
/**
* Send a request to the service and receive the response, using the provided socketTimeout in
* place of the client-provided one. This method is tread safe.
- * @param in -
- * @param socketTimeout -
+ *
+ * @param in
+ * -
+ * @param socketTimeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
*/
- public Transportable sendAndReceive(Transportable in, int socketTimeout) throws IOException,
- ServiceException {
+ public Transportable sendAndReceive(Transportable in, int socketTimeout)
+ throws IOException, ServiceException {
VinciClient c = getClientFromPool();
try {
return c.sendAndReceive(in, socketTimeout);
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/ServiceDownException.java b/jVinci/src/main/java/org/apache/vinci/transport/ServiceDownException.java
index 7cd81f5..b083159 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/ServiceDownException.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/ServiceDownException.java
@@ -26,7 +26,7 @@ import java.io.IOException;
* not be established.
*/
public class ServiceDownException extends IOException {
-
+
private static final long serialVersionUID = -6125121845524920235L;
/**
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/SimpleTransportable.java b/jVinci/src/main/java/org/apache/vinci/transport/SimpleTransportable.java
index 5ec57c8..969e40e 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/SimpleTransportable.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/SimpleTransportable.java
@@ -39,7 +39,8 @@ public final class SimpleTransportable implements Transportable {
* Create a SimpleTransportable that is an immutable copy of the provided Transportable object.
*
* @pre convert_me != null
- * @param convert_me -
+ * @param convert_me
+ * -
*/
public SimpleTransportable(Transportable convert_me) {
try {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/Transportable.java b/jVinci/src/main/java/org/apache/vinci/transport/Transportable.java
index 728526c..13087f2 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/Transportable.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/Transportable.java
@@ -34,7 +34,8 @@ public interface Transportable {
* @param is
* The stream to read from.
* @return -
- * @exception IOException -
+ * @exception IOException
+ * -
*/
KeyValuePair fromStream(InputStream is) throws IOException;
@@ -43,7 +44,8 @@ public interface Transportable {
*
* @param os
* The stream to write into.
- * @exception IOException -
+ * @exception IOException
+ * -
*/
void toStream(OutputStream os) throws IOException;
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/VNSException.java b/jVinci/src/main/java/org/apache/vinci/transport/VNSException.java
index f8132ce..4e2f50c 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/VNSException.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/VNSException.java
@@ -25,7 +25,7 @@ import java.io.IOException;
* Special exception type thrown by VinciClient/VinciServer when VNS itself reports an error.
*/
public class VNSException extends IOException {
-
+
private static final long serialVersionUID = -9150424759390586749L;
public VNSException(String message) {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/VinciClient.java b/jVinci/src/main/java/org/apache/vinci/transport/VinciClient.java
index f215fbf..da141ed 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/VinciClient.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/VinciClient.java
@@ -47,8 +47,10 @@ public class VinciClient extends BaseClient {
* @param service_name
* The name of the service to connect to.
*
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if no VNS_HOST has been specified.
*
@@ -67,8 +69,10 @@ public class VinciClient extends BaseClient {
* @param factory
* The factory used for creating return documents of desired type.
*
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if no VNS_HOST has been specified.
*
@@ -86,11 +90,16 @@ public class VinciClient extends BaseClient {
* @pre factory != null
* @pre myContext != null
*
- * @param service_name -
- * @param factory -
- * @param myContext -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @param service_name
+ * -
+ * @param factory
+ * -
+ * @param myContext
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if no VNS_HOST has been specified.
*/
@@ -104,15 +113,19 @@ public class VinciClient extends BaseClient {
/**
* @pre service_name != null
* @pre myContext != null
- * @param service_name -
- * @param myContext -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @param service_name
+ * -
+ * @param myContext
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if no VNS_HOST has been specified.
*/
- public VinciClient(String service_name, VinciContext myContext) throws ServiceDownException,
- VNSException {
+ public VinciClient(String service_name, VinciContext myContext)
+ throws ServiceDownException, VNSException {
this(service_name, VinciFrame.getVinciFrameFactory(), myContext);
}
@@ -125,15 +138,17 @@ public class VinciClient extends BaseClient {
* @param connectTimeout
* The number of milliseconds that will elapse before a connect attempt fails.
*
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if no VNS_HOST has been specified.
*
* @pre service_name != null
*/
- public VinciClient(String service_name, int connectTimeout) throws ServiceDownException,
- VNSException {
+ public VinciClient(String service_name, int connectTimeout)
+ throws ServiceDownException, VNSException {
this(service_name, VinciFrame.getVinciFrameFactory(), connectTimeout);
}
@@ -148,8 +163,10 @@ public class VinciClient extends BaseClient {
* @param connectTimeout
* The number of milliseconds that will elapse before a connect attempt fails.
*
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if no VNS_HOST has been specified.
*
@@ -169,12 +186,18 @@ public class VinciClient extends BaseClient {
* @pre factory != null
* @pre myContext != null
*
- * @param service_name -
- * @param factory -
- * @param myContext -
- * @param connectTimeout -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @param service_name
+ * -
+ * @param factory
+ * -
+ * @param myContext
+ * -
+ * @param connectTimeout
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if no VNS_HOST has been specified.
*/
@@ -190,11 +213,16 @@ public class VinciClient extends BaseClient {
*
* @pre service_name != null
* @pre myContext != null
- * @param service_name -
- * @param myContext -
- * @param connectTimeout -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @param service_name
+ * -
+ * @param myContext
+ * -
+ * @param connectTimeout
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if no VNS_HOST has been specified.
*/
@@ -213,7 +241,9 @@ public class VinciClient extends BaseClient {
/**
* Construct a new client WITHOUT opening a connection, using the specified factory to create
* return documents.
- * @param f -
+ *
+ * @param f
+ * -
*/
public VinciClient(TransportableFactory f) {
super(f);
@@ -222,6 +252,7 @@ public class VinciClient extends BaseClient {
/**
* Get the priority level of the service to which this client is connected. This method only works
* after the connection has been opened.
+ *
* @return -
*/
public int getLevel() {
@@ -235,6 +266,7 @@ public class VinciClient extends BaseClient {
* Services should have "non zero" instance numbers only when more than one instance of the
* service is running on the same host. The unique instance value allows each instance to be
* distinguished and uniquely addressed via a fully qualified service name.
+ *
* @return -
*/
@@ -246,14 +278,21 @@ public class VinciClient extends BaseClient {
* Convenience method for "one-shot"/single-query connections. Equivalent of manually creating a
* new VinciClient(), calling (non-static) sendAndReceive, and then closing the client.
*
- * @param in -
- * @param service_name -
- * @param factory -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param factory
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if the VNS host has not been specified.
*
@@ -262,8 +301,8 @@ public class VinciClient extends BaseClient {
* @pre factory != null
*/
static public Transportable sendAndReceive(Transportable in, String service_name,
- TransportableFactory factory) throws IOException, ServiceException, ServiceDownException,
- VNSException {
+ TransportableFactory factory)
+ throws IOException, ServiceException, ServiceDownException, VNSException {
return VinciContext.getGlobalContext().sendAndReceive(in, service_name, factory);
}
@@ -271,13 +310,19 @@ public class VinciClient extends BaseClient {
* Convenience method for "one-shot"/single-query connections. Equivalent of manually creating a
* new VinciClient(), calling (non-static) sendAndReceive, and then closing the client.
*
- * @param in -
- * @param service_name -
- * @param factory -
- * @param socket_timeout -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param factory
+ * -
+ * @param socket_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
* @throws IllegalStateException
* if the VNS host has not been specified.
*
@@ -288,22 +333,29 @@ public class VinciClient extends BaseClient {
*/
static public Transportable sendAndReceive(Transportable in, String service_name,
TransportableFactory factory, int socket_timeout) throws IOException, ServiceException {
- return VinciContext.getGlobalContext()
- .sendAndReceive(in, service_name, factory, socket_timeout);
+ return VinciContext.getGlobalContext().sendAndReceive(in, service_name, factory,
+ socket_timeout);
}
/**
* Convenience method for "one-shot"/single-query connections. Equivalent of manually creating a
* new VinciClient(), calling (non-static) sendAndReceive, and then closing the client.
*
- * @param in -
- * @param service_name -
- * @param factory -
- * @param socket_timeout -
- * @param connect_timeout -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param factory
+ * -
+ * @param socket_timeout
+ * -
+ * @param connect_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
* @throws IllegalStateException
* if the VNS host has not been specified.
*
@@ -315,13 +367,14 @@ public class VinciClient extends BaseClient {
static public Transportable sendAndReceive(Transportable in, String service_name,
TransportableFactory factory, int socket_timeout, int connect_timeout)
throws IOException, ServiceException {
- return VinciContext.getGlobalContext().sendAndReceive(in, service_name, factory,
- socket_timeout, connect_timeout);
+ return VinciContext.getGlobalContext().sendAndReceive(in, service_name, factory, socket_timeout,
+ connect_timeout);
}
/**
* Get the context associated with this client. By default clients use the global Vinci context,
* though this can be overridden.
+ *
* @return -
*/
public VinciContext getContext() {
@@ -337,7 +390,9 @@ public class VinciClient extends BaseClient {
* be used. You should set the context BEFORE a connection is open (e.g. ater using the no-arg
* constructor), otherwise the global context parameters will be used to establish the connection
* before you have a chance to change it.
- * @param c -
+ *
+ * @param c
+ * -
*/
public void setContext(VinciContext c) {
context = c;
@@ -347,6 +402,7 @@ public class VinciClient extends BaseClient {
* Get the fully qualified name of this service. This method is useful when for whatever reason a
* connection needs to be re-established with this exact same service instance. This method only
* works after connection has been established.
+ *
* @return -
*
* @pre getHost() != null
@@ -453,8 +509,8 @@ public class VinciClient extends BaseClient {
Debug.p("Resolved " + serviceName + " to: " + locator.host + ":" + locator.port);
return;
} catch (IOException e) {
- Debug.p("WARNING: Failed to connect to service at (" + locator.host + ":"
- + locator.port + "):" + e.getMessage());
+ Debug.p("WARNING: Failed to connect to service at (" + locator.host + ":" + locator.port
+ + "):" + e.getMessage());
connectFailed = true;
if (alreadyTried == null) {
alreadyTried = new ArrayList();
@@ -471,8 +527,8 @@ public class VinciClient extends BaseClient {
} else if (response.priority != 0 && !ResolveResult.isQualified(serviceName)) {
// If a service name was specified without qualifications, then
// we allow fail-over to lower-priority services.
- Debug.p("VinciClient.open(String)", "Resolving with lower priority than: "
- + response.priority);
+ Debug.p("VinciClient.open(String)",
+ "Resolving with lower priority than: " + response.priority);
myContext.flushFromCache(serviceName);
int next_level = response.priority;
if (next_level == -1) {
@@ -498,11 +554,10 @@ public class VinciClient extends BaseClient {
close();
open(serviceName);
}
-
+
/**
- * Gets wheter socket keepAlive is enabled. This overrides the method
- * in BaseClient, and makes this setting configurable through the
- * VinciContext.
+ * Gets wheter socket keepAlive is enabled. This overrides the method in BaseClient, and makes
+ * this setting configurable through the VinciContext.
*
* @return whether socket keepAlive is enabled.
*/
@@ -516,21 +571,27 @@ public class VinciClient extends BaseClient {
* method for the case where return result is known to be VinciFrame (eliminates the need for
* casting in the typical usage case).
*
- * @param in -
- * @param service_name -
+ * @param in
+ * -
+ * @param service_name
+ * -
* @return A VinciFrame representing the service result.
* @throws IllegalStateException
* if the VNS host has not been specified.
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
*
* @pre in != null
* @pre service_name != null
*/
- static public VinciFrame rpc(Transportable in, String service_name) throws IOException,
- ServiceException, ServiceDownException, VNSException {
+ static public VinciFrame rpc(Transportable in, String service_name)
+ throws IOException, ServiceException, ServiceDownException, VNSException {
return VinciContext.getGlobalContext().rpc(in, service_name);
}
@@ -545,14 +606,21 @@ public class VinciClient extends BaseClient {
* @pre in != null
* @pre service_name != null
* @pre timeout ≥ 0
- * @param in -
- * @param service_name -
- * @param timeout -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param timeout
+ * -
* @return A VinciFrame representing the service result.
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
*/
static public VinciFrame rpc(Transportable in, String service_name, int timeout)
throws IOException, ServiceException, ServiceDownException, VNSException {
@@ -571,19 +639,27 @@ public class VinciClient extends BaseClient {
* @pre service_name != null
* @pre timeout ≥ 0
* @pre connect_timeout > 0
- * @param in -
- * @param service_name -
- * @param timeout -
- * @param connect_timeout -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param timeout
+ * -
+ * @param connect_timeout
+ * -
* @return A VinciFrame representing the service result.
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
*/
static public VinciFrame rpc(Transportable in, String service_name, int timeout,
- int connect_timeout) throws IOException, ServiceException, ServiceDownException,
- VNSException {
+ int connect_timeout)
+ throws IOException, ServiceException, ServiceDownException, VNSException {
return VinciContext.getGlobalContext().rpc(in, service_name, timeout, connect_timeout);
}
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/VinciFrame.java b/jVinci/src/main/java/org/apache/vinci/transport/VinciFrame.java
index 01abf51..e1127c1 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/VinciFrame.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/VinciFrame.java
@@ -49,6 +49,7 @@ public class VinciFrame extends QueryableFrame {
/**
* Get a TransportableFactory that creates new VinciFrames.
+ *
* @return -
*/
static public TransportableFactory getVinciFrameFactory() {
@@ -66,7 +67,8 @@ public class VinciFrame extends QueryableFrame {
* Create a VinciFrame that is a (deep) copy of the given transportable.
*
* @pre t != null
- * @param t -
+ * @param t
+ * -
* @return -
*/
public static VinciFrame toVinciFrame(Transportable t) {
@@ -166,8 +168,10 @@ public class VinciFrame extends QueryableFrame {
*
* @pre key != null
* @pre val != null
- * @param key -
- * @param val -
+ * @param key
+ * -
+ * @param val
+ * -
* @return -
*/
public VinciFrame fset(String key, String val) {
@@ -180,8 +184,10 @@ public class VinciFrame extends QueryableFrame {
* doesn't exist, then the value is added.
*
* @pre key != null
- * @param key -
- * @param val -
+ * @param key
+ * -
+ * @param val
+ * -
* @return -
*/
public VinciFrame fset(String key, long val) {
@@ -194,8 +200,10 @@ public class VinciFrame extends QueryableFrame {
* doesn't exist, then the value is added.
*
* @pre key != null
- * @param key -
- * @param val -
+ * @param key
+ * -
+ * @param val
+ * -
* @return -
*/
public VinciFrame fset(String key, boolean val) {
@@ -208,8 +216,10 @@ public class VinciFrame extends QueryableFrame {
* doesn't exist, then the value is added.
*
* @pre key != null
- * @param key -
- * @param val -
+ * @param key
+ * -
+ * @param val
+ * -
* @return -
*/
public VinciFrame fset(String key, int val) {
@@ -223,8 +233,10 @@ public class VinciFrame extends QueryableFrame {
*
* @pre key != null
* @pre val != null
- * @param key -
- * @param val -
+ * @param key
+ * -
+ * @param val
+ * -
* @return -
*/
public VinciFrame fset(String key, int[] val) {
@@ -240,8 +252,10 @@ public class VinciFrame extends QueryableFrame {
* if val is null.
*
* @pre key != null
- * @param key -
- * @param val -
+ * @param key
+ * -
+ * @param val
+ * -
* @return -
*/
public VinciFrame fset(String key, Frame val) {
@@ -254,8 +268,10 @@ public class VinciFrame extends QueryableFrame {
* doesn't exist, then the value is added.
*
* @pre key != null
- * @param key -
- * @param val -
+ * @param key
+ * -
+ * @param val
+ * -
* @return -
*/
public VinciFrame fset(String key, double val) {
@@ -272,8 +288,10 @@ public class VinciFrame extends QueryableFrame {
*
* @pre key != null
* @pre bin != null
- * @param key -
- * @param bin -
+ * @param key
+ * -
+ * @param bin
+ * -
* @return -
*/
public VinciFrame fset(String key, byte[] bin) {
@@ -291,8 +309,10 @@ public class VinciFrame extends QueryableFrame {
*
* @pre key != null
* @pre bin != null
- * @param key -
- * @param bin -
+ * @param key
+ * -
+ * @param bin
+ * -
* @return -
*/
public VinciFrame fsetTrueBinary(String key, byte[] bin) {
@@ -309,8 +329,10 @@ public class VinciFrame extends QueryableFrame {
* if val is null.
*
* @pre key != null
- * @param key -
- * @param val -
+ * @param key
+ * -
+ * @param val
+ * -
*/
protected void set(String key, FrameComponent val) {
if (val != null) {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/VinciServer.java b/jVinci/src/main/java/org/apache/vinci/transport/VinciServer.java
index 19168f6..0e16cb3 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/VinciServer.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/VinciServer.java
@@ -60,8 +60,10 @@ public class VinciServer extends BaseServer {
*
* @param host_name
* The DNS hostname of the machine running this server.
- * @param service_name -
- * @param servable -
+ * @param service_name
+ * -
+ * @param servable
+ * -
*
* @pre service_name != null
* @pre host_name != null
@@ -75,8 +77,10 @@ public class VinciServer extends BaseServer {
* Create a new server that reports the current machine's IP address as the host. This should not
* be used for DHCP-based hosts since IP address can change.
*
- * @param service_name -
- * @param servable -
+ * @param service_name
+ * -
+ * @param servable
+ * -
* @throws UnknownHostException
* If there is an error determining machine IP address.
*
@@ -95,11 +99,16 @@ public class VinciServer extends BaseServer {
* @pre servable != null
* @pre myPriority ≥ -1
* @pre myInstance ≥ 0
- * @param service_name -
- * @param host_name -
- * @param servable -
- * @param myPriority -
- * @param myInstance -
+ * @param service_name
+ * -
+ * @param host_name
+ * -
+ * @param servable
+ * -
+ * @param myPriority
+ * -
+ * @param myInstance
+ * -
*/
public VinciServer(String service_name, String host_name, VinciServable servable, int myPriority,
int myInstance) {
@@ -115,12 +124,17 @@ public class VinciServer extends BaseServer {
* @pre host_name != null
* @pre servable != null
* @pre myPriority ≥ -1
- * @param service_name -
- * @param host_name -
- * @param servable -
- * @param myPriority -
+ * @param service_name
+ * -
+ * @param host_name
+ * -
+ * @param servable
+ * -
+ * @param myPriority
+ * -
*/
- public VinciServer(String service_name, String host_name, VinciServable servable, int myPriority) {
+ public VinciServer(String service_name, String host_name, VinciServable servable,
+ int myPriority) {
this(service_name, host_name, servable, myPriority, 0);
}
@@ -128,10 +142,14 @@ public class VinciServer extends BaseServer {
* @pre service_name != null
* @pre servable != null
* @pre myPriority ≥ -1
- * @param service_name -
- * @param servable -
- * @param myPriority -
- * @throws UnknownHostException -
+ * @param service_name
+ * -
+ * @param servable
+ * -
+ * @param myPriority
+ * -
+ * @throws UnknownHostException
+ * -
*/
public VinciServer(String service_name, VinciServable servable, int myPriority)
throws UnknownHostException {
@@ -143,11 +161,16 @@ public class VinciServer extends BaseServer {
* @pre servable != null
* @pre myPriority ≥ -1
* @pre myInstance ≥ 0
- * @param service_name -
- * @param servable -
- * @param myPriority -
- * @param myInstance -
- * @throws UnknownHostException -
+ * @param service_name
+ * -
+ * @param servable
+ * -
+ * @param myPriority
+ * -
+ * @param myInstance
+ * -
+ * @throws UnknownHostException
+ * -
*/
public VinciServer(String service_name, VinciServable servable, int myPriority, int myInstance)
throws UnknownHostException {
@@ -156,7 +179,9 @@ public class VinciServer extends BaseServer {
/**
* servable != null
- * @param servable -
+ *
+ * @param servable
+ * -
*/
public VinciServer(VinciServable servable) {
super(servable);
@@ -165,6 +190,7 @@ public class VinciServer extends BaseServer {
/**
* Get the context associated with this server. By default clients use the global Vinci context,
* though this can be overridden.
+ *
* @return -
*/
public VinciContext getContext() {
@@ -205,7 +231,9 @@ public class VinciServer extends BaseServer {
/**
* Set the VinciContext to be used by this server. Set to null if you wish the global context to
* be used.
- * @param c -
+ *
+ * @param c
+ * -
*/
public void setContext(VinciContext c) {
context = c;
@@ -280,15 +308,17 @@ public class VinciServer extends BaseServer {
* you want to stop the server call shutdownServing() -- this method should have probably been
* declared "protected". You can override this method if you want the shutdown message to be
* ignored in certain cases.
- * @param shutdown_message -
+ *
+ * @param shutdown_message
+ * -
* @return -
*/
public boolean shutdown(String shutdown_message) {
// Override this method if shutdown is to be ignored in certain cases (by returning
// false). Default implementation unconditionally halts serving,
// and hence always returns true.
- Debug.printDebuggingMessage("VinciServer.shutdown()", "Accepted shutdown request: "
- + shutdown_message);
+ Debug.printDebuggingMessage("VinciServer.shutdown()",
+ "Accepted shutdown request: " + shutdown_message);
new Thread(new Runnable() {
@Override
public void run() {
@@ -306,17 +336,20 @@ public class VinciServer extends BaseServer {
/**
* @return -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if VNS host isn't specified.
*/
protected int getPort() throws ServiceDownException, VNSException {
try {
VinciContext myContext = getContext();
- ServeonResult response = (ServeonResult) VinciClient.sendAndReceive(ServeonResult
- .composeQuery(serviceName, hostName, priority, instance), myContext.getVNSHost(),
- myContext.getVNSPort(), ServeonResult.factory, myContext.getVNSServeonTimeout());
+ ServeonResult response = (ServeonResult) VinciClient.sendAndReceive(
+ ServeonResult.composeQuery(serviceName, hostName, priority, instance),
+ myContext.getVNSHost(), myContext.getVNSPort(), ServeonResult.factory,
+ myContext.getVNSServeonTimeout());
return response.port;
} catch (IOException e) {
Debug.reportException(e);
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/XTalkTransporter.java b/jVinci/src/main/java/org/apache/vinci/transport/XTalkTransporter.java
index 4015cc0..1dafcb6 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/XTalkTransporter.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/XTalkTransporter.java
@@ -49,8 +49,10 @@ public class XTalkTransporter implements FrameTransporter {
/**
* Parse the data-stream according to the XTalk protocol.
*
- * @param is input stream
- * @param f frame
+ * @param is
+ * input stream
+ * @param f
+ * frame
* @return If the first tag belongs to the Vinci namespace, then this tag/value combination is
* returned. Otherwise returns null. Should there be a non-null return, then the value
* object of the KeyValuePair can be either FrameLeaf or Frame.
@@ -76,12 +78,15 @@ public class XTalkTransporter implements FrameTransporter {
*
* @pre is != null
* @pre f != null
-
- * @param is input stream
- * @param f frame
+ *
+ * @param is
+ * input stream
+ * @param f
+ * frame
* @return the key value pair
- * @throws IOException if the versions don't match, or have unexpected element marker
- * */
+ * @throws IOException
+ * if the versions don't match, or have unexpected element marker
+ */
public KeyValuePair fromStreamWork(InputStream is, Frame f) throws IOException {
return fromStreamWork(is, f, new byte[128], new char[128]);
}
@@ -90,8 +95,8 @@ public class XTalkTransporter implements FrameTransporter {
throws IOException {
int version = is.read();
if ((byte) version != VERSION_CODE) {
- throw new IOException("Xtalk version code doesn't match " + (int) VERSION_CODE + ": "
- + version);
+ throw new IOException(
+ "Xtalk version code doesn't match " + (int) VERSION_CODE + ": " + version);
}
int top_field_count = readInt(is);
// Skip over intro PI's.
@@ -119,8 +124,10 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param is the input stream
- * @throws IOException passthru
+ * @param is
+ * the input stream
+ * @throws IOException
+ * passthru
*
* @pre is != null
*/
@@ -140,8 +147,10 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param is the input stream
- * @throws IOException passthru
+ * @param is
+ * the input stream
+ * @throws IOException
+ * passthru
*
* @pre is != null
*/
@@ -152,12 +161,17 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param is the input stream
- * @param f frame
- * @param buffer -
- * @param cbuffer -
- * @return key value
- * @throws IOException passthru
+ * @param is
+ * the input stream
+ * @param f
+ * frame
+ * @param buffer
+ * -
+ * @param cbuffer
+ * -
+ * @return key value
+ * @throws IOException
+ * passthru
*
* @pre is != null
* @pre f != null
@@ -190,12 +204,17 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param is the input stream
- * @param f the Frame
- * @param buffer -
- * @param cbuffer -
+ * @param is
+ * the input stream
+ * @param f
+ * the Frame
+ * @param buffer
+ * -
+ * @param cbuffer
+ * -
* @return key value
- * @throws IOException passthru
+ * @throws IOException
+ * passthru
*
* @pre is != null
* @pre f != null
@@ -246,13 +265,20 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param is input stream
- * @param f frame
- * @param field_count field count
- * @param marker marker
- * @param buffer -
- * @param cbuffer -
- * @throws IOException passthru
+ * @param is
+ * input stream
+ * @param f
+ * frame
+ * @param field_count
+ * field count
+ * @param marker
+ * marker
+ * @param buffer
+ * -
+ * @param cbuffer
+ * -
+ * @throws IOException
+ * passthru
*
* @pre is != null
* @pre f != null
@@ -300,8 +326,10 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param is input stream
- * @throws IOException an EOFException if number to be skipped is bigger than the stream
+ * @param is
+ * input stream
+ * @throws IOException
+ * an EOFException if number to be skipped is bigger than the stream
*
* @pre is != null
*/
@@ -322,9 +350,11 @@ public class XTalkTransporter implements FrameTransporter {
* Consume a string from the input stream. TODO: Make a faster version that exploits work buffers
* to reduce allocations to a single string object.
*
- * @param is input stream
+ * @param is
+ * input stream
* @return the string
- * @throws IOException if key is longer than limit
+ * @throws IOException
+ * if key is longer than limit
*
* @pre is != null
*/
@@ -358,12 +388,18 @@ public class XTalkTransporter implements FrameTransporter {
/**
* Consume the string of bytesToRead utf-8 bytes. assumes buffers are big enough to hold
* bytesToRead bytes/chars
- * @param is input stream
- * @param byteBuf a byte buffer
- * @param charBuf a character buffer
- * @param bytesToRead the number of bytes to read
+ *
+ * @param is
+ * input stream
+ * @param byteBuf
+ * a byte buffer
+ * @param charBuf
+ * a character buffer
+ * @param bytesToRead
+ * the number of bytes to read
* @return the length of the converted characters
- * @throws IOException passthru
+ * @throws IOException
+ * passthru
*/
static public int consumeCharacters(InputStream is, byte[] byteBuf, char[] charBuf,
int bytesToRead) throws IOException {
@@ -373,9 +409,12 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param is input stream
- * @param f frame
- * @throws IOExcetion if the key length is too large
+ * @param is
+ * input stream
+ * @param f
+ * frame
+ * @throws IOExcetion
+ * if the key length is too large
*
* @pre is != null
* @pre f != null
@@ -393,9 +432,12 @@ public class XTalkTransporter implements FrameTransporter {
public static final byte[] HEADER = { DOCUMENT_MARKER, VERSION_CODE, 0, 0, 0, 1, ELEMENT_MARKER };
/**
- * @param os output stream
- * @param f frame
- * @throws IOException passthru
+ * @param os
+ * output stream
+ * @param f
+ * frame
+ * @throws IOException
+ * passthru
* @pre os != null
* @pre f != null
*/
@@ -414,10 +456,14 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param os output stream
- * @param f frame
- * @param workbuf -
- * @throws IOException passthru
+ * @param os
+ * output stream
+ * @param f
+ * frame
+ * @param workbuf
+ * -
+ * @throws IOException
+ * passthru
*
* @pre os != null
* @pre f != null
@@ -458,9 +504,13 @@ public class XTalkTransporter implements FrameTransporter {
/**
* Sends a string over, without the type byte.
- * @param str the string to send
- * @param os the output stream
- * @throws IOException passthru
+ *
+ * @param str
+ * the string to send
+ * @param os
+ * the output stream
+ * @throws IOException
+ * passthru
*
* @pre str != null
* @pre os != null
@@ -474,10 +524,15 @@ public class XTalkTransporter implements FrameTransporter {
/**
* Sends a string as utf8, using the temporary buffer if it is big enough to avoid allocating new
* memory.
- * @param str the string to send
- * @param os the output stream
- * @param buffer a buffer
- * @throws IOException passthru
+ *
+ * @param str
+ * the string to send
+ * @param os
+ * the output stream
+ * @param buffer
+ * a buffer
+ * @throws IOException
+ * passthru
*/
static public void stringToBin(String str, OutputStream os, byte[] buffer) throws IOException {
byte[] newbuf;
@@ -525,9 +580,12 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param write_me the integer to write
- * @param out the output stream
- * @throws IOException passthru
+ * @param write_me
+ * the integer to write
+ * @param out
+ * the output stream
+ * @throws IOException
+ * passthru
*
* @pre out != null
*/
@@ -540,9 +598,11 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param in the input stream
+ * @param in
+ * the input stream
* @return the integer
- * @throws IOException if any of the pieces read are negative
+ * @throws IOException
+ * if any of the pieces read are negative
*
* @pre in != null
*/
@@ -559,9 +619,12 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param b the byte array to read into
- * @param in the input stream
- * @throws IOException passthru
+ * @param b
+ * the byte array to read into
+ * @param in
+ * the input stream
+ * @throws IOException
+ * passthru
*
* @pre b != null
* @pre in != null
@@ -583,10 +646,14 @@ public class XTalkTransporter implements FrameTransporter {
/**
*
- * @param os the output stream
- * @param attributes attributes
- * @param workbuf a working buffer
- * @throws IOException passthru
+ * @param os
+ * the output stream
+ * @param attributes
+ * attributes
+ * @param workbuf
+ * a working buffer
+ * @throws IOException
+ * passthru
*
* @pre os != null
* @pre attributes != null
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/context/VinciContext.java b/jVinci/src/main/java/org/apache/vinci/transport/context/VinciContext.java
index 09e949f..03df0af 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/context/VinciContext.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/context/VinciContext.java
@@ -113,7 +113,7 @@ public class VinciContext {
private String host;
private int port;
-
+
private boolean socketKeepAliveEnabled = true;
static class CachedVNSResult {
@@ -150,8 +150,10 @@ public class VinciContext {
/**
* @pre myport ≥ 0
* @pre myport < 65536
- * @param myhost -
- * @param myport -
+ * @param myhost
+ * -
+ * @param myport
+ * -
*/
public VinciContext(String myhost, int myport) {
this.host = myhost;
@@ -167,7 +169,7 @@ public class VinciContext {
* Otherwise, you can set the hostname using the setVNSHost() method provided by this class.
*
* @return -
- * @throws IllegalStateException
+ * @throws IllegalStateException
* if the VNS host has not been specified.
*/
public String getVNSHost() {
@@ -187,6 +189,7 @@ public class VinciContext {
* System.setProperty("VNS_PORT", [hostname]) before ever invoking any Vinci client code.
* Otherwise, the port will default to 9000. You can override this default (or any
* property-specified value) by calling the setPort() method provided by this class.
+ *
* @return -
*/
public int getVNSPort() {
@@ -195,7 +198,9 @@ public class VinciContext {
/**
* Set the VNS hostname.
- * @param h -
+ *
+ * @param h
+ * -
*/
public void setVNSHost(String h) {
host = h;
@@ -207,7 +212,8 @@ public class VinciContext {
*
* @pre port ≥ 0
* @pre port < 65536
- * @param p -
+ * @param p
+ * -
*/
public void setVNSPort(int p) {
port = p;
@@ -217,6 +223,7 @@ public class VinciContext {
/**
* Returns whether clients can use stale resolve cache entries for service location in the event
* VNS is unreachable.
+ *
* @return -
*/
public boolean areStaleLookupsAllowed() {
@@ -226,7 +233,9 @@ public class VinciContext {
/**
* Set whether clients can use stale resolve cache entries for service location in the event VNS
* is unreachable. Default is true.
- * @param b -
+ *
+ * @param b
+ * -
*/
public void setAllowStaleLookups(boolean b) {
allowStaleLookups = b;
@@ -234,6 +243,7 @@ public class VinciContext {
/**
* Get the time-to-live of cached service locators (resolve results).
+ *
* @return -
*/
public int getResolveCacheTTL() {
@@ -243,7 +253,9 @@ public class VinciContext {
/**
* Set the time-to-live of cached service locators (resolve results). Default is 1 minute. Set to
* 0 to disable caching completely.
- * @param millis -
+ *
+ * @param millis
+ * -
*/
public void setResolveCacheTTL(int millis) {
ttlMillis = millis;
@@ -251,6 +263,7 @@ public class VinciContext {
/**
* Get the timeout setting of VNS resolve queries.
+ *
* @return -
*/
public int getVNSResolveTimeout() {
@@ -259,7 +272,9 @@ public class VinciContext {
/**
* Set the timeout of VNS resolve queries. Default is 20 seconds.
- * @param millis -
+ *
+ * @param millis
+ * -
*/
public void setVNSResolveTimeout(int millis) {
vnsResolveTimeout = millis;
@@ -267,6 +282,7 @@ public class VinciContext {
/**
* Get the timeout setting of VNS serveon queries.
+ *
* @return -
*/
public int getVNSServeonTimeout() {
@@ -275,14 +291,17 @@ public class VinciContext {
/**
* Set the timeout of VNS serveon queries. Default is 60 seconds.
- * @param millis -
+ *
+ * @param millis
+ * -
*/
public void setVNSServeonTimeout(int millis) {
vnsServeonTimeout = millis;
}
-
+
/**
* Returns whether socket keepAlive is enabled.
+ *
* @see java.net.Socket#setKeepAlive(boolean)
* @return -
*/
@@ -291,16 +310,19 @@ public class VinciContext {
}
/**
- * Set whether socket keepAlive is enabled. Default is true.
+ * Set whether socket keepAlive is enabled. Default is true.
+ *
* @see java.net.Socket#setKeepAlive(boolean)
- * @param b -
+ * @param b
+ * -
*/
public void setSocketKeepAliveEnabled(boolean b) {
socketKeepAliveEnabled = b;
- }
+ }
/**
* Get the global VinciContext used by Vinci classes when no context is explicitly specified.
+ *
* @return -
*/
static public VinciContext getGlobalContext() {
@@ -310,7 +332,8 @@ public class VinciContext {
/**
* Get a cached resolve result (if any).
*
- * @param serviceName -
+ * @param serviceName
+ * -
* @return the cached resolve result, or null if none is cached.
*
* @pre serviceName != null
@@ -329,7 +352,8 @@ public class VinciContext {
/**
* Get a cached resolve result (if any), but allow returning stale cache entries.
*
- * @param serviceName -
+ * @param serviceName
+ * -
* @return the cached resolve result, or null if none is cached.
*
* @pre serviceName != null
@@ -347,8 +371,10 @@ public class VinciContext {
*
* @pre serviceName != null
* @pre r != null
- * @param serviceName -
- * @param r -
+ * @param serviceName
+ * -
+ * @param r
+ * -
*/
synchronized public void cacheResolveResult(String serviceName, ResolveResult r) {
CachedVNSResult c = (CachedVNSResult) vnsCache.get(serviceName);
@@ -365,7 +391,8 @@ public class VinciContext {
* Flush any cache entries pertaining to the specified service.
*
* @pre serviceName != null
- * @param serviceName -
+ * @param serviceName
+ * -
*/
synchronized public void flushFromCache(String serviceName) {
vnsCache.remove(serviceName);
@@ -380,14 +407,21 @@ public class VinciContext {
*
* @see org.apache.vinci.transport.VinciClient
*
- * @param in -
- * @param service_name -
- * @param factory -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param factory
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if the VNS host has not been specified.
*
@@ -396,8 +430,8 @@ public class VinciContext {
* @pre factory != null
*/
public Transportable sendAndReceive(Transportable in, String service_name,
- TransportableFactory factory) throws IOException, ServiceException, ServiceDownException,
- VNSException {
+ TransportableFactory factory)
+ throws IOException, ServiceException, ServiceDownException, VNSException {
VinciClient tempClient = new VinciClient(service_name, factory, this);
try {
return tempClient.sendAndReceive(in);
@@ -411,13 +445,19 @@ public class VinciContext {
*
* @see org.apache.vinci.transport.VinciClient
*
- * @param in -
- * @param service_name -
- * @param factory -
- * @param socket_timeout -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param factory
+ * -
+ * @param socket_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
* @throws IllegalStateException
* if the VNS host has not been specified.
*
@@ -445,15 +485,22 @@ public class VinciContext {
*
* @see org.apache.vinci.transport.VinciClient
*
- * @param in -
- * @param service_name -
- * @param factory -
- * @param socket_timeout -
- * @param connect_timeout -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param factory
+ * -
+ * @param socket_timeout
+ * -
+ * @param connect_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
- * @throws IllegalStateException
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws IllegalStateException
* if the VNS host has not been specified.
*
* @pre in != null
@@ -478,21 +525,27 @@ public class VinciContext {
*
* @see org.apache.vinci.transport.VinciClient
*
- * @param in -
- * @param service_name -
+ * @param in
+ * -
+ * @param service_name
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if the VNS host has not been specified.
*
* @pre in != null
* @pre service_name != null
*/
- public VinciFrame rpc(Transportable in, String service_name) throws IOException,
- ServiceException, ServiceDownException, VNSException {
+ public VinciFrame rpc(Transportable in, String service_name)
+ throws IOException, ServiceException, ServiceDownException, VNSException {
VinciClient tempClient = new VinciClient(service_name, this);
try {
return tempClient.rpc(in);
@@ -506,14 +559,21 @@ public class VinciContext {
*
* @see org.apache.vinci.transport.VinciClient
*
- * @param in -
- * @param service_name -
- * @param timeout -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if the VNS host has not been specified.
*
@@ -521,8 +581,8 @@ public class VinciContext {
* @pre service_name != null
* @pre timeout ≥ 0
*/
- public VinciFrame rpc(Transportable in, String service_name, int timeout) throws IOException,
- ServiceException, ServiceDownException, VNSException {
+ public VinciFrame rpc(Transportable in, String service_name, int timeout)
+ throws IOException, ServiceException, ServiceDownException, VNSException {
VinciClient tempClient = new VinciClient(service_name, this);
tempClient.setSocketTimeout(timeout);
try {
@@ -540,15 +600,23 @@ public class VinciContext {
*
* @see org.apache.vinci.transport.VinciClient
*
- * @param in -
- * @param service_name -
- * @param socket_timeout -
- * @param connect_timeout -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param socket_timeout
+ * -
+ * @param connect_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if the VNS host has not been specified.
*
@@ -557,8 +625,8 @@ public class VinciContext {
* @pre timeout ≥ 0
*/
public VinciFrame rpc(Transportable in, String service_name, int socket_timeout,
- int connect_timeout) throws IOException, ServiceException, ServiceDownException,
- VNSException {
+ int connect_timeout)
+ throws IOException, ServiceException, ServiceDownException, VNSException {
VinciClient tempClient = new VinciClient(service_name, this, connect_timeout);
tempClient.setSocketTimeout(socket_timeout);
try {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/document/AFrame.java b/jVinci/src/main/java/org/apache/vinci/transport/document/AFrame.java
index 0e860b2..1e61091 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/document/AFrame.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/document/AFrame.java
@@ -72,6 +72,7 @@ public class AFrame extends VinciFrame {
/**
* Get a TransportableFactory that creates new AFrames.
+ *
* @return -
*/
static public TransportableFactory getAFrameFactory() {
@@ -84,7 +85,8 @@ public class AFrame extends VinciFrame {
/**
* @pre capacity ≥ 0
- * @param capacity -
+ * @param capacity
+ * -
*/
public AFrame(int capacity) {
super(capacity);
@@ -94,7 +96,8 @@ public class AFrame extends VinciFrame {
* Create an AFrame that is a (deep) copy of the given transportable.
*
* @pre t != null
- * @param t -
+ * @param t
+ * -
* @return -
*/
public static AFrame toAFrame(Transportable t) {
@@ -166,7 +169,8 @@ public class AFrame extends VinciFrame {
*
* @param key
* The key to be associated with the value.
- * @param val -
+ * @param val
+ * -
* @return The (empty) set of attributes associated with the added key.
*
* @pre key != null
@@ -182,7 +186,8 @@ public class AFrame extends VinciFrame {
*
* @param key
* The key to be associated with the value.
- * @param val -
+ * @param val
+ * -
* @return The (empty) set of attributes associated with the added key.
*
* @pre key != null
@@ -201,7 +206,8 @@ public class AFrame extends VinciFrame {
*
* @param key
* The key to be associated with the value.
- * @param val -
+ * @param val
+ * -
* @return The (empty) set of attributes associated with the added key.
*
* @pre key != null
@@ -432,18 +438,24 @@ public class AFrame extends VinciFrame {
* @pre in != null
* @pre service_name != null
*
- * @param in -
- * @param service_name -
+ * @param in
+ * -
+ * @param service_name
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if VNS_HOST is not specified.
*/
- static public AFrame rpc(Transportable in, String service_name) throws IOException,
- ServiceException, ServiceDownException, VNSException {
+ static public AFrame rpc(Transportable in, String service_name)
+ throws IOException, ServiceException, ServiceDownException, VNSException {
return (AFrame) VinciClient.sendAndReceive(in, service_name, getAFrameFactory());
}
@@ -452,21 +464,28 @@ public class AFrame extends VinciFrame {
* @pre service_name != null
* @pre socket_timeout ≥ 0
*
- * @param in -
- * @param service_name -
- * @param socket_timeout -
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param socket_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if VNS_HOST is not specified.
*/
static public AFrame rpc(Transportable in, String service_name, int socket_timeout)
throws IOException, ServiceException, ServiceDownException, VNSException {
- return (AFrame) VinciClient
- .sendAndReceive(in, service_name, getAFrameFactory(), socket_timeout);
+ return (AFrame) VinciClient.sendAndReceive(in, service_name, getAFrameFactory(),
+ socket_timeout);
}
/**
@@ -474,26 +493,34 @@ public class AFrame extends VinciFrame {
* @pre service_name != null
* @pre socket_timeout ≥ 0
*
- * WARNING: This method relies on JDK-1.4 specific functions. USE IT ONLY if you don't need to
- * maintain JDK1.3 compatability.
- *
- * @param in -
- * @param service_name -
- * @param socket_timeout -
- * @param connect_timeout -
+ * WARNING: This method relies on JDK-1.4 specific functions. USE IT ONLY if you don't need
+ * to maintain JDK1.3 compatability.
+ *
+ * @param in
+ * -
+ * @param service_name
+ * -
+ * @param socket_timeout
+ * -
+ * @param connect_timeout
+ * -
* @return -
- * @throws IOException -
- * @throws ServiceException -
- * @throws ServiceDownException -
- * @throws VNSException -
+ * @throws IOException
+ * -
+ * @throws ServiceException
+ * -
+ * @throws ServiceDownException
+ * -
+ * @throws VNSException
+ * -
* @throws IllegalStateException
* if VNS_HOST is not specified.
*/
static public AFrame rpc(Transportable in, String service_name, int socket_timeout,
- int connect_timeout) throws IOException, ServiceException, ServiceDownException,
- VNSException {
- return (AFrame) VinciClient.sendAndReceive(in, service_name, getAFrameFactory(),
- socket_timeout, connect_timeout);
+ int connect_timeout)
+ throws IOException, ServiceException, ServiceDownException, VNSException {
+ return (AFrame) VinciClient.sendAndReceive(in, service_name, getAFrameFactory(), socket_timeout,
+ connect_timeout);
}
/*
@@ -505,20 +532,18 @@ public class AFrame extends VinciFrame {
* VinciFrame, thus we can use the standard "fadd()" methods to create the // attribute list.
* f.aadd("KEY", "value1") // Add XML element and retrieve the attribute list object
* .fadd("attr1", "aval1") // Add an attribute for the tag. .fadd("attr2", "aval2") // Add another
- * attribute for the tag. .fadd("attr3", "you get the point");
- * // Note that with fadd() you can potentially create a duplicate attribute (an XML no-no), //
- * so the "idiot proof" method is to instead use fset(): f.aadd("VALUELESS_KEY") // Add a
- * valueless tag that has a couple of attributes .fset("foo", "bar") .fset("foo2", 2) .fset("foo",
- * "replaced bar");
- * // Here's how to create a nested AFrame: AFrame nested = new AFrame();
- * nested.aadd("NESTED_KEY", 1234.567) .fadd("nested", "attribute"); f.aadd("NESTED_FRAME",
- * nested) .fadd("attributename", new int[] {1,2,3});
- * // We can use either fadd() or aadd() to add attributeless tags, though fadd is // preferrable
- * since it avoids creating the attributes object. nested.fadd("ATTRIBUTELESS_KEY", "done with
- * fadd()"); nested.aadd("ANOTHER_ATTRIBUTELESS_KEY", "done with aadd()");
- *
- * System.out.println(f.toXML()); System.out.println();
- * // Querying key values: String foo_value = f.aget("VALUELESS_KEY").fgetString("foo");
+ * attribute for the tag. .fadd("attr3", "you get the point"); // Note that with fadd() you can
+ * potentially create a duplicate attribute (an XML no-no), // so the "idiot proof" method is to
+ * instead use fset(): f.aadd("VALUELESS_KEY") // Add a valueless tag that has a couple of
+ * attributes .fset("foo", "bar") .fset("foo2", 2) .fset("foo", "replaced bar"); // Here's how to
+ * create a nested AFrame: AFrame nested = new AFrame(); nested.aadd("NESTED_KEY", 1234.567)
+ * .fadd("nested", "attribute"); f.aadd("NESTED_FRAME", nested) .fadd("attributename", new int[]
+ * {1,2,3}); // We can use either fadd() or aadd() to add attributeless tags, though fadd is //
+ * preferrable since it avoids creating the attributes object. nested.fadd("ATTRIBUTELESS_KEY",
+ * "done with fadd()"); nested.aadd("ANOTHER_ATTRIBUTELESS_KEY", "done with aadd()");
+ *
+ * System.out.println(f.toXML()); System.out.println(); // Querying key values: String foo_value =
+ * f.aget("VALUELESS_KEY").fgetString("foo");
* System.out.println("Attribute value of foo from VALUELESS_KEY: " + foo_value);
* System.out.println("TEST: " + toAFrame(f).toXML()); }
*/
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/document/XMLToVinci.java b/jVinci/src/main/java/org/apache/vinci/transport/document/XMLToVinci.java
index f4d0a56..b09891e 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/document/XMLToVinci.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/document/XMLToVinci.java
@@ -54,10 +54,12 @@ public class XMLToVinci {
try {
spf.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
} catch (SAXNotRecognizedException | SAXNotSupportedException
- | ParserConfigurationException e) {
- System.err.println("Warning: SAXParserFactory didn't recognized the feature http://apache.org/xml/features/disallow-doctype-decl");
+ | ParserConfigurationException e) {
+ System.err.println(
+ "Warning: SAXParserFactory didn't recognized the feature http://apache.org/xml/features/disallow-doctype-decl");
}
}
+
/**
* Utility class not intended to be instantiated.
*/
@@ -258,7 +260,7 @@ public class XMLToVinci {
public static VinciFrame xmlToVinciFrame(Reader r) throws ServiceException {
XMLReader xr;
try {
- synchronized(spf) {
+ synchronized (spf) {
xr = spf.newSAXParser().getXMLReader();
}
} catch (SAXException e) {
@@ -271,9 +273,11 @@ public class XMLToVinci {
try {
xr.setFeature("http://xml.org/sax/features/namespaces", false);
} catch (SAXNotRecognizedException e) {
- System.err.println("Warning: XMLReader didn't recognize the feature http://xml.org/sax/features/namespaces");
+ System.err.println(
+ "Warning: XMLReader didn't recognize the feature http://xml.org/sax/features/namespaces");
} catch (SAXNotSupportedException e) {
- System.err.println("Warning: XMLReader doesn't support the feature http://xml.org/sax/features/namespaces");
+ System.err.println(
+ "Warning: XMLReader doesn't support the feature http://xml.org/sax/features/namespaces");
}
VinciFrameHandler handler = new VinciFrameHandler();
xr.setContentHandler(handler);
@@ -292,7 +296,7 @@ public class XMLToVinci {
* public static AFrame xmlToAFrame(Reader r) throws ServiceException { return (AFrame)
* xmlToTransportable(r, new AFrame()); }
*/
-
+
/**
* Convert the XML document (provided as a Reader) to the AFrame document model. Throws
* ServiceException if the XML parser reports any error. WARNING: This method will silently ignore
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/document/XMLToXTalk.java b/jVinci/src/main/java/org/apache/vinci/transport/document/XMLToXTalk.java
index 7f5956c..2c6cf0e 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/document/XMLToXTalk.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/document/XMLToXTalk.java
@@ -197,19 +197,26 @@ public class XMLToXTalk {
* representation of that data. If xml_filename is non-null, then this method will also create a
* UTF-8 representation of the xml file, exactly mimicing the XTalk encoding (e.g. removing
* irrelevant whitespace, expanding entity refs, etc).
- * @param r -
- * @param filename -
- * @param purgeWhitespace -
- * @param xml_filename -
- * @throws ServiceException -
- * @throws IOException -
+ *
+ * @param r
+ * -
+ * @param filename
+ * -
+ * @param purgeWhitespace
+ * -
+ * @param xml_filename
+ * -
+ * @throws ServiceException
+ * -
+ * @throws IOException
+ * -
*/
public static void xmlToXTalk(Reader r, String filename, boolean purgeWhitespace,
String xml_filename) throws ServiceException, IOException {
Writer xml_os = null;
if (xml_filename != null) {
- xml_os = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(xml_filename),
- StandardCharsets.UTF_8));
+ xml_os = new BufferedWriter(
+ new OutputStreamWriter(new FileOutputStream(xml_filename), StandardCharsets.UTF_8));
}
File file = new File(filename);
OutputStream os = new BufferedOutputStream(new FileOutputStream(file));
@@ -224,9 +231,11 @@ public class XMLToXTalk {
try {
spf.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
} catch (SAXNotRecognizedException e) {
- System.err.println("Warning: SAXParserFactory didn't recognized feature http://apache.org/xml/features/disallow-doctype-decl");
+ System.err.println(
+ "Warning: SAXParserFactory didn't recognized feature http://apache.org/xml/features/disallow-doctype-decl");
} catch (SAXNotSupportedException e) {
- System.err.println("Warning: SAXParserFactory doesn't support feature http://apache.org/xml/features/disallow-doctype-decl");
+ System.err.println(
+ "Warning: SAXParserFactory doesn't support feature http://apache.org/xml/features/disallow-doctype-decl");
}
xr = spf.newSAXParser().getXMLReader();
} catch (SAXException e) {
@@ -296,10 +305,11 @@ public class XMLToXTalk {
static private void skipString(RandomAccessFile raf) throws IOException {
final int count = raf.readInt();
// Debug.p("Skipping string of size: " + count);
- final int skipped = raf.skipBytes(count);
+ final int skipped = raf.skipBytes(count);
if (count != skipped) {
- throw new RuntimeException(String.format("%d bytes skipped when %d was requested, while reading from stream %s",
- skipped, count, raf));
+ throw new RuntimeException(
+ String.format("%d bytes skipped when %d was requested, while reading from stream %s",
+ skipped, count, raf));
}
}
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/document/XTalkToSAX.java b/jVinci/src/main/java/org/apache/vinci/transport/document/XTalkToSAX.java
index b4dc86d..a5c7f1d 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/document/XTalkToSAX.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/document/XTalkToSAX.java
@@ -68,6 +68,7 @@ public class XTalkToSAX {
* determine the size of these arrays with this method. This method in conjunction with
* resetBuffers lets application implement their own buffer management. Buffers can be reset
* during parsing, but not from another thread.
+ *
* @return -
*/
public int bufferSize() {
@@ -78,7 +79,9 @@ public class XTalkToSAX {
* Resets buffers to their initial size... this is useful because buffers can grow during parsing
* and this allows the space to be reclaimed without having to undo references to the parser
* object.
- * @param toSize -
+ *
+ * @param toSize
+ * -
*/
public void resizeBuffers(int toSize) {
if (this.byteBuffer.length != toSize) {
@@ -93,8 +96,10 @@ public class XTalkToSAX {
* the document. Use bufferSize() and resizeBuffers to manage memory in applications where very
* large strings may be encountered and the same object is used to parse many incoming documents.
*
- * @param is -
- * @param handler -
+ * @param is
+ * -
+ * @param handler
+ * -
* @throws IOException
* if underlying IOException from the stream or if XTalk format is invalid.
* @throws SAXException
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/util/Base64Converter.java b/jVinci/src/main/java/org/apache/vinci/transport/util/Base64Converter.java
index 2d1950f..129cc28 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/util/Base64Converter.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/util/Base64Converter.java
@@ -48,7 +48,8 @@ public class Base64Converter {
/**
* @pre from != null
- * @param from -
+ * @param from
+ * -
* @return -
*/
static public byte[] convertBinaryToBase64(byte[] from) {
@@ -57,19 +58,22 @@ public class Base64Converter {
/**
* @pre convert_me != null
- * @param convert_me -
+ * @param convert_me
+ * -
* @return -
*/
-
+
static public String convertStringToBase64String(String convert_me) {
return new String(convertBinaryToBase64(convert_me.getBytes()));
}
/**
* @pre base64 != null
- * @param base64 -
+ * @param base64
+ * -
* @return -
- * @throws Base64FormatException -
+ * @throws Base64FormatException
+ * -
*/
static public String convertBase64StringToString(String base64) throws Base64FormatException {
return new String(convertBase64ToBinary(base64.getBytes()));
@@ -77,9 +81,12 @@ public class Base64Converter {
/**
* @pre count ≤ from.length
- * @param from -
- * @param count -
- * @param line_breaks -
+ * @param from
+ * -
+ * @param count
+ * -
+ * @param line_breaks
+ * -
* @return -
*/
static public byte[] convertBinaryToBase64(byte[] from, final int count, boolean line_breaks) {
@@ -115,8 +122,11 @@ public class Base64Converter {
/**
* Calculates the size of the resulting Base64 string returned by this class for a binary byte
* array of the specified length. Includes carriage returns and all.
- * @param input_size -
- * @param line_breaks -
+ *
+ * @param input_size
+ * -
+ * @param line_breaks
+ * -
* @return -
*/
static public int calculateBase64OutputSize(int input_size, boolean line_breaks) {
@@ -135,9 +145,11 @@ public class Base64Converter {
/**
* @pre input != null
- * @param input -
+ * @param input
+ * -
* @return -
- * @throws Base64FormatException -
+ * @throws Base64FormatException
+ * -
*/
static public byte[] convertBase64ToBinary(byte[] input) throws Base64FormatException {
return convertBase64ToBinary(input, input.length);
@@ -146,10 +158,13 @@ public class Base64Converter {
/**
* @pre input != null
* @pre input_size ≤ input.length
- * @param input -
- * @param input_size -
+ * @param input
+ * -
+ * @param input_size
+ * -
* @return -
- * @throws Base64FormatException -
+ * @throws Base64FormatException
+ * -
*/
static public byte[] convertBase64ToBinary(byte[] input, final int input_size)
throws Base64FormatException {
@@ -169,10 +184,13 @@ public class Base64Converter {
*
* @pre input != null
* @pre input_size ≤ input.length
- * @param input -
- * @param input_size -
+ * @param input
+ * -
+ * @param input_size
+ * -
* @return -
- * @throws Base64FormatException -
+ * @throws Base64FormatException
+ * -
*/
static public int calculateBinaryOutputSize(byte[] input, final int input_size)
throws Base64FormatException {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/util/StreamMaterializer.java b/jVinci/src/main/java/org/apache/vinci/transport/util/StreamMaterializer.java
index e295515..0807ac5 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/util/StreamMaterializer.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/util/StreamMaterializer.java
@@ -40,9 +40,11 @@ public class StreamMaterializer {
* Bring the entire contents of the provided stream into a memory-resident byte array. Does NOT
* close the stream.
*
- * @param input_stream -
+ * @param input_stream
+ * -
* @return -
- * @throws IOException -
+ * @throws IOException
+ * -
* @exception IOException
* thrown by the input stream.
* @pre input_stream != null
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/util/UTFConverter.java b/jVinci/src/main/java/org/apache/vinci/transport/util/UTFConverter.java
index 6d10229..47d40b5 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/util/UTFConverter.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/util/UTFConverter.java
@@ -42,11 +42,13 @@ public class UTFConverter {
* @param bytearr
* Array of bytes.
* @return float.
- * @throws UTFDataFormatException if the UTF-8 is encoded improperly
- * @throws NumberFormatException if conversion to a number can't be done
+ * @throws UTFDataFormatException
+ * if the UTF-8 is encoded improperly
+ * @throws NumberFormatException
+ * if conversion to a number can't be done
*/
- static public float convertUTFToFloat(byte[] bytearr) throws UTFDataFormatException,
- NumberFormatException {
+ static public float convertUTFToFloat(byte[] bytearr)
+ throws UTFDataFormatException, NumberFormatException {
return Float.parseFloat(UTFConverter.convertUTFToString(bytearr));
}
@@ -56,11 +58,13 @@ public class UTFConverter {
* @param bytearr
* Array of bytes.
* @return double.
- * @throws UTFDataFormatException if the UTF-8 is encoded improperly
- * @throws NumberFormatException if conversion to a number can't be done
+ * @throws UTFDataFormatException
+ * if the UTF-8 is encoded improperly
+ * @throws NumberFormatException
+ * if conversion to a number can't be done
*/
- static public double convertUTFToDouble(byte[] bytearr) throws UTFDataFormatException,
- NumberFormatException {
+ static public double convertUTFToDouble(byte[] bytearr)
+ throws UTFDataFormatException, NumberFormatException {
return Double.parseDouble(UTFConverter.convertUTFToString(bytearr));
}
@@ -70,7 +74,8 @@ public class UTFConverter {
* @param bytearr
* Array of bytes.
* @return boolean.
- * @throws UTFDataFormatException if the UTF-8 is encoded improperly
+ * @throws UTFDataFormatException
+ * if the UTF-8 is encoded improperly
*/
static public boolean convertUTFToBool(byte[] bytearr) throws UTFDataFormatException {
return TRUE_VALUE.equals(UTFConverter.convertUTFToString(bytearr));
@@ -82,11 +87,13 @@ public class UTFConverter {
* @param bytearr
* Array of bytes.
* @return int.
- * @throws UTFDataFormatException if the UTF-8 is encoded improperly
- * @throws NumberFormatException if conversion to a number can't be done
+ * @throws UTFDataFormatException
+ * if the UTF-8 is encoded improperly
+ * @throws NumberFormatException
+ * if conversion to a number can't be done
*/
- static public int convertUTFToInt(byte[] bytearr) throws UTFDataFormatException,
- NumberFormatException {
+ static public int convertUTFToInt(byte[] bytearr)
+ throws UTFDataFormatException, NumberFormatException {
return Integer.parseInt(UTFConverter.convertUTFToString(bytearr));
}
@@ -96,11 +103,13 @@ public class UTFConverter {
* @param bytearr
* Array of bytes.
* @return long.
- * @throws UTFDataFormatException if the UTF-8 is encoded improperly
- * @throws NumberFormatException if conversion to a number can't be done
+ * @throws UTFDataFormatException
+ * if the UTF-8 is encoded improperly
+ * @throws NumberFormatException
+ * if conversion to a number can't be done
*/
- static public long convertUTFToLong(byte[] bytearr) throws UTFDataFormatException,
- NumberFormatException {
+ static public long convertUTFToLong(byte[] bytearr)
+ throws UTFDataFormatException, NumberFormatException {
return Long.parseLong(UTFConverter.convertUTFToString(bytearr));
}
@@ -110,7 +119,8 @@ public class UTFConverter {
* @param bytearr
* Array of bytes.
* @return String.
- * @throws UTFDataFormatException if the UTF-8 is encoded improperly
+ * @throws UTFDataFormatException
+ * if the UTF-8 is encoded improperly
*/
static public String convertUTFToString(byte[] bytearr) throws UTFDataFormatException {
char[] result = new char[bytearr.length];
@@ -132,10 +142,11 @@ public class UTFConverter {
* @param result
* Character array containing the converted characters.
* @return The length of the converted characters.
- * @throws UTFDataFormatException if the UTF-8 is encoded improperly
+ * @throws UTFDataFormatException
+ * if the UTF-8 is encoded improperly
*/
- static public int convertUTFToString(byte[] bytearr, final int beginOffset,
- final int inputLength, char[] result) throws UTFDataFormatException {
+ static public int convertUTFToString(byte[] bytearr, final int beginOffset, final int inputLength,
+ char[] result) throws UTFDataFormatException {
int outputLength = 0;
int count = beginOffset;
int c1, c2, c3;
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/util/XMLConverter.java b/jVinci/src/main/java/org/apache/vinci/transport/util/XMLConverter.java
index e362d96..8f6af7f 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/util/XMLConverter.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/util/XMLConverter.java
@@ -35,7 +35,8 @@ public class XMLConverter {
* Convert to XML string format. Uses CDATA encoding if there are more than 4 characters requiring
* ampersand encoding.
*
- * @param convert_me -
+ * @param convert_me
+ * -
* @return the converted string
* @pre convert_me != null
*/
@@ -48,7 +49,8 @@ public class XMLConverter {
/**
* Convert to XML string format without ever using CDATA encoding.
*
- * @param convert_me -
+ * @param convert_me
+ * -
* @return the converted string
*
* @pre convert_me != null
@@ -61,8 +63,10 @@ public class XMLConverter {
/**
*
- * @param convert_me -
- * @param append_to_me -
+ * @param convert_me
+ * -
+ * @param append_to_me
+ * -
*
* @pre convert_me != null
* @pre append_to_me != null
@@ -92,8 +96,10 @@ public class XMLConverter {
}
/**
- * @param convert_me -
- * @param append_to_me -
+ * @param convert_me
+ * -
+ * @param append_to_me
+ * -
*
* @pre convert_me != null
* @pre append_to_me != null
@@ -131,7 +137,8 @@ public class XMLConverter {
}
/**
- * @param convert_me -
+ * @param convert_me
+ * -
* @return -
* @pre convert_me != null
*/
@@ -143,8 +150,10 @@ public class XMLConverter {
/**
*
- * @param convert_me -
- * @param append_to_me -
+ * @param convert_me
+ * -
+ * @param append_to_me
+ * -
*
* @pre convert_me != null
* @pre append_to_me != null
@@ -182,4 +191,3 @@ public class XMLConverter {
}
} // class
-
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/vns/client/ResolveResult.java b/jVinci/src/main/java/org/apache/vinci/transport/vns/client/ResolveResult.java
index b1816e3..2e19560 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/vns/client/ResolveResult.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/vns/client/ResolveResult.java
@@ -54,7 +54,8 @@ public class ResolveResult extends Frame {
* Strip the qualifications from this qualified service name.
*
* @pre service_name != null
- * @param service_name -
+ * @param service_name
+ * -
* @return -
*/
static public String unqualifiedName(String service_name) {
@@ -72,7 +73,8 @@ public class ResolveResult extends Frame {
* are explicitly specified.)
*
* @pre service_name != null
- * @param service_name -
+ * @param service_name
+ * -
* @return -
*/
static public boolean isQualified(String service_name) {
@@ -87,7 +89,8 @@ public class ResolveResult extends Frame {
* accepts either qualified or unqualified service names.
*
* @pre service_name != null
- * @param service_name -
+ * @param service_name
+ * -
* @return -
*/
static public Frame composeQuery(String service_name) {
@@ -128,8 +131,10 @@ public class ResolveResult extends Frame {
* unqualified service names.
*
* @pre service_name != null
- * @param service_name -
- * @param mypriority -
+ * @param service_name
+ * -
+ * @param mypriority
+ * -
* @return -
*/
static public Frame composeQuery(String service_name, int mypriority) {
@@ -159,6 +164,7 @@ public class ResolveResult extends Frame {
/**
* Determine if there are more service listing to be fetched.
+ *
* @return -
*/
public boolean hasMore() {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/vns/client/ServeonResult.java b/jVinci/src/main/java/org/apache/vinci/transport/vns/client/ServeonResult.java
index 79ff795..791b0c4 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/vns/client/ServeonResult.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/vns/client/ServeonResult.java
@@ -49,10 +49,14 @@ public class ServeonResult extends Frame {
* @pre host_name != null
* @pre priority ≥ -1
* @pre instance ≥ 0
- * @param service_name -
- * @param host_name -
- * @param priority -
- * @param instance -
+ * @param service_name
+ * -
+ * @param host_name
+ * -
+ * @param priority
+ * -
+ * @param instance
+ * -
* @return -
*
*/
@@ -70,9 +74,12 @@ public class ServeonResult extends Frame {
* @pre service_name != null
* @pre host_name != null
* @pre priority ≥ -1
- * @param service_name -
- * @param host_name -
- * @param priority -
+ * @param service_name
+ * -
+ * @param host_name
+ * -
+ * @param priority
+ * -
* @return -
*/
static public Transportable composeQuery(String service_name, String host_name, int priority) {
@@ -87,8 +94,10 @@ public class ServeonResult extends Frame {
*
* @pre service_name != null
* @pre host_name != null
- * @param service_name -
- * @param host_name -
+ * @param service_name
+ * -
+ * @param host_name
+ * -
* @return -
*/
static public Transportable composeQuery(String service_name, String host_name) {
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/vns/client/VNSConfig.java b/jVinci/src/main/java/org/apache/vinci/transport/vns/client/VNSConfig.java
index 4fef50c..ecbfe84 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/vns/client/VNSConfig.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/vns/client/VNSConfig.java
@@ -42,7 +42,7 @@ public final class VNSConfig {
* if no VNS host has been specified.
*/
@Deprecated
-public String getHost() {
+ public String getHost() {
return VinciContext.getGlobalContext().getVNSHost();
}
@@ -59,7 +59,7 @@ public String getHost() {
* @deprecated Use VinciContext.getVNSPort() instead.
*/
@Deprecated
-public int getPort() {
+ public int getPort() {
return VinciContext.getGlobalContext().getVNSPort();
}
@@ -67,11 +67,12 @@ public int getPort() {
* Set the VNS hostname. Explicitly setting the VNS hostname using this method will override any
* hostname set via the VNS_HOST java property.
*
- * @param h -
+ * @param h
+ * -
* @deprecated Use VinciContext.setVNSHost() instead.
*/
@Deprecated
-public void setHost(String h) {
+ public void setHost(String h) {
VinciContext.getGlobalContext().setVNSHost(h);
}
@@ -79,11 +80,12 @@ public void setHost(String h) {
* Set the VNS port. Explicitly setting the VNS hostname using this method will override any port
* number set via the VNS_PORT java property.
*
- * @param p -
+ * @param p
+ * -
* @deprecated Use VinciContext.setVNSPort() instead.
*/
@Deprecated
-public void setPort(int p) {
+ public void setPort(int p) {
VinciContext.getGlobalContext().setVNSPort(p);
}
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/vns/service/NameClient.java b/jVinci/src/main/java/org/apache/vinci/transport/vns/service/NameClient.java
index cd86ce4..f5caffc 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/vns/service/NameClient.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/vns/service/NameClient.java
@@ -62,8 +62,8 @@ public class NameClient {
static Random R = new Random();
public NameClient() {
- configure(VinciContext.getGlobalContext().getVNSHost(), VinciContext.getGlobalContext()
- .getVNSPort());
+ configure(VinciContext.getGlobalContext().getVNSHost(),
+ VinciContext.getGlobalContext().getVNSPort());
}
public NameClient(String host, int port) {
@@ -111,8 +111,9 @@ public class NameClient {
public ServiceInfo[] lookup(String name, int level, String host, String instance, String ws) {
VinciFrame req = new VinciFrame();
- req.fadd("vinci:COMMAND", VNSConstants.RESOLVE_COMMAND).fadd("SERVICE", name).fadd("LEVEL",
- level).fadd("HOST", host).fadd("INSTANCE", instance).fadd("WORKSPACE", ws);
+ req.fadd("vinci:COMMAND", VNSConstants.RESOLVE_COMMAND).fadd("SERVICE", name)
+ .fadd("LEVEL", level).fadd("HOST", host).fadd("INSTANCE", instance)
+ .fadd("WORKSPACE", ws);
System.out.println(req.toXML());
VinciFrame resp = (VinciFrame) transmit(req);
@@ -177,8 +178,9 @@ public class NameClient {
}
public ServiceInfo resolve(String name, int level) {
- VinciFrame req = (VinciFrame) new VinciFrame().fadd("vinci:COMMAND",
- VNSConstants.RESOLVE_COMMAND).fadd("SERVICE", name).fadd("LEVEL", level);
+ VinciFrame req = (VinciFrame) new VinciFrame()
+ .fadd("vinci:COMMAND", VNSConstants.RESOLVE_COMMAND).fadd("SERVICE", name)
+ .fadd("LEVEL", level);
VinciFrame resp = (VinciFrame) transmit(req);
@@ -393,9 +395,9 @@ public class NameClient {
}
}
- VinciFrame out = (VinciFrame) new VinciFrame().fadd("vinci:COMMAND",
- VNSConstants.SERVEON_COMMAND).fadd("SERVICE", name).fadd("HOST", host).fadd("LEVEL",
- level).fadd("INSTANCE", instance);
+ VinciFrame out = (VinciFrame) new VinciFrame()
+ .fadd("vinci:COMMAND", VNSConstants.SERVEON_COMMAND).fadd("SERVICE", name)
+ .fadd("HOST", host).fadd("LEVEL", level).fadd("INSTANCE", instance);
VinciFrame resp = (VinciFrame) transmit(out);
@@ -427,8 +429,8 @@ public class NameClient {
QueryableFrame L;
for (int i = 0; i < S.length; i++) {
L = (QueryableFrame) A.get(i);
- S[i] = new ServiceInfo(name, L.fgetString("HOST"), L.fgetString("PORT"), level, L
- .fgetString("INSTANCE"));
+ S[i] = new ServiceInfo(name, L.fgetString("HOST"), L.fgetString("PORT"), level,
+ L.fgetString("INSTANCE"));
}
return S;
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/vns/service/ServiceAlias.java b/jVinci/src/main/java/org/apache/vinci/transport/vns/service/ServiceAlias.java
index 8fbb24f..2a0cf87 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/vns/service/ServiceAlias.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/vns/service/ServiceAlias.java
@@ -50,9 +50,9 @@ public class ServiceAlias implements ServiceInterface {
StringBuffer indent = new StringBuffer(offset);
while (offset > 0) {
indent.append(' ');
- offset --;
+ offset--;
}
-
+
StringBuffer result = new StringBuffer(50);
result = result.append(indent).append("<SERVICE>\n");
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/vns/service/ServiceRegistry.java b/jVinci/src/main/java/org/apache/vinci/transport/vns/service/ServiceRegistry.java
index 3da770e..efbf793 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/vns/service/ServiceRegistry.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/vns/service/ServiceRegistry.java
@@ -411,9 +411,10 @@ public class ServiceRegistry {
try {
dbf.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
} catch (ParserConfigurationException e) {
- System.err.println("Warning: DocumentBuilderFactory doesn't support the feature http://apache.org/xml/features/disallow-doctype-decl");
+ System.err.println(
+ "Warning: DocumentBuilderFactory doesn't support the feature http://apache.org/xml/features/disallow-doctype-decl");
}
-
+
DocumentBuilder docBuilder = dbf.newDocumentBuilder();
Document doc;
@@ -452,8 +453,8 @@ public class ServiceRegistry {
H.put(C.getNodeName(), C.getFirstChild().getNodeValue());
} else {
// Complex elements
- H.put(C.getNodeName(), XMLToVinci.xmlToVinciFrame(new StringReader(constructXMLString(C,
- true))));
+ H.put(C.getNodeName(),
+ XMLToVinci.xmlToVinciFrame(new StringReader(constructXMLString(C, true))));
}
} // End for j
diff --git a/jVinci/src/main/java/org/apache/vinci/transport/vns/service/VNS.java b/jVinci/src/main/java/org/apache/vinci/transport/vns/service/VNS.java
index 698fce0..03e10b8 100644
--- a/jVinci/src/main/java/org/apache/vinci/transport/vns/service/VNS.java
+++ b/jVinci/src/main/java/org/apache/vinci/transport/vns/service/VNS.java
@@ -225,8 +225,8 @@ public class VNS extends VinciServableAdapter {
System.out.println(" Set the ServerSocket backlog [default=" + backlog + "]");
System.out.println(" -m N --maxthreads N");
- System.out.println(" Set the maximum size of the VNS thread pool [default=" + maxThreads
- + "].");
+ System.out.println(
+ " Set the maximum size of the VNS thread pool [default=" + maxThreads + "].");
System.out.println(" -h --help");
System.out.println(" This help message");
@@ -574,12 +574,8 @@ public class VNS extends VinciServableAdapter {
} catch (Exception e) {
// Exact translation of the Python code [may not be necessary]
out = new VinciFrame();
- out
- .fadd(
- "vinci:ERROR",
- "Critical error :\n"
- + e
- + "\nThe server MAY not respond to further requests.\nPlease notify the administrator\n");
+ out.fadd("vinci:ERROR", "Critical error :\n" + e
+ + "\nThe server MAY not respond to further requests.\nPlease notify the administrator\n");
e.printStackTrace();
}
@@ -650,8 +646,8 @@ public class VNS extends VinciServableAdapter {
cache(name + "[" + servicesList[0].level + "]", new CachedItem(servicesList));
// Have a proxy pointer to the entry created if it is not the same
if (!servicesList[0].level.equals(level)) {
- cache(name + "[" + level + "]", new ProxyCachedItem(name + "[" + servicesList[0].level
- + "]"));
+ cache(name + "[" + level + "]",
+ new ProxyCachedItem(name + "[" + servicesList[0].level + "]"));
}
}
} else
@@ -797,8 +793,8 @@ public class VNS extends VinciServableAdapter {
}
VinciFrame resolve(VinciFrame in) {
- logRequest(VNSConstants.RESOLVE_COMMAND, in.fgetString("vinci:REMOTEIP"), in
- .fgetString("SERVICE"));
+ logRequest(VNSConstants.RESOLVE_COMMAND, in.fgetString("vinci:REMOTEIP"),
+ in.fgetString("SERVICE"));
if (in.fgetString("WORKSPACE") == null) {
return resolveDefaults(in);
@@ -916,10 +912,8 @@ public class VNS extends VinciServableAdapter {
public void run() {
Debug.p("Trying to shutdown old service ...");
VinciFrame shutdown = new VinciFrame();
- shutdown
- .fadd(
- "vinci:SHUTDOWN",
- "Identical service started on this host. Use the INSTANCE tag to run multiple instances of the same service on a single host.");
+ shutdown.fadd("vinci:SHUTDOWN",
+ "Identical service started on this host. Use the INSTANCE tag to run multiple instances of the same service on a single host.");
try {
VinciFrame f = BaseClient.rpc(shutdown, s_host, s_port, 10000);
Debug.p("Shutdown response received: " + f.toXML());
@@ -985,8 +979,8 @@ public class VNS extends VinciServableAdapter {
getFrame(false, "Malformed request");
else {
synchronized (SR) {
- ok = SR
- .addAlias(new ServiceAlias(service.fgetString("NAME"), service.fgetString("TARGET")));
+ ok = SR.addAlias(
+ new ServiceAlias(service.fgetString("NAME"), service.fgetString("TARGET")));
}
}
diff --git a/jcasgen-maven-plugin/src/main/java/org/apache/uima/tools/jcasgen/maven/JCasGenMojo.java b/jcasgen-maven-plugin/src/main/java/org/apache/uima/tools/jcasgen/maven/JCasGenMojo.java
index 68a3f7c..753ea1a 100644
--- a/jcasgen-maven-plugin/src/main/java/org/apache/uima/tools/jcasgen/maven/JCasGenMojo.java
+++ b/jcasgen-maven-plugin/src/main/java/org/apache/uima/tools/jcasgen/maven/JCasGenMojo.java
@@ -69,8 +69,8 @@ import org.xml.sax.SAXException;
*/
@Mojo(name = "generate", defaultPhase = LifecyclePhase.PROCESS_RESOURCES, requiresDependencyResolution = ResolutionScope.COMPILE)
public class JCasGenMojo extends AbstractMojo {
-
- @Parameter( defaultValue = "${project}", readonly = true )
+
+ @Parameter(defaultValue = "${project}", readonly = true)
private MavenProject project;
@Component
@@ -111,7 +111,7 @@ public class JCasGenMojo extends AbstractMojo {
// assemble the classpath
StringBuilder classpathBuilder = new StringBuilder();
-
+
// Source roots
for (String element : this.project.getCompileSourceRoots()) {
if (classpathBuilder.length() > 0) {
@@ -129,7 +129,7 @@ public class JCasGenMojo extends AbstractMojo {
classpathBuilder.append(element.getDirectory());
getLog().debug("JCasGen: Adding resource root to classpath '" + element.getDirectory() + "'");
}
-
+
// Dependencies
List<String> elements;
try {
@@ -197,7 +197,7 @@ public class JCasGenMojo extends AbstractMojo {
} finally {
IOUtil.close(typeSystemOs);
}
-
+
// skip JCasGen if there are no changes in the type system file or the files it
// references hasDelta resolves the imports!
if (!contextDelta && !this.hasDelta(typeSystem, classpath)) {
@@ -256,8 +256,8 @@ public class JCasGenMojo extends AbstractMojo {
}
/*
- * called by the common JCasGen code when it detects an error
- * If no exception, the "exception" parameter is null
+ * called by the common JCasGen code when it detects an error If no exception, the "exception"
+ * parameter is null
*/
@Override
public void newError(int severity, String message, Exception exception) {
@@ -269,7 +269,7 @@ public class JCasGenMojo extends AbstractMojo {
} else if (severity == IError.ERROR) {
String m = fullMessage;
if (exception != null) {
- m = m + "\nException: " + exception.getMessage();
+ m = m + "\nException: " + exception.getMessage();
}
throw new JCasGenException(m, exception);
} else {
@@ -360,7 +360,8 @@ public class JCasGenMojo extends AbstractMojo {
}
// for any type system file that is in the same project, return true if it has
// changed
- if (targetFile.getAbsolutePath().startsWith(this.project.getBasedir().getAbsolutePath())) {
+ if (targetFile.getAbsolutePath()
+ .startsWith(this.project.getBasedir().getAbsolutePath())) {
if (this.buildContext.hasDelta(targetFile)) {
this.getLog().info("Type system file " + sourceFile + " has changed");
return true;
diff --git a/jcasgen-maven-plugin/src/test/java/org/apache/uima/tools/jcasgen/maven/JCasGenMojoTest.java b/jcasgen-maven-plugin/src/test/java/org/apache/uima/tools/jcasgen/maven/JCasGenMojoTest.java
index 2d49001..7dce501 100644
--- a/jcasgen-maven-plugin/src/test/java/org/apache/uima/tools/jcasgen/maven/JCasGenMojoTest.java
+++ b/jcasgen-maven-plugin/src/test/java/org/apache/uima/tools/jcasgen/maven/JCasGenMojoTest.java
@@ -35,8 +35,8 @@ import org.junit.Test;
public class JCasGenMojoTest extends AbstractMojoTestCase {
- @Test
- public void testInvalidFeature() throws Exception {
+ @Test
+ public void testInvalidFeature() throws Exception {
Exception ee = null;
try {
this.test("invalidFeature");
@@ -44,38 +44,40 @@ public class JCasGenMojoTest extends AbstractMojoTestCase {
ee = e;
}
assertTrue(ee != null);
- assertEquals("JCasGen: The feature name 'type', specified in Type 'type.span.Sentence' is reserved. Please choose another name.", ee.getMessage());
+ assertEquals(
+ "JCasGen: The feature name 'type', specified in Type 'type.span.Sentence' is reserved. Please choose another name.",
+ ee.getMessage());
}
-
- @Test
- public void testSimple() throws Exception {
+
+ @Test
+ public void testSimple() throws Exception {
this.test("simple", "type.span.Sentence", "type.span.Token", "type.relation.Dependency");
}
- @Test
- public void testClasspath() throws Exception {
+ @Test
+ public void testClasspath() throws Exception {
this.test("classpath", "type.span.Sentence", "type.span.Token", "type.relation.Dependency");
}
- @Test
- public void testWildcard() throws Exception {
+ @Test
+ public void testWildcard() throws Exception {
this.test("wildcard", "type.span.Sentence", "type.span.Token");
}
- @Test
- public void testExclude() throws Exception {
+ @Test
+ public void testExclude() throws Exception {
this.test("exclude", "type.span.Sentence");
}
- @Test
- public void test(String projectName, String... types) throws Exception {
+ @Test
+ public void test(String projectName, String... types) throws Exception {
File projectSourceDirectory = getTestFile("src/test/resources/" + projectName);
File projectDirectory = getTestFile("target/project-" + projectName + "-test");
// Stage project to target folder
FileUtils.copyDirectoryStructure(projectSourceDirectory, projectDirectory);
-
+
File pomFile = new File(projectDirectory, "/pom.xml");
assertNotNull(pomFile);
assertTrue(pomFile.exists());
@@ -92,7 +94,7 @@ public class JCasGenMojoTest extends AbstractMojoTestCase {
if (source.exists()) {
FileUtils.copyDirectoryStructure(source, new File(project.getBuild().getOutputDirectory()));
}
-
+
// load the Mojo
JCasGenMojo generate = (JCasGenMojo) this.lookupConfiguredMojo(project, "generate");
assertNotNull(generate);
@@ -105,7 +107,7 @@ public class JCasGenMojoTest extends AbstractMojoTestCase {
// check that the Java files have been generated
File jCasGenDirectory = new File(project.getBasedir(), "target/generated-sources/jcasgen");
-
+
// Record all the files that were generated
DirectoryScanner ds = new DirectoryScanner();
ds.setBasedir(jCasGenDirectory);
@@ -115,20 +117,20 @@ public class JCasGenMojoTest extends AbstractMojoTestCase {
for (String scannedFile : ds.getIncludedFiles()) {
files.add(new File(ds.getBasedir(), scannedFile));
}
-
+
for (String type : types) {
File wrapperFile = new File(jCasGenDirectory + "/" + type.replace('.', '/') + ".java");
// no _type files in v3
-// File typeFile = new File(jCasGenDirectory + "/" + type.replace('.', '/') + "_Type.java");
-
+ // File typeFile = new File(jCasGenDirectory + "/" + type.replace('.', '/') + "_Type.java");
+
Assert.assertTrue(files.contains(wrapperFile));
// no _type files in v3
-// Assert.assertTrue(files.contains(typeFile));
-
+ // Assert.assertTrue(files.contains(typeFile));
+
files.remove(wrapperFile);
-// files.remove(typeFile);
+ // files.remove(typeFile);
}
-
+
// check that no extra files were generated
Assert.assertTrue(files.isEmpty());
[uima-uimaj] 12/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit 87ac952e4789b5bca2b91478e2b9d767bb9608b5
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:18:53 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../apache/uima/jcas/tcas/DocumentAnnotation.java | 26 +-
.../java/org/apache/uima/jcas/tcas/DocMeta.java | 406 ++++++++++++---------
.../uima/jcas/tcas/DocumentAnnotationTest.java | 88 ++---
3 files changed, 300 insertions(+), 220 deletions(-)
diff --git a/uimaj-document-annotation/src/main/java/org/apache/uima/jcas/tcas/DocumentAnnotation.java b/uimaj-document-annotation/src/main/java/org/apache/uima/jcas/tcas/DocumentAnnotation.java
index b85f1f6..72c2874 100644
--- a/uimaj-document-annotation/src/main/java/org/apache/uima/jcas/tcas/DocumentAnnotation.java
+++ b/uimaj-document-annotation/src/main/java/org/apache/uima/jcas/tcas/DocumentAnnotation.java
@@ -41,7 +41,7 @@ public class DocumentAnnotation extends Annotation {
/* public static string for use where constants are needed, e.g. in some Java Annotations */
public final static String _TypeName = CAS.TYPE_NAME_DOCUMENT_ANNOTATION;
public final static String _FeatName_language = "language";
-
+
public final static int typeIndexID = JCasRegistry.register(DocumentAnnotation.class);
public final static int type = typeIndexID;
@@ -51,9 +51,10 @@ public class DocumentAnnotation extends Annotation {
return typeIndexID;
}
- private final static CallSite _FC_language = TypeSystemImpl.createCallSite(DocumentAnnotation.class, "language");
+ private final static CallSite _FC_language = TypeSystemImpl
+ .createCallSite(DocumentAnnotation.class, "language");
private final static MethodHandle _FH_language = _FC_language.dynamicInvoker();
-
+
// Never called. Disable default constructor
protected DocumentAnnotation() {
}
@@ -63,10 +64,12 @@ public class DocumentAnnotation extends Annotation {
}
/**
- * used by generator
- * Make a new AnnotationBase
- * @param c -
- * @param t -
+ * used by generator Make a new AnnotationBase
+ *
+ * @param c
+ * -
+ * @param t
+ * -
*/
public DocumentAnnotation(TypeImpl t, CASImpl c) {
@@ -77,13 +80,18 @@ public class DocumentAnnotation extends Annotation {
// * Feature: language
/**
* getter for language
+ *
* @return the language
*/
- public String getLanguage() { return _getStringValueNc(wrapGetIntCatchException(_FH_language)); }
+ public String getLanguage() {
+ return _getStringValueNc(wrapGetIntCatchException(_FH_language));
+ }
/**
* setter for language
- * @param v the language
+ *
+ * @param v
+ * the language
*/
public void setLanguage(String v) {
_setStringValueNfc(wrapGetIntCatchException(_FH_language), v);
diff --git a/uimaj-document-annotation/src/test/java/org/apache/uima/jcas/tcas/DocMeta.java b/uimaj-document-annotation/src/test/java/org/apache/uima/jcas/tcas/DocMeta.java
index b3699a6..56f1eca 100644
--- a/uimaj-document-annotation/src/test/java/org/apache/uima/jcas/tcas/DocMeta.java
+++ b/uimaj-document-annotation/src/test/java/org/apache/uima/jcas/tcas/DocMeta.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-
+
/* Apache UIMA v3 - First created by JCasGen Mon Oct 02 16:32:10 EDT 2017 */
package org.apache.uima.jcas.tcas;
@@ -33,40 +33,47 @@ import org.apache.uima.jcas.cas.FSArray;
import org.apache.uima.jcas.cas.IntegerArray;
import org.apache.uima.jcas.cas.StringArray;
-
-/**
- * Updated by JCasGen Mon Oct 02 16:32:10 EDT 2017
- * XML source: C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-document-annotation/src/test/resources/ExampleCas/testTypeSystem_docmetadata.xml
- * @generated */
+/**
+ * Updated by JCasGen Mon Oct 02 16:32:10 EDT 2017 XML source:
+ * C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-document-annotation/src/test/resources/ExampleCas/testTypeSystem_docmetadata.xml
+ *
+ * @generated
+ */
public class DocMeta extends DocumentAnnotation {
-
- /** @generated
- * @ordered
+
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.jcas.tcas.DocMeta";
-
- /** @generated
- * @ordered
+
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static int typeIndexID = JCasRegistry.register(DocMeta.class);
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static int type = typeIndexID;
- /** @generated
- * @return index of the type
+
+ /**
+ * @generated
+ * @return index of the type
*/
@Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /* *******************
- * Feature Offsets *
- * *******************/
-
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
+
+ /*
+ * ******************* Feature Offsets *
+ *******************/
+
public final static String _FeatName_feat = "feat";
public final static String _FeatName_feat2 = "feat2";
public final static String _FeatName_feat3 = "feat3";
@@ -74,7 +81,6 @@ public class DocMeta extends DocumentAnnotation {
public final static String _FeatName_arrayints = "arrayints";
public final static String _FeatName_arrayFs = "arrayFs";
-
/* Feature Adjusted Offsets */
private final static CallSite _FC_feat = TypeSystemImpl.createCallSite(DocMeta.class, "feat");
private final static MethodHandle _FH_feat = _FC_feat.dynamicInvoker();
@@ -82,223 +88,289 @@ public class DocMeta extends DocumentAnnotation {
private final static MethodHandle _FH_feat2 = _FC_feat2.dynamicInvoker();
private final static CallSite _FC_feat3 = TypeSystemImpl.createCallSite(DocMeta.class, "feat3");
private final static MethodHandle _FH_feat3 = _FC_feat3.dynamicInvoker();
- private final static CallSite _FC_arraystr = TypeSystemImpl.createCallSite(DocMeta.class, "arraystr");
+ private final static CallSite _FC_arraystr = TypeSystemImpl.createCallSite(DocMeta.class,
+ "arraystr");
private final static MethodHandle _FH_arraystr = _FC_arraystr.dynamicInvoker();
- private final static CallSite _FC_arrayints = TypeSystemImpl.createCallSite(DocMeta.class, "arrayints");
+ private final static CallSite _FC_arrayints = TypeSystemImpl.createCallSite(DocMeta.class,
+ "arrayints");
private final static MethodHandle _FH_arrayints = _FC_arrayints.dynamicInvoker();
- private final static CallSite _FC_arrayFs = TypeSystemImpl.createCallSite(DocMeta.class, "arrayFs");
+ private final static CallSite _FC_arrayFs = TypeSystemImpl.createCallSite(DocMeta.class,
+ "arrayFs");
private final static MethodHandle _FH_arrayFs = _FC_arrayFs.dynamicInvoker();
-
- /** Never called. Disable default constructor
- * @generated */
- protected DocMeta() {/* intentionally empty block */}
-
- /** Internal - constructor used by generator
+ /**
+ * Never called. Disable default constructor
+ *
* @generated
- * @param casImpl the CAS this Feature Structure belongs to
- * @param type the type of this Feature Structure
+ */
+ protected DocMeta() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator
+ *
+ * @generated
+ * @param casImpl
+ * the CAS this Feature Structure belongs to
+ * @param type
+ * the type of this Feature Structure
*/
public DocMeta(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /** @generated
- * @param jcas JCas to which this Feature Structure belongs
+
+ /**
+ * @generated
+ * @param jcas
+ * JCas to which this Feature Structure belongs
*/
public DocMeta(JCas jcas) {
super(jcas);
- readObject();
- }
-
+ readObject();
+ }
- /** @generated
- * @param jcas JCas to which this Feature Structure belongs
- * @param begin offset to the begin spot in the SofA
- * @param end offset to the end spot in the SofA
- */
+ /**
+ * @generated
+ * @param jcas
+ * JCas to which this Feature Structure belongs
+ * @param begin
+ * offset to the begin spot in the SofA
+ * @param end
+ * offset to the end spot in the SofA
+ */
public DocMeta(JCas jcas, int begin, int end) {
super(jcas);
setBegin(begin);
setEnd(end);
readObject();
- }
+ }
- /**
- * <!-- begin-user-doc -->
- * Write your own initialization here
- * <!-- end-user-doc -->
+ /**
+ * <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->
*
- * @generated modifiable
+ * @generated modifiable
*/
- private void readObject() {/*default - does nothing empty block */}
-
-
-
- //*--------------*
- //* Feature: feat
-
- /** getter for feat - gets
+ private void readObject() {
+ /* default - does nothing empty block */}
+
+ // *--------------*
+ // * Feature: feat
+
+ /**
+ * getter for feat - gets
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public String getFeat() { return _getStringValueNc(wrapGetIntCatchException(_FH_feat));}
-
- /** setter for feat - sets
+ public String getFeat() {
+ return _getStringValueNc(wrapGetIntCatchException(_FH_feat));
+ }
+
+ /**
+ * setter for feat - sets
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setFeat(String v) {
_setStringValueNfc(wrapGetIntCatchException(_FH_feat), v);
- }
-
-
-
- //*--------------*
- //* Feature: feat2
-
- /** getter for feat2 - gets
+ }
+
+ // *--------------*
+ // * Feature: feat2
+
+ /**
+ * getter for feat2 - gets
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public String getFeat2() { return _getStringValueNc(wrapGetIntCatchException(_FH_feat2));}
-
- /** setter for feat2 - sets
+ public String getFeat2() {
+ return _getStringValueNc(wrapGetIntCatchException(_FH_feat2));
+ }
+
+ /**
+ * setter for feat2 - sets
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setFeat2(String v) {
_setStringValueNfc(wrapGetIntCatchException(_FH_feat2), v);
- }
-
-
-
- //*--------------*
- //* Feature: feat3
-
- /** getter for feat3 - gets
+ }
+
+ // *--------------*
+ // * Feature: feat3
+
+ /**
+ * getter for feat3 - gets
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public String getFeat3() { return _getStringValueNc(wrapGetIntCatchException(_FH_feat3));}
-
- /** setter for feat3 - sets
+ public String getFeat3() {
+ return _getStringValueNc(wrapGetIntCatchException(_FH_feat3));
+ }
+
+ /**
+ * setter for feat3 - sets
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setFeat3(String v) {
_setStringValueNfc(wrapGetIntCatchException(_FH_feat3), v);
- }
-
-
-
- //*--------------*
- //* Feature: arraystr
-
- /** getter for arraystr - gets
+ }
+
+ // *--------------*
+ // * Feature: arraystr
+
+ /**
+ * getter for arraystr - gets
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public StringArray getArraystr() { return (StringArray)(_getFeatureValueNc(wrapGetIntCatchException(_FH_arraystr)));}
-
- /** setter for arraystr - sets
+ public StringArray getArraystr() {
+ return (StringArray) (_getFeatureValueNc(wrapGetIntCatchException(_FH_arraystr)));
+ }
+
+ /**
+ * setter for arraystr - sets
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setArraystr(StringArray v) {
_setFeatureValueNcWj(wrapGetIntCatchException(_FH_arraystr), v);
- }
-
-
- /** indexed getter for arraystr - gets an indexed value -
+ }
+
+ /**
+ * indexed getter for arraystr - gets an indexed value -
+ *
* @generated
- * @param i index in the array to get
- * @return value of the element at index i
+ * @param i
+ * index in the array to get
+ * @return value of the element at index i
*/
public String getArraystr(int i) {
- return ((StringArray)(_getFeatureValueNc(wrapGetIntCatchException(_FH_arraystr)))).get(i);}
+ return ((StringArray) (_getFeatureValueNc(wrapGetIntCatchException(_FH_arraystr)))).get(i);
+ }
- /** indexed setter for arraystr - sets an indexed value -
+ /**
+ * indexed setter for arraystr - sets an indexed value -
+ *
* @generated
- * @param i index in the array to set
- * @param v value to set into the array
+ * @param i
+ * index in the array to set
+ * @param v
+ * value to set into the array
*/
public void setArraystr(int i, String v) {
- ((StringArray)(_getFeatureValueNc(wrapGetIntCatchException(_FH_arraystr)))).set(i, v);
- }
-
-
- //*--------------*
- //* Feature: arrayints
-
- /** getter for arrayints - gets
+ ((StringArray) (_getFeatureValueNc(wrapGetIntCatchException(_FH_arraystr)))).set(i, v);
+ }
+
+ // *--------------*
+ // * Feature: arrayints
+
+ /**
+ * getter for arrayints - gets
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public IntegerArray getArrayints() { return (IntegerArray)(_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayints)));}
-
- /** setter for arrayints - sets
+ public IntegerArray getArrayints() {
+ return (IntegerArray) (_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayints)));
+ }
+
+ /**
+ * setter for arrayints - sets
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setArrayints(IntegerArray v) {
_setFeatureValueNcWj(wrapGetIntCatchException(_FH_arrayints), v);
- }
-
-
- /** indexed getter for arrayints - gets an indexed value -
+ }
+
+ /**
+ * indexed getter for arrayints - gets an indexed value -
+ *
* @generated
- * @param i index in the array to get
- * @return value of the element at index i
+ * @param i
+ * index in the array to get
+ * @return value of the element at index i
*/
public int getArrayints(int i) {
- return ((IntegerArray)(_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayints)))).get(i);}
+ return ((IntegerArray) (_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayints)))).get(i);
+ }
- /** indexed setter for arrayints - sets an indexed value -
+ /**
+ * indexed setter for arrayints - sets an indexed value -
+ *
* @generated
- * @param i index in the array to set
- * @param v value to set into the array
+ * @param i
+ * index in the array to set
+ * @param v
+ * value to set into the array
*/
public void setArrayints(int i, int v) {
- ((IntegerArray)(_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayints)))).set(i, v);
- }
-
-
- //*--------------*
- //* Feature: arrayFs
-
- /** getter for arrayFs - gets
+ ((IntegerArray) (_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayints)))).set(i, v);
+ }
+
+ // *--------------*
+ // * Feature: arrayFs
+
+ /**
+ * getter for arrayFs - gets
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public FSArray getArrayFs() { return (FSArray)(_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayFs)));}
-
- /** setter for arrayFs - sets
+ public FSArray getArrayFs() {
+ return (FSArray) (_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayFs)));
+ }
+
+ /**
+ * setter for arrayFs - sets
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setArrayFs(FSArray v) {
_setFeatureValueNcWj(wrapGetIntCatchException(_FH_arrayFs), v);
- }
-
-
- /** indexed getter for arrayFs - gets an indexed value -
+ }
+
+ /**
+ * indexed getter for arrayFs - gets an indexed value -
+ *
* @generated
- * @param i index in the array to get
- * @return value of the element at index i
+ * @param i
+ * index in the array to get
+ * @return value of the element at index i
*/
public Annotation getArrayFs(int i) {
- return (Annotation)(((FSArray)(_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayFs)))).get(i));}
+ return (Annotation) (((FSArray) (_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayFs))))
+ .get(i));
+ }
- /** indexed setter for arrayFs - sets an indexed value -
+ /**
+ * indexed setter for arrayFs - sets an indexed value -
+ *
* @generated
- * @param i index in the array to set
- * @param v value to set into the array
+ * @param i
+ * index in the array to set
+ * @param v
+ * value to set into the array
*/
public void setArrayFs(int i, Annotation v) {
- ((FSArray)(_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayFs)))).set(i, v);
- }
+ ((FSArray) (_getFeatureValueNc(wrapGetIntCatchException(_FH_arrayFs)))).set(i, v);
}
-
-
\ No newline at end of file
+}
diff --git a/uimaj-document-annotation/src/test/java/org/apache/uima/jcas/tcas/DocumentAnnotationTest.java b/uimaj-document-annotation/src/test/java/org/apache/uima/jcas/tcas/DocumentAnnotationTest.java
index 3d43b73..3f7e30b 100644
--- a/uimaj-document-annotation/src/test/java/org/apache/uima/jcas/tcas/DocumentAnnotationTest.java
+++ b/uimaj-document-annotation/src/test/java/org/apache/uima/jcas/tcas/DocumentAnnotationTest.java
@@ -48,14 +48,13 @@ import org.apache.uima.util.XMLInputSource;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
-
public class DocumentAnnotationTest {
JCas jcas;
private CAS source;
private CAS target;
-
- @BeforeEach
- public void setUp() throws Exception {
+
+ @BeforeEach
+ public void setUp() throws Exception {
try {
CAS cas = CasCreationUtils.createCas(new TypeSystemDescription_impl(), null, null);
this.jcas = cas.getJCas();
@@ -63,18 +62,18 @@ public class DocumentAnnotationTest {
JUnitExtension.handleException(e);
}
}
-
- @Test
- public void testGetDocumentAnnotation() throws Exception {
+
+ @Test
+ public void testGetDocumentAnnotation() throws Exception {
try {
assertTrue(jcas.getDocumentAnnotationFs() instanceof DocumentAnnotation);
} catch (Exception e) {
JUnitExtension.handleException(e);
}
}
-
- @Test
- public void testCreateDocumentAnnot() throws Exception {
+
+ @Test
+ public void testCreateDocumentAnnot() throws Exception {
try {
DocumentAnnotation b = (DocumentAnnotation) jcas.getDocumentAnnotationFs();
jcas.reset();
@@ -83,75 +82,76 @@ public class DocumentAnnotationTest {
JUnitExtension.handleException(e);
}
}
-
- @Test
- public void testDocMeta() throws Exception {
+
+ @Test
+ public void testDocMeta() throws Exception {
File typeSystemFile = JUnitExtension.getFile("ExampleCas/testTypeSystem_docmetadata.xml");
- TypeSystemDescription typeSystem = UIMAFramework.getXMLParser().parseTypeSystemDescription(
- new XMLInputSource(typeSystemFile));
-
+ TypeSystemDescription typeSystem = UIMAFramework.getXMLParser()
+ .parseTypeSystemDescription(new XMLInputSource(typeSystemFile));
+
source = CasCreationUtils.createCas(typeSystem, new TypePriorities_impl(), null);
target = CasCreationUtils.createCas(typeSystem, new TypePriorities_impl(), null);
-
+
jcas = source.getJCas();
-
+
tstSerdesB4Sofa(SerialFormat.XMI);
tstSerdesB4Sofa(SerialFormat.XCAS);
tstSerdesB4Sofa(SerialFormat.BINARY);
tstSerdesB4Sofa(SerialFormat.COMPRESSED);
- tstSerdesB4Sofa(SerialFormat.COMPRESSED_FILTERED);
+ tstSerdesB4Sofa(SerialFormat.COMPRESSED_FILTERED);
}
-
+
private void tstSerdesB4Sofa(SerialFormat format) throws IOException {
source.reset();
target.reset();
-
+
new DocMeta(jcas).addToIndexes();
-
+
jcas.setDocumentText("something");
-
+
new Annotation(jcas);
-
+
ByteArrayOutputStream bos = new ByteArrayOutputStream();
CasIOUtils.save(source, bos, format);
bos.close();
-
+
CasIOUtils.load(new ByteArrayInputStream(bos.toByteArray()), target);
AnnotationFS c = target.getDocumentAnnotation();
System.out.println(c);
- System.out.println(target.<DocMeta>getDocumentAnnotation());
- assertTrue(CasCompare.compareCASes((CASImpl)source, (CASImpl)target));
+ System.out.println(target.<DocMeta> getDocumentAnnotation());
+ assertTrue(CasCompare.compareCASes((CASImpl) source, (CASImpl) target));
}
-
- @Test
- public void testToString() throws InvalidXMLException, IOException, ResourceInitializationException, CASException {
+
+ @Test
+ public void testToString()
+ throws InvalidXMLException, IOException, ResourceInitializationException, CASException {
File typeSystemFile = JUnitExtension.getFile("ExampleCas/testTypeSystem_docmetadata.xml");
- TypeSystemDescription typeSystem = UIMAFramework.getXMLParser().parseTypeSystemDescription(
- new XMLInputSource(typeSystemFile));
-
+ TypeSystemDescription typeSystem = UIMAFramework.getXMLParser()
+ .parseTypeSystemDescription(new XMLInputSource(typeSystemFile));
+
source = CasCreationUtils.createCas(typeSystem, new TypePriorities_impl(), null);
jcas = source.getJCas();
-
+
DocMeta d = new DocMeta(jcas);
d.setFeat("a string");
d.setFeat2("b string");
d.setFeat3("c string");
-
+
FSArray fsa = new FSArray(jcas, 2);
- fsa.set(0, new Annotation(jcas, 1,2));
- fsa.set(1, new Annotation(jcas, 3,4));
+ fsa.set(0, new Annotation(jcas, 1, 2));
+ fsa.set(1, new Annotation(jcas, 3, 4));
d.setArrayFs(fsa);
-
+
IntegerArray intarr = new IntegerArray(jcas, 2);
- intarr.set(0, 10);
- intarr.set(1, -10);
+ intarr.set(0, 10);
+ intarr.set(1, -10);
d.setArrayints(intarr);
-
+
StringArray strarr = new StringArray(jcas, 2);
- strarr.set(0, "first");
- strarr.set(1, "second");
+ strarr.set(0, "first");
+ strarr.set(1, "second");
d.setArraystr(strarr);
-
+
System.out.println(d.toString());
}
[uima-uimaj] 08/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit fe58341000fc02b90de3782c17a63e25b6ac3006
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:13:46 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../src/main/java/example/PersonTitle.java | 202 ++++++-----
.../apache/uima/examples/ExampleApplication.java | 4 +-
.../org/apache/uima/examples/PrintAnnotations.java | 37 +-
.../main/java/org/apache/uima/examples/RunAE.java | 64 ++--
.../uima/examples/SofaExampleApplication.java | 81 +++--
.../uima/examples/SourceDocumentInformation.java | 270 ++++++++------
.../java/org/apache/uima/examples/XmlDetagger.java | 28 +-
.../uima/examples/cas/PersonTitleAnnotator.java | 68 ++--
.../apache/uima/examples/cas/RegExAnnotator.java | 51 +--
.../CasMultiplierExampleApplication.java | 2 +-
.../examples/casMultiplier/SimpleTextMerger.java | 11 +-
.../casMultiplier/SimpleTextSegmenter.java | 3 +-
.../uima/examples/cpe/AnnotationPrinter.java | 21 +-
.../examples/cpe/FileSystemCollectionReader.java | 40 +-
.../uima/examples/cpe/InlineXmlCasConsumer.java | 5 +-
.../cpe/PersonTitleDBWriterCasConsumer.java | 52 +--
.../org/apache/uima/examples/cpe/SimpleRunCPE.java | 28 +-
.../org/apache/uima/examples/cpe/SimpleRunCPM.java | 42 ++-
.../uima/examples/cpe/XCasWriterCasConsumer.java | 17 +-
.../examples/flow/AdvancedFixedFlowController.java | 100 ++---
.../examples/flow/WhiteboardFlowController.java | 15 +-
.../examples/flow/WhiteboardFlowController2.java | 18 +-
.../apache/uima/examples/tokenizer/Sentence.java | 120 +++---
.../tokenizer/SimpleTokenAndSentenceAnnotator.java | 29 +-
.../org/apache/uima/examples/tokenizer/Token.java | 120 +++---
.../uima/examples/xmi/Ecore2UimaTypeSystem.java | 113 +++---
.../uima/examples/xmi/UimaTypeSystem2Ecore.java | 93 +++--
.../uima/examples/xmi/XmiCollectionReader.java | 16 +-
.../uima/examples/xmi/XmiEcoreCasConsumer.java | 28 +-
.../uima/examples/xmi/XmiWriterCasConsumer.java | 14 +-
.../java/org/apache/uima/tutorial/DateAnnot.java | 154 ++++----
.../org/apache/uima/tutorial/DateTimeAnnot.java | 216 +++++------
.../java/org/apache/uima/tutorial/Meeting.java | 402 +++++++++++----------
.../java/org/apache/uima/tutorial/RoomNumber.java | 217 +++++------
.../org/apache/uima/tutorial/SentenceAnnot.java | 143 ++++----
.../java/org/apache/uima/tutorial/TimeAnnot.java | 154 ++++----
.../java/org/apache/uima/tutorial/UimaAcronym.java | 244 +++++++------
.../java/org/apache/uima/tutorial/UimaMeeting.java | 190 +++++-----
.../java/org/apache/uima/tutorial/WordAnnot.java | 143 ++++----
.../uima/tutorial/ex2/RoomNumberAnnotator.java | 2 +-
.../apache/uima/tutorial/ex3/TutorialDateTime.java | 30 +-
.../apache/uima/tutorial/ex4/MeetingAnnotator.java | 18 +-
.../uima/tutorial/ex6/UimaMeetingAnnotator.java | 5 +-
43 files changed, 1955 insertions(+), 1655 deletions(-)
diff --git a/uimaj-examples/src/main/java/example/PersonTitle.java b/uimaj-examples/src/main/java/example/PersonTitle.java
index 881cc38..e99aa15 100644
--- a/uimaj-examples/src/main/java/example/PersonTitle.java
+++ b/uimaj-examples/src/main/java/example/PersonTitle.java
@@ -28,7 +28,6 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
/**
* A Personal Title. Updated by JCasGen Mon May 23 17:48:43 EDT 2005 XML source:
* c:\a\eclipse\301jxe\jedii_examples\descriptors\analysis_engine\NamesAndPersonTitles_TAE.xml
@@ -37,44 +36,45 @@ import org.apache.uima.jcas.tcas.Annotation;
*/
public class PersonTitle extends Annotation {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "example.PersonTitle";
-
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(PersonTitle.class);
-
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
-
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /* *******************
- * Feature Offsets *
- * *******************/
-
- public final static String _FeatName_Kind = "Kind";
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(PersonTitle.class);
+
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
+
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
+
+ /*
+ * ******************* Feature Offsets *
+ *******************/
+
+ public final static String _FeatName_Kind = "Kind";
/* Feature Adjusted Offsets */
private final static CallSite _FC_Kind = TypeSystemImpl.createCallSite(PersonTitle.class, "Kind");
@@ -85,71 +85,81 @@ public class PersonTitle extends Annotation {
*
* @generated
*/
- protected PersonTitle() {/* intentionally empty block */}
-
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public PersonTitle(TypeImpl type, CASImpl casImpl) {
+ protected PersonTitle() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public PersonTitle(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /**
- * Instantiates a new person title.
- *
- * @param jcas the jcas
- * @generated
- */
- public PersonTitle(JCas jcas) {
+
+ /**
+ * Instantiates a new person title.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public PersonTitle(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
+
+ /**
+ * Instantiates a new person title.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public PersonTitle(JCas jcas, int begin, int end) {
super(jcas);
- readObject();
- }
-
-
- /**
- * Instantiates a new person title.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public PersonTitle(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
-
- /**
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
+
+ /**
* <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->*
- * @generated modifiable
+ *
+ * @generated modifiable
+ */
+ private void readObject() {
+ }
+
+ // *--------------*
+ // * Feature: Kind
+ /**
+ * getter for Kind - gets The kind of title - Civilian, Military, or Government.
+ *
+ * @return the kind
+ * @generated
*/
- private void readObject() {
- }
-
- // *--------------*
- // * Feature: Kind
- /**
- * getter for Kind - gets The kind of title - Civilian, Military, or Government.
- *
- * @return the kind
- * @generated
- */
- public String getKind() { return _getStringValueNc(wrapGetIntCatchException(_FH_Kind));}
-
- /**
- * setter for Kind - sets The kind of title - Civilian, Military, or Government.
- *
- * @param v the new kind
- * @generated
- */
- public void setKind(String v) {
+ public String getKind() {
+ return _getStringValueNc(wrapGetIntCatchException(_FH_Kind));
+ }
+
+ /**
+ * setter for Kind - sets The kind of title - Civilian, Military, or Government.
+ *
+ * @param v
+ * the new kind
+ * @generated
+ */
+ public void setKind(String v) {
_setStringValueNfc(wrapGetIntCatchException(_FH_Kind), v);
- }
-
}
+
+}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/ExampleApplication.java b/uimaj-examples/src/main/java/org/apache/uima/examples/ExampleApplication.java
index f003a7d..64b4806 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/ExampleApplication.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/ExampleApplication.java
@@ -113,8 +113,8 @@ public class ExampleApplication {
* @param aCAS
* CAS that will be used to hold analysis results
*/
- private static void processFile(File aFile, AnalysisEngine aAE, CAS aCAS) throws IOException,
- AnalysisEngineProcessException {
+ private static void processFile(File aFile, AnalysisEngine aAE, CAS aCAS)
+ throws IOException, AnalysisEngineProcessException {
System.out.println("Processing file " + aFile.getName());
String document = FileUtils.file2String(aFile);
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/PrintAnnotations.java b/uimaj-examples/src/main/java/org/apache/uima/examples/PrintAnnotations.java
index 48e3f54..5aae277 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/PrintAnnotations.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/PrintAnnotations.java
@@ -41,7 +41,6 @@ import org.apache.uima.resource.ResourceSpecifier;
import org.apache.uima.util.FileUtils;
import org.apache.uima.util.XMLInputSource;
-
/**
* A simple example of how to extract information from the CAS. This example retrieves all
* annotations of a specified type from a CAS and prints them (along with all of their features) to
@@ -60,26 +59,25 @@ public class PrintAnnotations {
* the PrintStream to which output will be written
*/
public static void printAnnotations(CAS aCAS, PrintStream aOut) {
-
+
// Version 3 using select with Stream support
aCAS.select(Annotation.class).forEach(fs -> printFS(fs, aCAS, 0, aOut));
-// // Version 3 using select with extended for
-// for (Annotation fs : aCAS.getAnnotationIndex().select(Annotation.class)) {
-// printFS(fs, aCAS, 0, aOut);
-// }
-//
-// // version 2 style using iterators
-// FSIterator<AnnotationFS> iter = aCAS.getAnnotationIndex().iterator();
-//
-// // iterate
-// while (iter.isValid()) {
-// FeatureStructure fs = iter.get();
-// printFS(fs, aCAS, 0, aOut);
-// iter.moveToNext();
-// }
-
-
+ // // Version 3 using select with extended for
+ // for (Annotation fs : aCAS.getAnnotationIndex().select(Annotation.class)) {
+ // printFS(fs, aCAS, 0, aOut);
+ // }
+ //
+ // // version 2 style using iterators
+ // FSIterator<AnnotationFS> iter = aCAS.getAnnotationIndex().iterator();
+ //
+ // // iterate
+ // while (iter.isValid()) {
+ // FeatureStructure fs = iter.get();
+ // printFS(fs, aCAS, 0, aOut);
+ // iter.moveToNext();
+ // }
+
}
/**
@@ -244,7 +242,8 @@ public class PrintAnnotations {
* descriptor for the TAE to run and an input file. Additional arguments are Type or Feature names
* to be included in the ResultSpecification passed to the TAE.
*
- * @param args - see above
+ * @param args
+ * - see above
*/
public static void main(String[] args) {
try {
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/RunAE.java b/uimaj-examples/src/main/java/org/apache/uima/examples/RunAE.java
index ed31b44..a592c48 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/RunAE.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/RunAE.java
@@ -46,7 +46,6 @@ import org.apache.uima.tools.components.InlineXmlCasConsumer;
import org.apache.uima.tools.components.XmlDetagger;
import org.apache.uima.util.AnalysisEnginePerformanceReports;
-
/**
* An example application that reads documents from the file system, sends them though an Analysis
* Engine(AE), and produces XML files with inline annotations. This application uses a
@@ -57,8 +56,8 @@ import org.apache.uima.util.AnalysisEnginePerformanceReports;
* <AE descriptor or JAR file name> <input dir>
* [<output dir>]</code>
* <p>
- * If <code>output dir</code> is not specified, the analysis results will not be output. This can
- * be useful when only interested in performance statistics.
+ * If <code>output dir</code> is not specified, the analysis results will not be output. This can be
+ * useful when only interested in performance statistics.
* <p>
* <u>OPTIONS</u>
* <p>
@@ -107,7 +106,7 @@ public class RunAE implements StatusCallbackListener {
/** The xmi input. */
private boolean xmiInput = false;
-
+
/** The x lenient. */
private boolean xLenient = false;
@@ -120,7 +119,8 @@ public class RunAE implements StatusCallbackListener {
/**
* Constructor. Sets up and runs an Analysis Engine.
*
- * @param args the args
+ * @param args
+ * the args
*/
public RunAE(String[] args) {
try {
@@ -143,8 +143,8 @@ public class RunAE implements StatusCallbackListener {
.produceCasProcessorConfigurationParameterSettings();
CpeCollectionReader cpeCollRdr = cpeDesc.getAllCollectionCollectionReaders()[0];
cpeCollRdr.setConfigurationParameterSettings(crSettings);
- crSettings.setParameterValue(FileSystemCollectionReader.PARAM_INPUTDIR, inputDir
- .getAbsolutePath());
+ crSettings.setParameterValue(FileSystemCollectionReader.PARAM_INPUTDIR,
+ inputDir.getAbsolutePath());
crSettings.setParameterValue(FileSystemCollectionReader.PARAM_ENCODING, encoding);
crSettings.setParameterValue(FileSystemCollectionReader.PARAM_LANGUAGE, language);
if (xcasInput) {
@@ -160,8 +160,8 @@ public class RunAE implements StatusCallbackListener {
CpeCasProcessor xmlDetaggerCasProc = null;
if (xmlTagName != null && xmlTagName.length() > 0) {
xmlDetaggerCasProc = CpeDescriptorFactory.produceCasProcessor("XmlDetagger");
- CpeComponentDescriptor cpeComponentDescriptor =
- CpeDescriptorFactory.produceComponentDescriptor(XmlDetagger.getDescriptorURL().toString());
+ CpeComponentDescriptor cpeComponentDescriptor = CpeDescriptorFactory
+ .produceComponentDescriptor(XmlDetagger.getDescriptorURL().toString());
xmlDetaggerCasProc.setCpeComponentDescriptor(cpeComponentDescriptor);
CasProcessorConfigurationParameterSettings detaggerSettings = CpeDescriptorFactory
.produceCasProcessorConfigurationParameterSettings();
@@ -173,8 +173,8 @@ public class RunAE implements StatusCallbackListener {
// add user's AE to CPE
CpeCasProcessor casProc = CpeDescriptorFactory.produceCasProcessor("UserAE");
- CpeComponentDescriptor cpeComponentDescriptor =
- CpeDescriptorFactory.produceComponentDescriptor(aeSpecifierFile.getAbsolutePath());
+ CpeComponentDescriptor cpeComponentDescriptor = CpeDescriptorFactory
+ .produceComponentDescriptor(aeSpecifierFile.getAbsolutePath());
casProc.setCpeComponentDescriptor(cpeComponentDescriptor);
casProc.setMaxErrorCount(0);
cpeDesc.addCasProcessor(casProc);
@@ -184,14 +184,14 @@ public class RunAE implements StatusCallbackListener {
CpeCasProcessor casCon = null;
if (outputDir != null) {
casCon = CpeDescriptorFactory.produceCasProcessor("CasConsumer");
- cpeComponentDescriptor =
- CpeDescriptorFactory.produceComponentDescriptor(InlineXmlCasConsumer.getDescriptorURL().toString());
- casCon.setCpeComponentDescriptor(cpeComponentDescriptor);
+ cpeComponentDescriptor = CpeDescriptorFactory
+ .produceComponentDescriptor(InlineXmlCasConsumer.getDescriptorURL().toString());
+ casCon.setCpeComponentDescriptor(cpeComponentDescriptor);
CasProcessorConfigurationParameterSettings consumerSettings = CpeDescriptorFactory
.produceCasProcessorConfigurationParameterSettings();
casCon.setConfigurationParameterSettings(consumerSettings);
- consumerSettings.setParameterValue(InlineXmlCasConsumer.PARAM_OUTPUTDIR, outputDir
- .getAbsolutePath());
+ consumerSettings.setParameterValue(InlineXmlCasConsumer.PARAM_OUTPUTDIR,
+ outputDir.getAbsolutePath());
if (xcasInput) {
consumerSettings.setParameterValue(InlineXmlCasConsumer.PARAM_XCAS, "XCAS");
} else if (xmiInput) {
@@ -237,18 +237,18 @@ public class RunAE implements StatusCallbackListener {
docsProcessed = 0;
mCPE.process();
} catch (Exception e) {
- //special check for using XML detagger with remotes, which will generate an error
- //since sofa mappings aren't supported for remotes
- if (xmlTagName != null && xmlTagName.length() > 0 && e instanceof UIMAException &&
- ((UIMAException)e).hasMessageKey(ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE)) {
- System.err.println("The XML detagging feature (-t) is not supported for remote Analysis Engines or for Aggregates containing remotes.");
- }
- else {
+ // special check for using XML detagger with remotes, which will generate an error
+ // since sofa mappings aren't supported for remotes
+ if (xmlTagName != null && xmlTagName.length() > 0 && e instanceof UIMAException
+ && ((UIMAException) e).hasMessageKey(
+ ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE)) {
+ System.err.println(
+ "The XML detagging feature (-t) is not supported for remote Analysis Engines or for Aggregates containing remotes.");
+ } else {
e.printStackTrace();
}
}
}
-
/**
* Initialization complete.
@@ -262,8 +262,10 @@ public class RunAE implements StatusCallbackListener {
/**
* Entity process complete.
*
- * @param aCas the a cas
- * @param aStatus the a status
+ * @param aCas
+ * the a cas
+ * @param aStatus
+ * the a status
* @see org.apache.uima.collection.StatusCallbackListener#entityProcessComplete(org.apache.uima.cas.CAS,
* org.apache.uima.collection.EntityProcessStatus)
*/
@@ -278,8 +280,8 @@ public class RunAE implements StatusCallbackListener {
// retrieve the filename of the input file from the CAS
// (it was put there by the FileSystemCollectionReader)
if (!(xcasInput || xmiInput)) {
- Type fileLocType = aCas.getTypeSystem().getType(
- "org.apache.uima.examples.SourceDocumentInformation");
+ Type fileLocType = aCas.getTypeSystem()
+ .getType("org.apache.uima.examples.SourceDocumentInformation");
Feature fileNameFeat = fileLocType.getFeatureByBaseName("uri");
FSIterator it = aCas.getAnnotationIndex(fileLocType).iterator();
FeatureStructure fileLoc = it.get();
@@ -378,7 +380,8 @@ public class RunAE implements StatusCallbackListener {
/**
* Reads command line arguments and sets static class variables appropriately.
*
- * @param args the args
+ * @param args
+ * the args
* @return true if command line args were valid, false if not
*/
private boolean processCmdLineArgs(String[] args) {
@@ -459,7 +462,8 @@ public class RunAE implements StatusCallbackListener {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
new RunAE(args);
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/SofaExampleApplication.java b/uimaj-examples/src/main/java/org/apache/uima/examples/SofaExampleApplication.java
index 0a57c4f..49ebc7a 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/SofaExampleApplication.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/SofaExampleApplication.java
@@ -31,7 +31,6 @@ import org.apache.uima.cas.Type;
import org.apache.uima.jcas.tcas.Annotation;
import org.apache.uima.util.XMLInputSource;
-
/**
* A simple Multiple Subject of Analysis (multi-Sofa) test application. Creates a text Sofa with
* English text, calls an annotator that creates a text Sofa with German text, then dumps all
@@ -40,20 +39,23 @@ import org.apache.uima.util.XMLInputSource;
* The application takes no arguments.
*/
public class SofaExampleApplication {
-
+
/**
* Main program.
*
- * @param args the arguments
- * @throws UIMAException the UIMA exception
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param args
+ * the arguments
+ * @throws UIMAException
+ * the UIMA exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
public static void main(String[] args) throws UIMAException, IOException {
// parse AnalysisEngine descriptor
XMLInputSource input = new XMLInputSource(
"descriptors/analysis_engine/SofaExampleAnnotator.xml");
- AnalysisEngineDescription desc = UIMAFramework.getXMLParser().parseAnalysisEngineDescription(
- input);
+ AnalysisEngineDescription desc = UIMAFramework.getXMLParser()
+ .parseAnalysisEngineDescription(input);
// create AnalysisEngine
AnalysisEngine seAnnotator = UIMAFramework.produceAnalysisEngine(desc);
@@ -70,19 +72,19 @@ public class SofaExampleApplication {
seAnnotator.process(cas);
System.out.println("---Printing all annotations for English Sofa---");
- englishView.select(Annotation.class).forEach(annot ->
- System.out.println(" " + annot.getType().getName() + ": " + annot.getCoveredText()));
-
-// // get annotation iterator for the English CAS view
-// FSIndex anIndex = englishView.getAnnotationIndex();
-// FSIterator anIter = anIndex.iterator();
-//
-// // and print out all annotations found
-// while (anIter.isValid()) {
-// AnnotationFS annot = (AnnotationFS) anIter.get();
-// System.out.println(" " + annot.getType().getName() + ": " + annot.getCoveredText());
-// anIter.moveToNext();
-// }
+ englishView.select(Annotation.class).forEach(annot -> System.out
+ .println(" " + annot.getType().getName() + ": " + annot.getCoveredText()));
+
+ // // get annotation iterator for the English CAS view
+ // FSIndex anIndex = englishView.getAnnotationIndex();
+ // FSIterator anIter = anIndex.iterator();
+ //
+ // // and print out all annotations found
+ // while (anIter.isValid()) {
+ // AnnotationFS annot = (AnnotationFS) anIter.get();
+ // System.out.println(" " + annot.getType().getName() + ": " + annot.getCoveredText());
+ // anIter.moveToNext();
+ // }
// now try to get the CAS view for the German Sofa
System.out.println();
@@ -91,7 +93,7 @@ public class SofaExampleApplication {
Feature other = cross.getFeatureByBaseName("otherAnnotation");
System.out.println("---Printing all annotations for German Sofa---");
-
+
for (Annotation annot : germanView.select(Annotation.class)) {
System.out.println(" " + annot.getType().getName() + ": " + annot.getCoveredText());
if (annot.getType() == cross) {
@@ -99,25 +101,24 @@ public class SofaExampleApplication {
System.out.println(" other annotation feature: " + crossAnnot.getCoveredText());
}
}
-
-
-// // and annotator iterator for the German CAS View
-// anIndex = germanView.getAnnotationIndex();
-// anIter = anIndex.iterator();
-// Type cross = germanView.getTypeSystem().getType("sofa.test.CrossAnnotation");
-// Feature other = cross.getFeatureByBaseName("otherAnnotation");
-//
-// // print out all annotations for the German Sofa
-// System.out.println("---Printing all annotations for German Sofa---");
-// while (anIter.isValid()) {
-// AnnotationFS annot = (AnnotationFS) anIter.get();
-// System.out.println(" " + annot.getType().getName() + ": " + annot.getCoveredText());
-// if (annot.getType() == cross) {
-// AnnotationFS crossAnnot = (AnnotationFS) annot.getFeatureValue(other);
-// System.out.println(" other annotation feature: " + crossAnnot.getCoveredText());
-// }
-// anIter.moveToNext();
-// }
+
+ // // and annotator iterator for the German CAS View
+ // anIndex = germanView.getAnnotationIndex();
+ // anIter = anIndex.iterator();
+ // Type cross = germanView.getTypeSystem().getType("sofa.test.CrossAnnotation");
+ // Feature other = cross.getFeatureByBaseName("otherAnnotation");
+ //
+ // // print out all annotations for the German Sofa
+ // System.out.println("---Printing all annotations for German Sofa---");
+ // while (anIter.isValid()) {
+ // AnnotationFS annot = (AnnotationFS) anIter.get();
+ // System.out.println(" " + annot.getType().getName() + ": " + annot.getCoveredText());
+ // if (annot.getType() == cross) {
+ // AnnotationFS crossAnnot = (AnnotationFS) annot.getFeatureValue(other);
+ // System.out.println(" other annotation feature: " + crossAnnot.getCoveredText());
+ // }
+ // anIter.moveToNext();
+ // }
// Clean up
seAnnotator.destroy();
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java b/uimaj-examples/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java
index b928816..d2d3662 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-
+
/* Apache UIMA v3 - First created by JCasGen Wed Mar 02 13:42:57 EST 2016 */
package org.apache.uima.examples;
@@ -31,175 +31,233 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
-/** Stores detailed information about the original source document from which the current CAS was initialized. All information (like size) refers to the source document and not to the document in the CAS which may be converted and filtered by a CAS Initializer. For example this information will be written to the Semantic Search index so that the original document contents can be retrieved by queries.
- * Updated by JCasGen Sun Oct 08 19:24:05 EDT 2017
- * XML source: C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/resources/org/apache/uima/examples/SourceDocumentInformation.xml
- * @generated */
+/**
+ * Stores detailed information about the original source document from which the current CAS was
+ * initialized. All information (like size) refers to the source document and not to the document in
+ * the CAS which may be converted and filtered by a CAS Initializer. For example this information
+ * will be written to the Semantic Search index so that the original document contents can be
+ * retrieved by queries. Updated by JCasGen Sun Oct 08 19:24:05 EDT 2017 XML source:
+ * C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/resources/org/apache/uima/examples/SourceDocumentInformation.xml
+ *
+ * @generated
+ */
public class SourceDocumentInformation extends Annotation {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.examples.SourceDocumentInformation";
-
- /** @generated
- * @ordered
+
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static int typeIndexID = JCasRegistry.register(SourceDocumentInformation.class);
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static int type = typeIndexID;
- /** @generated
- * @return index of the type
+
+ /**
+ * @generated
+ * @return index of the type
*/
@Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /* *******************
- * Feature Names *
- * *******************/
-
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
+
+ /*
+ * ******************* Feature Names *
+ *******************/
+
public final static String _FeatName_uri = "uri";
public final static String _FeatName_offsetInSource = "offsetInSource";
public final static String _FeatName_documentSize = "documentSize";
public final static String _FeatName_lastSegment = "lastSegment";
-
/* Feature Adjusted Offsets */
- private final static CallSite _FC_uri = TypeSystemImpl.createCallSite(SourceDocumentInformation.class, "uri");
+ private final static CallSite _FC_uri = TypeSystemImpl
+ .createCallSite(SourceDocumentInformation.class, "uri");
private final static MethodHandle _FH_uri = _FC_uri.dynamicInvoker();
- private final static CallSite _FC_offsetInSource = TypeSystemImpl.createCallSite(SourceDocumentInformation.class, "offsetInSource");
+ private final static CallSite _FC_offsetInSource = TypeSystemImpl
+ .createCallSite(SourceDocumentInformation.class, "offsetInSource");
private final static MethodHandle _FH_offsetInSource = _FC_offsetInSource.dynamicInvoker();
- private final static CallSite _FC_documentSize = TypeSystemImpl.createCallSite(SourceDocumentInformation.class, "documentSize");
+ private final static CallSite _FC_documentSize = TypeSystemImpl
+ .createCallSite(SourceDocumentInformation.class, "documentSize");
private final static MethodHandle _FH_documentSize = _FC_documentSize.dynamicInvoker();
- private final static CallSite _FC_lastSegment = TypeSystemImpl.createCallSite(SourceDocumentInformation.class, "lastSegment");
+ private final static CallSite _FC_lastSegment = TypeSystemImpl
+ .createCallSite(SourceDocumentInformation.class, "lastSegment");
private final static MethodHandle _FH_lastSegment = _FC_lastSegment.dynamicInvoker();
-
- /** Never called. Disable default constructor
- * @generated */
- protected SourceDocumentInformation() {/* intentionally empty block */}
-
- /** Internal - constructor used by generator
+
+ /**
+ * Never called. Disable default constructor
+ *
+ * @generated
+ */
+ protected SourceDocumentInformation() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator
+ *
* @generated
- * @param casImpl the CAS this Feature Structure belongs to
- * @param type the type of this Feature Structure
+ * @param casImpl
+ * the CAS this Feature Structure belongs to
+ * @param type
+ * the type of this Feature Structure
*/
public SourceDocumentInformation(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /** @generated
- * @param jcas JCas to which this Feature Structure belongs
+
+ /**
+ * @generated
+ * @param jcas
+ * JCas to which this Feature Structure belongs
*/
public SourceDocumentInformation(JCas jcas) {
super(jcas);
- readObject();
- }
-
+ readObject();
+ }
- /** @generated
- * @param jcas JCas to which this Feature Structure belongs
- * @param begin offset to the begin spot in the SofA
- * @param end offset to the end spot in the SofA
- */
+ /**
+ * @generated
+ * @param jcas
+ * JCas to which this Feature Structure belongs
+ * @param begin
+ * offset to the begin spot in the SofA
+ * @param end
+ * offset to the end spot in the SofA
+ */
public SourceDocumentInformation(JCas jcas, int begin, int end) {
super(jcas);
setBegin(begin);
setEnd(end);
readObject();
- }
+ }
- /**
- * <!-- begin-user-doc -->
- * Write your own initialization here
- * <!-- end-user-doc -->
+ /**
+ * <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->
*
- * @generated modifiable
+ * @generated modifiable
*/
- private void readObject() {/*default - does nothing empty block */}
-
-
-
- //*--------------*
- //* Feature: uri
+ private void readObject() {
+ /* default - does nothing empty block */}
- /** getter for uri - gets URI of document. (For example, file:///MyDirectory/myFile.txt for a simple file or http://incubator.apache.org/uima/index.html for content from a web source.)
+ // *--------------*
+ // * Feature: uri
+
+ /**
+ * getter for uri - gets URI of document. (For example, file:///MyDirectory/myFile.txt for a
+ * simple file or http://incubator.apache.org/uima/index.html for content from a web source.)
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public String getUri() { return _getStringValueNc(wrapGetIntCatchException(_FH_uri));}
-
- /** setter for uri - sets URI of document. (For example, file:///MyDirectory/myFile.txt for a simple file or http://incubator.apache.org/uima/index.html for content from a web source.)
+ public String getUri() {
+ return _getStringValueNc(wrapGetIntCatchException(_FH_uri));
+ }
+
+ /**
+ * setter for uri - sets URI of document. (For example, file:///MyDirectory/myFile.txt for a
+ * simple file or http://incubator.apache.org/uima/index.html for content from a web source.)
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setUri(String v) {
_setStringValueNfc(wrapGetIntCatchException(_FH_uri), v);
- }
-
-
-
- //*--------------*
- //* Feature: offsetInSource
+ }
+
+ // *--------------*
+ // * Feature: offsetInSource
- /** getter for offsetInSource - gets Byte offset of the start of document content within original source file or other input source. Only used if the CAS document was retrieved from an source where one physical source file contained several conceptual documents. Zero otherwise.
+ /**
+ * getter for offsetInSource - gets Byte offset of the start of document content within original
+ * source file or other input source. Only used if the CAS document was retrieved from an source
+ * where one physical source file contained several conceptual documents. Zero otherwise.
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public int getOffsetInSource() { return _getIntValueNc(wrapGetIntCatchException(_FH_offsetInSource));}
-
- /** setter for offsetInSource - sets Byte offset of the start of document content within original source file or other input source. Only used if the CAS document was retrieved from an source where one physical source file contained several conceptual documents. Zero otherwise.
+ public int getOffsetInSource() {
+ return _getIntValueNc(wrapGetIntCatchException(_FH_offsetInSource));
+ }
+
+ /**
+ * setter for offsetInSource - sets Byte offset of the start of document content within original
+ * source file or other input source. Only used if the CAS document was retrieved from an source
+ * where one physical source file contained several conceptual documents. Zero otherwise.
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setOffsetInSource(int v) {
_setIntValueNfc(wrapGetIntCatchException(_FH_offsetInSource), v);
- }
-
-
-
- //*--------------*
- //* Feature: documentSize
+ }
- /** getter for documentSize - gets Size of original document in bytes before processing by CAS Initializer. Either absolute file size of size within file or other source.
+ // *--------------*
+ // * Feature: documentSize
+
+ /**
+ * getter for documentSize - gets Size of original document in bytes before processing by CAS
+ * Initializer. Either absolute file size of size within file or other source.
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public int getDocumentSize() { return _getIntValueNc(wrapGetIntCatchException(_FH_documentSize));}
-
- /** setter for documentSize - sets Size of original document in bytes before processing by CAS Initializer. Either absolute file size of size within file or other source.
+ public int getDocumentSize() {
+ return _getIntValueNc(wrapGetIntCatchException(_FH_documentSize));
+ }
+
+ /**
+ * setter for documentSize - sets Size of original document in bytes before processing by CAS
+ * Initializer. Either absolute file size of size within file or other source.
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setDocumentSize(int v) {
_setIntValueNfc(wrapGetIntCatchException(_FH_documentSize), v);
- }
-
-
-
- //*--------------*
- //* Feature: lastSegment
+ }
+
+ // *--------------*
+ // * Feature: lastSegment
- /** getter for lastSegment - gets For a CAS that represents a segment of a larger source document, this flag indicates whether this CAS is the final segment of the source document. This is useful for downstream components that want to take some action after having seen all of the segments of a particular source document.
+ /**
+ * getter for lastSegment - gets For a CAS that represents a segment of a larger source document,
+ * this flag indicates whether this CAS is the final segment of the source document. This is
+ * useful for downstream components that want to take some action after having seen all of the
+ * segments of a particular source document.
+ *
* @generated
- * @return value of the feature
+ * @return value of the feature
*/
- public boolean getLastSegment() { return _getBooleanValueNc(wrapGetIntCatchException(_FH_lastSegment));}
-
- /** setter for lastSegment - sets For a CAS that represents a segment of a larger source document, this flag indicates whether this CAS is the final segment of the source document. This is useful for downstream components that want to take some action after having seen all of the segments of a particular source document.
+ public boolean getLastSegment() {
+ return _getBooleanValueNc(wrapGetIntCatchException(_FH_lastSegment));
+ }
+
+ /**
+ * setter for lastSegment - sets For a CAS that represents a segment of a larger source document,
+ * this flag indicates whether this CAS is the final segment of the source document. This is
+ * useful for downstream components that want to take some action after having seen all of the
+ * segments of a particular source document.
+ *
* @generated
- * @param v value to set into the feature
+ * @param v
+ * value to set into the feature
*/
public void setLastSegment(boolean v) {
_setBooleanValueNfc(wrapGetIntCatchException(_FH_lastSegment), v);
- }
-
}
-
\ No newline at end of file
+}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/XmlDetagger.java b/uimaj-examples/src/main/java/org/apache/uima/examples/XmlDetagger.java
index b3f937b..457210a 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/XmlDetagger.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/XmlDetagger.java
@@ -51,19 +51,18 @@ public class XmlDetagger extends CasAnnotator_ImplBase {
* file will be considered the document.
*/
public static final String PARAM_XMLTAG = "XmlTagContainingText";
-
+
private SAXParserFactory parserFactory = XMLUtils.createSAXParserFactory();
-
+
private Type sourceDocInfoType;
private String mXmlTagContainingText = null;
-
@Override
public void initialize(UimaContext aContext) throws ResourceInitializationException {
super.initialize(aContext);
// Get config param setting
- mXmlTagContainingText = (String) getContext().getConfigParameterValue(PARAM_XMLTAG);
+ mXmlTagContainingText = (String) getContext().getConfigParameterValue(PARAM_XMLTAG);
}
@Override
@@ -97,11 +96,11 @@ public class XmlDetagger extends CasAnnotator_ImplBase {
if (null != sourceDocInfoFs) {
plainTextView.addFsToIndexes(sourceDocInfoFs);
}
-// Iterator iter = xmlCas.getAnnotationIndex(sourceDocInfoType).iterator();
-// if (iter.hasNext()) {
-// FeatureStructure sourceDocInfoFs = (FeatureStructure) iter.next();
-// plainTextView.getIndexRepository().addFS(sourceDocInfoFs);
-// }
+ // Iterator iter = xmlCas.getAnnotationIndex(sourceDocInfoType).iterator();
+ // if (iter.hasNext()) {
+ // FeatureStructure sourceDocInfoFs = (FeatureStructure) iter.next();
+ // plainTextView.getIndexRepository().addFS(sourceDocInfoFs);
+ // }
}
@@ -112,9 +111,10 @@ public class XmlDetagger extends CasAnnotator_ImplBase {
public DetagHandler() {
insideTextTag = (mXmlTagContainingText == null);
}
-
+
@Override
- public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
+ public void startElement(String uri, String localName, String qName, Attributes attributes)
+ throws SAXException {
if (qName.equalsIgnoreCase(mXmlTagContainingText)) {
insideTextTag = true;
}
@@ -130,14 +130,14 @@ public class XmlDetagger extends CasAnnotator_ImplBase {
@Override
public void characters(char[] ch, int start, int length) throws SAXException {
if (insideTextTag) {
- detaggedText.append(ch, start, length);
+ detaggedText.append(ch, start, length);
}
}
-
+
@Override
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException {
if (insideTextTag) {
- detaggedText.append(ch, start, length);
+ detaggedText.append(ch, start, length);
}
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/cas/PersonTitleAnnotator.java b/uimaj-examples/src/main/java/org/apache/uima/examples/cas/PersonTitleAnnotator.java
index 768eee1..6eca24f 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/cas/PersonTitleAnnotator.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/cas/PersonTitleAnnotator.java
@@ -79,7 +79,7 @@ public class PersonTitleAnnotator extends CasAnnotator_ImplBase {
* The list of government titles, read from the GovernmentTitles configuration parameter.
*/
private String[] mGovernmentTitles;
-
+
/**
* Show warning message just once
*/
@@ -132,8 +132,8 @@ public class PersonTitleAnnotator extends CasAnnotator_ImplBase {
}
// Get the value for the "ContainingType" parameter if there is one
- String containingTypeName = (String) getContext().getConfigParameterValue(
- "ContainingAnnotationType");
+ String containingTypeName = (String) getContext()
+ .getConfigParameterValue("ContainingAnnotationType");
if (containingTypeName != null) {
mContainingType = aTypeSystem.getType(containingTypeName);
if (mContainingType == null) {
@@ -157,13 +157,14 @@ public class PersonTitleAnnotator extends CasAnnotator_ImplBase {
try {
// If the ResultSpec doesn't include the PersonTitle type, we have
// nothing to do.
- if (!getResultSpecification().containsType("example.PersonTitle",aCAS.getDocumentLanguage())) {
+ if (!getResultSpecification().containsType("example.PersonTitle",
+ aCAS.getDocumentLanguage())) {
if (!warningMsgShown) {
String m = String.format(
- "No output is being produced by the PersonTitleAnnotator because the Result Specification did not contain" +
- " a request for the type example.PersonTitle with the language '%s'%n" +
- " (Note: this message will only be shown once.)%n",
- aCAS.getDocumentLanguage());
+ "No output is being produced by the PersonTitleAnnotator because the Result Specification did not contain"
+ + " a request for the type example.PersonTitle with the language '%s'%n"
+ + " (Note: this message will only be shown once.)%n",
+ aCAS.getDocumentLanguage());
System.err.println(m);
logger.log(Level.WARNING, m);
warningMsgShown = true;
@@ -178,32 +179,32 @@ public class PersonTitleAnnotator extends CasAnnotator_ImplBase {
} else {
// Search only within annotations of type mContainingType
- //v3
-
- for (Annotation annot : aCAS.<Annotation>select(mContainingType)) {
-
- String coveredText = annot.getCoveredText(); // Get text covered by this annotation
- int annotBegin = annot.getBegin(); // Get begin position of this annotation
+ // v3
+
+ for (Annotation annot : aCAS.<Annotation> select(mContainingType)) {
+
+ String coveredText = annot.getCoveredText(); // Get text covered by this annotation
+ int annotBegin = annot.getBegin(); // Get begin position of this annotation
annotateRange(aCAS, coveredText, annotBegin); // search for matches within this
-
+
}
-
+
// v2
-// // Get an iterator over the annotations of type mContainingType.
-// FSIterator it = aCAS.getAnnotationIndex(mContainingType).iterator();
-// // Loop over the iterator.
-// while (it.isValid()) {
-// // Get the next annotation from the iterator
-// AnnotationFS annot = (AnnotationFS) it.get();
-// // Get text covered by this annotation
-// String coveredText = annot.getCoveredText();
-// // Get begin position of this annotation
-// int annotBegin = annot.getBegin();
-// // search for matches within this
-// annotateRange(aCAS, coveredText, annotBegin);
-// // Advance the iterator.
-// it.moveToNext();
-// }
+ // // Get an iterator over the annotations of type mContainingType.
+ // FSIterator it = aCAS.getAnnotationIndex(mContainingType).iterator();
+ // // Loop over the iterator.
+ // while (it.isValid()) {
+ // // Get the next annotation from the iterator
+ // AnnotationFS annot = (AnnotationFS) it.get();
+ // // Get text covered by this annotation
+ // String coveredText = annot.getCoveredText();
+ // // Get begin position of this annotation
+ // int annotBegin = annot.getBegin();
+ // // search for matches within this
+ // annotateRange(aCAS, coveredText, annotBegin);
+ // // Advance the iterator.
+ // it.moveToNext();
+ // }
}
} catch (Exception e) {
throw new AnalysisEngineProcessException(e);
@@ -246,7 +247,7 @@ public class PersonTitleAnnotator extends CasAnnotator_ImplBase {
protected void annotateRange(CAS aCAS, String aText, int aBeginPos, String aTitleType,
String[] aTitles) {
// Loop over the matchStrings.
-
+
for (int i = 0; i < aTitles.length; i++) {
// logger.log("Looking for string: " + matchStrings[i]);
// Find a first match, if it exists.
@@ -286,7 +287,8 @@ public class PersonTitleAnnotator extends CasAnnotator_ImplBase {
protected void createAnnotation(CAS aCAS, int aBeginPos, int aEndPos, String aTitleType) {
AnnotationFS title = aCAS.createAnnotation(mPersonTitleType, aBeginPos, aEndPos);
// Set the "kind" feature if it's part of the ResultSpec
- if (getResultSpecification().containsFeature("example.PersonTitle:Kind",aCAS.getDocumentLanguage())) {
+ if (getResultSpecification().containsFeature("example.PersonTitle:Kind",
+ aCAS.getDocumentLanguage())) {
title.setStringValue(mPersonTitleKindFeature, aTitleType);
}
// Add the annotation to the index.
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/cas/RegExAnnotator.java b/uimaj-examples/src/main/java/org/apache/uima/examples/cas/RegExAnnotator.java
index ab10cf0..69d4432 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/cas/RegExAnnotator.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/cas/RegExAnnotator.java
@@ -54,24 +54,24 @@ import org.apache.uima.util.Level;
* <p>
* This annotator takes the following optional configuration parameters:
* <ul>
- * <li><code>Patterns</code> - array of Strings indicating regular expressions to match. The
- * pattern language is described at <a
- * href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html">
- * http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html</a>) </li>
+ * <li><code>Patterns</code> - array of Strings indicating regular expressions to match. The pattern
+ * language is described at
+ * <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html">
+ * http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html</a>)</li>
* <li><code>TypeNames</code> - array of Strings indicating names of Types to be created from the
- * patterns. </li>
- * <li><code>ContainingAnnotationTypes</code> - an array of input annotation types. This
- * annotator will only produce new annotations that are contained within existing annotaions of
- * these types. (This is optional.) </li>
- * <li><code>AnnotateEntireContainedAnnotation</code> - When the ContainingAnnoationTypes
- * parameter is specified, a value of true for this parameter will cause the entire containing
- * annotation to be used as the span of the new annotation, rather than just the span of the regular
- * expression match. This can be used to "classify" previously created annotations according to
- * whether or not they contain text matching a regular expression. </li>
+ * patterns.</li>
+ * <li><code>ContainingAnnotationTypes</code> - an array of input annotation types. This annotator
+ * will only produce new annotations that are contained within existing annotaions of these types.
+ * (This is optional.)</li>
+ * <li><code>AnnotateEntireContainedAnnotation</code> - When the ContainingAnnoationTypes parameter
+ * is specified, a value of true for this parameter will cause the entire containing annotation to
+ * be used as the span of the new annotation, rather than just the span of the regular expression
+ * match. This can be used to "classify" previously created annotations according to whether or not
+ * they contain text matching a regular expression.</li>
* </ul>
* <p>
- * The indices of the <code>Patterns</code> and <code>TypeNames</code> arrays correspond, so
- * that a substring that matches <code>Patterns[i]</code> will result in an annotation of type
+ * The indices of the <code>Patterns</code> and <code>TypeNames</code> arrays correspond, so that a
+ * substring that matches <code>Patterns[i]</code> will result in an annotation of type
* <code>TypeNames[i]</code>.
* <p>
* It is also possible to provide an external resource file that declares the annotation type names
@@ -104,11 +104,11 @@ public class RegExAnnotator extends CasAnnotator_ImplBase {
// Retrieve configuration parameters
String[] patternStrings = (String[]) getContext().getConfigParameterValue("Patterns");
String[] typeNames = (String[]) getContext().getConfigParameterValue("TypeNames");
- mContainingAnnotationTypeNames = (String[]) getContext().getConfigParameterValue(
- "ContainingAnnotationTypes");
+ mContainingAnnotationTypeNames = (String[]) getContext()
+ .getConfigParameterValue("ContainingAnnotationTypes");
if (mContainingAnnotationTypeNames != null && mContainingAnnotationTypeNames.length > 0) {
- mAnnotateEntireContainingAnnotation = (Boolean) getContext().getConfigParameterValue(
- "AnnotateEntireContainingAnnotation");
+ mAnnotateEntireContainingAnnotation = (Boolean) getContext()
+ .getConfigParameterValue("AnnotateEntireContainingAnnotation");
} else {
mAnnotateEntireContainingAnnotation = Boolean.FALSE;
}
@@ -251,7 +251,7 @@ public class RegExAnnotator extends CasAnnotator_ImplBase {
* parameters.
*
* @param aCAS
- * the CAS to process
+ * the CAS to process
* @throws AnalysisEngineProcessException
* if a failure occurs during processing.
*
@@ -275,7 +275,9 @@ public class RegExAnnotator extends CasAnnotator_ImplBase {
// iterate over all annotation types for which we have patterns
for (int j = 0; j < mCASTypes.length; j++) {
// see if the ResultSpec contains this type
- if (getResultSpecification().containsType(mCASTypes[j].getName(),aCAS.getDocumentLanguage()) || getResultSpecification().containsType(mCASTypes[j].getName())) {
+ if (getResultSpecification().containsType(mCASTypes[j].getName(),
+ aCAS.getDocumentLanguage())
+ || getResultSpecification().containsType(mCASTypes[j].getName())) {
// try to match each pattern that we have for this annotation type
for (int k = 0; k < mPatterns[j].length; k++) {
int pos = 0;
@@ -311,8 +313,8 @@ public class RegExAnnotator extends CasAnnotator_ImplBase {
* Utility method that determines which subranges of the document text should be annotated by this
* annotator. This is done as follows:
* <ul>
- * <li>If <code>mContainingAnnotationTypes</code> is <code>null</code>, the entire document
- * is eligible for annotation.</li>
+ * <li>If <code>mContainingAnnotationTypes</code> is <code>null</code>, the entire document is
+ * eligible for annotation.</li>
* <li>If <code>mContainingAnnotationTypes</code> is not <code>null</code>, then each of its
* elements is expected to be an Annotation Type name. The CAS is queried for existing annotations
* of any of these Types, and the only subranges of the document eligible for annotation are those
@@ -369,7 +371,8 @@ public class RegExAnnotator extends CasAnnotator_ImplBase {
private Pattern[][] mPatterns;
/**
- * The names of the CAS types that this annotator produces from the patterns in {@link #mPatterns}.
+ * The names of the CAS types that this annotator produces from the patterns in
+ * {@link #mPatterns}.
*/
private ArrayList<String> mTypeNames;
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/CasMultiplierExampleApplication.java b/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/CasMultiplierExampleApplication.java
index 7f66ac7..f7d59b6 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/CasMultiplierExampleApplication.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/CasMultiplierExampleApplication.java
@@ -74,7 +74,7 @@ public class CasMultiplierExampleApplication {
// pass the CAS to the AnalysisEngine and get back
// a CasIterator for stepping over the output CASes that are produced.
-
+
CasIterator casIterator = ae.processAndOutputNewCASes(initialCas);
while (casIterator.hasNext()) {
CAS outCas = casIterator.next();
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/SimpleTextMerger.java b/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/SimpleTextMerger.java
index 27487fc..a1931af 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/SimpleTextMerger.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/SimpleTextMerger.java
@@ -49,13 +49,13 @@ import org.apache.uima.util.CasCopier;
* that would also make this example more complicated.
*/
public class SimpleTextMerger extends JCasMultiplier_ImplBase {
-
+
public static final String MESSAGE_DIGEST = "org.apache.uima.examples.casMultiplier.ExampleCasMultiplierMessages";
-
+
public static final String MISSING_SOURCE_DOCUMENT_INFO = "missing_source_document_info";
-
+
public static final String NO_NEXT_CAS = "no_next_cas";
-
+
private StringBuffer mDocBuf = new StringBuffer();
private JCas mMergedCas;
@@ -67,7 +67,8 @@ public class SimpleTextMerger extends JCasMultiplier_ImplBase {
/*
* (non-Javadoc)
*
- * @see org.apache.uima.analysis_component.AnalysisComponent_ImplBase#initialize(org.apache.uima.UimaContext)
+ * @see org.apache.uima.analysis_component.AnalysisComponent_ImplBase#initialize(org.apache.uima.
+ * UimaContext)
*/
@Override
public void initialize(UimaContext aContext) throws ResourceInitializationException {
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/SimpleTextSegmenter.java b/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/SimpleTextSegmenter.java
index 6912b81..8364413 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/SimpleTextSegmenter.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/casMultiplier/SimpleTextSegmenter.java
@@ -46,7 +46,8 @@ public class SimpleTextSegmenter extends JCasMultiplier_ImplBase {
/*
* (non-Javadoc)
*
- * @see org.apache.uima.analysis_component.AnalysisComponent_ImplBase#initialize(org.apache.uima.UimaContext)
+ * @see org.apache.uima.analysis_component.AnalysisComponent_ImplBase#initialize(org.apache.uima.
+ * UimaContext)
*/
@Override
public void initialize(UimaContext aContext) throws ResourceInitializationException {
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/AnnotationPrinter.java b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/AnnotationPrinter.java
index ea13fac..f55f932 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/AnnotationPrinter.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/AnnotationPrinter.java
@@ -36,13 +36,12 @@ import org.apache.uima.resource.ResourceInitializationException;
import org.apache.uima.resource.ResourceProcessException;
import org.apache.uima.util.ProcessTrace;
-
/**
* An example of CAS Consumer. <br>
* AnnotationPrinter prints to an output file all annotations in the CAS. <br>
* Parameters needed by the AnnotationPrinter are
* <ol>
- * <li> "outputFile" : file to which the output files should be written.</li>
+ * <li>"outputFile" : file to which the output files should be written.</li>
* </ol>
* <br>
* These parameters are set in the initialize method to the values specified in the descriptor file.
@@ -53,7 +52,7 @@ import org.apache.uima.util.ProcessTrace;
*/
public class AnnotationPrinter extends CasConsumer_ImplBase implements CasObjectProcessor {
-
+
/** The out file. */
File outFile;
@@ -88,8 +87,8 @@ public class AnnotationPrinter extends CasConsumer_ImplBase implements CasObject
if (outFile.getParentFile() != null && !outFile.getParentFile().exists()) {
if (!outFile.getParentFile().mkdirs())
throw new ResourceInitializationException(
- ResourceInitializationException.RESOURCE_DATA_NOT_VALID, new Object[] { oPath,
- "outputFile" });
+ ResourceInitializationException.RESOURCE_DATA_NOT_VALID,
+ new Object[] { oPath, "outputFile" });
}
try {
fileWriter = new FileWriter(outFile);
@@ -170,8 +169,8 @@ public class AnnotationPrinter extends CasConsumer_ImplBase implements CasObject
* @see org.apache.uima.collection.CasConsumer#batchProcessComplete(ProcessTrace)
*/
@Override
- public void batchProcessComplete(ProcessTrace aTrace) throws ResourceProcessException,
- IOException {
+ public void batchProcessComplete(ProcessTrace aTrace)
+ throws ResourceProcessException, IOException {
// nothing to do in this case as AnnotationPrinter doesnot do
// anything cumulatively
}
@@ -188,8 +187,8 @@ public class AnnotationPrinter extends CasConsumer_ImplBase implements CasObject
* @see org.apache.uima.collection.CasConsumer#collectionProcessComplete(ProcessTrace)
*/
@Override
- public void collectionProcessComplete(ProcessTrace aTrace) throws ResourceProcessException,
- IOException {
+ public void collectionProcessComplete(ProcessTrace aTrace)
+ throws ResourceProcessException, IOException {
if (fileWriter != null) {
fileWriter.close();
}
@@ -221,8 +220,8 @@ public class AnnotationPrinter extends CasConsumer_ImplBase implements CasObject
if (oFile.getParentFile() != null && !oFile.getParentFile().exists()) {
if (!oFile.getParentFile().mkdirs())
throw new ResourceConfigurationException(
- ResourceInitializationException.RESOURCE_DATA_NOT_VALID, new Object[] { oPath,
- "outputFile" });
+ ResourceInitializationException.RESOURCE_DATA_NOT_VALID,
+ new Object[] { oPath, "outputFile" });
}
fileWriter = new FileWriter(oFile);
} catch (IOException e) {
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/FileSystemCollectionReader.java b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/FileSystemCollectionReader.java
index 5f7c08c..5ace9a9 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/FileSystemCollectionReader.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/FileSystemCollectionReader.java
@@ -35,7 +35,6 @@ import org.apache.uima.util.FileUtils;
import org.apache.uima.util.Progress;
import org.apache.uima.util.ProgressImpl;
-
/**
* A simple collection reader that reads documents from a directory in the filesystem. It can be
* configured with the following parameters:
@@ -67,11 +66,11 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
public static final String PARAM_LANGUAGE = "Language";
/**
- * Name of optional configuration parameter that indicates including
- * the subdirectories (recursively) of the current input directory.
+ * Name of optional configuration parameter that indicates including the subdirectories
+ * (recursively) of the current input directory.
*/
public static final String PARAM_SUBDIR = "BrowseSubdirectories";
-
+
/** The m files. */
private ArrayList<File> mFiles;
@@ -80,7 +79,7 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
/** The m language. */
private String mLanguage;
-
+
/** The m recursive. */
private Boolean mRecursive;
@@ -90,14 +89,15 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
/**
* Initialize.
*
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
* @see org.apache.uima.collection.CollectionReader_ImplBase#initialize()
*/
@Override
public void initialize() throws ResourceInitializationException {
File directory = new File(((String) getConfigParameterValue(PARAM_INPUTDIR)).trim());
- mEncoding = (String) getConfigParameterValue(PARAM_ENCODING);
- mLanguage = (String) getConfigParameterValue(PARAM_LANGUAGE);
+ mEncoding = (String) getConfigParameterValue(PARAM_ENCODING);
+ mLanguage = (String) getConfigParameterValue(PARAM_LANGUAGE);
mRecursive = (Boolean) getConfigParameterValue(PARAM_SUBDIR);
if (null == mRecursive) { // could be null if not set, it is optional
mRecursive = Boolean.FALSE;
@@ -115,13 +115,13 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
mFiles = new ArrayList<>();
addFilesFromDir(directory);
}
-
+
/**
- * This method adds files in the directory passed in as a parameter to mFiles.
- * If mRecursive is true, it will include all files in all
- * subdirectories (recursively), as well.
+ * This method adds files in the directory passed in as a parameter to mFiles. If mRecursive is
+ * true, it will include all files in all subdirectories (recursively), as well.
*
- * @param dir the dir
+ * @param dir
+ * the dir
*/
private void addFilesFromDir(File dir) {
File[] files = dir.listFiles();
@@ -148,9 +148,12 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
/**
* Gets the next.
*
- * @param aCAS the a CAS
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws CollectionException the collection exception
+ * @param aCAS
+ * the a CAS
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws CollectionException
+ * the collection exception
* @see org.apache.uima.collection.CollectionReader#getNext(org.apache.uima.cas.CAS)
*/
@Override
@@ -165,7 +168,7 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
// open input stream to file
File file = (File) mFiles.get(mCurrentIndex++);
String text = FileUtils.file2String(file, mEncoding);
- // put document in CAS
+ // put document in CAS
jcas.setDocumentText(text);
// set language if it was explicitly specified as a configuration parameter
@@ -189,7 +192,8 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
/**
* Close.
*
- * @throws IOException Signals that an I/O exception has occurred.
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
* @see org.apache.uima.collection.base_cpm.BaseCollectionReader#close()
*/
@Override
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/InlineXmlCasConsumer.java b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/InlineXmlCasConsumer.java
index fd6eeb5..cb4768f 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/InlineXmlCasConsumer.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/InlineXmlCasConsumer.java
@@ -36,7 +36,6 @@ import org.apache.uima.resource.ResourceInitializationException;
import org.apache.uima.resource.ResourceProcessException;
import org.apache.uima.util.CasToInlineXml;
-
/**
* A simple CAS consumer that generates inline XML and writes it to a file. UTF-8 encoding is used.
* <p>
@@ -63,7 +62,9 @@ public class InlineXmlCasConsumer extends CasConsumer_ImplBase {
/** The m doc num. */
private int mDocNum;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.collection.CasConsumer_ImplBase#initialize()
*/
@Override
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/PersonTitleDBWriterCasConsumer.java b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/PersonTitleDBWriterCasConsumer.java
index c246b18..07c0f4f 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/PersonTitleDBWriterCasConsumer.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/PersonTitleDBWriterCasConsumer.java
@@ -39,7 +39,6 @@ import org.apache.uima.util.ProcessTrace;
import example.PersonTitle;
-
/**
* A simple CAS consumer that creates a Derby (Cloudscape) database in the file system. You can
* obtain this database from http://incubator.apache.org/derby/ *
@@ -47,7 +46,7 @@ import example.PersonTitle;
* This CAS Consumer takes one parameters:
* <ul>
* <li><code>OutputDirectory</code> - path to directory which is the "System" directory for the
- * derby DB. </li>
+ * derby DB.</li>
* </ul>
*
* It deletes all the databases at the system location (!!!), Creates a new database (takes the most
@@ -106,7 +105,9 @@ public class PersonTitleDBWriterCasConsumer extends CasConsumer_ImplBase {
/** The start time. */
private long startTime;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.collection.CasConsumer_ImplBase#initialize()
*/
@Override
@@ -140,8 +141,8 @@ public class PersonTitleDBWriterCasConsumer extends CasConsumer_ImplBase {
*/
@Override
public void processCas(CAS aCAS) throws ResourceProcessException {
- System.out.println("Time: " + (System.currentTimeMillis() - startTime)
- + " DB Writer: ProcessCas called");
+ System.out.println(
+ "Time: " + (System.currentTimeMillis() - startTime) + " DB Writer: ProcessCas called");
JCas jcas;
try {
jcas = aCAS.getJCas();
@@ -166,10 +167,8 @@ public class PersonTitleDBWriterCasConsumer extends CasConsumer_ImplBase {
// (derby also has a network accessed database driver)
if (firstEverCall) {
firstEverCall = false;
- System.out
- .println("Time: "
- + (System.currentTimeMillis() - startTime)
- + " DB Writer: Doing first process call ever (even during re-runs) initialization");
+ System.out.println("Time: " + (System.currentTimeMillis() - startTime)
+ + " DB Writer: Doing first process call ever (even during re-runs) initialization");
try {
// note: newInstance() call is needed to reinitialize properly after
// derby has been shutdown
@@ -212,10 +211,8 @@ public class PersonTitleDBWriterCasConsumer extends CasConsumer_ImplBase {
}
con = DriverManager.getConnection("jdbc:derby:ExamplePersonTitleDB;create=true");
- System.out
- .println("Time: "
- + (System.currentTimeMillis() - startTime)
- + " DB Writer: First Time Initiailization: Created the ExamplePersonTitleDB and connected to it.");
+ System.out.println("Time: " + (System.currentTimeMillis() - startTime)
+ + " DB Writer: First Time Initiailization: Created the ExamplePersonTitleDB and connected to it.");
// Databases typically use user-names and passwords; these can
// be passed as //properties to the getConnection method.
@@ -245,15 +242,15 @@ public class PersonTitleDBWriterCasConsumer extends CasConsumer_ImplBase {
}
// get the singleton instance of the SourceDocumentInformation
- SourceDocumentInformation sdi = (SourceDocumentInformation)
- jcas.getAnnotationIndex(SourceDocumentInformation.type).iterator().next();
+ SourceDocumentInformation sdi = (SourceDocumentInformation) jcas
+ .getAnnotationIndex(SourceDocumentInformation.type).iterator().next();
System.out.println("Time: " + (System.currentTimeMillis() - startTime)
+ " DB Writer: Processing doc: '" + sdi.getUri() + "'");
stmt.setString(1, truncate(sdi.getUri(), MAX_URI_LENGTH));
- for (FSIterator iter = jcas.getAnnotationIndex(PersonTitle.type).iterator();
- iter.hasNext();) {
+ for (FSIterator iter = jcas.getAnnotationIndex(PersonTitle.type).iterator(); iter
+ .hasNext();) {
PersonTitle pt = (PersonTitle) iter.next();
stmt.setString(2, truncate(pt.getCoveredText(), MAX_TITLE_LENGTH));
stmt.setInt(3, pt.getBegin());
@@ -293,12 +290,16 @@ public class PersonTitleDBWriterCasConsumer extends CasConsumer_ImplBase {
}
}
- /* (non-Javadoc)
- * @see org.apache.uima.collection.CasConsumer_ImplBase#collectionProcessComplete(org.apache.uima.util.ProcessTrace)
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.collection.CasConsumer_ImplBase#collectionProcessComplete(org.apache.uima.util.
+ * ProcessTrace)
*/
@Override
- public void collectionProcessComplete(ProcessTrace arg0) throws ResourceProcessException,
- IOException {
+ public void collectionProcessComplete(ProcessTrace arg0)
+ throws ResourceProcessException, IOException {
firstCall = true;
try {
@@ -335,7 +336,8 @@ public class PersonTitleDBWriterCasConsumer extends CasConsumer_ImplBase {
/**
* Delete dir.
*
- * @param f the f
+ * @param f
+ * the f
*/
private void deleteDir(File f) {
if (f.isDirectory()) {
@@ -350,8 +352,10 @@ public class PersonTitleDBWriterCasConsumer extends CasConsumer_ImplBase {
/**
* Truncate.
*
- * @param s the s
- * @param length the length
+ * @param s
+ * the s
+ * @param length
+ * the length
* @return the string
*/
private String truncate(String s, int length) {
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/SimpleRunCPE.java b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/SimpleRunCPE.java
index a190eae..2b30378 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/SimpleRunCPE.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/SimpleRunCPE.java
@@ -31,7 +31,6 @@ import org.apache.uima.collection.StatusCallbackListener;
import org.apache.uima.collection.metadata.CpeDescription;
import org.apache.uima.util.XMLInputSource;
-
/**
* Main Class that runs a Collection Processing Engine (CPE). This class reads a CPE Descriptor as a
* command-line argument and instantiates the CPE. It also registers a callback listener with the
@@ -47,15 +46,17 @@ public class SimpleRunCPE extends Thread {
/** Start time of CPE initialization. */
private long mStartTime;
-
+
/** Start time of the processing. */
private long mInitCompleteTime;
/**
* Constructor for the class.
*
- * @param args command line arguments into the program - see class description
- * @throws Exception the exception
+ * @param args
+ * command line arguments into the program - see class description
+ * @throws Exception
+ * the exception
*/
public SimpleRunCPE(String args[]) throws Exception {
mStartTime = System.currentTimeMillis();
@@ -68,8 +69,8 @@ public class SimpleRunCPE extends Thread {
// parse CPE descriptor
System.out.println("Parsing CPE Descriptor");
- CpeDescription cpeDesc = UIMAFramework.getXMLParser().parseCpeDescription(
- new XMLInputSource(args[0]));
+ CpeDescription cpeDesc = UIMAFramework.getXMLParser()
+ .parseCpeDescription(new XMLInputSource(args[0]));
// instantiate CPE
System.out.println("Instantiating CPE");
mCPE = UIMAFramework.produceCollectionProcessingEngine(cpeDesc);
@@ -93,7 +94,6 @@ public class SimpleRunCPE extends Thread {
}
}
-
/**
* Prints the usage message.
*/
@@ -105,8 +105,10 @@ public class SimpleRunCPE extends Thread {
/**
* main class.
*
- * @param args Command line arguments - see class description
- * @throws Exception the exception
+ * @param args
+ * Command line arguments - see class description
+ * @throws Exception
+ * the exception
*/
public static void main(String[] args) throws Exception {
new SimpleRunCPE(args);
@@ -118,7 +120,7 @@ public class SimpleRunCPE extends Thread {
*
*/
class StatusCallbackListenerImpl implements StatusCallbackListener {
-
+
/** The entity count. */
int entityCount = 0;
@@ -131,7 +133,7 @@ public class SimpleRunCPE extends Thread {
* @see StatusCallbackListener#initializationComplete()
*/
@Override
- public void initializationComplete() {
+ public void initializationComplete() {
System.out.println("CPM Initialization Complete");
mInitCompleteTime = System.currentTimeMillis();
}
@@ -166,13 +168,13 @@ public class SimpleRunCPE extends Thread {
System.out.print("; " + size + " characters");
}
System.out.println();
- long initTime = mInitCompleteTime - mStartTime;
+ long initTime = mInitCompleteTime - mStartTime;
long processingTime = time - mInitCompleteTime;
long elapsedTime = initTime + processingTime;
System.out.println("Total Time Elapsed: " + elapsedTime + " ms ");
System.out.println("Initialization Time: " + initTime + " ms");
System.out.println("Processing Time: " + processingTime + " ms");
-
+
System.out.println("\n\n ------------------ PERFORMANCE REPORT ------------------\n");
System.out.println(mCPE.getPerformanceReport().toString());
// stop the JVM. Otherwise main thread will still be blocked waiting for
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/SimpleRunCPM.java b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/SimpleRunCPM.java
index bfb8886..31ced1b 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/SimpleRunCPM.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/SimpleRunCPM.java
@@ -34,23 +34,22 @@ import org.apache.uima.collection.StatusCallbackListener;
import org.apache.uima.resource.ResourceSpecifier;
import org.apache.uima.util.XMLInputSource;
-
/**
* Main Class that runs the Collection Processing Manager (CPM). This class reads descriptor files
* and initiailizes the following components:
* <ol>
- * <li> CollectionReader </li>
- * <li> Analysis Engine </li>
- * <li> CAS Consumer </li>
+ * <li>CollectionReader</li>
+ * <li>Analysis Engine</li>
+ * <li>CAS Consumer</li>
* </ol>
* <br>
* It also registers a callback listener with the CPM, which will print progress and statistics to
* System.out. <br>
* Command lines arguments for the run are :
* <ol>
- * <li> args[0] : CollectionReader descriptor file </li>
- * <li> args[1] : CAS Consumer descriptor file. </li>
- * <li> args[2] : AnnotationPrinter descriptor file </li>
+ * <li>args[0] : CollectionReader descriptor file</li>
+ * <li>args[1] : CAS Consumer descriptor file.</li>
+ * <li>args[2] : AnnotationPrinter descriptor file</li>
* </ol>
* <br>
* Example : <br>
@@ -74,9 +73,12 @@ public class SimpleRunCPM extends Thread {
/**
* Constructor for the class.
*
- * @param args command line arguments into the program - see class description
- * @throws UIMAException the UIMA exception
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param args
+ * command line arguments into the program - see class description
+ * @throws UIMAException
+ * the UIMA exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
public SimpleRunCPM(String args[]) throws UIMAException, IOException {
mStartTime = System.currentTimeMillis();
@@ -97,14 +99,14 @@ public class SimpleRunCPM extends Thread {
// AnalysisEngine
System.out.println("Initializing AnalysisEngine");
- ResourceSpecifier aeSpecifier = UIMAFramework.getXMLParser().parseResourceSpecifier(
- new XMLInputSource(args[1]));
+ ResourceSpecifier aeSpecifier = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(new XMLInputSource(args[1]));
AnalysisEngine ae = UIMAFramework.produceAnalysisEngine(aeSpecifier);
// CAS Consumer
System.out.println("Initializing CAS Consumer");
- ResourceSpecifier consumerSpecifier = UIMAFramework.getXMLParser().parseCasConsumerDescription(
- new XMLInputSource(args[2]));
+ ResourceSpecifier consumerSpecifier = UIMAFramework.getXMLParser()
+ .parseCasConsumerDescription(new XMLInputSource(args[2]));
CasConsumer casConsumer = UIMAFramework.produceCasConsumer(consumerSpecifier);
// create a new Collection Processing Manager
@@ -124,7 +126,6 @@ public class SimpleRunCPM extends Thread {
mCPM.process(collectionReader, 10);
}
-
/**
* Prints the usage message.
*/
@@ -138,9 +139,12 @@ public class SimpleRunCPM extends Thread {
/**
* main class.
*
- * @param args Command line arguments - see class description
- * @throws UIMAException the UIMA exception
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param args
+ * Command line arguments - see class description
+ * @throws UIMAException
+ * the UIMA exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
public static void main(String[] args) throws UIMAException, IOException {
new SimpleRunCPM(args);
@@ -152,7 +156,7 @@ public class SimpleRunCPM extends Thread {
*
*/
class StatusCallbackListenerImpl implements StatusCallbackListener {
-
+
/** The entity count. */
int entityCount = 0;
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/XCasWriterCasConsumer.java b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/XCasWriterCasConsumer.java
index 3916b77..889cd61 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/XCasWriterCasConsumer.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/cpe/XCasWriterCasConsumer.java
@@ -51,7 +51,6 @@ import org.apache.uima.resource.ResourceProcessException;
import org.apache.uima.util.XMLSerializer;
import org.xml.sax.SAXException;
-
/**
* A simple CAS consumer that generates XCAS (XML representation of the CAS) files in the
* filesystem.
@@ -76,7 +75,9 @@ public class XCasWriterCasConsumer extends CasConsumer_ImplBase {
/** The m doc num. */
private int mDocNum;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.collection.CasConsumer_ImplBase#initialize()
*/
@Override
@@ -142,10 +143,14 @@ public class XCasWriterCasConsumer extends CasConsumer_ImplBase {
/**
* Serialize a CAS to a file in XCAS format.
*
- * @param aCas CAS to serialize
- * @param name output file
- * @throws IOException if an I/O failure occurs
- * @throws SAXException if an error occurs generating the XML text
+ * @param aCas
+ * CAS to serialize
+ * @param name
+ * output file
+ * @throws IOException
+ * if an I/O failure occurs
+ * @throws SAXException
+ * if an error occurs generating the XML text
*/
private void writeXCas(CAS aCas, File name) throws IOException, SAXException {
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/flow/AdvancedFixedFlowController.java b/uimaj-examples/src/main/java/org/apache/uima/examples/flow/AdvancedFixedFlowController.java
index 5f5b39d..ea75009 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/flow/AdvancedFixedFlowController.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/flow/AdvancedFixedFlowController.java
@@ -46,7 +46,7 @@ public class AdvancedFixedFlowController extends CasFlowController_ImplBase {
public static final String PARAM_ACTION_AFTER_CAS_MULTIPLIER = "ActionAfterCasMultiplier";
public static final String PARAM_ALLOW_CONTINUE_ON_FAILURE = "AllowContinueOnFailure";
-
+
public static final String PARAM_FLOW = "Flow";
private static final int ACTION_CONTINUE = 0;
@@ -60,14 +60,14 @@ public class AdvancedFixedFlowController extends CasFlowController_ImplBase {
private ArrayList<Step> mSequence;
private int mActionAfterCasMultiplier;
-
+
private Set<String> mAEsAllowingContinueOnFailure = new HashSet<>();
@Override
-public void initialize(FlowControllerContext aContext) throws ResourceInitializationException {
+ public void initialize(FlowControllerContext aContext) throws ResourceInitializationException {
super.initialize(aContext);
- String[] flow = (String[])aContext.getConfigParameterValue(PARAM_FLOW);
+ String[] flow = (String[]) aContext.getConfigParameterValue(PARAM_FLOW);
mSequence = new ArrayList<>();
for (int i = 0; i < flow.length; i++) {
String[] aes = flow[i].split(",");
@@ -77,7 +77,7 @@ public void initialize(FlowControllerContext aContext) throws ResourceInitializa
Collection<String> keys = new ArrayList<>();
keys.addAll(Arrays.asList(aes));
mSequence.add(new ParallelStep(keys));
- }
+ }
}
String actionAfterCasMultiplier = (String) aContext
@@ -95,15 +95,13 @@ public void initialize(FlowControllerContext aContext) throws ResourceInitializa
} else {
throw new ResourceInitializationException(); // TODO
}
-
- String[] aeKeysAllowingContinue = (String[])aContext
+
+ String[] aeKeysAllowingContinue = (String[]) aContext
.getConfigParameterValue(PARAM_ALLOW_CONTINUE_ON_FAILURE);
if (aeKeysAllowingContinue != null) {
mAEsAllowingContinueOnFailure.addAll(Arrays.asList(aeKeysAllowingContinue));
}
-
-
-
+
}
/*
@@ -112,11 +110,13 @@ public void initialize(FlowControllerContext aContext) throws ResourceInitializa
* @see org.apache.uima.flow.CasFlowController_ImplBase#computeFlow(org.apache.uima.cas.CAS)
*/
@Override
-public Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException {
+ public Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException {
return new FixedFlowObject(0);
}
-
- /* (non-Javadoc)
+
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.flow.FlowController_ImplBase#addAnalysisEngines(java.util.Collection)
*/
@Override
@@ -127,24 +127,26 @@ public Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException {
mSequence.add(new ParallelStep(new ArrayList<>(aKeys)));
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.flow.FlowController_ImplBase#removeAnalysisEngines(java.util.Collection)
*/
@Override
- public synchronized void removeAnalysisEngines(Collection<String> aKeys) throws AnalysisEngineProcessException {
+ public synchronized void removeAnalysisEngines(Collection<String> aKeys)
+ throws AnalysisEngineProcessException {
// Remove keys from Sequence ... replace with null so step indices are still valid
for (int i = 0; i < mSequence.size(); ++i) {
- Step step = (Step)mSequence.get(i);
- if (step instanceof SimpleStep && aKeys.contains(((SimpleStep)step).getAnalysisEngineKey())) {
+ Step step = (Step) mSequence.get(i);
+ if (step instanceof SimpleStep
+ && aKeys.contains(((SimpleStep) step).getAnalysisEngineKey())) {
mSequence.set(i, null);
- }
- else if (step instanceof ParallelStep) {
+ } else if (step instanceof ParallelStep) {
Collection<String> keys = new ArrayList<>(((ParallelStep) step).getAnalysisEngineKeys());
keys.removeAll(aKeys);
if (keys.isEmpty()) {
mSequence.set(i, null);
- }
- else {
+ } else {
mSequence.set(i, new ParallelStep(keys));
}
}
@@ -227,7 +229,7 @@ public Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException {
// if next step is a CasMultiplier, set wasPassedToCasMultiplier to true for next time
if (stepContainsCasMultiplier(nextStep)) {
wasPassedToCasMultiplier = true;
- }
+ }
// now send the CAS to the next AE(s) in sequence.
return nextStep;
@@ -236,26 +238,24 @@ public Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException {
private boolean stepContainsCasMultiplier(Step nextStep) {
if (nextStep instanceof SimpleStep) {
AnalysisEngineMetaData md = (AnalysisEngineMetaData) getContext()
- .getAnalysisEngineMetaDataMap().get(((SimpleStep)nextStep).getAnalysisEngineKey());
- return md != null && md.getOperationalProperties() != null &&
- md.getOperationalProperties().getOutputsNewCASes();
- }
- else if (nextStep instanceof ParallelStep) {
- Iterator<String> iter = ((ParallelStep)nextStep).getAnalysisEngineKeys().iterator();
+ .getAnalysisEngineMetaDataMap().get(((SimpleStep) nextStep).getAnalysisEngineKey());
+ return md != null && md.getOperationalProperties() != null
+ && md.getOperationalProperties().getOutputsNewCASes();
+ } else if (nextStep instanceof ParallelStep) {
+ Iterator<String> iter = ((ParallelStep) nextStep).getAnalysisEngineKeys().iterator();
while (iter.hasNext()) {
- String key = (String)iter.next();
+ String key = (String) iter.next();
AnalysisEngineMetaData md = (AnalysisEngineMetaData) getContext()
- .getAnalysisEngineMetaDataMap().get(key);
- if (md != null && md.getOperationalProperties() != null &&
- md.getOperationalProperties().getOutputsNewCASes()) {
+ .getAnalysisEngineMetaDataMap().get(key);
+ if (md != null && md.getOperationalProperties() != null
+ && md.getOperationalProperties().getOutputsNewCASes()) {
return true;
- }
+ }
}
return false;
- }
- else {
+ } else {
return false;
- }
+ }
}
/*
@@ -264,38 +264,40 @@ public Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException {
* @see org.apache.uima.flow.CasFlow_ImplBase#newCasProduced(CAS, String)
*/
@Override
- public synchronized Flow newCasProduced(CAS newCas, String producedBy) throws AnalysisEngineProcessException {
+ public synchronized Flow newCasProduced(CAS newCas, String producedBy)
+ throws AnalysisEngineProcessException {
// record that the input CAS has been segmented (affects its subsequent flow)
casMultiplierProducedNewCas = true;
// start the new output CAS from the next node after the CasMultiplier that produced it
int i = 0;
- while (!stepContains((Step)mSequence.get(i), producedBy)) {
+ while (!stepContains((Step) mSequence.get(i), producedBy)) {
i++;
- }
+ }
return new FixedFlowObject(i + 1, true);
}
private boolean stepContains(Step step, String producedBy) {
if (step instanceof SimpleStep) {
- return ((SimpleStep)step).getAnalysisEngineKey().equals(producedBy);
- }
- else if (step instanceof ParallelStep) {
- Iterator<String> iter = ((ParallelStep)step).getAnalysisEngineKeys().iterator();
+ return ((SimpleStep) step).getAnalysisEngineKey().equals(producedBy);
+ } else if (step instanceof ParallelStep) {
+ Iterator<String> iter = ((ParallelStep) step).getAnalysisEngineKeys().iterator();
while (iter.hasNext()) {
- String key = (String)iter.next();
+ String key = (String) iter.next();
if (key.equals(producedBy)) {
return true;
}
}
return false;
- }
- else {
+ } else {
return false;
}
}
-
- /* (non-Javadoc)
- * @see org.apache.uima.flow.CasFlow_ImplBase#continueOnFailure(java.lang.String, java.lang.Exception)
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.flow.CasFlow_ImplBase#continueOnFailure(java.lang.String,
+ * java.lang.Exception)
*/
@Override
public boolean continueOnFailure(String failedAeKey, Exception failure) {
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/flow/WhiteboardFlowController.java b/uimaj-examples/src/main/java/org/apache/uima/examples/flow/WhiteboardFlowController.java
index c79e3ae..5a130fe 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/flow/WhiteboardFlowController.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/flow/WhiteboardFlowController.java
@@ -55,11 +55,12 @@ public class WhiteboardFlowController extends CasFlowController_ImplBase {
* UIMA logger instance we will use to log messages when flow decisions are made.
*/
private Logger mLogger;
-
-
-
- /* (non-Javadoc)
- * @see org.apache.uima.flow.FlowController_ImplBase#initialize(org.apache.uima.flow.FlowControllerContext)
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.flow.FlowController_ImplBase#initialize(org.apache.uima.flow.
+ * FlowControllerContext)
*/
@Override
public void initialize(FlowControllerContext aContext) throws ResourceInitializationException {
@@ -76,8 +77,8 @@ public class WhiteboardFlowController extends CasFlowController_ImplBase {
public Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException {
WhiteboardFlow flow = new WhiteboardFlow();
// No need to do the following as of release 2.3.0
- // because the framework automatically does this
-// flow.setCas(aCAS);
+ // because the framework automatically does this
+ // flow.setCas(aCAS);
return flow;
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/flow/WhiteboardFlowController2.java b/uimaj-examples/src/main/java/org/apache/uima/examples/flow/WhiteboardFlowController2.java
index a11639b..f82699d 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/flow/WhiteboardFlowController2.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/flow/WhiteboardFlowController2.java
@@ -69,20 +69,24 @@ public class WhiteboardFlowController2 extends CasFlowController_ImplBase {
* UIMA logger instance we will use to log messages when flow decisions are made.
*/
private Logger mLogger;
-
- /* (non-Javadoc)
- * @see org.apache.uima.flow.FlowController_ImplBase#initialize(org.apache.uima.flow.FlowControllerContext)
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.flow.FlowController_ImplBase#initialize(org.apache.uima.flow.
+ * FlowControllerContext)
*/
@Override
public void initialize(FlowControllerContext aContext) throws ResourceInitializationException {
super.initialize(aContext);
mLogger = aContext.getLogger();
}
-
+
/*
* (non-Javadoc)
*
- * @see org.apache.uima.flow.CasFlowController_ImplBase#typeSystemInit(org.apache.uima.cas.TypeSystem)
+ * @see
+ * org.apache.uima.flow.CasFlowController_ImplBase#typeSystemInit(org.apache.uima.cas.TypeSystem)
*/
@Override
public void typeSystemInit(TypeSystem aTypeSystem) throws AnalysisEngineProcessException {
@@ -128,8 +132,8 @@ public class WhiteboardFlowController2 extends CasFlowController_ImplBase {
public Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException {
WhiteboardFlow flow = new WhiteboardFlow();
// No need to do the following as of release 2.3.0
- // because the framework automatically does this
-// flow.setCas(aCAS);
+ // because the framework automatically does this
+ // flow.setCas(aCAS);
return flow;
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/Sentence.java b/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/Sentence.java
index fee58a6..c10a447 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/Sentence.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/Sentence.java
@@ -24,75 +24,83 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
/**
* The Class Sentence.
*/
public class Sentence extends Annotation {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.examples.tokenizer.Sentence";
-
- /** The Constant typeIndexID. */
- public static final int typeIndexID = JCasRegistry.register(Sentence.class);
- /** The Constant type. */
- public static final int type = typeIndexID;
+ /** The Constant typeIndexID. */
+ public static final int typeIndexID = JCasRegistry.register(Sentence.class);
+
+ /** The Constant type. */
+ public static final int type = typeIndexID;
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.jcas.tcas.Annotation#getTypeIndexID()
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
- /* (non-Javadoc)
- * @see org.apache.uima.jcas.tcas.Annotation#getTypeIndexID()
- */
- @Override
- public int getTypeIndexID() {
- return typeIndexID;
- }
+ /**
+ * Instantiates a new sentence.
+ */
+ // Never called. Disable default constructor
+ protected Sentence() {
+ }
- /**
- * Instantiates a new sentence.
- */
- // Never called. Disable default constructor
- protected Sentence() {
- }
+ /**
+ * Internal - Constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ */
+ public Sentence(TypeImpl type, CASImpl casImpl) {
+ super(type, casImpl);
+ }
- /**
- * Internal - Constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- */
- public Sentence(TypeImpl type, CASImpl casImpl) {
- super(type, casImpl);
- }
+ /**
+ * Instantiates a new sentence.
+ *
+ * @param jcas
+ * the jcas
+ */
+ public Sentence(JCas jcas) {
+ super(jcas);
+ }
- /**
- * Instantiates a new sentence.
- *
- * @param jcas the jcas
- */
- public Sentence(JCas jcas) {
- super(jcas);
- }
+ /**
+ * Instantiates a new sentence.
+ *
+ * @param jcas
+ * the jcas
+ * @param start
+ * the start
+ * @param end
+ * the end
+ */
+ public Sentence(JCas jcas, int start, int end) {
+ super(jcas, start, end);
+ }
- /**
- * Instantiates a new sentence.
- *
- * @param jcas the jcas
- * @param start the start
- * @param end the end
- */
- public Sentence(JCas jcas, int start, int end) {
- super(jcas, start, end);
- }
- /**
- * <!-- begin-user-doc -->
- * Write your own initialization here
- * <!-- end-user-doc -->
+ /**
+ * <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->
*
- * @generated modifiable
+ * @generated modifiable
*/
- private void readObject() {/*default - does nothing empty block */}
-
+ private void readObject() {
+ /* default - does nothing empty block */}
+
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/SimpleTokenAndSentenceAnnotator.java b/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/SimpleTokenAndSentenceAnnotator.java
index 0a6ad53..809130f 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/SimpleTokenAndSentenceAnnotator.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/SimpleTokenAndSentenceAnnotator.java
@@ -28,7 +28,6 @@ import org.apache.uima.analysis_engine.AnalysisEngineProcessException;
import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.tcas.Annotation;
-
/**
* An example annotator that annotates Tokens and Sentences.
*/
@@ -38,13 +37,16 @@ public class SimpleTokenAndSentenceAnnotator extends JCasAnnotator_ImplBase {
* The Class Maker.
*/
static abstract class Maker {
-
+
/**
* New annotation.
*
- * @param jcas the jcas
- * @param start the start
- * @param end the end
+ * @param jcas
+ * the jcas
+ * @param start
+ * the start
+ * @param end
+ * the end
* @return the annotation
*/
abstract Annotation newAnnotation(JCas jcas, int start, int end);
@@ -89,8 +91,11 @@ public class SimpleTokenAndSentenceAnnotator extends JCasAnnotator_ImplBase {
// *************************************************************
// * process *
- /* (non-Javadoc)
- * @see org.apache.uima.analysis_component.JCasAnnotator_ImplBase#process(org.apache.uima.jcas.JCas)
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.analysis_component.JCasAnnotator_ImplBase#process(org.apache.uima.jcas.JCas)
*/
// *************************************************************
@Override
@@ -108,14 +113,16 @@ public class SimpleTokenAndSentenceAnnotator extends JCasAnnotator_ImplBase {
/**
* Make annotations.
*
- * @param m the m
- * @param b the b
+ * @param m
+ * the m
+ * @param b
+ * the b
*/
// *************************************************************
void makeAnnotations(Maker m, BreakIterator b) {
b.setText(input);
- for (int end = b.next(), start = b.first(); end != BreakIterator.DONE; start = end, end = b
- .next()) {
+ for (int end = b.next(),
+ start = b.first(); end != BreakIterator.DONE; start = end, end = b.next()) {
// eliminate all-whitespace tokens
boolean isWhitespace = true;
for (int i = start; i < end; i++) {
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/Token.java b/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/Token.java
index 7ec6b10..0e95e9d 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/Token.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/tokenizer/Token.java
@@ -24,75 +24,83 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
/**
* The Class Token.
*/
public class Token extends Annotation {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.examples.tokenizer.Token";
-
- /** The Constant typeIndexID. */
- public static final int typeIndexID = JCasRegistry.register(Token.class);
- /** The Constant type. */
- public static final int type = typeIndexID;
+ /** The Constant typeIndexID. */
+ public static final int typeIndexID = JCasRegistry.register(Token.class);
+
+ /** The Constant type. */
+ public static final int type = typeIndexID;
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.jcas.tcas.Annotation#getTypeIndexID()
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
- /* (non-Javadoc)
- * @see org.apache.uima.jcas.tcas.Annotation#getTypeIndexID()
- */
- @Override
- public int getTypeIndexID() {
- return typeIndexID;
- }
+ /**
+ * Instantiates a new token.
+ */
+ // Never called. Disable default constructor
+ protected Token() {
+ }
- /**
- * Instantiates a new token.
- */
- // Never called. Disable default constructor
- protected Token() {
- }
+ /**
+ * Internal - Constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ */
+ public Token(TypeImpl type, CASImpl casImpl) {
+ super(type, casImpl);
+ }
- /**
- * Internal - Constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- */
- public Token(TypeImpl type, CASImpl casImpl) {
- super(type, casImpl);
- }
+ /**
+ * Instantiates a new token.
+ *
+ * @param jcas
+ * the jcas
+ */
+ public Token(JCas jcas) {
+ super(jcas);
+ }
- /**
- * Instantiates a new token.
- *
- * @param jcas the jcas
- */
- public Token(JCas jcas) {
- super(jcas);
- }
+ /**
+ * Instantiates a new token.
+ *
+ * @param jcas
+ * the jcas
+ * @param start
+ * the start
+ * @param end
+ * the end
+ */
+ public Token(JCas jcas, int start, int end) {
+ super(jcas, start, end);
+ }
- /**
- * Instantiates a new token.
- *
- * @param jcas the jcas
- * @param start the start
- * @param end the end
- */
- public Token(JCas jcas, int start, int end) {
- super(jcas, start, end);
- }
- /**
- * <!-- begin-user-doc -->
- * Write your own initialization here
- * <!-- end-user-doc -->
+ /**
+ * <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->
*
- * @generated modifiable
+ * @generated modifiable
*/
- private void readObject() {/*default - does nothing empty block */}
-
+ private void readObject() {
+ /* default - does nothing empty block */}
+
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/Ecore2UimaTypeSystem.java b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/Ecore2UimaTypeSystem.java
index 9ce04fa..9d01def 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/Ecore2UimaTypeSystem.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/Ecore2UimaTypeSystem.java
@@ -57,7 +57,6 @@ import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.emf.ecore.xmi.impl.XMIResourceFactoryImpl;
-
/**
* Converts an Ecore model to a UIMA TypeSystemDescription.
*/
@@ -161,10 +160,14 @@ public class Ecore2UimaTypeSystem {
/**
* E package 2 uima types.
*
- * @param aEPackage the a E package
- * @param aResultTypes the a result types
- * @param aOptions the a options
- * @throws URISyntaxException the URI syntax exception
+ * @param aEPackage
+ * the a E package
+ * @param aResultTypes
+ * the a result types
+ * @param aOptions
+ * the a options
+ * @throws URISyntaxException
+ * the URI syntax exception
*/
private static void ePackage2UimaTypes(EPackage aEPackage, List aResultTypes, Map aOptions)
throws URISyntaxException {
@@ -201,14 +204,18 @@ public class Ecore2UimaTypeSystem {
/**
* Eclass 2 uima type.
*
- * @param aEClass the a E class
- * @param aUimaNamespace the a uima namespace
- * @param aOptions the a options
+ * @param aEClass
+ * the a E class
+ * @param aUimaNamespace
+ * the a uima namespace
+ * @param aOptions
+ * the a options
* @return the type description
- * @throws URISyntaxException the URI syntax exception
+ * @throws URISyntaxException
+ * the URI syntax exception
*/
- private static TypeDescription eclass2UimaType(EClass aEClass, String aUimaNamespace, Map aOptions)
- throws URISyntaxException {
+ private static TypeDescription eclass2UimaType(EClass aEClass, String aUimaNamespace,
+ Map aOptions) throws URISyntaxException {
TypeDescription type = uimaFactory.createTypeDescription();
// set name
if (aUimaNamespace != null) {
@@ -252,9 +259,8 @@ public class Ecore2UimaTypeSystem {
// if there are multiple supertypes, the first one is arbitrarily chosen
// as the single supertype for the UIMA type. Other features are copied-down.
if (supertypes.size() > 1) {
- System.err.println("Warning: EClass " + aEClass.getName()
- + " defines multiple supertypes. " + "The UIMA supertype will be "
- + type.getSupertypeName()
+ System.err.println("Warning: EClass " + aEClass.getName() + " defines multiple supertypes. "
+ + "The UIMA supertype will be " + type.getSupertypeName()
+ "; features inherited from other supertypes will be copied down.");
}
}
@@ -295,8 +301,10 @@ public class Ecore2UimaTypeSystem {
/**
* Contains named element.
*
- * @param locallyDefinedFeatures the locally defined features
- * @param name the name
+ * @param locallyDefinedFeatures
+ * the locally defined features
+ * @param name
+ * the name
* @return true, if successful
*/
private static boolean containsNamedElement(EList locallyDefinedFeatures, String name) {
@@ -315,11 +323,15 @@ public class Ecore2UimaTypeSystem {
/**
* Eenum 2 uima type.
*
- * @param aEEnum the a E enum
- * @param aUimaNamespace the a uima namespace
- * @param aOptions the a options
+ * @param aEEnum
+ * the a E enum
+ * @param aUimaNamespace
+ * the a uima namespace
+ * @param aOptions
+ * the a options
* @return the type description
- * @throws URISyntaxException the URI syntax exception
+ * @throws URISyntaxException
+ * the URI syntax exception
*/
private static TypeDescription eenum2UimaType(EEnum aEEnum, String aUimaNamespace, Map aOptions)
throws URISyntaxException {
@@ -356,10 +368,13 @@ public class Ecore2UimaTypeSystem {
/**
* E structural feature 2 uima feature.
*
- * @param aStructuralFeature the a structural feature
- * @param aOptions the a options
+ * @param aStructuralFeature
+ * the a structural feature
+ * @param aOptions
+ * the a options
* @return -
- * @throws URISyntaxException the URI syntax exception
+ * @throws URISyntaxException
+ * the URI syntax exception
*/
private static FeatureDescription eStructuralFeature2UimaFeature(
EStructuralFeature aStructuralFeature, Map aOptions) throws URISyntaxException {
@@ -419,7 +434,8 @@ public class Ecore2UimaTypeSystem {
/**
* Checks if is array or list.
*
- * @param rangeTypeName the range type name
+ * @param rangeTypeName
+ * the range type name
* @return true, if is array or list
*/
private static boolean isArrayOrList(String rangeTypeName) {
@@ -442,11 +458,15 @@ public class Ecore2UimaTypeSystem {
/**
* Gets the uima type name.
*
- * @param aEcoreType the a ecore type
- * @param aMultiValued the a multi valued
- * @param aOptions the a options
+ * @param aEcoreType
+ * the a ecore type
+ * @param aMultiValued
+ * the a multi valued
+ * @param aOptions
+ * the a options
* @return the uima type name
- * @throws URISyntaxException the URI syntax exception
+ * @throws URISyntaxException
+ * the URI syntax exception
*/
private static String getUimaTypeName(EClassifier aEcoreType, boolean aMultiValued, Map aOptions)
throws URISyntaxException {
@@ -473,10 +493,9 @@ public class Ecore2UimaTypeSystem {
if (epackage != null) {
String uimaNamespace = namespaceUri2UimaNamespace(epackage.getNsURI());
if (uimaNamespace != null) {
- return uimaNamespace + '.' + aEcoreType.getName();
- }
- else {
- return aEcoreType.getName();
+ return uimaNamespace + '.' + aEcoreType.getName();
+ } else {
+ return aEcoreType.getName();
}
} else {
return aEcoreType.getName();
@@ -484,8 +503,9 @@ public class Ecore2UimaTypeSystem {
} else // primitive type
{
if (aEcoreType.equals(EcorePackage.eINSTANCE.getEInt())) {
- return aMultiValued ? (useUimaLists ? CAS.TYPE_NAME_INTEGER_LIST
- : CAS.TYPE_NAME_INTEGER_ARRAY) : CAS.TYPE_NAME_INTEGER;
+ return aMultiValued
+ ? (useUimaLists ? CAS.TYPE_NAME_INTEGER_LIST : CAS.TYPE_NAME_INTEGER_ARRAY)
+ : CAS.TYPE_NAME_INTEGER;
} else if (aEcoreType.equals(EcorePackage.eINSTANCE.getEShort())) {
return aMultiValued ? CAS.TYPE_NAME_SHORT_ARRAY : CAS.TYPE_NAME_SHORT;
} else if (aEcoreType.equals(EcorePackage.eINSTANCE.getELong())) {
@@ -511,8 +531,9 @@ public class Ecore2UimaTypeSystem {
System.err.println("Warning: unknown EDataType " + aEcoreType.getName()
+ " being mapped to uima.cas.String.");
}
- return aMultiValued ? (useUimaLists ? CAS.TYPE_NAME_STRING_LIST
- : CAS.TYPE_NAME_STRING_ARRAY) : CAS.TYPE_NAME_STRING;
+ return aMultiValued
+ ? (useUimaLists ? CAS.TYPE_NAME_STRING_LIST : CAS.TYPE_NAME_STRING_ARRAY)
+ : CAS.TYPE_NAME_STRING;
}
}
}
@@ -520,9 +541,11 @@ public class Ecore2UimaTypeSystem {
/**
* Namespace uri 2 uima namespace.
*
- * @param nsUri the ns uri
+ * @param nsUri
+ * the ns uri
* @return the string
- * @throws URISyntaxException the URI syntax exception
+ * @throws URISyntaxException
+ * the URI syntax exception
*/
private static String namespaceUri2UimaNamespace(String nsUri) throws URISyntaxException {
// Check for the special "no namespace URI", which maps to the null UIMA namespace
@@ -540,10 +563,10 @@ public class Ecore2UimaTypeSystem {
} else {
// The URI is a URL
while (uimaNs.startsWith("/")) {
- uimaNs = uimaNs.substring(1);
+ uimaNs = uimaNs.substring(1);
}
if (uimaNs.endsWith(".ecore")) {
- uimaNs = uimaNs.substring(0, uimaNs.length() - 6);
+ uimaNs = uimaNs.substring(0, uimaNs.length() - 6);
}
uimaNs = uimaNs.replace('/', '.');
}
@@ -555,8 +578,10 @@ public class Ecore2UimaTypeSystem {
* Main program. Takes two arguments: the filename of an input .ecore file and the filename of the
* UIMA TypeSystem file to generate.
*
- * @param args the arguments
- * @throws Exception the exception
+ * @param args
+ * the arguments
+ * @throws Exception
+ * the exception
*/
public static void main(String[] args) throws Exception {
if (args.length != 2) {
@@ -581,8 +606,8 @@ public class Ecore2UimaTypeSystem {
try {
CasCreationUtils.createCas(tsDesc, null, new FsIndexDescription[0]);
} catch (Exception e) {
- System.err
- .println("Warning: CAS could not be created from the output type system. The following problem occurred:");
+ System.err.println(
+ "Warning: CAS could not be created from the output type system. The following problem occurred:");
System.err.println(e.getMessage());
}
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/UimaTypeSystem2Ecore.java b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/UimaTypeSystem2Ecore.java
index cb6c8f3..3ee6b01 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/UimaTypeSystem2Ecore.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/UimaTypeSystem2Ecore.java
@@ -54,38 +54,46 @@ import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
import org.eclipse.emf.ecore.xmi.impl.XMIResourceFactoryImpl;
-
/**
* Converts a UIMA TypeSystemDescription to an Ecore model.
*/
public class UimaTypeSystem2Ecore {
-
+
/**
* Converts a UIMA TypeSystem descriptor to an Ecore model.
*
- * @param aUimaTypeSystemFilePath file path to UIMA TypeSystem descritpor
- * @param aOutputResource An EMF Resource to be populated with the Ecore model
- * @param aOptions a Map defining options for the conversion. Valid keys for this map are defined as
+ * @param aUimaTypeSystemFilePath
+ * file path to UIMA TypeSystem descritpor
+ * @param aOutputResource
+ * An EMF Resource to be populated with the Ecore model
+ * @param aOptions
+ * a Map defining options for the conversion. Valid keys for this map are defined as
* constants on this class.
- * @throws InvalidXMLException if the TypeSystem descriptor, or one of its imports, is not valid or if there are
+ * @throws InvalidXMLException
+ * if the TypeSystem descriptor, or one of its imports, is not valid or if there are
* duplicate, inconsistent definitions of the same type.
- * @throws IOException if an failure occur while reading the descriptor file
+ * @throws IOException
+ * if an failure occur while reading the descriptor file
*/
public static void uimaTypeSystem2Ecore(String aUimaTypeSystemFilePath, Resource aOutputResource,
Map aOptions) throws InvalidXMLException, IOException {
- TypeSystemDescription tsDesc = UIMAFramework.getXMLParser().parseTypeSystemDescription(
- new XMLInputSource(aUimaTypeSystemFilePath));
+ TypeSystemDescription tsDesc = UIMAFramework.getXMLParser()
+ .parseTypeSystemDescription(new XMLInputSource(aUimaTypeSystemFilePath));
uimaTypeSystem2Ecore(tsDesc, aOutputResource, aOptions);
}
/**
* Converts a UIMA TypeSystemDescription to an Ecore model.
*
- * @param aTypeSystem UIMA TypeSystemDescription object to convert
- * @param aOutputResource An EMF Resource to be populated with the Ecore model
- * @param aOptions a Map defining options for the conversion. Valid keys for this map are defined as
+ * @param aTypeSystem
+ * UIMA TypeSystemDescription object to convert
+ * @param aOutputResource
+ * An EMF Resource to be populated with the Ecore model
+ * @param aOptions
+ * a Map defining options for the conversion. Valid keys for this map are defined as
* constants on this class.
- * @throws InvalidXMLException if the TypeSystem descriptor imports another descriptor that could not be
+ * @throws InvalidXMLException
+ * if the TypeSystem descriptor imports another descriptor that could not be
* successfully parsed, or if there are duplicate, inconsistent definitions of the same
* type.
*/
@@ -97,14 +105,19 @@ public class UimaTypeSystem2Ecore {
/**
* Converts a UIMA TypeSystemDescription to an Ecore model.
*
- * @param aTypeSystem UIMA TypeSystemDescription object to convert
- * @param aOutputResource An EMF Resource to be populated with the Ecore model
- * @param aOptions a Map defining options for the conversion. Valid keys for this map are defined as
+ * @param aTypeSystem
+ * UIMA TypeSystemDescription object to convert
+ * @param aOutputResource
+ * An EMF Resource to be populated with the Ecore model
+ * @param aOptions
+ * a Map defining options for the conversion. Valid keys for this map are defined as
* constants on this class.
- * @param aSchemaLocationMap optional parameter - if non-null, this map will be populated with (Namespace URI,
+ * @param aSchemaLocationMap
+ * optional parameter - if non-null, this map will be populated with (Namespace URI,
* Schema Location) pairs, suitable for inclusion in the "schemaLocation" attribute of
* XMI instance documents.
- * @throws InvalidXMLException the invalid XML exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
*/
public static void uimaTypeSystem2Ecore(TypeSystemDescription aTypeSystem,
Resource aOutputResource, Map aOptions, Map aSchemaLocationMap)
@@ -123,7 +136,8 @@ public class UimaTypeSystem2Ecore {
// merge, to eliminate duplicate type definitions
try {
- aTypeSystem = CasCreationUtils.mergeTypeSystems(Arrays.asList(new TypeSystemDescription[] { aTypeSystem }));
+ aTypeSystem = CasCreationUtils
+ .mergeTypeSystems(Arrays.asList(new TypeSystemDescription[] { aTypeSystem }));
} catch (ResourceInitializationException e) {
throw new InvalidXMLException(e);
}
@@ -173,7 +187,7 @@ public class UimaTypeSystem2Ecore {
String supertypeName = type.getSupertypeName();
EClassifier superclass = lookupEClassifierForType(supertypeName); // creates EClass if not
// already existing
- eclass.getESuperTypes().add((EClass)superclass);
+ eclass.getESuperTypes().add((EClass) superclass);
// set features
FeatureDescription[] features = type.getFeatures();
@@ -201,8 +215,10 @@ public class UimaTypeSystem2Ecore {
/**
* Load uima builtins ecore.
*
- * @param resourceSet the resource set
- * @param aSchemaLocationMap the a schema location map
+ * @param resourceSet
+ * the resource set
+ * @param aSchemaLocationMap
+ * the a schema location map
* @return the resource
*/
private static Resource loadUimaBuiltinsEcore(ResourceSet resourceSet, Map aSchemaLocationMap) {
@@ -233,8 +249,10 @@ public class UimaTypeSystem2Ecore {
/**
* Uima type 2 E classifier.
*
- * @param aType the a type
- * @param aOptions the a options
+ * @param aType
+ * the a type
+ * @param aOptions
+ * the a options
* @return the e classifier
*/
private static EClassifier uimaType2EClassifier(TypeDescription aType, Map aOptions) {
@@ -292,15 +310,17 @@ public class UimaTypeSystem2Ecore {
/**
* Uima feature 2 E structural feature.
*
- * @param aFeature the a feature
- * @param aOptions the a options
+ * @param aFeature
+ * the a feature
+ * @param aOptions
+ * the a options
* @return the e structural feature
*/
private static EStructuralFeature uimaFeature2EStructuralFeature(FeatureDescription aFeature,
Map aOptions) {
String range = aFeature.getRangeTypeName();
- boolean multiRefAllowed = aFeature.getMultipleReferencesAllowed() == null ? false : aFeature
- .getMultipleReferencesAllowed();
+ boolean multiRefAllowed = aFeature.getMultipleReferencesAllowed() == null ? false
+ : aFeature.getMultipleReferencesAllowed();
EStructuralFeature efeat;
// map primitive types to EAttributes
if (CAS.TYPE_NAME_STRING.equals(range)) {
@@ -334,9 +354,8 @@ public class UimaTypeSystem2Ecore {
efeat = EcoreFactory.eINSTANCE.createEAttribute();
efeat.setEType(EcorePackage.eINSTANCE.getEString());
efeat.setUpperBound(-1);
- } else if ((CAS.TYPE_NAME_INTEGER_ARRAY.equals(range) || CAS.TYPE_NAME_INTEGER_LIST
- .equals(range))
- && !multiRefAllowed) {
+ } else if ((CAS.TYPE_NAME_INTEGER_ARRAY.equals(range)
+ || CAS.TYPE_NAME_INTEGER_LIST.equals(range)) && !multiRefAllowed) {
efeat = EcoreFactory.eINSTANCE.createEAttribute();
efeat.setEType(EcorePackage.eINSTANCE.getEInt());
efeat.setUpperBound(-1);
@@ -420,7 +439,8 @@ public class UimaTypeSystem2Ecore {
/**
* Lookup E classifier for type.
*
- * @param aFullTypeName the a full type name
+ * @param aFullTypeName
+ * the a full type name
* @return the e classifier
*/
private static EClassifier lookupEClassifierForType(String aFullTypeName) {
@@ -491,7 +511,8 @@ public class UimaTypeSystem2Ecore {
/**
* Uima namespace 2 namespace uri.
*
- * @param uimaNamespace the uima namespace
+ * @param uimaNamespace
+ * the uima namespace
* @return the string
*/
private static String uimaNamespace2NamespaceUri(String uimaNamespace) {
@@ -508,8 +529,10 @@ public class UimaTypeSystem2Ecore {
* Main program. Takes two arguments: the filename of an input TypeSystem descriptor file and the
* filename of the Ecore/XMI file to generate.
*
- * @param args the arguments
- * @throws Exception the exception
+ * @param args
+ * the arguments
+ * @throws Exception
+ * the exception
*/
public static void main(String[] args) throws Exception {
// register default resource factory
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiCollectionReader.java b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiCollectionReader.java
index 87ad67f..b4ce927 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiCollectionReader.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiCollectionReader.java
@@ -44,15 +44,15 @@ public class XmiCollectionReader extends CollectionReader_ImplBase {
* files.
*/
public static final String PARAM_INPUTDIR = "InputDirectory";
-
+
/**
- * Name of the configuration parameter that must be set to indicate if the
- * execution fails if an encountered type is unknown
+ * Name of the configuration parameter that must be set to indicate if the execution fails if an
+ * encountered type is unknown
*/
public static final String PARAM_FAILUNKNOWN = "FailOnUnknownType";
private Boolean mFailOnUnknownType;
-
+
private ArrayList mFiles;
private int mCurrentIndex;
@@ -62,10 +62,10 @@ public class XmiCollectionReader extends CollectionReader_ImplBase {
*/
@Override
public void initialize() throws ResourceInitializationException {
- mFailOnUnknownType = (Boolean) getConfigParameterValue(PARAM_FAILUNKNOWN);
- if (null == mFailOnUnknownType) {
- mFailOnUnknownType = true; // default to true if not specified
- }
+ mFailOnUnknownType = (Boolean) getConfigParameterValue(PARAM_FAILUNKNOWN);
+ if (null == mFailOnUnknownType) {
+ mFailOnUnknownType = true; // default to true if not specified
+ }
File directory = new File(((String) getConfigParameterValue(PARAM_INPUTDIR)).trim());
mCurrentIndex = 0;
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiEcoreCasConsumer.java b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiEcoreCasConsumer.java
index 94cc960..f19eed3 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiEcoreCasConsumer.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiEcoreCasConsumer.java
@@ -88,8 +88,8 @@ public class XmiEcoreCasConsumer extends CasConsumer_ImplBase {
if (!mOutputDir.exists()) {
mOutputDir.mkdirs();
}
- writeEcoreTypeSystem = Boolean.TRUE.equals(getUimaContext().getConfigParameterValue(
- PARAM_WRITE_ECORE_TYPESYSTEM));
+ writeEcoreTypeSystem = Boolean.TRUE
+ .equals(getUimaContext().getConfigParameterValue(PARAM_WRITE_ECORE_TYPESYSTEM));
}
/**
@@ -153,30 +153,34 @@ public class XmiEcoreCasConsumer extends CasConsumer_ImplBase {
* CAS to serialize
* @param name
* output file
- * @throws SAXException -
- * @throws Exception -
+ * @throws SAXException
+ * -
+ * @throws Exception
+ * -
*
- * @throws ResourceProcessException -
+ * @throws ResourceProcessException
+ * -
*/
- private void writeXmi(CAS aCas, File name, String modelFileName) throws IOException, SAXException {
+ private void writeXmi(CAS aCas, File name, String modelFileName)
+ throws IOException, SAXException {
FileOutputStream out = null;
try {
// Generate E-core for type system, but only once
if (writeEcoreTypeSystem && !isModelGenerated) {
- TypeSystemDescription tsDesc = TypeSystemUtil.typeSystem2TypeSystemDescription(aCas
- .getTypeSystem());
+ TypeSystemDescription tsDesc = TypeSystemUtil
+ .typeSystem2TypeSystemDescription(aCas.getTypeSystem());
// register default resource factory
Resource.Factory.Registry.INSTANCE.getExtensionToFactoryMap().put("*",
new XMIResourceFactoryImpl());
ResourceSet resourceSet = new ResourceSetImpl();
- URI outputURI = URI.createFileURI(new File(mOutputDir, "typesystem.ecore")
- .getAbsolutePath());
+ URI outputURI = URI
+ .createFileURI(new File(mOutputDir, "typesystem.ecore").getAbsolutePath());
Resource outputResource = resourceSet.createResource(outputURI);
schemaLocationMap = new HashMap();
try {
- UimaTypeSystem2Ecore
- .uimaTypeSystem2Ecore(tsDesc, outputResource, null, schemaLocationMap);
+ UimaTypeSystem2Ecore.uimaTypeSystem2Ecore(tsDesc, outputResource, null,
+ schemaLocationMap);
} catch (InvalidXMLException e) {
// this should not happen. TypeSystemUtil.typeSystem2TypeSystemDescription
// should never produce an invalid TypeSystemDescription!
diff --git a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiWriterCasConsumer.java b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiWriterCasConsumer.java
index 0e19e0f..1913d90 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiWriterCasConsumer.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/examples/xmi/XmiWriterCasConsumer.java
@@ -109,7 +109,7 @@ public class XmiWriterCasConsumer extends CasConsumer_ImplBase {
}
}
if (outFile == null) {
- outFile = new File(mOutputDir, "doc" + mDocNum++ + ".xmi");
+ outFile = new File(mOutputDir, "doc" + mDocNum++ + ".xmi");
}
// serialize XCAS and write to output file
try {
@@ -128,12 +128,16 @@ public class XmiWriterCasConsumer extends CasConsumer_ImplBase {
* CAS to serialize
* @param name
* output file
- * @throws SAXException -
- * @throws Exception -
+ * @throws SAXException
+ * -
+ * @throws Exception
+ * -
*
- * @throws ResourceProcessException -
+ * @throws ResourceProcessException
+ * -
*/
- private void writeXmi(CAS aCas, File name, String modelFileName) throws IOException, SAXException {
+ private void writeXmi(CAS aCas, File name, String modelFileName)
+ throws IOException, SAXException {
try (OutputStream out = new FileOutputStream(name)) {
// write XMI
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/DateAnnot.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/DateAnnot.java
index 948c071..8a51d21 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/DateAnnot.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/DateAnnot.java
@@ -23,94 +23,104 @@ import org.apache.uima.cas.impl.TypeImpl;
import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
-
-/**
- * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017
- * XML source: C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
- * @generated */
+/**
+ * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017 XML source:
+ * C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
+ *
+ * @generated
+ */
public class DateAnnot extends DateTimeAnnot {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.tutorial.DateAnnot";
-
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(DateAnnot.class);
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(DateAnnot.class);
+
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
+
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /**
+ /**
* Never called. Disable default constructor
*
* @generated
*/
- protected DateAnnot() {/* intentionally empty block */}
-
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public DateAnnot(TypeImpl type, CASImpl casImpl) {
+ protected DateAnnot() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public DateAnnot(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /**
- * Instantiates a new date annot.
- *
- * @param jcas the jcas
- * @generated
- */
- public DateAnnot(JCas jcas) {
- super(jcas);
- readObject();
- }
+ /**
+ * Instantiates a new date annot.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public DateAnnot(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
- /**
- * Instantiates a new date annot.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public DateAnnot(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
+ /**
+ * Instantiates a new date annot.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public DateAnnot(JCas jcas, int begin, int end) {
+ super(jcas);
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
- /**
+ /**
* <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->*
- * @generated modifiable
+ *
+ * @generated modifiable
*/
- private void readObject() {
- }
+ private void readObject() {
+ }
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/DateTimeAnnot.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/DateTimeAnnot.java
index 0181bc4..89338e7 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/DateTimeAnnot.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/DateTimeAnnot.java
@@ -28,127 +28,139 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
-/**
- * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017
- * XML source: C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
- * @generated */
+/**
+ * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017 XML source:
+ * C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
+ *
+ * @generated
+ */
public class DateTimeAnnot extends Annotation {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.tutorial.DateTimeAnnot";
-
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(DateTimeAnnot.class);
-
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
-
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /* *******************
- * Feature Offsets *
- * *******************/
-
- public final static String _FeatName_shortDateString = "shortDateString";
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(DateTimeAnnot.class);
+
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
+
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
+
+ /*
+ * ******************* Feature Offsets *
+ *******************/
+
+ public final static String _FeatName_shortDateString = "shortDateString";
/* Feature Adjusted Offsets */
- private final static CallSite _FC_shortDateString = TypeSystemImpl.createCallSite(DateTimeAnnot.class, "shortDateString");
+ private final static CallSite _FC_shortDateString = TypeSystemImpl
+ .createCallSite(DateTimeAnnot.class, "shortDateString");
private final static MethodHandle _FH_shortDateString = _FC_shortDateString.dynamicInvoker();
-
/**
* Never called. Disable default constructor
*
* @generated
*/
- protected DateTimeAnnot() {/* intentionally empty block */}
-
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public DateTimeAnnot(TypeImpl type, CASImpl casImpl) {
+ protected DateTimeAnnot() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public DateTimeAnnot(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /**
- * Instantiates a new date time annot.
- *
- * @param jcas the jcas
- * @generated
- */
- public DateTimeAnnot(JCas jcas) {
+
+ /**
+ * Instantiates a new date time annot.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public DateTimeAnnot(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
+
+ /**
+ * Instantiates a new date time annot.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public DateTimeAnnot(JCas jcas, int begin, int end) {
super(jcas);
- readObject();
- }
-
-
- /**
- * Instantiates a new date time annot.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public DateTimeAnnot(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
-
- /**
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
+
+ /**
* <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->*
- * @generated modifiable
+ *
+ * @generated modifiable
+ */
+ private void readObject() {
+ }
+
+ // *--------------*
+ // * Feature: shortDateString
+ /**
+ * getter for shortDateString - gets.
+ *
+ * @return the short date string
+ * @generated
*/
- private void readObject() {
- }
-
- // *--------------*
- // * Feature: shortDateString
- /**
- * getter for shortDateString - gets.
- *
- * @return the short date string
- * @generated
- */
- public String getShortDateString() { return _getStringValueNc(wrapGetIntCatchException(_FH_shortDateString));}
-
- /**
- * setter for shortDateString - sets.
- *
- * @param v the new short date string
- * @generated
- */
- public void setShortDateString(String v) {
+ public String getShortDateString() {
+ return _getStringValueNc(wrapGetIntCatchException(_FH_shortDateString));
+ }
+
+ /**
+ * setter for shortDateString - sets.
+ *
+ * @param v
+ * the new short date string
+ * @generated
+ */
+ public void setShortDateString(String v) {
_setStringValueNfc(wrapGetIntCatchException(_FH_shortDateString), v);
- }
-
}
+
+}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/Meeting.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/Meeting.java
index 28f4197..7089e0f 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/Meeting.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/Meeting.java
@@ -28,229 +28,255 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
-/**
- * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017
- * XML source: C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
- * @generated */
+/**
+ * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017 XML source:
+ * C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
+ *
+ * @generated
+ */
public class Meeting extends Annotation {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.tutorial.Meeting";
-
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(Meeting.class);
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(Meeting.class);
+
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
+
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
+
+ /*
+ * ******************* Feature Offsets *
+ *******************/
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /* *******************
- * Feature Offsets *
- * *******************/
-
public final static String _FeatName_room = "room";
public final static String _FeatName_date = "date";
public final static String _FeatName_startTime = "startTime";
public final static String _FeatName_endTime = "endTime";
-
/* Feature Adjusted Offsets */
private final static CallSite _FC_room = TypeSystemImpl.createCallSite(Meeting.class, "room");
private final static MethodHandle _FH_room = _FC_room.dynamicInvoker();
private final static CallSite _FC_date = TypeSystemImpl.createCallSite(Meeting.class, "date");
private final static MethodHandle _FH_date = _FC_date.dynamicInvoker();
- private final static CallSite _FC_startTime = TypeSystemImpl.createCallSite(Meeting.class, "startTime");
+ private final static CallSite _FC_startTime = TypeSystemImpl.createCallSite(Meeting.class,
+ "startTime");
private final static MethodHandle _FH_startTime = _FC_startTime.dynamicInvoker();
- private final static CallSite _FC_endTime = TypeSystemImpl.createCallSite(Meeting.class, "endTime");
+ private final static CallSite _FC_endTime = TypeSystemImpl.createCallSite(Meeting.class,
+ "endTime");
private final static MethodHandle _FH_endTime = _FC_endTime.dynamicInvoker();
-
-
- /**
+ /**
* Never called. Disable default constructor
*
* @generated
*/
- protected Meeting() {/* intentionally empty block */}
-
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public Meeting(TypeImpl type, CASImpl casImpl) {
+ protected Meeting() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public Meeting(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /**
- * Instantiates a new meeting.
- *
- * @param jcas the jcas
- * @generated
- */
- public Meeting(JCas jcas) {
- super(jcas);
- readObject();
- }
+ /**
+ * Instantiates a new meeting.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public Meeting(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
- /**
- * Instantiates a new meeting.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public Meeting(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
+ /**
+ * Instantiates a new meeting.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public Meeting(JCas jcas, int begin, int end) {
+ super(jcas);
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
- /**
+ /**
* <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->*
- * @generated modifiable
+ *
+ * @generated modifiable
+ */
+ private void readObject() {
+ }
+
+ // *--------------*
+ // * Feature: room
+ /**
+ * getter for room - gets.
+ *
+ * @return the room
+ * @generated
*/
- private void readObject() {
- }
+ public RoomNumber getRoom() {
+ return (RoomNumber) (_getFeatureValueNc(wrapGetIntCatchException(_FH_room)));
+ }
- // *--------------*
- // * Feature: room
- /**
- * getter for room - gets.
- *
- * @return the room
- * @generated
- */
- public RoomNumber getRoom() { return (RoomNumber)(_getFeatureValueNc(wrapGetIntCatchException(_FH_room)));}
-
- /**
- * setter for room - sets.
- *
- * @param v the new room
- * @generated
- */
- public void setRoom(RoomNumber v) {
+ /**
+ * setter for room - sets.
+ *
+ * @param v
+ * the new room
+ * @generated
+ */
+ public void setRoom(RoomNumber v) {
_setFeatureValueNcWj(wrapGetIntCatchException(_FH_room), v);
- }
-
-
-
- // *--------------*
- // * Feature: date
- /**
- * getter for date - gets.
- *
- * @return the date
- * @generated
- */
- public DateAnnot getDate() { return (DateAnnot)(_getFeatureValueNc(wrapGetIntCatchException(_FH_date)));}
-
- /**
- * setter for date - sets.
- *
- * @param v the new date
- * @generated
- */
- public void setDate(DateAnnot v) {
+ }
+
+ // *--------------*
+ // * Feature: date
+ /**
+ * getter for date - gets.
+ *
+ * @return the date
+ * @generated
+ */
+ public DateAnnot getDate() {
+ return (DateAnnot) (_getFeatureValueNc(wrapGetIntCatchException(_FH_date)));
+ }
+
+ /**
+ * setter for date - sets.
+ *
+ * @param v
+ * the new date
+ * @generated
+ */
+ public void setDate(DateAnnot v) {
_setFeatureValueNcWj(wrapGetIntCatchException(_FH_date), v);
- }
-
-
-
- // *--------------*
- // * Feature: startTime
- /**
- * getter for startTime - gets.
- *
- * @return the start time
- * @generated
- */
- public TimeAnnot getStartTime() { return (TimeAnnot)(_getFeatureValueNc(wrapGetIntCatchException(_FH_startTime)));}
-
- /**
- * setter for startTime - sets.
- *
- * @param v the new start time
- * @generated
- */
- public void setStartTime(TimeAnnot v) {
+ }
+
+ // *--------------*
+ // * Feature: startTime
+ /**
+ * getter for startTime - gets.
+ *
+ * @return the start time
+ * @generated
+ */
+ public TimeAnnot getStartTime() {
+ return (TimeAnnot) (_getFeatureValueNc(wrapGetIntCatchException(_FH_startTime)));
+ }
+
+ /**
+ * setter for startTime - sets.
+ *
+ * @param v
+ * the new start time
+ * @generated
+ */
+ public void setStartTime(TimeAnnot v) {
_setFeatureValueNcWj(wrapGetIntCatchException(_FH_startTime), v);
- }
-
-
-
- // *--------------*
- // * Feature: endTime
- /**
- * getter for endTime - gets.
- *
- * @return the end time
- * @generated
- */
- public TimeAnnot getEndTime() { return (TimeAnnot)(_getFeatureValueNc(wrapGetIntCatchException(_FH_endTime)));}
-
- /**
- * setter for endTime - sets.
- *
- * @param v the new end time
- * @generated
- */
- public void setEndTime(TimeAnnot v) {
+ }
+
+ // *--------------*
+ // * Feature: endTime
+ /**
+ * getter for endTime - gets.
+ *
+ * @return the end time
+ * @generated
+ */
+ public TimeAnnot getEndTime() {
+ return (TimeAnnot) (_getFeatureValueNc(wrapGetIntCatchException(_FH_endTime)));
+ }
+
+ /**
+ * setter for endTime - sets.
+ *
+ * @param v
+ * the new end time
+ * @generated
+ */
+ public void setEndTime(TimeAnnot v) {
_setFeatureValueNcWj(wrapGetIntCatchException(_FH_endTime), v);
- }
-
- /**
- * Custom constructor taking all parameters.
- *
- * @param jcas the jcas
- * @param start the start
- * @param end the end
- * @param room the room
- * @param date the date
- * @param startTime the start time
- * @param endTime the end time
- */
- public Meeting(JCas jcas, int start, int end, RoomNumber room, DateAnnot date, TimeAnnot startTime, TimeAnnot endTime) {
- this(jcas, start, end);
- setRoom(room);
- setDate(date);
- setStartTime(startTime);
- setEndTime(endTime);
- }
+ }
+
+ /**
+ * Custom constructor taking all parameters.
+ *
+ * @param jcas
+ * the jcas
+ * @param start
+ * the start
+ * @param end
+ * the end
+ * @param room
+ * the room
+ * @param date
+ * the date
+ * @param startTime
+ * the start time
+ * @param endTime
+ * the end time
+ */
+ public Meeting(JCas jcas, int start, int end, RoomNumber room, DateAnnot date,
+ TimeAnnot startTime, TimeAnnot endTime) {
+ this(jcas, start, end);
+ setRoom(room);
+ setDate(date);
+ setStartTime(startTime);
+ setEndTime(endTime);
+ }
- /* (non-Javadoc)
- * @see org.apache.uima.cas.impl.FeatureStructureImplC#toString()
- */
- @Override
- public String toString() {
- return "Meeting in " + getRoom().getCoveredText() + " on " + getDate().getCoveredText() + ", " + getStartTime().getCoveredText() + " - " + getEndTime().getCoveredText();
- }
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.cas.impl.FeatureStructureImplC#toString()
+ */
+ @Override
+ public String toString() {
+ return "Meeting in " + getRoom().getCoveredText() + " on " + getDate().getCoveredText() + ", "
+ + getStartTime().getCoveredText() + " - " + getEndTime().getCoveredText();
+ }
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/RoomNumber.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/RoomNumber.java
index 82cf3c8..77df5ef 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/RoomNumber.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/RoomNumber.java
@@ -28,126 +28,139 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
-/**
- * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017
- * XML source: C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
- * @generated */
+/**
+ * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017 XML source:
+ * C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
+ *
+ * @generated
+ */
public class RoomNumber extends Annotation {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.tutorial.RoomNumber";
-
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(RoomNumber.class);
-
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
-
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /* *******************
- * Feature Offsets *
- * *******************/
-
- public final static String _FeatName_building = "building";
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(RoomNumber.class);
+
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
+
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
+
+ /*
+ * ******************* Feature Offsets *
+ *******************/
+
+ public final static String _FeatName_building = "building";
/* Feature Adjusted Offsets */
- private final static CallSite _FC_building = TypeSystemImpl.createCallSite(RoomNumber.class, "building");
+ private final static CallSite _FC_building = TypeSystemImpl.createCallSite(RoomNumber.class,
+ "building");
private final static MethodHandle _FH_building = _FC_building.dynamicInvoker();
- /**
+ /**
* Never called. Disable default constructor
*
* @generated
*/
- protected RoomNumber() {/* intentionally empty block */}
-
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public RoomNumber(TypeImpl type, CASImpl casImpl) {
+ protected RoomNumber() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public RoomNumber(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /**
- * Instantiates a new room number.
- *
- * @param jcas the jcas
- * @generated
- */
- public RoomNumber(JCas jcas) {
+
+ /**
+ * Instantiates a new room number.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public RoomNumber(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
+
+ /**
+ * Instantiates a new room number.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public RoomNumber(JCas jcas, int begin, int end) {
super(jcas);
- readObject();
- }
-
-
- /**
- * Instantiates a new room number.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public RoomNumber(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
-
- /**
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
+
+ /**
* <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->*
- * @generated modifiable
+ *
+ * @generated modifiable
*/
- private void readObject() {
- }
-
- // *--------------*
- // * Feature: building
- /**
- * getter for building - gets Building containing this room.
- *
- * @return the building
- * @generated
- */
- public String getBuilding() { return _getStringValueNc(wrapGetIntCatchException(_FH_building));}
-
- /**
- * setter for building - sets Building containing this room.
- *
- * @param v the new building
- * @generated
- */
- public void setBuilding(String v) {
+ private void readObject() {
+ }
+
+ // *--------------*
+ // * Feature: building
+ /**
+ * getter for building - gets Building containing this room.
+ *
+ * @return the building
+ * @generated
+ */
+ public String getBuilding() {
+ return _getStringValueNc(wrapGetIntCatchException(_FH_building));
+ }
+
+ /**
+ * setter for building - sets Building containing this room.
+ *
+ * @param v
+ * the new building
+ * @generated
+ */
+ public void setBuilding(String v) {
_setStringValueNfc(wrapGetIntCatchException(_FH_building), v);
- }
-
}
+
+}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/SentenceAnnot.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/SentenceAnnot.java
index 097c99d..19708be 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/SentenceAnnot.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/SentenceAnnot.java
@@ -24,7 +24,6 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
/**
* Updated by JCasGen Mon Nov 29 15:02:37 EST 2004 XML source: C:/Program
* Files/apache/uima/examples/descriptors/tutorial/ex6/TutorialTypeSystem.xml
@@ -33,83 +32,89 @@ import org.apache.uima.jcas.tcas.Annotation;
*/
public class SentenceAnnot extends Annotation {
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(SentenceAnnot.class);
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(SentenceAnnot.class);
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {
- return typeIndexID;
- }
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
- /**
+ /**
* Never called. Disable default constructor
*
* @generated
*/
- protected SentenceAnnot() {
- }
+ protected SentenceAnnot() {
+ }
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public SentenceAnnot(TypeImpl type, CASImpl casImpl) {
- super(type, casImpl);
- readObject();
- }
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public SentenceAnnot(TypeImpl type, CASImpl casImpl) {
+ super(type, casImpl);
+ readObject();
+ }
- /**
- * Instantiates a new sentence annot.
- *
- * @param jcas the jcas
- * @generated
- */
- public SentenceAnnot(JCas jcas) {
- super(jcas);
- readObject();
- }
+ /**
+ * Instantiates a new sentence annot.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public SentenceAnnot(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
- /**
- * Instantiates a new sentence annot.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public SentenceAnnot(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
+ /**
+ * Instantiates a new sentence annot.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public SentenceAnnot(JCas jcas, int begin, int end) {
+ super(jcas);
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
- /**
- * <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->.
- *
- * @generated modifiable
- */
- private void readObject() {
- }
+ /**
+ * <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->.
+ *
+ * @generated modifiable
+ */
+ private void readObject() {
+ }
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/TimeAnnot.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/TimeAnnot.java
index b8f588d..706c152 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/TimeAnnot.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/TimeAnnot.java
@@ -23,94 +23,104 @@ import org.apache.uima.cas.impl.TypeImpl;
import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
-
-/**
- * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017
- * XML source: C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
- * @generated */
+/**
+ * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017 XML source:
+ * C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
+ *
+ * @generated
+ */
public class TimeAnnot extends DateTimeAnnot {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.tutorial.TimeAnnot";
-
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(TimeAnnot.class);
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(TimeAnnot.class);
+
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
+
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /**
+ /**
* Never called. Disable default constructor
*
* @generated
*/
- protected TimeAnnot() {/* intentionally empty block */}
-
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public TimeAnnot(TypeImpl type, CASImpl casImpl) {
+ protected TimeAnnot() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public TimeAnnot(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /**
- * Instantiates a new time annot.
- *
- * @param jcas the jcas
- * @generated
- */
- public TimeAnnot(JCas jcas) {
- super(jcas);
- readObject();
- }
+ /**
+ * Instantiates a new time annot.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public TimeAnnot(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
- /**
- * Instantiates a new time annot.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public TimeAnnot(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
+ /**
+ * Instantiates a new time annot.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public TimeAnnot(JCas jcas, int begin, int end) {
+ super(jcas);
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
- /**
+ /**
* <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->*
- * @generated modifiable
+ *
+ * @generated modifiable
*/
- private void readObject() {
- }
+ private void readObject() {
+ }
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/UimaAcronym.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/UimaAcronym.java
index 217fe0b..3b70209 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/UimaAcronym.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/UimaAcronym.java
@@ -28,139 +28,155 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
-/**
- * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017
- * XML source: C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
- * @generated */
+/**
+ * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017 XML source:
+ * C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
+ *
+ * @generated
+ */
public class UimaAcronym extends Annotation {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.tutorial.UimaAcronym";
-
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(UimaAcronym.class);
-
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
-
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /* *******************
- * Feature Offsets *
- * *******************/
-
- public final static String _FeatName_expandedForm = "expandedForm";
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(UimaAcronym.class);
+
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
+
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
+
+ /*
+ * ******************* Feature Offsets *
+ *******************/
+
+ public final static String _FeatName_expandedForm = "expandedForm";
/* Feature Adjusted Offsets */
- private final static CallSite _FC_expandedForm = TypeSystemImpl.createCallSite(UimaAcronym.class, "expandedForm");
+ private final static CallSite _FC_expandedForm = TypeSystemImpl.createCallSite(UimaAcronym.class,
+ "expandedForm");
private final static MethodHandle _FH_expandedForm = _FC_expandedForm.dynamicInvoker();
-
/**
* Never called. Disable default constructor
*
* @generated
*/
- protected UimaAcronym() {/* intentionally empty block */}
-
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public UimaAcronym(TypeImpl type, CASImpl casImpl) {
+ protected UimaAcronym() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public UimaAcronym(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /**
- * Instantiates a new uima acronym.
- *
- * @param jcas the jcas
- * @generated
- */
- public UimaAcronym(JCas jcas) {
+
+ /**
+ * Instantiates a new uima acronym.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public UimaAcronym(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
+
+ /**
+ * Instantiates a new uima acronym.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public UimaAcronym(JCas jcas, int begin, int end) {
super(jcas);
- readObject();
- }
-
-
- /**
- * Instantiates a new uima acronym.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public UimaAcronym(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
-
- /**
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
+
+ /**
* <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->*
- * @generated modifiable
+ *
+ * @generated modifiable
*/
- private void readObject() {
- }
-
- // *--------------*
- // * Feature: expandedForm
- /**
- * getter for expandedForm - gets.
- *
- * @return the expanded form
- * @generated
- */
- public String getExpandedForm() { return _getStringValueNc(wrapGetIntCatchException(_FH_expandedForm));}
-
- /**
- * setter for expandedForm - sets.
- *
- * @param v the new expanded form
- * @generated
- */
- public void setExpandedForm(String v) {
+ private void readObject() {
+ }
+
+ // *--------------*
+ // * Feature: expandedForm
+ /**
+ * getter for expandedForm - gets.
+ *
+ * @return the expanded form
+ * @generated
+ */
+ public String getExpandedForm() {
+ return _getStringValueNc(wrapGetIntCatchException(_FH_expandedForm));
+ }
+
+ /**
+ * setter for expandedForm - sets.
+ *
+ * @param v
+ * the new expanded form
+ * @generated
+ */
+ public void setExpandedForm(String v) {
_setStringValueNfc(wrapGetIntCatchException(_FH_expandedForm), v);
- }
-
- /**
- * Custom constructor taking all parameters.
- *
- * @param jcas the jcas
- * @param start the start
- * @param end the end
- * @param expandedForm the expanded form
- */
- public UimaAcronym(JCas jcas, int start, int end, String expandedForm) {
- super(jcas, start, end);
- setExpandedForm(expandedForm);
- }
+ }
+
+ /**
+ * Custom constructor taking all parameters.
+ *
+ * @param jcas
+ * the jcas
+ * @param start
+ * the start
+ * @param end
+ * the end
+ * @param expandedForm
+ * the expanded form
+ */
+ public UimaAcronym(JCas jcas, int start, int end, String expandedForm) {
+ super(jcas, start, end);
+ setExpandedForm(expandedForm);
+ }
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/UimaMeeting.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/UimaMeeting.java
index ea01670..a8256ed 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/UimaMeeting.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/UimaMeeting.java
@@ -23,109 +23,127 @@ import org.apache.uima.cas.impl.TypeImpl;
import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
-
-/**
- * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017
- * XML source: C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
- * @generated */
+/**
+ * Updated by JCasGen Sun Oct 08 19:34:17 EDT 2017 XML source:
+ * C:/au/svnCheckouts/uv3/trunk/uimaj-v3/uimaj-examples/src/main/descriptors/tutorial/ex6/TutorialTypeSystem.xml
+ *
+ * @generated
+ */
public class UimaMeeting extends Meeting {
- /** @generated
- * @ordered
+ /**
+ * @generated
+ * @ordered
*/
- @SuppressWarnings ("hiding")
+ @SuppressWarnings("hiding")
public final static String _TypeName = "org.apache.uima.tutorial.UimaMeeting";
-
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(UimaMeeting.class);
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(UimaMeeting.class);
+
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
+
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {return typeIndexID;}
-
-
- /**
+ /**
* Never called. Disable default constructor
*
* @generated
*/
- protected UimaMeeting() {/* intentionally empty block */}
-
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public UimaMeeting(TypeImpl type, CASImpl casImpl) {
+ protected UimaMeeting() {
+ /* intentionally empty block */}
+
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public UimaMeeting(TypeImpl type, CASImpl casImpl) {
super(type, casImpl);
readObject();
}
-
- /**
- * Instantiates a new uima meeting.
- *
- * @param jcas the jcas
- * @generated
- */
- public UimaMeeting(JCas jcas) {
- super(jcas);
- readObject();
- }
+ /**
+ * Instantiates a new uima meeting.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public UimaMeeting(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
- /**
- * Instantiates a new uima meeting.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public UimaMeeting(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
+ /**
+ * Instantiates a new uima meeting.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public UimaMeeting(JCas jcas, int begin, int end) {
+ super(jcas);
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
- /**
+ /**
* <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->*
- * @generated modifiable
+ *
+ * @generated modifiable
*/
- private void readObject() {
- }
+ private void readObject() {
+ }
- /**
- * Custom constructor taking all parameters.
- *
- * @param jcas the jcas
- * @param start the start
- * @param end the end
- * @param room the room
- * @param date the date
- * @param startTime the start time
- * @param endTime the end time
- */
- public UimaMeeting(JCas jcas, int start, int end, RoomNumber room, DateAnnot date, TimeAnnot startTime, TimeAnnot endTime) {
- super(jcas, start, end, room, date, startTime, endTime);
- }
+ /**
+ * Custom constructor taking all parameters.
+ *
+ * @param jcas
+ * the jcas
+ * @param start
+ * the start
+ * @param end
+ * the end
+ * @param room
+ * the room
+ * @param date
+ * the date
+ * @param startTime
+ * the start time
+ * @param endTime
+ * the end time
+ */
+ public UimaMeeting(JCas jcas, int start, int end, RoomNumber room, DateAnnot date,
+ TimeAnnot startTime, TimeAnnot endTime) {
+ super(jcas, start, end, room, date, startTime, endTime);
+ }
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/WordAnnot.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/WordAnnot.java
index d7af457..d38932d 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/WordAnnot.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/WordAnnot.java
@@ -24,7 +24,6 @@ import org.apache.uima.jcas.JCas;
import org.apache.uima.jcas.JCasRegistry;
import org.apache.uima.jcas.tcas.Annotation;
-
/**
* Updated by JCasGen Mon Nov 29 15:02:38 EST 2004 XML source: C:/Program
* Files/apache/uima/examples/descriptors/tutorial/ex6/TutorialTypeSystem.xml
@@ -33,83 +32,89 @@ import org.apache.uima.jcas.tcas.Annotation;
*/
public class WordAnnot extends Annotation {
- /**
- * The Constant typeIndexID.
- *
- * @generated
- * @ordered
- */
- public static final int typeIndexID = JCasRegistry.register(WordAnnot.class);
+ /**
+ * The Constant typeIndexID.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int typeIndexID = JCasRegistry.register(WordAnnot.class);
- /**
- * The Constant type.
- *
- * @generated
- * @ordered
- */
- public static final int type = typeIndexID;
+ /**
+ * The Constant type.
+ *
+ * @generated
+ * @ordered
+ */
+ public static final int type = typeIndexID;
- /**
- * Gets the type index ID.
- *
- * @return the type index ID
- * @generated
- */
- @Override
- public int getTypeIndexID() {
- return typeIndexID;
- }
+ /**
+ * Gets the type index ID.
+ *
+ * @return the type index ID
+ * @generated
+ */
+ @Override
+ public int getTypeIndexID() {
+ return typeIndexID;
+ }
- /**
+ /**
* Never called. Disable default constructor
*
* @generated
*/
- protected WordAnnot() {
- }
+ protected WordAnnot() {
+ }
- /**
- * Internal - constructor used by generator.
- *
- * @param type the type
- * @param casImpl the cas impl
- * @generated
- */
- public WordAnnot(TypeImpl type, CASImpl casImpl) {
- super(type, casImpl);
- readObject();
- }
+ /**
+ * Internal - constructor used by generator.
+ *
+ * @param type
+ * the type
+ * @param casImpl
+ * the cas impl
+ * @generated
+ */
+ public WordAnnot(TypeImpl type, CASImpl casImpl) {
+ super(type, casImpl);
+ readObject();
+ }
- /**
- * Instantiates a new word annot.
- *
- * @param jcas the jcas
- * @generated
- */
- public WordAnnot(JCas jcas) {
- super(jcas);
- readObject();
- }
+ /**
+ * Instantiates a new word annot.
+ *
+ * @param jcas
+ * the jcas
+ * @generated
+ */
+ public WordAnnot(JCas jcas) {
+ super(jcas);
+ readObject();
+ }
- /**
- * Instantiates a new word annot.
- *
- * @param jcas the jcas
- * @param begin the begin
- * @param end the end
- */
- public WordAnnot(JCas jcas, int begin, int end) {
- super(jcas);
- setBegin(begin);
- setEnd(end);
- readObject();
- }
+ /**
+ * Instantiates a new word annot.
+ *
+ * @param jcas
+ * the jcas
+ * @param begin
+ * the begin
+ * @param end
+ * the end
+ */
+ public WordAnnot(JCas jcas, int begin, int end) {
+ super(jcas);
+ setBegin(begin);
+ setEnd(end);
+ readObject();
+ }
- /**
- * <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->.
- *
- * @generated modifiable
- */
- private void readObject() {
- }
+ /**
+ * <!-- begin-user-doc --> Write your own initialization here <!-- end-user-doc -->.
+ *
+ * @generated modifiable
+ */
+ private void readObject() {
+ }
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex2/RoomNumberAnnotator.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex2/RoomNumberAnnotator.java
index d1e3086..6cfa6e1 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex2/RoomNumberAnnotator.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex2/RoomNumberAnnotator.java
@@ -75,7 +75,7 @@ public class RoomNumberAnnotator extends JCasAnnotator_ImplBase {
getLogger().log(Level.FINEST, "Found: " + annotation);
// or, using slf4j
// note: this call skips constructing the message if tracing is not enabled
-// getSlf4jLogger().trace("Found: {}", annotation);
+ // getSlf4jLogger().trace("Found: {}", annotation);
}
}
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex3/TutorialDateTime.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex3/TutorialDateTime.java
index d14b85e..e5c544f 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex3/TutorialDateTime.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex3/TutorialDateTime.java
@@ -122,7 +122,7 @@ public class TutorialDateTime extends JCasAnnotator_ImplBase {
};
static final String defaultYear = "2003";
-
+
private static boolean warningMessageShown = false;
// PROCESS
@@ -137,27 +137,27 @@ public class TutorialDateTime extends JCasAnnotator_ImplBase {
// Create Annotations
ResultSpecification resultSpec = getResultSpecification();
- boolean timeWanted = resultSpec.containsType("org.apache.uima.tutorial.TimeAnnot", aJCas.getDocumentLanguage());
- boolean dateWanted = resultSpec.containsType("org.apache.uima.tutorial.DateAnnot", aJCas.getDocumentLanguage());
+ boolean timeWanted = resultSpec.containsType("org.apache.uima.tutorial.TimeAnnot",
+ aJCas.getDocumentLanguage());
+ boolean dateWanted = resultSpec.containsType("org.apache.uima.tutorial.DateAnnot",
+ aJCas.getDocumentLanguage());
if (timeWanted)
makeAnnotations(timeAnnotationMaker, hoursMinutesPattern, dfTimeShort);
-
- if (dateWanted) {
+
+ if (dateWanted) {
makeAnnotations(dateAnnotationMaker, numericDatePattern, dfDateShort);
makeAnnotations(dateAnnotationMaker, mediumDatePattern, dfDateMedium);
makeAnnotations(dateAnnotationMaker, longDatePattern, dfDateLong);
}
-
+
if (!timeWanted && !dateWanted && !warningMessageShown) {
String m = String.format(
- "No output is being produced by the TutorialDateTime annotator because the Result Specification did not contain" +
- " a request for the type%n" +
- " org.apache.uima.tutorial.TimeAnnot nor%n" +
- " org.apache.uima.tutorial.DateAnnot" +
- " with the language '%s'%n" +
- " (Note: this message will only be shown once.)%n",
- aJCas.getDocumentLanguage());
+ "No output is being produced by the TutorialDateTime annotator because the Result Specification did not contain"
+ + " a request for the type%n" + " org.apache.uima.tutorial.TimeAnnot nor%n"
+ + " org.apache.uima.tutorial.DateAnnot" + " with the language '%s'%n"
+ + " (Note: this message will only be shown once.)%n",
+ aJCas.getDocumentLanguage());
System.err.println(m);
getContext().getLogger().log(Level.WARNING, m);
warningMessageShown = true;
@@ -168,8 +168,8 @@ public class TutorialDateTime extends JCasAnnotator_ImplBase {
void makeAnnotations(Maker m, BreakIterator b) {
b.setText(input);
- for (int end = b.next(), start = b.first(); end != BreakIterator.DONE; start = end, end = b
- .next()) {
+ for (int end = b.next(),
+ start = b.first(); end != BreakIterator.DONE; start = end, end = b.next()) {
// eliminate all-whitespace tokens
boolean isWhitespace = true;
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex4/MeetingAnnotator.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex4/MeetingAnnotator.java
index d488879..1d6161b 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex4/MeetingAnnotator.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex4/MeetingAnnotator.java
@@ -67,21 +67,21 @@ public class MeetingAnnotator extends JCasAnnotator_ImplBase {
for (RoomNumber room : roomNumberIndex.select()) {
for (DateAnnot date : dateIndex.select()) {
- for(TimeAnnot time1 : timeIndex.select()) {
+ for (TimeAnnot time1 : timeIndex.select()) {
for (TimeAnnot time2 : timeIndex.select()) {
// times must be different annotations
if (time1 != time2) {
// compute the begin and end of the span
- int minBegin = Math.min(Math.min(time1.getBegin(), time2.getBegin()),
- Math.min(date .getBegin(), room .getBegin()));
- int maxEnd = Math.max(Math.max(time1.getEnd(), time2.getEnd()),
- Math.max(date .getEnd(), room .getEnd()));
+ int minBegin = Math.min(Math.min(time1.getBegin(), time2.getBegin()),
+ Math.min(date.getBegin(), room.getBegin()));
+ int maxEnd = Math.max(Math.max(time1.getEnd(), time2.getEnd()),
+ Math.max(date.getEnd(), room.getEnd()));
// span must be smaller than the window size?
- if (maxEnd - minBegin < mWindowSize &&
- // span must not overlap the last annotation we made
- minBegin > lastMeetingEnd) {
+ if (maxEnd - minBegin < mWindowSize &&
+ // span must not overlap the last annotation we made
+ minBegin > lastMeetingEnd) {
// annotate
Meeting mtg = new Meeting(aJCas, minBegin, maxEnd, room, date, time1, time2);
mtg.addToIndexes();
@@ -90,7 +90,7 @@ public class MeetingAnnotator extends JCasAnnotator_ImplBase {
}
}
}
- }
+ }
}
}
}
diff --git a/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex6/UimaMeetingAnnotator.java b/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex6/UimaMeetingAnnotator.java
index c84d972..5b4778e 100644
--- a/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex6/UimaMeetingAnnotator.java
+++ b/uimaj-examples/src/main/java/org/apache/uima/tutorial/ex6/UimaMeetingAnnotator.java
@@ -101,8 +101,9 @@ public class UimaMeetingAnnotator extends JCasAnnotator_ImplBase {
// look up token in map to see if it is an acronym
if (mMap.get(token) != null) {
// create annotation
- UimaMeeting annot = new UimaMeeting(aJCas, meeting.getBegin(), meeting.getEnd(), meeting
- .getRoom(), meeting.getDate(), meeting.getStartTime(), meeting.getEndTime());
+ UimaMeeting annot = new UimaMeeting(aJCas, meeting.getBegin(), meeting.getEnd(),
+ meeting.getRoom(), meeting.getDate(), meeting.getStartTime(),
+ meeting.getEndTime());
// Add annotation to a list, to be later added to the indexes.
// We need to do this because it's not allowed to add to an
// index that you're currently iterating over.
[uima-uimaj] 06/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit e3c64769669937180940a95946a1ef85ca5c2cef
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:08:09 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../uima/tools/AnnotationFeaturesViewer.java | 17 +-
.../apache/uima/tools/AnnotationViewerMain.java | 67 +-
.../src/main/java/org/apache/uima/tools/RunAE.java | 65 +-
.../org/apache/uima/tools/ValidateDescriptor.java | 7 +-
.../org/apache/uima/tools/annot_view/Gladis.java | 8 +-
.../components/FileSystemCollectionReader.java | 25 +-
.../tools/components/InlineXmlCasConsumer.java | 15 +-
.../tools/components/XCasWriterCasConsumer.java | 7 +-
.../tools/components/XmiWriterCasConsumer.java | 23 +-
.../apache/uima/tools/components/XmlDetagger.java | 29 +-
.../apache/uima/tools/cpm/AnalysisEnginePanel.java | 28 +-
.../org/apache/uima/tools/cpm/ConfigField.java | 18 +-
.../org/apache/uima/tools/cpm/ConsumerPanel.java | 31 +-
.../java/org/apache/uima/tools/cpm/CpmFrame.java | 28 +-
.../java/org/apache/uima/tools/cpm/CpmPanel.java | 468 ++++++-----
.../uima/tools/cpm/ElapsedTimeFormatter.java | 6 +-
.../uima/tools/cpm/JTabbedPaneWithCloseIcons.java | 45 +-
.../org/apache/uima/tools/cpm/MetaDataPanel.java | 29 +-
.../uima/tools/cpm/PerformanceReportDialog.java | 41 +-
.../apache/uima/tools/cpm/TabClosedListener.java | 9 +-
.../cvd/AnnotationDisplayCustomizationFrame.java | 124 +--
.../apache/uima/tools/cvd/AnnotationExtent.java | 11 +-
.../java/org/apache/uima/tools/cvd/ArrayNode.java | 22 +-
.../org/apache/uima/tools/cvd/AutoFoldingMenu.java | 14 +-
.../main/java/org/apache/uima/tools/cvd/CVD.java | 24 +-
.../java/org/apache/uima/tools/cvd/ColorIcon.java | 8 +-
.../java/org/apache/uima/tools/cvd/FSNode.java | 329 ++++----
.../org/apache/uima/tools/cvd/FSTreeModel.java | 163 ++--
.../java/org/apache/uima/tools/cvd/FSTreeNode.java | 5 +-
.../org/apache/uima/tools/cvd/IndexTreeNode.java | 22 +-
.../org/apache/uima/tools/cvd/LogFileViewer.java | 284 +++----
.../java/org/apache/uima/tools/cvd/MainFrame.java | 378 +++++----
.../org/apache/uima/tools/cvd/MarkupExtent.java | 11 +-
.../uima/tools/cvd/MultiAnnotViewerFrame.java | 40 +-
.../org/apache/uima/tools/cvd/MultiMarkup.java | 37 +-
.../org/apache/uima/tools/cvd/RecentFilesList.java | 27 +-
.../uima/tools/cvd/StringFsPopupEventAdapter.java | 57 +-
.../org/apache/uima/tools/cvd/TypeTreeNode.java | 14 +-
.../uima/tools/cvd/control/AboutHandler.java | 20 +-
.../uima/tools/cvd/control/AboutUimaHandler.java | 9 +-
.../uima/tools/cvd/control/AddLanguageHandler.java | 9 +-
.../cvd/control/AnnotatorOpenEventHandler.java | 8 +-
.../cvd/control/AnnotatorRerunEventHandler.java | 8 +-
.../cvd/control/AnnotatorRunCPCEventHandler.java | 8 +-
.../cvd/control/AnnotatorRunOnCasEventHandler.java | 8 +-
.../uima/tools/cvd/control/CaretChangeHandler.java | 8 +-
.../cvd/control/CloseAnnotationViewHandler.java | 14 +-
.../tools/cvd/control/CloseLogViewHandler.java | 15 +-
.../tools/cvd/control/CloseTypeSystemHandler.java | 12 +-
.../tools/cvd/control/ColorPrefsOpenHandler.java | 8 +-
.../tools/cvd/control/ColorPrefsSaveHandler.java | 8 +-
.../tools/cvd/control/FSTreeSelectionListener.java | 9 +-
.../tools/cvd/control/FileOpenEventHandler.java | 10 +-
.../tools/cvd/control/FileSaveAsEventHandler.java | 9 +-
.../tools/cvd/control/FileSaveEventHandler.java | 9 +-
.../uima/tools/cvd/control/FocusFSAction.java | 9 +-
.../uima/tools/cvd/control/FocusIRAction.java | 9 +-
.../uima/tools/cvd/control/FocusTextAction.java | 9 +-
.../apache/uima/tools/cvd/control/HelpHandler.java | 13 +-
.../uima/tools/cvd/control/IndexPopupListener.java | 32 +-
.../cvd/control/IndexTreeSelectionListener.java | 15 +-
.../control/LoadRecentDescFileEventHandler.java | 14 +-
.../control/LoadRecentTextFileEventHandler.java | 14 +-
.../uima/tools/cvd/control/MainFrameClosing.java | 12 +-
.../uima/tools/cvd/control/ManualHandler.java | 27 +-
.../tools/cvd/control/NewTextEventHandler.java | 9 +-
.../uima/tools/cvd/control/PopupHandler.java | 13 +-
.../uima/tools/cvd/control/PopupListener.java | 17 +-
.../tools/cvd/control/RemoveLanguageHandler.java | 9 +-
.../cvd/control/RestoreLangDefaultsHandler.java | 9 +-
.../uima/tools/cvd/control/SetCodePageHandler.java | 9 +-
.../uima/tools/cvd/control/SetDataPathHandler.java | 11 +-
.../uima/tools/cvd/control/SetLanguageHandler.java | 9 +-
.../tools/cvd/control/SetLogConfigHandler.java | 5 +-
.../cvd/control/ShowAnnotatedTextHandler.java | 12 +-
.../control/ShowAnnotationCustomizerHandler.java | 11 +-
.../tools/cvd/control/ShowTypesystemHandler.java | 9 +-
.../tools/cvd/control/SofaSelectionListener.java | 21 +-
.../uima/tools/cvd/control/SystemExitHandler.java | 9 +-
.../tools/cvd/control/TextChangedListener.java | 14 +-
.../tools/cvd/control/TextContextMenuAction.java | 8 +-
.../uima/tools/cvd/control/TextFocusHandler.java | 4 +-
.../uima/tools/cvd/control/TreeFocusHandler.java | 13 +-
.../control/TypeSystemFileOpenEventHandler.java | 16 +-
.../org/apache/uima/tools/cvd/control/UndoMgr.java | 17 +-
.../cvd/control/XCASFileOpenEventHandler.java | 12 +-
.../uima/tools/cvd/control/XCASSaveHandler.java | 8 +-
.../uima/tools/cvd/control/XCASSaveTSHandler.java | 8 +-
.../tools/cvd/control/XmiCasFileOpenHandler.java | 12 +-
.../uima/tools/cvd/control/XmiCasSaveHandler.java | 15 +-
.../uima/tools/cvd/tsview/FeatureTableModel.java | 16 +-
.../apache/uima/tools/cvd/tsview/MainFrame.java | 48 +-
.../tools/docanalyzer/AnnotationViewerDialog.java | 200 +++--
.../uima/tools/docanalyzer/DocumentAnalyzer.java | 315 ++++----
.../uima/tools/docanalyzer/FileSelector.java | 59 +-
.../tools/docanalyzer/FileSelectorListener.java | 22 +-
.../uima/tools/docanalyzer/PrefsMediator.java | 71 +-
.../uima/tools/docanalyzer/TfDocumentListener.java | 8 +-
.../tools/docanalyzer/TfFileSelectorListener.java | 8 +-
.../uima/tools/docanalyzer/TfFocusListener.java | 8 +-
.../java/org/apache/uima/tools/jcasgen/GUI.java | 31 +-
.../apache/uima/tools/jcasgen/GuiErrorImpl.java | 7 +-
.../uima/tools/jcasgen/GuiProgressMonitor.java | 26 +-
.../java/org/apache/uima/tools/jcasgen/IError.java | 12 +-
.../java/org/apache/uima/tools/jcasgen/IMerge.java | 27 +-
.../uima/tools/jcasgen/IProgressMonitor.java | 15 +-
.../uima/tools/jcasgen/JCasTypeTemplate.java | 329 ++++----
.../java/org/apache/uima/tools/jcasgen/Jg.java | 810 +++++++++++--------
.../uima/tools/jcasgen/LogThrowErrorImpl.java | 3 +-
.../java/org/apache/uima/tools/jcasgen/Prefs.java | 17 +-
.../org/apache/uima/tools/jcasgen/TypeInfo.java | 16 +-
.../tools/jcasgen/UimaLoggerProgressMonitor.java | 26 +-
.../java/org/apache/uima/tools/jcasgen/Waiter.java | 3 +-
.../uima/tools/pear/install/InstallPear.java | 33 +-
.../uima/tools/pear/install/InstallPearCli.java | 79 +-
.../uima/tools/pear/merger/PMController.java | 27 +-
.../uima/tools/pear/merger/PMControllerHelper.java | 8 +-
.../apache/uima/tools/pear/merger/PMUimaAgent.java | 38 +-
.../uima/tools/pear/packager/PearPackager.java | 41 +-
.../apache/uima/tools/stylemap/AnTreeListener.java | 12 +-
.../tools/stylemap/AnnotationFeaturesViewer.java | 42 +-
.../apache/uima/tools/stylemap/ColorEditor.java | 21 +-
.../apache/uima/tools/stylemap/ColorParser.java | 27 +-
.../apache/uima/tools/stylemap/ColorRenderer.java | 11 +-
.../uima/tools/stylemap/LabelCellEditor.java | 10 +-
.../apache/uima/tools/stylemap/MyCellRenderer.java | 24 +-
.../apache/uima/tools/stylemap/StyleConstants.java | 3 +-
.../apache/uima/tools/stylemap/StyleMapEditor.java | 93 ++-
.../apache/uima/tools/stylemap/StyleMapEntry.java | 26 +-
.../apache/uima/tools/stylemap/StyleMapTable.java | 19 +-
.../uima/tools/stylemap/StyleMapTableModel.java | 49 +-
.../uima/tools/stylemap/StyleMapXmlParser.java | 24 +-
.../uima/tools/stylemap/TableDropAdapter.java | 13 +-
.../uima/tools/stylemap/TableGUIMediator.java | 21 +-
.../tools/stylemap/TableSelectionListener.java | 21 +-
.../apache/uima/tools/util/gui/AboutDialog.java | 27 +-
.../org/apache/uima/tools/util/gui/Caption.java | 6 +-
.../tools/util/gui/FileChooserBugWorkarounds.java | 5 +-
.../apache/uima/tools/util/gui/FileSelector.java | 118 +--
.../uima/tools/util/gui/FileSelectorListener.java | 22 +-
.../org/apache/uima/tools/util/gui/FormPanel.java | 17 +-
.../apache/uima/tools/util/gui/ImageButton.java | 10 +-
.../apache/uima/tools/util/gui/IntegerField.java | 12 +-
.../apache/uima/tools/util/gui/ListSelector.java | 28 +-
.../apache/uima/tools/util/gui/SliderField.java | 27 +-
.../uima/tools/util/gui/SpringUtilities.java | 82 +-
.../tools/util/gui/TransportControlListener.java | 15 +-
.../uima/tools/util/gui/TransportControlPanel.java | 32 +-
.../apache/uima/tools/util/gui/XMLFileFilter.java | 14 +-
.../util/htmlview/AnnotationViewGenerator.java | 68 +-
.../uima/tools/viewer/CasAnnotationViewer.java | 853 +++++++++++----------
.../tools/viewer/CasAnnotationViewerApplet.java | 11 +-
.../apache/uima/tools/viewer/CasTreeViewer.java | 52 +-
.../uima/tools/viewer/CasTreeViewerApplet.java | 9 +-
.../apache/uima/tools/viewer/EntityResolver.java | 48 +-
.../uima/tools/pear/merger/PearMergerTest.java | 29 +-
.../uima/tools/viewer/CasAnnotationViewerTest.java | 127 +--
157 files changed, 4247 insertions(+), 3226 deletions(-)
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationFeaturesViewer.java b/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationFeaturesViewer.java
index 4a422e7..08b2837 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationFeaturesViewer.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationFeaturesViewer.java
@@ -39,7 +39,6 @@ import org.apache.uima.analysis_engine.TypeOrFeature;
import org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData;
import org.apache.uima.resource.metadata.Capability;
-
/**
* A tree view of Annotations and associated features.
*
@@ -94,8 +93,10 @@ public class AnnotationFeaturesViewer extends JPanel implements ActionListener {
/**
* Populate.
*
- * @param analysisEngine the analysis engine
- * @param aeMetaData the ae meta data
+ * @param analysisEngine
+ * the analysis engine
+ * @param aeMetaData
+ * the ae meta data
*/
public void populate(AnalysisEngine analysisEngine, AnalysisEngineMetaData aeMetaData) {
tree = generateTreeView(analysisEngine, aeMetaData);
@@ -119,8 +120,10 @@ public class AnnotationFeaturesViewer extends JPanel implements ActionListener {
/**
* Generate tree view.
*
- * @param analysisEngine the analysis engine
- * @param aeMetaData the ae meta data
+ * @param analysisEngine
+ * the analysis engine
+ * @param aeMetaData
+ * the ae meta data
* @return the j tree
*/
private JTree generateTreeView(AnalysisEngine analysisEngine, AnalysisEngineMetaData aeMetaData) {
@@ -176,7 +179,9 @@ public class AnnotationFeaturesViewer extends JPanel implements ActionListener {
return null;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationViewerMain.java b/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationViewerMain.java
index 8c0a55e..9ffa982 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationViewerMain.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/AnnotationViewerMain.java
@@ -69,15 +69,14 @@ import org.apache.uima.util.CasCreationUtils;
import org.apache.uima.util.InvalidXMLException;
import org.apache.uima.util.XMLInputSource;
-
/**
- * Main Annotation Viewer GUI. Allows user to choose directory of XCAS or XMI files, then
- * launches the AnnotationViewerDialog.
+ * Main Annotation Viewer GUI. Allows user to choose directory of XCAS or XMI files, then launches
+ * the AnnotationViewerDialog.
*
*
*/
public class AnnotationViewerMain extends JFrame {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -3201723535833938833L;
@@ -111,7 +110,7 @@ public class AnnotationViewerMain extends JFrame {
/** The about dialog. */
private JDialog aboutDialog;
- /** Stores user preferences. */
+ /** Stores user preferences. */
private Preferences prefs = Preferences.userRoot().node("org/apache/uima/tools/AnnotationViewer");
/**
@@ -183,8 +182,8 @@ public class AnnotationViewerMain extends JFrame {
inputDir);
inputFileSelector.setSelected(inputDir.getAbsolutePath());
- taeDescriptorFileSelector = new FileSelector("", "TAE Descriptor File",
- JFileChooser.FILES_ONLY, uimaHomeDir);
+ taeDescriptorFileSelector = new FileSelector("", "TAE Descriptor File", JFileChooser.FILES_ONLY,
+ uimaHomeDir);
File descriptorFile = new File(uimaHomeDir,
"examples/descriptors/analysis_engine/PersonTitleAnnotator.xml");
@@ -264,12 +263,15 @@ public class AnnotationViewerMain extends JFrame {
/**
* View documents.
*
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
- public void viewDocuments() throws InvalidXMLException, IOException,
- ResourceInitializationException {
+ public void viewDocuments()
+ throws InvalidXMLException, IOException, ResourceInitializationException {
File descriptorFile = new File(taeDescriptorFileSelector.getSelected());
if (!descriptorFile.exists() || descriptorFile.isDirectory()) {
displayError("Descriptor File \"" + descriptorFile.getPath() + "\" does not exist.");
@@ -288,8 +290,8 @@ public class AnnotationViewerMain extends JFrame {
File styleMapFile;
if (descriptor instanceof AnalysisEngineDescription) {
cas = CasCreationUtils.createCas((AnalysisEngineDescription) descriptor);
- styleMapFile = getStyleMapFile((AnalysisEngineDescription) descriptor, descriptorFile
- .getPath());
+ styleMapFile = getStyleMapFile((AnalysisEngineDescription) descriptor,
+ descriptorFile.getPath());
} else if (descriptor instanceof TypeSystemDescription) {
TypeSystemDescription tsDesc = (TypeSystemDescription) descriptor;
tsDesc.resolveImports();
@@ -307,9 +309,8 @@ public class AnnotationViewerMain extends JFrame {
// PrefsMediator is also used in DocumentAnalyzer, where the
// output dir is the directory containing XCAS files.
prefsMed.setOutputDir(inputDir.toString());
- AnnotationViewerDialog viewerDialog = new AnnotationViewerDialog(this,
- "Analyzed Documents", prefsMed, styleMapFile, null, cas.getTypeSystem(), null, false,
- cas);
+ AnnotationViewerDialog viewerDialog = new AnnotationViewerDialog(this, "Analyzed Documents",
+ prefsMed, styleMapFile, null, cas.getTypeSystem(), null, false, cas);
viewerDialog.pack();
viewerDialog.setModal(true);
viewerDialog.setVisible(true);
@@ -318,10 +319,13 @@ public class AnnotationViewerMain extends JFrame {
/**
* Gets the style map file.
*
- * @param tad the tad
- * @param descFileName the desc file name
+ * @param tad
+ * the tad
+ * @param descFileName
+ * the desc file name
* @return the style map file
- * @throws IOException -
+ * @throws IOException
+ * -
*/
private File getStyleMapFile(AnalysisEngineDescription tad, String descFileName)
throws IOException {
@@ -341,10 +345,13 @@ public class AnnotationViewerMain extends JFrame {
/**
* Gets the style map file.
*
- * @param tsd the tsd
- * @param descFileName the desc file name
+ * @param tsd
+ * the tsd
+ * @param descFileName
+ * the desc file name
* @return the style map file
- * @throws IOException -
+ * @throws IOException
+ * -
*/
private File getStyleMapFile(TypeSystemDescription tsd, String descFileName) throws IOException {
File styleMapFile = getStyleMapFileName(descFileName);
@@ -363,7 +370,8 @@ public class AnnotationViewerMain extends JFrame {
/**
* Gets the name of the style map file for the given AE or TypeSystem descriptor filename.
*
- * @param aDescriptorFileName the a descriptor file name
+ * @param aDescriptorFileName
+ * the a descriptor file name
* @return the style map file name
*/
public File getStyleMapFileName(String aDescriptorFileName) {
@@ -380,7 +388,8 @@ public class AnnotationViewerMain extends JFrame {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
final AnnotationViewerMain frame = new AnnotationViewerMain();
@@ -415,8 +424,8 @@ public class AnnotationViewerMain extends JFrame {
// restore preferences
inputFileSelector.setSelected(prefs.get("inDir", defaultInputDir.toString()));
- taeDescriptorFileSelector.setSelected(prefs.get("taeDescriptorFile", defaultTaeDescriptorFile
- .toString()));
+ taeDescriptorFileSelector
+ .setSelected(prefs.get("taeDescriptorFile", defaultTaeDescriptorFile.toString()));
}
/**
@@ -480,7 +489,7 @@ public class AnnotationViewerMain extends JFrame {
displayError(message);
}
-
+
/*
* (non-Javadoc)
*
@@ -489,5 +498,5 @@ public class AnnotationViewerMain extends JFrame {
@Override
public Dimension getPreferredSize() {
return new Dimension(640, 200);
- }
+ }
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java b/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java
index 47aef16..21788c9 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/RunAE.java
@@ -46,7 +46,6 @@ import org.apache.uima.tools.components.InlineXmlCasConsumer;
import org.apache.uima.tools.components.XmlDetagger;
import org.apache.uima.util.AnalysisEnginePerformanceReports;
-
/**
* An example application that reads documents from the file system, sends them though an Analysis
* Engine(AE), and produces XML files with inline annotations. This application uses a
@@ -57,8 +56,8 @@ import org.apache.uima.util.AnalysisEnginePerformanceReports;
* <AE descriptor or JAR file name> <input dir>
* [<output dir>]</code>
* <p>
- * If <code>output dir</code> is not specified, the analysis results will not be output. This can
- * be useful when only interested in performance statistics.
+ * If <code>output dir</code> is not specified, the analysis results will not be output. This can be
+ * useful when only interested in performance statistics.
* <p>
* <u>OPTIONS</u>
* <p>
@@ -107,7 +106,7 @@ public class RunAE implements StatusCallbackListener {
/** The xmi input. */
private boolean xmiInput = false;
-
+
/** The x lenient. */
private boolean xLenient = false;
@@ -120,7 +119,8 @@ public class RunAE implements StatusCallbackListener {
/**
* Constructor. Sets up and runs an Analysis Engine.
*
- * @param args the args
+ * @param args
+ * the args
*/
public RunAE(String[] args) {
try {
@@ -143,8 +143,8 @@ public class RunAE implements StatusCallbackListener {
.produceCasProcessorConfigurationParameterSettings();
CpeCollectionReader cpeCollRdr = cpeDesc.getAllCollectionCollectionReaders()[0];
cpeCollRdr.setConfigurationParameterSettings(crSettings);
- crSettings.setParameterValue(FileSystemCollectionReader.PARAM_INPUTDIR, inputDir
- .getAbsolutePath());
+ crSettings.setParameterValue(FileSystemCollectionReader.PARAM_INPUTDIR,
+ inputDir.getAbsolutePath());
crSettings.setParameterValue(FileSystemCollectionReader.PARAM_ENCODING, encoding);
crSettings.setParameterValue(FileSystemCollectionReader.PARAM_LANGUAGE, language);
if (xcasInput) {
@@ -160,8 +160,8 @@ public class RunAE implements StatusCallbackListener {
CpeCasProcessor xmlDetaggerCasProc = null;
if (xmlTagName != null && xmlTagName.length() > 0) {
xmlDetaggerCasProc = CpeDescriptorFactory.produceCasProcessor("XmlDetagger");
- CpeComponentDescriptor cpeComponentDescriptor =
- CpeDescriptorFactory.produceComponentDescriptor(XmlDetagger.getDescriptorURL().toString());
+ CpeComponentDescriptor cpeComponentDescriptor = CpeDescriptorFactory
+ .produceComponentDescriptor(XmlDetagger.getDescriptorURL().toString());
xmlDetaggerCasProc.setCpeComponentDescriptor(cpeComponentDescriptor);
CasProcessorConfigurationParameterSettings detaggerSettings = CpeDescriptorFactory
.produceCasProcessorConfigurationParameterSettings();
@@ -173,8 +173,8 @@ public class RunAE implements StatusCallbackListener {
// add user's AE to CPE
CpeCasProcessor casProc = CpeDescriptorFactory.produceCasProcessor("UserAE");
- CpeComponentDescriptor cpeComponentDescriptor =
- CpeDescriptorFactory.produceComponentDescriptor(aeSpecifierFile.getAbsolutePath());
+ CpeComponentDescriptor cpeComponentDescriptor = CpeDescriptorFactory
+ .produceComponentDescriptor(aeSpecifierFile.getAbsolutePath());
casProc.setCpeComponentDescriptor(cpeComponentDescriptor);
casProc.setMaxErrorCount(0);
cpeDesc.addCasProcessor(casProc);
@@ -184,14 +184,14 @@ public class RunAE implements StatusCallbackListener {
CpeCasProcessor casCon = null;
if (outputDir != null) {
casCon = CpeDescriptorFactory.produceCasProcessor("CasConsumer");
- cpeComponentDescriptor =
- CpeDescriptorFactory.produceComponentDescriptor(InlineXmlCasConsumer.getDescriptorURL().toString());
+ cpeComponentDescriptor = CpeDescriptorFactory
+ .produceComponentDescriptor(InlineXmlCasConsumer.getDescriptorURL().toString());
casCon.setCpeComponentDescriptor(cpeComponentDescriptor);
CasProcessorConfigurationParameterSettings consumerSettings = CpeDescriptorFactory
.produceCasProcessorConfigurationParameterSettings();
casCon.setConfigurationParameterSettings(consumerSettings);
- consumerSettings.setParameterValue(InlineXmlCasConsumer.PARAM_OUTPUTDIR, outputDir
- .getAbsolutePath());
+ consumerSettings.setParameterValue(InlineXmlCasConsumer.PARAM_OUTPUTDIR,
+ outputDir.getAbsolutePath());
if (xcasInput) {
consumerSettings.setParameterValue(InlineXmlCasConsumer.PARAM_XCAS, "XCAS");
} else if (xmiInput) {
@@ -237,17 +237,18 @@ public class RunAE implements StatusCallbackListener {
docsProcessed = 0;
mCPE.process();
} catch (Exception e) {
- //special check for using XML detagger with remotes, which will generate an error
- //since sofa mappings aren't supported for remotes
- if (xmlTagName != null && xmlTagName.length() > 0 && e instanceof UIMAException &&
- ((UIMAException)e).hasMessageKey(ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE)) {
- System.err.println("The XML detagging feature (-t) is not supported for remote Analysis Engines or for Aggregates containing remotes.");
- }
- else {
+ // special check for using XML detagger with remotes, which will generate an error
+ // since sofa mappings aren't supported for remotes
+ if (xmlTagName != null && xmlTagName.length() > 0 && e instanceof UIMAException
+ && ((UIMAException) e).hasMessageKey(
+ ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE)) {
+ System.err.println(
+ "The XML detagging feature (-t) is not supported for remote Analysis Engines or for Aggregates containing remotes.");
+ } else {
e.printStackTrace();
}
}
- }
+ }
/**
* Initialization complete.
@@ -261,8 +262,10 @@ public class RunAE implements StatusCallbackListener {
/**
* Entity process complete.
*
- * @param aCas the a cas
- * @param aStatus the a status
+ * @param aCas
+ * the a cas
+ * @param aStatus
+ * the a status
* @see org.apache.uima.collection.StatusCallbackListener#entityProcessComplete(org.apache.uima.cas.CAS,
* org.apache.uima.collection.EntityProcessStatus)
*/
@@ -277,8 +280,8 @@ public class RunAE implements StatusCallbackListener {
// retrieve the filename of the input file from the CAS
// (it was put there by the FileSystemCollectionReader)
if (!(xcasInput || xmiInput)) {
- Type fileLocType = aCas.getTypeSystem().getType(
- "org.apache.uima.examples.SourceDocumentInformation");
+ Type fileLocType = aCas.getTypeSystem()
+ .getType("org.apache.uima.examples.SourceDocumentInformation");
Feature fileNameFeat = fileLocType.getFeatureByBaseName("uri");
FSIterator it = aCas.getAnnotationIndex(fileLocType).iterator();
FeatureStructure fileLoc = it.get();
@@ -370,13 +373,14 @@ public class RunAE implements StatusCallbackListener {
System.err.println("-lenient - ignore out-of-typesystem content when deserializing XML files.");
System.err.println("-l <ISO language> - specify the ISO Language code to set.");
System.err.println("-e <encoding> - specify the character encoding to use.");
-
+
}
/**
* Reads command line arguments and sets static class variables appropriately.
*
- * @param args the args
+ * @param args
+ * the args
* @return true if command line args were valid, false if not
*/
private boolean processCmdLineArgs(String[] args) {
@@ -457,7 +461,8 @@ public class RunAE implements StatusCallbackListener {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
new RunAE(args);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/ValidateDescriptor.java b/uimaj-tools/src/main/java/org/apache/uima/tools/ValidateDescriptor.java
index fe6c66b..fb23364 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/ValidateDescriptor.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/ValidateDescriptor.java
@@ -24,7 +24,6 @@ import org.apache.uima.UIMA_IllegalStateException;
import org.apache.uima.resource.ResourceCreationSpecifier;
import org.apache.uima.util.XMLInputSource;
-
/**
* Command-line utility for validating a descriptor. Supports CollectionReader, CasInitializer,
* AnalysisEngine, and CasConsumer descriptors.
@@ -34,8 +33,10 @@ public class ValidateDescriptor {
/**
* Runs the ValidateDescriptor tool.
*
- * @param args takes one argument, the path to a descriptor file.
- * @throws Exception the exception
+ * @param args
+ * takes one argument, the path to a descriptor file.
+ * @throws Exception
+ * the exception
*/
public static void main(String[] args) throws Exception {
if (args.length != 1) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/annot_view/Gladis.java b/uimaj-tools/src/main/java/org/apache/uima/tools/annot_view/Gladis.java
index 3e93909..83fb6d1 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/annot_view/Gladis.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/annot_view/Gladis.java
@@ -17,14 +17,13 @@
* under the License.
*/
-
package org.apache.uima.tools.annot_view;
import org.apache.uima.tools.cvd.CVD;
-
/**
- * Compatibility class, delegates to the new {@link org.apache.uima.tools.cvd.CVD org.apache.uima.tools.cvd.CVD}.
+ * Compatibility class, delegates to the new {@link org.apache.uima.tools.cvd.CVD
+ * org.apache.uima.tools.cvd.CVD}.
*
* @deprecated Use org.apache.uima.tools.cvd.CVD instead.
*/
@@ -34,7 +33,8 @@ public class Gladis {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
CVD.main(args);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/components/FileSystemCollectionReader.java b/uimaj-tools/src/main/java/org/apache/uima/tools/components/FileSystemCollectionReader.java
index eddfa09..c50946e 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/components/FileSystemCollectionReader.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/components/FileSystemCollectionReader.java
@@ -82,8 +82,8 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
public static final String PARAM_XCAS = "XCAS";
/**
- * Name of the configuration parameter that must be set to indicate if the
- * execution proceeds if an encountered type is unknown
+ * Name of the configuration parameter that must be set to indicate if the execution proceeds if
+ * an encountered type is unknown
*/
public static final String PARAM_LENIENT = "LENIENT";
@@ -98,7 +98,7 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
private boolean mTEXT;
private String mXCAS;
-
+
private boolean lenient;
/**
@@ -111,9 +111,11 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
mEncoding = (String) getConfigParameterValue(PARAM_ENCODING);
mLanguage = (String) getConfigParameterValue(PARAM_LANGUAGE);
mXCAS = (String) getConfigParameterValue(PARAM_XCAS);
- //XCAS parameter can be set to "xcas" or "xmi", as well as "true" (which for historical reasons
- //means the same as "xcas"). Any other value will cause the input file to be treated as a text document.
- mTEXT = !("xcas".equalsIgnoreCase(mXCAS) || "xmi".equalsIgnoreCase(mXCAS) || "true".equalsIgnoreCase(mXCAS));
+ // XCAS parameter can be set to "xcas" or "xmi", as well as "true" (which for historical reasons
+ // means the same as "xcas"). Any other value will cause the input file to be treated as a text
+ // document.
+ mTEXT = !("xcas".equalsIgnoreCase(mXCAS) || "xmi".equalsIgnoreCase(mXCAS)
+ || "true".equalsIgnoreCase(mXCAS));
String mLenient = (String) getConfigParameterValue(PARAM_LENIENT);
lenient = "true".equalsIgnoreCase(mLenient);
@@ -165,7 +167,7 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
getCasInitializer().initializeCas(fis, aCAS);
} else // No CAS Initiliazer, so read file and set document text ourselves
{
- String text = FileUtils.file2String(file, mEncoding);
+ String text = FileUtils.file2String(file, mEncoding);
// put document text in JCas
jcas.setDocumentText(text);
}
@@ -196,8 +198,7 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
try {
if (mXCAS.equalsIgnoreCase("xmi")) {
XmiCasDeserializer.deserialize(fis, aCAS, lenient);
- }
- else {
+ } else {
XCASDeserializer.deserialize(fis, aCAS, lenient);
}
} catch (SAXException e) {
@@ -247,10 +248,10 @@ public class FileSystemCollectionReader extends CollectionReader_ImplBase {
public static CollectionReaderDescription getDescription() throws InvalidXMLException {
InputStream descStream = FileSystemCollectionReader.class
.getResourceAsStream("FileSystemCollectionReader.xml");
- return UIMAFramework.getXMLParser().parseCollectionReaderDescription(
- new XMLInputSource(descStream, null));
+ return UIMAFramework.getXMLParser()
+ .parseCollectionReaderDescription(new XMLInputSource(descStream, null));
}
-
+
public static URL getDescriptorURL() {
return FileSystemCollectionReader.class.getResource("FileSystemCollectionReader.xml");
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/components/InlineXmlCasConsumer.java b/uimaj-tools/src/main/java/org/apache/uima/tools/components/InlineXmlCasConsumer.java
index 02df771..acb20cc 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/components/InlineXmlCasConsumer.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/components/InlineXmlCasConsumer.java
@@ -53,8 +53,8 @@ import org.xml.sax.SAXException;
* This CAS Consumer takes two parameters:
* <ul>
* <li><code>OutputDirectory</code> - path to directory into which output files will be written</li>
- * <li><code>OutputFilter</code> (optional) - an FSMatchConstraint which annotations must match
- * in order to be included in the output. If omitted, all annotations will be included in the
+ * <li><code>OutputFilter</code> (optional) - an FSMatchConstraint which annotations must match in
+ * order to be included in the output. If omitted, all annotations will be included in the
* output.</li>
* </ul>
* <p>
@@ -84,7 +84,7 @@ public class InlineXmlCasConsumer extends CasConsumer_ImplBase {
private int mDocNum;
private String mXCAS;
-
+
private boolean mTEXT;
@Override
@@ -164,8 +164,7 @@ public class InlineXmlCasConsumer extends CasConsumer_ImplBase {
if (mXCAS.equalsIgnoreCase("xcas")) {
XCASSerializer ser = new XCASSerializer(aCAS.getTypeSystem());
ser.serialize(aCAS, xmlSer.getContentHandler());
- }
- else {
+ } else {
XmiCasSerializer ser = new XmiCasSerializer(aCAS.getTypeSystem());
ser.serialize(aCAS, xmlSer.getContentHandler());
}
@@ -199,10 +198,10 @@ public class InlineXmlCasConsumer extends CasConsumer_ImplBase {
public static CasConsumerDescription getDescription() throws InvalidXMLException {
InputStream descStream = InlineXmlCasConsumer.class
.getResourceAsStream("InlineXmlCasConsumer.xml");
- return UIMAFramework.getXMLParser().parseCasConsumerDescription(
- new XMLInputSource(descStream, null));
+ return UIMAFramework.getXMLParser()
+ .parseCasConsumerDescription(new XMLInputSource(descStream, null));
}
-
+
public static URL getDescriptorURL() {
return InlineXmlCasConsumer.class.getResource("InlineXmlCasConsumer.xml");
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/components/XCasWriterCasConsumer.java b/uimaj-tools/src/main/java/org/apache/uima/tools/components/XCasWriterCasConsumer.java
index e0fdfa5..567a6ec 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/components/XCasWriterCasConsumer.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/components/XCasWriterCasConsumer.java
@@ -111,7 +111,8 @@ public class XCasWriterCasConsumer extends CasConsumer_ImplBase {
try {
// handle blanks in path
// https://issues.apache.org/jira/browse/UIMA-1748
- // use 3 arg form of URI Constructor to properly quote any otherwise illegal chars such as blank
+ // use 3 arg form of URI Constructor to properly quote any otherwise illegal chars such as
+ // blank
// https://issues.apache.org/jira/browse/UIMA-2097
URI uri = UriUtils.quote(fileLoc.getUri());
inFile = new File(uri);
@@ -172,8 +173,8 @@ public class XCasWriterCasConsumer extends CasConsumer_ImplBase {
public static CasConsumerDescription getDescription() throws InvalidXMLException {
InputStream descStream = XCasWriterCasConsumer.class
.getResourceAsStream("XCasWriterCasConsumer.xml");
- return UIMAFramework.getXMLParser().parseCasConsumerDescription(
- new XMLInputSource(descStream, null));
+ return UIMAFramework.getXMLParser()
+ .parseCasConsumerDescription(new XMLInputSource(descStream, null));
}
public static URL getDescriptorURL() {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/components/XmiWriterCasConsumer.java b/uimaj-tools/src/main/java/org/apache/uima/tools/components/XmiWriterCasConsumer.java
index 0fbe590..fadf8ea 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/components/XmiWriterCasConsumer.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/components/XmiWriterCasConsumer.java
@@ -104,7 +104,8 @@ public class XmiWriterCasConsumer extends CasConsumer_ImplBase {
try {
// handle blanks in path
// https://issues.apache.org/jira/browse/UIMA-1748
- // use 3 arg form of URI Constructor to properly quote any otherwise illegal chars such as blank
+ // use 3 arg form of URI Constructor to properly quote any otherwise illegal chars such as
+ // blank
// https://issues.apache.org/jira/browse/UIMA-2097
URI uri = UriUtils.quote(fileLoc.getUri());
inFile = new File(uri);
@@ -139,12 +140,16 @@ public class XmiWriterCasConsumer extends CasConsumer_ImplBase {
* CAS to serialize
* @param name
* output file
- * @throws SAXException -
- * @throws Exception -
+ * @throws SAXException
+ * -
+ * @throws Exception
+ * -
*
- * @throws ResourceProcessException -
+ * @throws ResourceProcessException
+ * -
*/
- private void writeXmi(CAS aCas, File name, String modelFileName) throws IOException, SAXException {
+ private void writeXmi(CAS aCas, File name, String modelFileName)
+ throws IOException, SAXException {
try (FileOutputStream out = new FileOutputStream(name)) {
// write XMI
@@ -166,11 +171,11 @@ public class XmiWriterCasConsumer extends CasConsumer_ImplBase {
public static CasConsumerDescription getDescription() throws InvalidXMLException {
InputStream descStream = XCasWriterCasConsumer.class
.getResourceAsStream("XmiWriterCasConsumer.xml");
- return UIMAFramework.getXMLParser().parseCasConsumerDescription(
- new XMLInputSource(descStream, null));
+ return UIMAFramework.getXMLParser()
+ .parseCasConsumerDescription(new XMLInputSource(descStream, null));
}
-
+
public static URL getDescriptorURL() {
return XmiWriterCasConsumer.class.getResource("XmiWriterCasConsumer.xml");
- }
+ }
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/components/XmlDetagger.java b/uimaj-tools/src/main/java/org/apache/uima/tools/components/XmlDetagger.java
index 51f38f0..d95f832 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/components/XmlDetagger.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/components/XmlDetagger.java
@@ -57,19 +57,18 @@ public class XmlDetagger extends CasAnnotator_ImplBase {
* file will be considered the document.
*/
public static final String PARAM_TEXT_TAG = "XmlTagContainingText";
-
+
private SAXParserFactory parserFactory = XMLUtils.createSAXParserFactory();
private Type sourceDocInfoType;
private String mXmlTagContainingText = null;
-
@Override
public void initialize(UimaContext aContext) throws ResourceInitializationException {
super.initialize(aContext);
// Get config param setting
- mXmlTagContainingText = (String) getContext().getConfigParameterValue(PARAM_TEXT_TAG);
+ mXmlTagContainingText = (String) getContext().getConfigParameterValue(PARAM_TEXT_TAG);
}
@Override
@@ -107,7 +106,7 @@ public class XmlDetagger extends CasAnnotator_ImplBase {
}
}
-
+
/**
* Parses and returns the descriptor for this Analysis Gnein. The descriptor is stored in the
* uima-core.jar file and located using the ClassLoader.
@@ -118,15 +117,14 @@ public class XmlDetagger extends CasAnnotator_ImplBase {
* if the descriptor is invalid or missing
*/
public static AnalysisEngineDescription getDescription() throws InvalidXMLException {
- InputStream descStream = XmlDetagger.class
- .getResourceAsStream("XmlDetagger.xml");
- return UIMAFramework.getXMLParser().parseAnalysisEngineDescription(
- new XMLInputSource(descStream, null));
- }
+ InputStream descStream = XmlDetagger.class.getResourceAsStream("XmlDetagger.xml");
+ return UIMAFramework.getXMLParser()
+ .parseAnalysisEngineDescription(new XMLInputSource(descStream, null));
+ }
public static URL getDescriptorURL() {
return XmlDetagger.class.getResource("XmlDetagger.xml");
- }
+ }
class DetagHandler extends DefaultHandler {
private StringBuffer detaggedText = new StringBuffer();
@@ -135,9 +133,10 @@ public class XmlDetagger extends CasAnnotator_ImplBase {
public DetagHandler() {
insideTextTag = (mXmlTagContainingText == null);
}
-
+
@Override
- public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
+ public void startElement(String uri, String localName, String qName, Attributes attributes)
+ throws SAXException {
if (qName.equalsIgnoreCase(mXmlTagContainingText)) {
insideTextTag = true;
}
@@ -153,14 +152,14 @@ public class XmlDetagger extends CasAnnotator_ImplBase {
@Override
public void characters(char[] ch, int start, int length) throws SAXException {
if (insideTextTag) {
- detaggedText.append(ch, start, length);
+ detaggedText.append(ch, start, length);
}
}
-
+
@Override
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException {
if (insideTextTag) {
- detaggedText.append(ch, start, length);
+ detaggedText.append(ch, start, length);
}
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/AnalysisEnginePanel.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/AnalysisEnginePanel.java
index 7908c80..d6f0608 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/AnalysisEnginePanel.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/AnalysisEnginePanel.java
@@ -30,12 +30,11 @@ import org.apache.uima.resource.ResourceSpecifier;
import org.apache.uima.util.InvalidXMLException;
import org.apache.uima.util.XMLInputSource;
-
/**
* The Class AnalysisEnginePanel.
*/
public class AnalysisEnginePanel extends MetaDataPanel {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -5927337001602381195L;
@@ -54,9 +53,12 @@ public class AnalysisEnginePanel extends MetaDataPanel {
/**
* Instantiates a new analysis engine panel.
*
- * @param aeSpecifier the ae specifier
- * @param specifierFile the specifier file
- * @param fileModStamp the file mod stamp
+ * @param aeSpecifier
+ * the ae specifier
+ * @param specifierFile
+ * the specifier file
+ * @param fileModStamp
+ * the file mod stamp
*/
public AnalysisEnginePanel(ResourceSpecifier aeSpecifier, File specifierFile, long fileModStamp) {
super(4); // 4 columns
@@ -86,7 +88,8 @@ public class AnalysisEnginePanel extends MetaDataPanel {
/**
* Sets the last file sync timestamp.
*
- * @param timestamp the new last file sync timestamp
+ * @param timestamp
+ * the new last file sync timestamp
*/
public void setLastFileSyncTimestamp(long timestamp) {
this.lastFileSyncTimestamp = timestamp;
@@ -95,7 +98,8 @@ public class AnalysisEnginePanel extends MetaDataPanel {
/**
* Checks for file changed.
*
- * @param lastCheck the last check
+ * @param lastCheck
+ * the last check
* @return true, if successful
*/
public boolean hasFileChanged(long lastCheck) {
@@ -106,13 +110,15 @@ public class AnalysisEnginePanel extends MetaDataPanel {
/**
* Refresh from file.
*
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
public void refreshFromFile() throws InvalidXMLException, IOException {
clearAll();
- this.aeSpecifier = UIMAFramework.getXMLParser().parseResourceSpecifier(
- new XMLInputSource(this.specifierFile));
+ this.aeSpecifier = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(new XMLInputSource(this.specifierFile));
if (aeSpecifier instanceof AnalysisEngineDescription) {
AnalysisEngineDescription aeDescription = (AnalysisEngineDescription) aeSpecifier;
populate(aeDescription.getMetaData(), null);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConfigField.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConfigField.java
index 3766aec..5dfa2d8 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConfigField.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConfigField.java
@@ -28,7 +28,6 @@ import javax.swing.JTextField;
import org.apache.uima.tools.util.gui.FileSelector;
import org.apache.uima.tools.util.gui.ListSelector;
-
/**
* Configuration Field class used for representation of resource parameters in dynamically created
* MetaDataPanels.
@@ -36,7 +35,7 @@ import org.apache.uima.tools.util.gui.ListSelector;
* @see org.apache.uima.tools.cpm.MetaDataPanel
*/
public class ConfigField {
-
+
/** The parameter name. */
private String parameterName;
@@ -58,10 +57,14 @@ public class ConfigField {
/**
* Instantiates a new config field.
*
- * @param pn Resource parameter name e.g. outputDir
- * @param cs String value of Java type used for value e.g. Integer
- * @param mv true if the value is a multi-value array
- * @param c Component used to represent field - Could be JTextField, JCheckBox, FileSelector or
+ * @param pn
+ * Resource parameter name e.g. outputDir
+ * @param cs
+ * String value of Java type used for value e.g. Integer
+ * @param mv
+ * true if the value is a multi-value array
+ * @param c
+ * Component used to represent field - Could be JTextField, JCheckBox, FileSelector or
* ListSelector
*/
public ConfigField(String pn, String cs, boolean mv, JComponent c) {
@@ -166,7 +169,8 @@ public class ConfigField {
/**
* Sets the field value.
*
- * @param fieldValue the new field value
+ * @param fieldValue
+ * the new field value
*/
public void setFieldValue(Object fieldValue) {
if (fieldComponent instanceof JTextField) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConsumerPanel.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConsumerPanel.java
index c3eb5b9..7bb7d56 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConsumerPanel.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ConsumerPanel.java
@@ -28,12 +28,11 @@ import org.apache.uima.resource.ResourceSpecifier;
import org.apache.uima.util.InvalidXMLException;
import org.apache.uima.util.XMLInputSource;
-
/**
* The Class ConsumerPanel.
*/
public class ConsumerPanel extends MetaDataPanel {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -6822046781435538398L;
@@ -49,11 +48,15 @@ public class ConsumerPanel extends MetaDataPanel {
/**
* Instantiates a new consumer panel.
*
- * @param casConsumerSpecifier the cas consumer specifier
- * @param specifierFile the specifier file
- * @param fileModStamp the file mod stamp
+ * @param casConsumerSpecifier
+ * the cas consumer specifier
+ * @param specifierFile
+ * the specifier file
+ * @param fileModStamp
+ * the file mod stamp
*/
- public ConsumerPanel(ResourceSpecifier casConsumerSpecifier, File specifierFile, long fileModStamp) {
+ public ConsumerPanel(ResourceSpecifier casConsumerSpecifier, File specifierFile,
+ long fileModStamp) {
super(4); // 4 columns
this.casConsumerSpecifier = casConsumerSpecifier;
@@ -82,7 +85,8 @@ public class ConsumerPanel extends MetaDataPanel {
/**
* Sets the last file sync timestamp.
*
- * @param timestamp the new last file sync timestamp
+ * @param timestamp
+ * the new last file sync timestamp
*/
public void setLastFileSyncTimestamp(long timestamp) {
this.lastFileSyncTimestamp = timestamp;
@@ -91,7 +95,8 @@ public class ConsumerPanel extends MetaDataPanel {
/**
* Checks for file changed.
*
- * @param lastCheck the last check
+ * @param lastCheck
+ * the last check
* @return true, if successful
*/
public boolean hasFileChanged(long lastCheck) {
@@ -102,13 +107,15 @@ public class ConsumerPanel extends MetaDataPanel {
/**
* Refresh from file.
*
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
public void refreshFromFile() throws InvalidXMLException, IOException {
clearAll();
- this.casConsumerSpecifier = UIMAFramework.getXMLParser().parseResourceSpecifier(
- new XMLInputSource(this.specifierFile));
+ this.casConsumerSpecifier = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(new XMLInputSource(this.specifierFile));
if (casConsumerSpecifier instanceof CasConsumerDescription) {
CasConsumerDescription consumerDescription = (CasConsumerDescription) casConsumerSpecifier;
populate(consumerDescription.getMetaData(), null);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmFrame.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmFrame.java
index daac8da..ac832df 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmFrame.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmFrame.java
@@ -46,12 +46,11 @@ import org.apache.uima.tools.images.Images;
import org.apache.uima.tools.util.gui.AboutDialog;
import org.apache.uima.tools.util.gui.FileChooserBugWorkarounds;
-
/**
* The Class CpmFrame.
*/
public class CpmFrame extends JFrame implements ActionListener {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 756368351780483658L;
@@ -135,7 +134,7 @@ public class CpmFrame extends JFrame implements ActionListener {
exitMenuItem = new JMenuItem("Exit");
exitMenuItem.addActionListener(this);
fileMenu.add(exitMenuItem);
-
+
JMenu viewMenu = new JMenu("View");
List viewMenuItems = cpmPanel.createViewMenuItems();
iter = viewMenuItems.iterator();
@@ -157,7 +156,9 @@ public class CpmFrame extends JFrame implements ActionListener {
return menuBar;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
@@ -174,7 +175,9 @@ public class CpmFrame extends JFrame implements ActionListener {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.Container#getPreferredSize()
*/
@Override
@@ -186,19 +189,20 @@ public class CpmFrame extends JFrame implements ActionListener {
/**
* Runs the application.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
- //GUI creation must be done in the event handler thread, because Swing is
- //not thread-safe. This is particularly important for the CPE Configurator
- //because it's initialization can be quite complex (it loads the last known
- //CPE descriptor).
+ // GUI creation must be done in the event handler thread, because Swing is
+ // not thread-safe. This is particularly important for the CPE Configurator
+ // because it's initialization can be quite complex (it loads the last known
+ // CPE descriptor).
SwingUtilities.invokeLater(new Runnable() {
@Override
public void run() {
- initGUI();
+ initGUI();
}
- });
+ });
}
/**
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmPanel.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmPanel.java
index 3fc8988..c61abf8 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmPanel.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/CpmPanel.java
@@ -101,13 +101,12 @@ import org.apache.uima.util.Progress;
import org.apache.uima.util.UriUtils;
import org.apache.uima.util.XMLInputSource;
-
/**
* The Class CpmPanel.
*/
public class CpmPanel extends JPanel implements ActionListener, FileSelectorListener,
TabClosedListener, TransportControlListener {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -5096300176103368922L;
@@ -125,9 +124,9 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/** The Constant PREFS_CPE_DESCRIPTOR_FILE. */
private static final String PREFS_CPE_DESCRIPTOR_FILE = "cpeDescriptorFile";
-
+
/** The Constant PREFS_SAVE_USING_IMPORTS. */
- private static final String PREFS_SAVE_USING_IMPORTS ="saveUsingImports";
+ private static final String PREFS_SAVE_USING_IMPORTS = "saveUsingImports";
/** The open cpe desc menu item. */
private JMenuItem openCpeDescMenuItem;
@@ -265,7 +264,7 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/** The last file sync user prompt time. */
private long lastFileSyncUserPromptTime;
- /** Stores user preferences. */
+ /** Stores user preferences. */
private Preferences prefs = Preferences.userRoot().node("org/apache/uima/tools/CPE_GUI");
/** The m shutting down. */
@@ -282,10 +281,10 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/** The current cpe desc. */
private CpeDescription currentCpeDesc = createEmptyCpeDescription();
-
+
/** The default resource manager. */
private final ResourceManager defaultResourceManager = UIMAFramework.newDefaultResourceManager();
-
+
/** The save using imports. */
private boolean saveUsingImports = true;
@@ -296,7 +295,6 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
* Instantiates a new cpm panel.
*/
public CpmPanel() {
-
// The following is VERY flaky:
// Don't 'try' this at home:
@@ -458,7 +456,7 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
initFileChoosers();
- //create file selectors (used to populate CR and CI panels later)
+ // create file selectors (used to populate CR and CI panels later)
readerFileSelector = new FileSelector(null, "Collection Reader Descriptor",
JFileChooser.FILES_ONLY, fileChooserRootDir, new XMLFileFilter());
readerFileSelector.addFileSelectorListener(this, collectionReaderPanel);
@@ -477,7 +475,7 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
// CAS initializer panel is initially hidden since it is deprecated
setCasInitializerPanelVisible(false);
-
+
// read preferences (loads last opened CPE descriptor)
if (System.getProperty("uima.noprefs") == null) {
readPreferences();
@@ -512,8 +510,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
consumerFileChooser.addChoosableFileFilter(new XMLFileFilter());
File consumerDescDir = fileChooserRootDir;
if (consumerSpecifiers.size() > 0) {
- File lastConsumerFile = new File((String) consumerSpecifiers
- .get(consumerSpecifiers.size() - 1));
+ File lastConsumerFile = new File(
+ (String) consumerSpecifiers.get(consumerSpecifiers.size() - 1));
consumerDescDir = lastConsumerFile.getParentFile();
}
if (consumerDescDir.exists()) {
@@ -557,13 +555,13 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
refreshMenuItem.addActionListener(this);
menuItemList.add(refreshMenuItem);
- JMenu saveOptionsSubmenu = new JMenu ("Save Options");
+ JMenu saveOptionsSubmenu = new JMenu("Save Options");
saveUsingImportMenuItem = new JCheckBoxMenuItem("Use <import>");
saveUsingImportMenuItem.addActionListener(this);
saveUsingImportMenuItem.setSelected(saveUsingImports);
saveOptionsSubmenu.add(saveUsingImportMenuItem);
menuItemList.add(saveOptionsSubmenu);
-
+
clearAllMenuItem = new JMenuItem("Clear All");
clearAllMenuItem.addActionListener(this);
menuItemList.add(clearAllMenuItem);
@@ -586,11 +584,12 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
return menuItemList;
}
-
+
/**
* Sets the cas initializer panel visible.
*
- * @param visible the new cas initializer panel visible
+ * @param visible
+ * the new cas initializer panel visible
*/
private void setCasInitializerPanelVisible(boolean visible) {
casInitializerPanel.setVisible(visible);
@@ -626,7 +625,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Sets the save using imports.
*
- * @param b the new save using imports
+ * @param b
+ * the new save using imports
*/
private void setSaveUsingImports(boolean b) {
saveUsingImports = b;
@@ -653,8 +653,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
updateCpeDescriptionParameterOverrides();
// intantiate CPE
- mCPE = null; // to allow GC of previous ae's that may
- // hold onto lots of memory e.g. OpenNLP
+ mCPE = null; // to allow GC of previous ae's that may
+ // hold onto lots of memory e.g. OpenNLP
mCPE = UIMAFramework.produceCollectionProcessingEngine(currentCpeDesc);
// attach callback listener
@@ -674,7 +674,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
* Updates the configuration parameter settings in this.currentCpeDesc to match the current state
* of the GUI.
*
- * @throws Exception the exception
+ * @throws Exception
+ * the exception
*/
private void updateCpeDescriptionParameterOverrides() throws Exception {
// first check for descriptors out of sync with filesystem
@@ -722,8 +723,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
}
// CAS Consumers
for (int i = 0; i < consumerSpecifiers.size(); i++) {
- CpeCasProcessor casProc = currentCpeDesc.getCpeCasProcessors().getCpeCasProcessor(
- aeSpecifiers.size() + i);
+ CpeCasProcessor casProc = currentCpeDesc.getCpeCasProcessors()
+ .getCpeCasProcessor(aeSpecifiers.size() + i);
ConsumerPanel consumerPanel = (ConsumerPanel) consumerTabbedPane.getComponentAt(i);
if (consumerPanel.isModified()) {
CasProcessorConfigurationParameterSettings settings = CpeDescriptorFactory
@@ -740,9 +741,12 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
* Called by createCpeDescription to add configuration parameter overrides to the CpeDescription
* being constructed, based on the user's changes in the GUI.
*
- * @param aSettings the CasProcessorConfigurationParameterSettings element that will be modified
- * @param aPanel the GUI panel representing settings for the CAS Processor
- * @throws CpeDescriptorException the cpe descriptor exception
+ * @param aSettings
+ * the CasProcessorConfigurationParameterSettings element that will be modified
+ * @param aPanel
+ * the GUI panel representing settings for the CAS Processor
+ * @throws CpeDescriptorException
+ * the cpe descriptor exception
*/
private void createParameterOverrides(CasProcessorConfigurationParameterSettings aSettings,
MetaDataPanel aPanel) throws CpeDescriptorException {
@@ -776,7 +780,9 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
selectedComponentsChanged = false;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
@@ -828,8 +834,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
if (index > 0) {
// update CPE descriptor
try {
- CpeCasProcessor casProcToMove = currentCpeDesc.getCpeCasProcessors().getCpeCasProcessor(
- index);
+ CpeCasProcessor casProcToMove = currentCpeDesc.getCpeCasProcessors()
+ .getCpeCasProcessor(index);
currentCpeDesc.getCpeCasProcessors().removeCpeCasProcessor(index);
currentCpeDesc.getCpeCasProcessors().addCpeCasProcessor(casProcToMove, index - 1);
} catch (CpeDescriptorException e) {
@@ -847,8 +853,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
if (index > -1 && index < aeTabbedPane.getTabCount() - 1) {
// update CPE descriptor
try {
- CpeCasProcessor casProcToMove = currentCpeDesc.getCpeCasProcessors().getCpeCasProcessor(
- index);
+ CpeCasProcessor casProcToMove = currentCpeDesc.getCpeCasProcessors()
+ .getCpeCasProcessor(index);
currentCpeDesc.getCpeCasProcessors().removeCpeCasProcessor(index);
currentCpeDesc.getCpeCasProcessors().addCpeCasProcessor(casProcToMove, index + 1);
} catch (CpeDescriptorException e) {
@@ -889,8 +895,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
// update CPE descriptor
try {
int absIndex = aeSpecifiers.size() + index;
- CpeCasProcessor casProcToMove = currentCpeDesc.getCpeCasProcessors().getCpeCasProcessor(
- absIndex);
+ CpeCasProcessor casProcToMove = currentCpeDesc.getCpeCasProcessors()
+ .getCpeCasProcessor(absIndex);
currentCpeDesc.getCpeCasProcessors().removeCpeCasProcessor(absIndex);
currentCpeDesc.getCpeCasProcessors().addCpeCasProcessor(casProcToMove, absIndex - 1);
} catch (CpeDescriptorException e) {
@@ -909,8 +915,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
// update CPE descriptor
try {
int absIndex = aeSpecifiers.size() + index;
- CpeCasProcessor casProcToMove = currentCpeDesc.getCpeCasProcessors().getCpeCasProcessor(
- absIndex);
+ CpeCasProcessor casProcToMove = currentCpeDesc.getCpeCasProcessors()
+ .getCpeCasProcessor(absIndex);
currentCpeDesc.getCpeCasProcessors().removeCpeCasProcessor(absIndex);
currentCpeDesc.getCpeCasProcessors().addCpeCasProcessor(casProcToMove, absIndex + 1);
} catch (CpeDescriptorException e) {
@@ -945,8 +951,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
} else if (source == viewCasInitializerPanelMenuItem) {
setCasInitializerPanelVisible(!casInitializerPanel.isVisible());
} else if (source == saveUsingImportMenuItem) {
- setSaveUsingImports(!saveUsingImports);
- }
+ setSaveUsingImports(!saveUsingImports);
+ }
}
/**
@@ -1011,15 +1017,17 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Do save cpe descriptor.
*
- * @param aFile the a file
- * @throws Exception the exception
+ * @param aFile
+ * the a file
+ * @throws Exception
+ * the exception
*/
private void doSaveCpeDescriptor(File aFile) throws Exception {
// update the parameter overrides according to GUI settings
updateCpeDescriptionParameterOverrides();
-
+
if (saveUsingImports) {
- //replace <include> with <import>, and update relative import paths
+ // replace <include> with <import>, and update relative import paths
updateImports(aFile);
}
@@ -1038,17 +1046,19 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
}
}
- //mark descriptor with new location, for later import resolution
+ // mark descriptor with new location, for later import resolution
currentCpeDesc.setSourceUrl(aFile.toURI().toURL());
-
+
clearDirty();
}
/**
* Update imports.
*
- * @param cpeDescSaveFile the cpe desc save file
- * @throws Exception the exception
+ * @param cpeDescSaveFile
+ * the cpe desc save file
+ * @throws Exception
+ * the exception
*/
private void updateImports(File cpeDescSaveFile) throws Exception {
CpeCollectionReader[] readers = currentCpeDesc.getAllCollectionCollectionReaders();
@@ -1064,46 +1074,51 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
for (int i = 0; i < casProcs.length; i++) {
updateImport(casProcs[i].getCpeComponentDescriptor(), cpeDescSaveFile);
}
-
+
}
/**
* Update import.
*
- * @param descriptor the descriptor
- * @param cpeDescSaveFile the cpe desc save file
- * @throws Exception the exception
+ * @param descriptor
+ * the descriptor
+ * @param cpeDescSaveFile
+ * the cpe desc save file
+ * @throws Exception
+ * the exception
*/
- private void updateImport(CpeComponentDescriptor descriptor, File cpeDescSaveFile) throws Exception {
- //don't touch import by name
+ private void updateImport(CpeComponentDescriptor descriptor, File cpeDescSaveFile)
+ throws Exception {
+ // don't touch import by name
if (descriptor.getImport() != null && descriptor.getImport().getName() != null)
return;
-
- //for include or import by location, get the absolute URL of the descriptor
+
+ // for include or import by location, get the absolute URL of the descriptor
URL descUrl = descriptor.findAbsoluteUrl(defaultResourceManager);
-
- //don't touch URLs with protocol other than file:
+
+ // don't touch URLs with protocol other than file:
if ("file".equals(descUrl.getProtocol())) {
File descFile = urlToFile(descUrl);
- //try to find relative path from cpeDescSaveFile to descFile
+ // try to find relative path from cpeDescSaveFile to descFile
String relPath = FileUtils.findRelativePath(descFile, cpeDescSaveFile.getParentFile());
if (relPath != null) {
- //update CPE descriptor
+ // update CPE descriptor
descriptor.setInclude(null);
Import newImport = UIMAFramework.getResourceSpecifierFactory().createImport();
newImport.setLocation(relPath);
descriptor.setImport(newImport);
}
- }
+ }
}
/**
- * Utility method for convertion a URL to a File name, taking care of
- * proper escaping.
+ * Utility method for convertion a URL to a File name, taking care of proper escaping.
*
- * @param url a URL
+ * @param url
+ * a URL
* @return File corresponding to that URL
- * @throws URISyntaxException the URI syntax exception
+ * @throws URISyntaxException
+ * the URI syntax exception
*/
private File urlToFile(URL url) throws URISyntaxException {
return new File(UriUtils.quote(url));
@@ -1128,7 +1143,7 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
}
}
- if (FILE_ENTITY_PROGRESS_INDEX >= 0) { // uima-1086
+ if (FILE_ENTITY_PROGRESS_INDEX >= 0) { // uima-1086
int value = (int) progress[FILE_ENTITY_PROGRESS_INDEX].getCompleted();
progressBar.setValue(value);
@@ -1145,7 +1160,7 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
}
/**
- * Ask user to confirm exist. Return true if they confirm, false if not.
+ * Ask user to confirm exist. Return true if they confirm, false if not.
*
* @return true, if successful
*/
@@ -1168,9 +1183,10 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
// ask for confirm if configuration settings have been modified
try {
if (isDirty()) {
- int rv = JOptionPane.showConfirmDialog(this, "Configuration settings have been modified. "
- + "Would you like to save the CPE descriptor?", "Exit",
- JOptionPane.YES_NO_CANCEL_OPTION);
+ int rv = JOptionPane.showConfirmDialog(this,
+ "Configuration settings have been modified. "
+ + "Would you like to save the CPE descriptor?",
+ "Exit", JOptionPane.YES_NO_CANCEL_OPTION);
if (rv == JOptionPane.CANCEL_OPTION) {
mShuttingDown = false;
@@ -1248,8 +1264,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
File readerSpecifierFile = new File(readerFileSelector.getSelected());
if (readerSpecifierFile.lastModified() > this.collectionReaderLastFileSyncTimestamp) {
try {
- populateCollectionReaderPanel(currentCpeDesc.getAllCollectionCollectionReaders()[0]
- .getCollectionIterator());
+ populateCollectionReaderPanel(
+ currentCpeDesc.getAllCollectionCollectionReaders()[0].getCollectionIterator());
} catch (Exception e) {
displayError(e);
}
@@ -1260,8 +1276,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
File casInitializerSpecifierFile = new File(casInitializerFileSelector.getSelected());
if (casInitializerSpecifierFile.lastModified() > this.casInitializerLastFileSyncTimestamp) {
try {
- populateCasInitializerPanel(currentCpeDesc.getAllCollectionCollectionReaders()[0]
- .getCasInitializer());
+ populateCasInitializerPanel(
+ currentCpeDesc.getAllCollectionCollectionReaders()[0].getCasInitializer());
} catch (Exception e) {
displayError(e);
}
@@ -1357,11 +1373,15 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Populate collection reader panel.
*
- * @param cpeColRdr the cpe col rdr
+ * @param cpeColRdr
+ * the cpe col rdr
* @return true, if successful
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws ResourceConfigurationException the resource configuration exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws ResourceConfigurationException
+ * the resource configuration exception
*/
private boolean populateCollectionReaderPanel(CpeCollectionReaderIterator cpeColRdr)
throws InvalidXMLException, IOException, ResourceConfigurationException {
@@ -1370,12 +1390,12 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
String specifierFile = null;
if (cpeColRdr != null) {
specifierUrl = cpeColRdr.getDescriptor().findAbsoluteUrl(defaultResourceManager);
- //CPE GUI only supports file URLs
+ // CPE GUI only supports file URLs
if (!"file".equals(specifierUrl.getProtocol())) {
- displayError("Could not load descriptor from URL " + specifierUrl.toString() +
- ". CPE Configurator only supports file: URLs");
+ displayError("Could not load descriptor from URL " + specifierUrl.toString()
+ + ". CPE Configurator only supports file: URLs");
return false;
- }
+ }
try {
specifierFile = urlToFile(specifierUrl).toString();
} catch (URISyntaxException e) {
@@ -1409,10 +1429,10 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
} else {
collectionReaderLastFileSyncTimestamp = f.lastModified();
XMLInputSource readerInputSource = new XMLInputSource(f);
- collectionReaderDesc = UIMAFramework.getXMLParser().parseCollectionReaderDescription(
- readerInputSource);
- collectionReaderPanel.populate(collectionReaderDesc.getMetaData(), cpeColRdr
- .getConfigurationParameterSettings());
+ collectionReaderDesc = UIMAFramework.getXMLParser()
+ .parseCollectionReaderDescription(readerInputSource);
+ collectionReaderPanel.populate(collectionReaderDesc.getMetaData(),
+ cpeColRdr.getConfigurationParameterSettings());
}
}
return true;
@@ -1426,11 +1446,15 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Populate cas initializer panel.
*
- * @param cpeCasIni the cpe cas ini
+ * @param cpeCasIni
+ * the cpe cas ini
* @return true, if successful
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws ResourceConfigurationException the resource configuration exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws ResourceConfigurationException
+ * the resource configuration exception
*/
private boolean populateCasInitializerPanel(CpeCollectionReaderCasInitializer cpeCasIni)
throws InvalidXMLException, IOException, ResourceConfigurationException {
@@ -1439,12 +1463,12 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
String specifierFile = null;
if (cpeCasIni != null) {
specifierUrl = cpeCasIni.getDescriptor().findAbsoluteUrl(defaultResourceManager);
- //CPE GUI only supports file URLs
+ // CPE GUI only supports file URLs
if (!"file".equals(specifierUrl.getProtocol())) {
- displayError("Could not load descriptor from URL " + specifierUrl.toString() +
- ". CPE Configurator only supports file: URLs");
+ displayError("Could not load descriptor from URL " + specifierUrl.toString()
+ + ". CPE Configurator only supports file: URLs");
return false;
- }
+ }
try {
specifierFile = urlToFile(specifierUrl).toString();
} catch (URISyntaxException e) {
@@ -1481,11 +1505,11 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
} else {
casInitializerLastFileSyncTimestamp = f.lastModified();
XMLInputSource casIniInputSource = new XMLInputSource(f);
- casInitializerDesc = UIMAFramework.getXMLParser().parseCasInitializerDescription(
- casIniInputSource);
+ casInitializerDesc = UIMAFramework.getXMLParser()
+ .parseCasInitializerDescription(casIniInputSource);
- casInitializerPanel.populate(casInitializerDesc.getMetaData(), cpeCasIni
- .getConfigurationParameterSettings());
+ casInitializerPanel.populate(casInitializerDesc.getMetaData(),
+ cpeCasIni.getConfigurationParameterSettings());
return true;
}
} finally {
@@ -1497,11 +1521,16 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Adds the AE.
*
- * @param aeSpecifierFile the ae specifier file
- * @throws CpeDescriptorException the cpe descriptor exception
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws ResourceConfigurationException the resource configuration exception
+ * @param aeSpecifierFile
+ * the ae specifier file
+ * @throws CpeDescriptorException
+ * the cpe descriptor exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws ResourceConfigurationException
+ * the resource configuration exception
*/
private void addAE(String aeSpecifierFile) throws CpeDescriptorException, InvalidXMLException,
IOException, ResourceConfigurationException {
@@ -1521,22 +1550,28 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Adds the AE.
*
- * @param cpeCasProc the cpe cas proc
+ * @param cpeCasProc
+ * the cpe cas proc
* @return true, if successful
- * @throws CpeDescriptorException the cpe descriptor exception
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws ResourceConfigurationException the resource configuration exception
+ * @throws CpeDescriptorException
+ * the cpe descriptor exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws ResourceConfigurationException
+ * the resource configuration exception
*/
private boolean addAE(CpeCasProcessor cpeCasProc) throws CpeDescriptorException,
InvalidXMLException, IOException, ResourceConfigurationException {
- URL aeSpecifierUrl = cpeCasProc.getCpeComponentDescriptor().findAbsoluteUrl(defaultResourceManager);
- //CPE GUI only supports file URLs
+ URL aeSpecifierUrl = cpeCasProc.getCpeComponentDescriptor()
+ .findAbsoluteUrl(defaultResourceManager);
+ // CPE GUI only supports file URLs
if (!"file".equals(aeSpecifierUrl.getProtocol())) {
- displayError("Could not load descriptor from URL " + aeSpecifierUrl.toString() +
- ". CPE Configurator only supports file: URLs");
+ displayError("Could not load descriptor from URL " + aeSpecifierUrl.toString()
+ + ". CPE Configurator only supports file: URLs");
return false;
- }
+ }
File f;
try {
f = urlToFile(aeSpecifierUrl);
@@ -1546,8 +1581,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
}
long fileModStamp = f.lastModified(); // get mod stamp before parsing, to prevent race condition
XMLInputSource aeInputSource = new XMLInputSource(aeSpecifierUrl);
- ResourceSpecifier aeSpecifier = UIMAFramework.getXMLParser().parseResourceSpecifier(
- aeInputSource);
+ ResourceSpecifier aeSpecifier = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(aeInputSource);
AnalysisEnginePanel aePanel = new AnalysisEnginePanel(aeSpecifier, f, fileModStamp);
String tabName;
@@ -1572,11 +1607,16 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Adds the consumer.
*
- * @param consumerSpecifierFile the consumer specifier file
- * @throws CpeDescriptorException the cpe descriptor exception
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws ResourceConfigurationException the resource configuration exception
+ * @param consumerSpecifierFile
+ * the consumer specifier file
+ * @throws CpeDescriptorException
+ * the cpe descriptor exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws ResourceConfigurationException
+ * the resource configuration exception
*/
private void addConsumer(String consumerSpecifierFile) throws CpeDescriptorException,
InvalidXMLException, IOException, ResourceConfigurationException {
@@ -1595,23 +1635,28 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Adds the consumer.
*
- * @param cpeCasProc the cpe cas proc
+ * @param cpeCasProc
+ * the cpe cas proc
* @return true, if successful
- * @throws CpeDescriptorException the cpe descriptor exception
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws ResourceConfigurationException the resource configuration exception
+ * @throws CpeDescriptorException
+ * the cpe descriptor exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws ResourceConfigurationException
+ * the resource configuration exception
*/
private boolean addConsumer(CpeCasProcessor cpeCasProc) throws CpeDescriptorException,
InvalidXMLException, IOException, ResourceConfigurationException {
- URL consumerSpecifierUrl = cpeCasProc.getCpeComponentDescriptor().findAbsoluteUrl(
- defaultResourceManager);
- //CPE GUI only supports file URLs
+ URL consumerSpecifierUrl = cpeCasProc.getCpeComponentDescriptor()
+ .findAbsoluteUrl(defaultResourceManager);
+ // CPE GUI only supports file URLs
if (!"file".equals(consumerSpecifierUrl.getProtocol())) {
- displayError("Could not load descriptor from URL " + consumerSpecifierUrl.toString() +
- ". CPE Configurator only supports file: URLs");
+ displayError("Could not load descriptor from URL " + consumerSpecifierUrl.toString()
+ + ". CPE Configurator only supports file: URLs");
return false;
- }
+ }
File f;
try {
f = urlToFile(consumerSpecifierUrl);
@@ -1622,8 +1667,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
long fileModStamp = f.lastModified(); // get mod stamp before parsing, to prevent race condition
XMLInputSource consumerInputSource = new XMLInputSource(consumerSpecifierUrl);
- ResourceSpecifier casConsumerSpecifier = UIMAFramework.getXMLParser().parseResourceSpecifier(
- consumerInputSource);
+ ResourceSpecifier casConsumerSpecifier = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(consumerInputSource);
ConsumerPanel consumerPanel = new ConsumerPanel(casConsumerSpecifier, f, fileModStamp);
String tabName;
@@ -1647,7 +1692,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Make unique cas processor name.
*
- * @param baseName the base name
+ * @param baseName
+ * the base name
* @return the string
*/
private String makeUniqueCasProcessorName(String baseName) {
@@ -1674,8 +1720,11 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
consumerSpecifiers.clear();
}
- /* (non-Javadoc)
- * @see org.apache.uima.tools.util.gui.FileSelectorListener#fileSelected(javax.swing.JComponent, java.lang.String)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.tools.util.gui.FileSelectorListener#fileSelected(javax.swing.JComponent,
+ * java.lang.String)
*/
// FileSelectorListener:
@Override
@@ -1691,15 +1740,15 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
currentCpeDesc.setAllCollectionCollectionReaders(null);
currentCpeDesc.addCollectionReader(fileString);
CpeCollectionReader[] readers = currentCpeDesc.getAllCollectionCollectionReaders();
-
-// CpeCollectionReader[] readers = currentCpeDesc.getAllCollectionCollectionReaders();
-// if (readers.length == 0) {
-// currentCpeDesc.addCollectionReader(fileString);
-// readers = currentCpeDesc.getAllCollectionCollectionReaders();
-// } else {
-// readers[0].getCollectionIterator().getDescriptor().getInclude().set(fileString);
-// readers[0].getCollectionIterator().setConfigurationParameterSettings(null);
-// }
+
+ // CpeCollectionReader[] readers = currentCpeDesc.getAllCollectionCollectionReaders();
+ // if (readers.length == 0) {
+ // currentCpeDesc.addCollectionReader(fileString);
+ // readers = currentCpeDesc.getAllCollectionCollectionReaders();
+ // } else {
+ // readers[0].getCollectionIterator().getDescriptor().getInclude().set(fileString);
+ // readers[0].getCollectionIterator().setConfigurationParameterSettings(null);
+ // }
rv = populateCollectionReaderPanel(readers[0].getCollectionIterator());
} else {
@@ -1713,16 +1762,16 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
currentCpeDesc.setAllCollectionCollectionReaders(null);
currentCpeDesc.addCasInitializer(fileString);
CpeCollectionReader[] readers = currentCpeDesc.getAllCollectionCollectionReaders();
-
-// CpeCollectionReader[] readers = currentCpeDesc.getAllCollectionCollectionReaders();
-// if (readers.length == 0 || readers[0].getCasInitializer() == null) {
-// currentCpeDesc.addCasInitializer(fileString);
-// readers = currentCpeDesc.getAllCollectionCollectionReaders();
-// } else {
-// readers[0].getCasInitializer().getDescriptor().getInclude().set(fileString);
-// // clear config settings
-// readers[0].getCasInitializer().setConfigurationParameterSettings(null);
-// }
+
+ // CpeCollectionReader[] readers = currentCpeDesc.getAllCollectionCollectionReaders();
+ // if (readers.length == 0 || readers[0].getCasInitializer() == null) {
+ // currentCpeDesc.addCasInitializer(fileString);
+ // readers = currentCpeDesc.getAllCollectionCollectionReaders();
+ // } else {
+ // readers[0].getCasInitializer().getDescriptor().getInclude().set(fileString);
+ // // clear config settings
+ // readers[0].getCasInitializer().setConfigurationParameterSettings(null);
+ // }
rv = populateCasInitializerPanel(readers[0].getCasInitializer());
} else {
// no CAS initializer selected - OK
@@ -1744,8 +1793,11 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
return rv;
}
- /* (non-Javadoc)
- * @see org.apache.uima.tools.cpm.TabClosedListener#tabClosed(org.apache.uima.tools.cpm.JTabbedPaneWithCloseIcons, int)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.tools.cpm.TabClosedListener#tabClosed(org.apache.uima.tools.cpm.
+ * JTabbedPaneWithCloseIcons, int)
*/
// TabClosedListener:
@Override
@@ -1764,7 +1816,9 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.util.gui.TransportControlListener#controlStarted()
*/
@Override
@@ -1774,7 +1828,9 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
setFrameEnabled(false);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.util.gui.TransportControlListener#controlPaused()
*/
@Override
@@ -1792,13 +1848,15 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
progressTimer.stop();
performanceQueryTimer.stop();
- PerformanceReportDialog perfReportDlg = new PerformanceReportDialog(CpmPanel.this
- .getParentFrame());
+ PerformanceReportDialog perfReportDlg = new PerformanceReportDialog(
+ CpmPanel.this.getParentFrame());
perfReportDlg.displayStats(mCPE.getPerformanceReport(), progressBar.getValue(),
"Processing is paused.");
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.util.gui.TransportControlListener#controlResumed()
*/
@Override
@@ -1814,7 +1872,9 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
performanceQueryTimer.restart();
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.util.gui.TransportControlListener#controlStopped()
*/
@Override
@@ -1969,11 +2029,16 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Open cpe descriptor.
*
- * @param aFile the a file
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws CpeDescriptorException the cpe descriptor exception
- * @throws ResourceConfigurationException the resource configuration exception
+ * @param aFile
+ * the a file
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws CpeDescriptorException
+ * the cpe descriptor exception
+ * @throws ResourceConfigurationException
+ * the resource configuration exception
*/
private void openCpeDescriptor(File aFile) throws InvalidXMLException, IOException,
CpeDescriptorException, ResourceConfigurationException {
@@ -1983,8 +2048,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
// update GUI
// Collection Reader
CpeCollectionReader[] collRdrs = currentCpeDesc.getAllCollectionCollectionReaders(); // more
- // than
- // one??
+ // than
+ // one??
CpeCollectionReader collRdr = null;
if (collRdrs != null && collRdrs.length > 0) {
collRdr = collRdrs[0];
@@ -2012,26 +2077,26 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
for (int i = 0; i < casProcs.length; i++) {
boolean success = true;
try {
- URL specifierUrl = casProcs[i].getCpeComponentDescriptor().findAbsoluteUrl(defaultResourceManager);
- ResourceSpecifier specifier = UIMAFramework.getXMLParser().parseResourceSpecifier(
- new XMLInputSource(specifierUrl));
+ URL specifierUrl = casProcs[i].getCpeComponentDescriptor()
+ .findAbsoluteUrl(defaultResourceManager);
+ ResourceSpecifier specifier = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(new XMLInputSource(specifierUrl));
if (isCasConsumerSpecifier(specifier)) {
success = addConsumer(casProcs[i]);
} else {
success = addAE(casProcs[i]);
}
- }
- catch(Exception e) {
+ } catch (Exception e) {
System.err.println("Error loading CPE Descriptor " + aFile.getPath());
- e.printStackTrace();
- success= false;
+ e.printStackTrace();
+ success = false;
}
if (!success) {
currentCpeDesc.getCpeCasProcessors().removeCpeCasProcessor(i - numFailed);
numFailed++;
}
- }
-
+ }
+
prefs.put(PREFS_CPE_DESCRIPTOR_FILE, aFile.getAbsolutePath());
// nothing should be dirty when we first open
@@ -2041,7 +2106,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Checks if is cas consumer specifier.
*
- * @param specifier the specifier
+ * @param specifier
+ * the specifier
* @return true, if is cas consumer specifier
*/
private boolean isCasConsumerSpecifier(ResourceSpecifier specifier) {
@@ -2058,8 +2124,10 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
* The Class StatusCallbackListenerImpl.
*/
class StatusCallbackListenerImpl implements StatusCallbackListener {
-
- /* (non-Javadoc)
+
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.collection.base_cpm.BaseStatusCallbackListener#initializationComplete()
*/
@Override
@@ -2087,8 +2155,12 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
progressTimer.start();
}
- /* (non-Javadoc)
- * @see org.apache.uima.collection.StatusCallbackListener#entityProcessComplete(org.apache.uima.cas.CAS, org.apache.uima.collection.EntityProcessStatus)
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.collection.StatusCallbackListener#entityProcessComplete(org.apache.uima.cas.
+ * CAS, org.apache.uima.collection.EntityProcessStatus)
*/
@Override
public void entityProcessComplete(CAS aCas, EntityProcessStatus aStatus) {
@@ -2099,22 +2171,29 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.collection.base_cpm.BaseStatusCallbackListener#batchProcessComplete()
*/
@Override
public void batchProcessComplete() {
}
- /* (non-Javadoc)
- * @see org.apache.uima.collection.base_cpm.BaseStatusCallbackListener#collectionProcessComplete()
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.collection.base_cpm.BaseStatusCallbackListener#collectionProcessComplete()
*/
@Override
public void collectionProcessComplete() {
onCompletion();
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.collection.base_cpm.BaseStatusCallbackListener#paused()
*/
@Override
@@ -2122,7 +2201,9 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
System.out.println("StatusCallbackListenerImpl::paused()");
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.collection.base_cpm.BaseStatusCallbackListener#resumed()
*/
@Override
@@ -2130,14 +2211,16 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
System.out.println("StatusCallbackListenerImpl::resumed");
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.collection.base_cpm.BaseStatusCallbackListener#aborted()
*/
@Override
public void aborted() {
if (!mShuttingDown && !mPaused) {
- PerformanceReportDialog perfReportDlg = new PerformanceReportDialog(CpmPanel.this
- .getParentFrame());
+ PerformanceReportDialog perfReportDlg = new PerformanceReportDialog(
+ CpmPanel.this.getParentFrame());
perfReportDlg.displayStats(mCPE.getPerformanceReport(), progressBar.getValue(),
"Processing aborted.");
}
@@ -2147,11 +2230,11 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
}
/**
- * MetaDataPanel used for Collection Reader & AE selection and configuration. Adds a reset method
- * to clear out related components when specifier file selection changes.
+ * MetaDataPanel used for Collection Reader & AE selection and configuration. Adds a reset
+ * method to clear out related components when specifier file selection changes.
*/
static class ResetableMetaDataPanel extends MetaDataPanel {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -4573780175511175666L;
@@ -2164,7 +2247,8 @@ public class CpmPanel extends JPanel implements ActionListener, FileSelectorList
/**
* Instantiates a new resetable meta data panel.
*
- * @param nrColumns the nr columns
+ * @param nrColumns
+ * the nr columns
*/
public ResetableMetaDataPanel(int nrColumns) {
super(nrColumns);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ElapsedTimeFormatter.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ElapsedTimeFormatter.java
index 57381a8..5404645 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ElapsedTimeFormatter.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/ElapsedTimeFormatter.java
@@ -19,16 +19,16 @@
package org.apache.uima.tools.cpm;
-
/**
* The Class ElapsedTimeFormatter.
*/
final public class ElapsedTimeFormatter {
-
+
/**
* Format.
*
- * @param totalSecs the total secs
+ * @param totalSecs
+ * the total secs
* @return the string
*/
public static String format(int totalSecs) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/JTabbedPaneWithCloseIcons.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/JTabbedPaneWithCloseIcons.java
index 5dc465f..32af3ab 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/JTabbedPaneWithCloseIcons.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/JTabbedPaneWithCloseIcons.java
@@ -29,7 +29,6 @@ import java.awt.event.MouseListener;
import javax.swing.Icon;
import javax.swing.JTabbedPane;
-
/**
* A JTabbedPane which has a close ('X') icon on each tab. To add a tab, use the method
* addTab(String, Component) To have an extra icon on each tab (e.g. showing the file type) use the
@@ -39,7 +38,7 @@ import javax.swing.JTabbedPane;
*/
public class JTabbedPaneWithCloseIcons extends JTabbedPane implements MouseListener {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 7680554379341154297L;
@@ -56,13 +55,16 @@ public class JTabbedPaneWithCloseIcons extends JTabbedPane implements MouseListe
/**
* Adds the tab closed listener.
*
- * @param aTabClosedListener the a tab closed listener
+ * @param aTabClosedListener
+ * the a tab closed listener
*/
public void addTabClosedListener(TabClosedListener aTabClosedListener) {
this.tabClosedListener = aTabClosedListener;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.JTabbedPane#addTab(java.lang.String, java.awt.Component)
*/
@Override
@@ -73,9 +75,12 @@ public class JTabbedPaneWithCloseIcons extends JTabbedPane implements MouseListe
/**
* Adds the tab.
*
- * @param title the title
- * @param component the component
- * @param extraIcon the extra icon
+ * @param title
+ * the title
+ * @param component
+ * the component
+ * @param extraIcon
+ * the extra icon
*/
public void addTab(String title, Component component, Icon extraIcon) {
super.addTab(title, new CloseTabIcon(extraIcon), component);
@@ -84,8 +89,10 @@ public class JTabbedPaneWithCloseIcons extends JTabbedPane implements MouseListe
/**
* Move tab.
*
- * @param fromIndex the from index
- * @param toIndex the to index
+ * @param fromIndex
+ * the from index
+ * @param toIndex
+ * the to index
*/
public void moveTab(int fromIndex, int toIndex) {
Component componentToMove = this.getComponentAt(fromIndex);
@@ -96,7 +103,9 @@ public class JTabbedPaneWithCloseIcons extends JTabbedPane implements MouseListe
this.setTitleAt(toIndex, title);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseListener#mouseClicked(java.awt.event.MouseEvent)
*/
@Override
@@ -112,28 +121,36 @@ public class JTabbedPaneWithCloseIcons extends JTabbedPane implements MouseListe
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseListener#mouseEntered(java.awt.event.MouseEvent)
*/
@Override
public void mouseEntered(MouseEvent e) {
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseListener#mouseExited(java.awt.event.MouseEvent)
*/
@Override
public void mouseExited(MouseEvent e) {
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseListener#mousePressed(java.awt.event.MouseEvent)
*/
@Override
public void mousePressed(MouseEvent e) {
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseListener#mouseReleased(java.awt.event.MouseEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/MetaDataPanel.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/MetaDataPanel.java
index 6f92cb5..3ee40b6 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/MetaDataPanel.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/MetaDataPanel.java
@@ -41,7 +41,6 @@ import org.apache.uima.tools.util.gui.FileSelector;
import org.apache.uima.tools.util.gui.FormPanel;
import org.apache.uima.tools.util.gui.ListSelector;
-
/**
*
* A dynamically generated form panel with components generated from configuration parameters
@@ -52,7 +51,7 @@ import org.apache.uima.tools.util.gui.ListSelector;
*/
public class MetaDataPanel extends FormPanel {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 2002216386886772644L;
@@ -73,7 +72,8 @@ public class MetaDataPanel extends FormPanel {
/**
* Instantiates a new meta data panel.
*
- * @param nrColumns the nr columns
+ * @param nrColumns
+ * the nr columns
*/
public MetaDataPanel(int nrColumns) {
super(nrColumns);
@@ -82,8 +82,10 @@ public class MetaDataPanel extends FormPanel {
/**
* Populate.
*
- * @param md the md
- * @param overrides the overrides
+ * @param md
+ * the md
+ * @param overrides
+ * the overrides
*/
public void populate(ResourceMetaData md, CasProcessorConfigurationParameterSettings overrides) {
metaData = md;
@@ -105,9 +107,8 @@ public class MetaDataPanel extends FormPanel {
boolean multiValued = parameters[i].isMultiValued();
boolean requiresFileSelector = false;
- if ((name.endsWith("Dir") || name.endsWith("Directory") || name.endsWith("Descriptor") || name
- .indexOf("File") != -1)
- && type.equals("String"))
+ if ((name.endsWith("Dir") || name.endsWith("Directory") || name.endsWith("Descriptor")
+ || name.indexOf("File") != -1) && type.equals("String"))
requiresFileSelector = true;
boolean justDirectories = false;
@@ -123,8 +124,8 @@ public class MetaDataPanel extends FormPanel {
Object parameterValue = cps.getParameterValue(name);
if (type.equals("Boolean"))
- field = new JCheckBox((String) null, (parameterValue == null) ? false
- : (Boolean) parameterValue);
+ field = new JCheckBox((String) null,
+ (parameterValue == null) ? false : (Boolean) parameterValue);
else if (multiValued == false) {
if (requiresFileSelector == false) {
String stringValue = (parameterValue == null) ? "" : parameterValue.toString();
@@ -186,8 +187,10 @@ public class MetaDataPanel extends FormPanel {
/**
* Sets the value.
*
- * @param fieldName Configuration parameter field name
- * @param fieldValue Field value
+ * @param fieldName
+ * Configuration parameter field name
+ * @param fieldValue
+ * Field value
*/
public void setValue(String fieldName, Object fieldValue) {
// Find fieldName in fieldList:
@@ -201,7 +204,7 @@ public class MetaDataPanel extends FormPanel {
}
/**
- * Removes all fields.
+ * Removes all fields.
*/
public void clearAll() {
Component components[] = gridBagPanel.getComponents();
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/PerformanceReportDialog.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/PerformanceReportDialog.java
index 916a578..35ffbc3 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/PerformanceReportDialog.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/PerformanceReportDialog.java
@@ -38,13 +38,12 @@ import javax.swing.tree.DefaultTreeModel;
import org.apache.uima.util.ProcessTrace;
import org.apache.uima.util.ProcessTraceEvent;
-
/**
* Mock-up of dialog for reporting performance stats.
*
*/
public class PerformanceReportDialog extends JDialog {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 7747258424181047062L;
@@ -66,9 +65,12 @@ public class PerformanceReportDialog extends JDialog {
/**
* Instantiates a new performance report dialog.
*
- * @param aFrame the a frame
- * @throws HeadlessException the headless exception
- * @throws java.awt.HeadlessException the java.awt. headless exception
+ * @param aFrame
+ * the a frame
+ * @throws HeadlessException
+ * the headless exception
+ * @throws java.awt.HeadlessException
+ * the java.awt. headless exception
*/
public PerformanceReportDialog(Frame aFrame) throws HeadlessException {
super(aFrame, true);
@@ -98,11 +100,15 @@ public class PerformanceReportDialog extends JDialog {
/**
* Display stats.
*
- * @param aProcessTrace the a process trace
- * @param aNumDocsProcessed the a num docs processed
- * @param aStatusMessage the a status message
+ * @param aProcessTrace
+ * the a process trace
+ * @param aNumDocsProcessed
+ * the a num docs processed
+ * @param aStatusMessage
+ * the a status message
*/
- public void displayStats(ProcessTrace aProcessTrace, int aNumDocsProcessed, String aStatusMessage) {
+ public void displayStats(ProcessTrace aProcessTrace, int aNumDocsProcessed,
+ String aStatusMessage) {
statusLabel.setText(aStatusMessage);
docsProcessedLabel.setText("Documents Processed: " + aNumDocsProcessed);
@@ -117,8 +123,8 @@ public class PerformanceReportDialog extends JDialog {
totalTimeLabel.setText("Total Time: " + totalTimeSeconds + " seconds");
// create root tree node
- DefaultMutableTreeNode root = new DefaultMutableTreeNode("100% (" + totalTime
- + "ms) - Collection Processing Engine");
+ DefaultMutableTreeNode root = new DefaultMutableTreeNode(
+ "100% (" + totalTime + "ms) - Collection Processing Engine");
// build tree
it = aProcessTrace.getEvents().iterator();
while (it.hasNext()) {
@@ -133,9 +139,12 @@ public class PerformanceReportDialog extends JDialog {
/**
* Builds the event tree.
*
- * @param aEvent the a event
- * @param aParentNode the a parent node
- * @param aTotalTime the a total time
+ * @param aEvent
+ * the a event
+ * @param aParentNode
+ * the a parent node
+ * @param aTotalTime
+ * the a total time
*/
public void buildEventTree(ProcessTraceEvent aEvent, DefaultMutableTreeNode aParentNode,
long aTotalTime) {
@@ -154,8 +163,8 @@ public class PerformanceReportDialog extends JDialog {
type = aEvent.getType();
}
- DefaultMutableTreeNode node = new DefaultMutableTreeNode(pctStr + " (" + duration + "ms) - "
- + aEvent.getComponentName() + " (" + type + ")");
+ DefaultMutableTreeNode node = new DefaultMutableTreeNode(
+ pctStr + " (" + duration + "ms) - " + aEvent.getComponentName() + " (" + type + ")");
aParentNode.add(node);
Iterator it = aEvent.getSubEvents().iterator();
while (it.hasNext()) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/TabClosedListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/TabClosedListener.java
index 406aeee..b266cc0 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/TabClosedListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cpm/TabClosedListener.java
@@ -19,19 +19,20 @@
package org.apache.uima.tools.cpm;
-
/**
* Callback interface used in conjunction with JTabbedPaneWithCloseIcons.
*
* @see org.apache.uima.tools.cpm.JTabbedPaneWithCloseIcons
*/
public interface TabClosedListener {
-
+
/**
* Tab closed.
*
- * @param source the JTabbedPaneWithCloseIcons control sending this event
- * @param tabPos position of the tab that was closed
+ * @param source
+ * the JTabbedPaneWithCloseIcons control sending this event
+ * @param tabPos
+ * position of the tab that was closed
*/
void tabClosed(JTabbedPaneWithCloseIcons source, int tabPos);
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationDisplayCustomizationFrame.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationDisplayCustomizationFrame.java
index af84c51..f44b0ac 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationDisplayCustomizationFrame.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationDisplayCustomizationFrame.java
@@ -50,7 +50,6 @@ import javax.swing.tree.TreeModel;
import org.apache.uima.cas.CAS;
import org.apache.uima.cas.TypeSystem;
-
/**
* TODO: add type comment for <code>AnnotationDisplayCustomizationFrame</code>.
*
@@ -62,28 +61,27 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
private static final long serialVersionUID = -6695661439132793537L;
/**
- * The listener interface for receiving typeTreeSelection events.
- * The class that is interested in processing a typeTreeSelection
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addTypeTreeSelectionListener</code> method. When
- * the typeTreeSelection event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving typeTreeSelection events. The class that is interested in
+ * processing a typeTreeSelection event implements this interface, and the object created with
+ * that class is registered with a component using the component's
+ * <code>addTypeTreeSelectionListener</code> method. When the typeTreeSelection event occurs, that
+ * object's appropriate method is invoked.
*
* @see TypeTreeSelectionEvent
*/
private class TypeTreeSelectionListener implements TreeSelectionListener {
-
+
/**
* Value changed.
*
- * @param event the event
+ * @param event
+ * the event
* @see javax.swing.event.TreeSelectionListener#valueChanged(javax.swing.event.TreeSelectionEvent)
*/
@Override
public void valueChanged(TreeSelectionEvent event) {
DefaultMutableTreeNode node = (DefaultMutableTreeNode) AnnotationDisplayCustomizationFrame.this.tree
- .getLastSelectedPathComponent();
+ .getLastSelectedPathComponent();
String typeName = (String) node.getUserObject();
if (typeName.equals(AnnotationDisplayCustomizationFrame.this.currentTypeName)) {
return;
@@ -98,13 +96,15 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
*/
private class CustomizeBgButtonHandler implements ActionListener {
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
public void actionPerformed(ActionEvent event) {
Color color = JColorChooser.showDialog(AnnotationDisplayCustomizationFrame.this,
- "Choose color", AnnotationDisplayCustomizationFrame.this.bgColor);
+ "Choose color", AnnotationDisplayCustomizationFrame.this.bgColor);
if (color != null) {
AnnotationDisplayCustomizationFrame.this.bgColor = color;
AnnotationDisplayCustomizationFrame.this.bgIcon.setColor(color);
@@ -122,13 +122,15 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
*/
private class CustomizeFgButtonHandler implements ActionListener {
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
public void actionPerformed(ActionEvent event) {
Color color = JColorChooser.showDialog(AnnotationDisplayCustomizationFrame.this,
- "Choose color", AnnotationDisplayCustomizationFrame.this.fgColor);
+ "Choose color", AnnotationDisplayCustomizationFrame.this.fgColor);
if (color != null) {
AnnotationDisplayCustomizationFrame.this.fgColor = color;
AnnotationDisplayCustomizationFrame.this.fgIcon.setColor(color);
@@ -146,24 +148,26 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
*/
private class AcceptButtonHandler implements ActionListener {
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
public void actionPerformed(ActionEvent event) {
Style style = AnnotationDisplayCustomizationFrame.this.styleMap
- .get(AnnotationDisplayCustomizationFrame.this.currentTypeName);
+ .get(AnnotationDisplayCustomizationFrame.this.currentTypeName);
if (style == null) {
style = AnnotationDisplayCustomizationFrame.this.textPane.addStyle(
- AnnotationDisplayCustomizationFrame.this.currentTypeName,
- AnnotationDisplayCustomizationFrame.this.styleMap.get(CAS.TYPE_NAME_ANNOTATION));
+ AnnotationDisplayCustomizationFrame.this.currentTypeName,
+ AnnotationDisplayCustomizationFrame.this.styleMap.get(CAS.TYPE_NAME_ANNOTATION));
}
- StyleConstants.setForeground(style, StyleConstants
- .getForeground(AnnotationDisplayCustomizationFrame.this.currentStyle));
- StyleConstants.setBackground(style, StyleConstants
- .getBackground(AnnotationDisplayCustomizationFrame.this.currentStyle));
- AnnotationDisplayCustomizationFrame.this.styleMap.put(
- AnnotationDisplayCustomizationFrame.this.currentTypeName, style);
+ StyleConstants.setForeground(style,
+ StyleConstants.getForeground(AnnotationDisplayCustomizationFrame.this.currentStyle));
+ StyleConstants.setBackground(style,
+ StyleConstants.getBackground(AnnotationDisplayCustomizationFrame.this.currentStyle));
+ AnnotationDisplayCustomizationFrame.this.styleMap
+ .put(AnnotationDisplayCustomizationFrame.this.currentTypeName, style);
enableButtons(false);
AnnotationDisplayCustomizationFrame.this.repaint();
}
@@ -175,23 +179,25 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
*/
private class CancelButtonHandler implements ActionListener {
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
public void actionPerformed(ActionEvent event) {
Style style = AnnotationDisplayCustomizationFrame.this.styleMap
- .get(AnnotationDisplayCustomizationFrame.this.currentTypeName);
+ .get(AnnotationDisplayCustomizationFrame.this.currentTypeName);
if (style == null) {
style = AnnotationDisplayCustomizationFrame.this.styleMap.get(CAS.TYPE_NAME_ANNOTATION);
}
// assert(style != null);
AnnotationDisplayCustomizationFrame.this.fgColor = StyleConstants.getForeground(style);
AnnotationDisplayCustomizationFrame.this.fgIcon
- .setColor(AnnotationDisplayCustomizationFrame.this.fgColor);
+ .setColor(AnnotationDisplayCustomizationFrame.this.fgColor);
AnnotationDisplayCustomizationFrame.this.bgColor = StyleConstants.getBackground(style);
AnnotationDisplayCustomizationFrame.this.bgIcon
- .setColor(AnnotationDisplayCustomizationFrame.this.bgColor);
+ .setColor(AnnotationDisplayCustomizationFrame.this.bgColor);
setCurrentStyle(style);
setTextPane();
enableButtons(false);
@@ -251,7 +257,8 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Instantiates a new annotation display customization frame.
*
- * @throws java.awt.HeadlessException the java.awt. headless exception
+ * @throws java.awt.HeadlessException
+ * the java.awt. headless exception
*/
public AnnotationDisplayCustomizationFrame() {
}
@@ -259,7 +266,8 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Instantiates a new annotation display customization frame.
*
- * @param arg0 the arg 0
+ * @param arg0
+ * the arg 0
*/
public AnnotationDisplayCustomizationFrame(GraphicsConfiguration arg0) {
super(arg0);
@@ -268,8 +276,10 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Instantiates a new annotation display customization frame.
*
- * @param arg0 the arg 0
- * @throws java.awt.HeadlessException the java.awt. headless exception
+ * @param arg0
+ * the arg 0
+ * @throws java.awt.HeadlessException
+ * the java.awt. headless exception
*/
public AnnotationDisplayCustomizationFrame(String arg0) {
super(arg0);
@@ -278,8 +288,10 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Instantiates a new annotation display customization frame.
*
- * @param arg0 the arg 0
- * @param arg1 the arg 1
+ * @param arg0
+ * the arg 0
+ * @param arg1
+ * the arg 1
*/
public AnnotationDisplayCustomizationFrame(String arg0, GraphicsConfiguration arg1) {
super(arg0, arg1);
@@ -288,7 +300,8 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Sets the current style.
*
- * @param style the new current style
+ * @param style
+ * the new current style
*/
private void setCurrentStyle(Style style) {
// Copy style.
@@ -300,7 +313,8 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Enable buttons.
*
- * @param flag the flag
+ * @param flag
+ * the flag
*/
private void enableButtons(boolean flag) {
this.acceptButton.setEnabled(flag);
@@ -310,8 +324,10 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Inits the.
*
- * @param styleMap1 the style map 1
- * @param cas the cas
+ * @param styleMap1
+ * the style map 1
+ * @param cas
+ * the cas
*/
public void init(Map<String, Style> styleMap1, CAS cas) {
this.styleMap = styleMap1;
@@ -327,7 +343,8 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Creates the customization panel.
*
- * @param typeName the type name
+ * @param typeName
+ * the type name
* @return the j panel
*/
private JPanel createCustomizationPanel(String typeName) {
@@ -361,7 +378,8 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Sets the customization panel.
*
- * @param typeName the new customization panel
+ * @param typeName
+ * the new customization panel
*/
private void setCustomizationPanel(String typeName) {
this.currentTypeName = typeName;
@@ -385,7 +403,8 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Creates the button panel.
*
- * @param buttonPanel the button panel
+ * @param buttonPanel
+ * the button panel
*/
private void createButtonPanel(JPanel buttonPanel) {
this.acceptButton = new JButton("OK");
@@ -423,9 +442,12 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Creates the color panel.
*
- * @param text the text
- * @param icon the icon
- * @param buttonType the button type
+ * @param text
+ * the text
+ * @param icon
+ * the icon
+ * @param buttonType
+ * the button type
* @return the j panel
*/
private JPanel createColorPanel(String text, ColorIcon icon, int buttonType) {
@@ -447,7 +469,8 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Creates the tree model.
*
- * @param ts the ts
+ * @param ts
+ * the ts
* @return the tree model
*/
private TreeModel createTreeModel(TypeSystem ts) {
@@ -463,9 +486,12 @@ public class AnnotationDisplayCustomizationFrame extends JFrame {
/**
* Adds the children.
*
- * @param node the node
- * @param type the type
- * @param ts the ts
+ * @param node
+ * the node
+ * @param type
+ * the type
+ * @param ts
+ * the ts
*/
private static void addChildren(DefaultMutableTreeNode node, org.apache.uima.cas.Type type,
TypeSystem ts) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationExtent.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationExtent.java
index eb2d8d1..0bb7bbf 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationExtent.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AnnotationExtent.java
@@ -21,7 +21,6 @@ package org.apache.uima.tools.cvd;
import javax.swing.text.Style;
-
/**
* The Class AnnotationExtent.
*/
@@ -36,13 +35,15 @@ public class AnnotationExtent {
/** The style. */
private Style style;
-
/**
* Instantiates a new annotation extent.
*
- * @param start the start
- * @param end the end
- * @param style the style
+ * @param start
+ * the start
+ * @param end
+ * the end
+ * @param style
+ * the style
*/
public AnnotationExtent(int start, int end, Style style) {
this.start = start;
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/ArrayNode.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/ArrayNode.java
index d6269e3..8b0c28c 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/ArrayNode.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/ArrayNode.java
@@ -19,7 +19,6 @@
package org.apache.uima.tools.cvd;
-
/**
* TODO: add type comment for <code>ArrayNode</code>.
*
@@ -39,19 +38,22 @@ public class ArrayNode extends FSTreeNode {
/** The end. */
private int end;
-
/**
* Instantiates a new array node.
*
- * @param start the start
- * @param end the end
+ * @param start
+ * the start
+ * @param end
+ * the end
*/
public ArrayNode(int start, int end) {
this.start = start;
this.end = end;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#toString()
*/
@Override
@@ -59,7 +61,9 @@ public class ArrayNode extends FSTreeNode {
return "[" + this.start + ".." + this.end + "]";
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.cvd.FSTreeNode#initChildren()
*/
@Override
@@ -70,7 +74,8 @@ public class ArrayNode extends FSTreeNode {
/**
* Degree.
*
- * @param i the i
+ * @param i
+ * the i
* @return the int
*/
// Compute the degree of i: (number of decimals of (i-1)) - 1.
@@ -81,7 +86,7 @@ public class ArrayNode extends FSTreeNode {
}
return (int) Math.log10(i - 1);
}
-
+
/**
* Gets the end.
*
@@ -99,6 +104,5 @@ public class ArrayNode extends FSTreeNode {
public int getStart() {
return this.start;
}
-
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AutoFoldingMenu.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AutoFoldingMenu.java
index b002847..48e4b30 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AutoFoldingMenu.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/AutoFoldingMenu.java
@@ -22,7 +22,6 @@ package org.apache.uima.tools.cvd;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
-
/**
* Auto-folding menu. It overrides the add(JMenuItem) method only.
*
@@ -46,8 +45,10 @@ public class AutoFoldingMenu extends JMenu {
/**
* Instantiates a new auto folding menu.
*
- * @param title the title
- * @param max the max
+ * @param title
+ * the title
+ * @param max
+ * the max
*/
public AutoFoldingMenu(String title, int max) {
super(title);
@@ -57,13 +58,16 @@ public class AutoFoldingMenu extends JMenu {
/**
* Instantiates a new auto folding menu.
*
- * @param title the title
+ * @param title
+ * the title
*/
public AutoFoldingMenu(String title) {
this(title, DEFAULT_MENU_SIZE);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.JMenu#add(javax.swing.JMenuItem)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/CVD.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/CVD.java
index 4605679..2005d17 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/CVD.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/CVD.java
@@ -30,7 +30,6 @@ import org.apache.uima.internal.util.CommandLineParser;
import org.apache.uima.resource.RelativePathResolver;
import org.apache.uima.tools.images.Images;
-
/**
* The main class for the CAS Visual Debugger.
*
@@ -58,9 +57,9 @@ public class CVD {
/** The Constant LOOK_AND_FEEL_PARAM. */
private static final String LOOK_AND_FEEL_PARAM = "-lookandfeel";
-
+
/** The Constant XMI_FILE_PARAM. */
- private static final String XMI_FILE_PARAM = "-xmi";
+ private static final String XMI_FILE_PARAM = "-xmi";
/**
* Instantiates a new cvd.
@@ -80,7 +79,8 @@ public class CVD {
/**
* Creates the main frame.
*
- * @param iniFile the ini file
+ * @param iniFile
+ * the ini file
* @return the main frame
*/
public static MainFrame createMainFrame(File iniFile) {
@@ -120,7 +120,7 @@ public class CVD {
parser.addParameter(DATA_PATH_PARAM, true);
parser.addParameter(LOOK_AND_FEEL_PARAM, true);
parser.addParameter(EXECUTE_SWITCH);
- parser.addParameter(XMI_FILE_PARAM, true);
+ parser.addParameter(XMI_FILE_PARAM, true);
parser.addParameter(INI_FILE_PARAM, true);
return parser;
}
@@ -129,8 +129,8 @@ public class CVD {
* Prints the usage.
*/
private static final void printUsage() {
- System.out
- .println("Usage: java org.apache.uima.cvd.CVD [-text <TextFile>] [-desc <XmlDescriptor>] [-datapath <DataPath>] [-exec]");
+ System.out.println(
+ "Usage: java org.apache.uima.cvd.CVD [-text <TextFile>] [-desc <XmlDescriptor>] [-datapath <DataPath>] [-exec]");
System.out.println("Additional optional parameters:");
System.out.println(" -lookandfeel <LookAndFeelClassName>");
}
@@ -138,7 +138,8 @@ public class CVD {
/**
* Check cmd line syntax.
*
- * @param clp the clp
+ * @param clp
+ * the clp
* @return true, if successful
*/
private static final boolean checkCmdLineSyntax(CommandLineParser clp) {
@@ -166,7 +167,8 @@ public class CVD {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
try {
@@ -206,9 +208,9 @@ public class CVD {
frame.loadAEDescriptor(new File(clp.getParamArgument(DESC_FILE_PARAM)));
}
if (clp.isInArgsList(TEXT_FILE_PARAM)) {
- frame.loadTextFile(new File(clp.getParamArgument(TEXT_FILE_PARAM)));
+ frame.loadTextFile(new File(clp.getParamArgument(TEXT_FILE_PARAM)));
} else if (clp.isInArgsList(XMI_FILE_PARAM)) {
- frame.loadXmiFile(new File(clp.getParamArgument(XMI_FILE_PARAM)));
+ frame.loadXmiFile(new File(clp.getParamArgument(XMI_FILE_PARAM)));
}
if (clp.isInArgsList(EXECUTE_SWITCH)) {
frame.runAE(true);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/ColorIcon.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/ColorIcon.java
index 0e0786e..f1b3b39 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/ColorIcon.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/ColorIcon.java
@@ -25,7 +25,6 @@ import java.awt.Graphics;
import javax.swing.Icon;
-
/**
* TODO: add type comment for <code>ColorIcon</code>.
*
@@ -39,7 +38,6 @@ public class ColorIcon implements Icon {
/** The color. */
private Color color = Color.black;
-
/**
* Instantiates a new color icon.
*/
@@ -49,7 +47,8 @@ public class ColorIcon implements Icon {
/**
* Instantiates a new color icon.
*
- * @param color the color
+ * @param color
+ * the color
*/
public ColorIcon(Color color) {
this();
@@ -59,7 +58,8 @@ public class ColorIcon implements Icon {
/**
* Sets the color.
*
- * @param color the new color
+ * @param color
+ * the new color
*/
public void setColor(Color color) {
this.color = color;
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSNode.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSNode.java
index b4e0dc5..931fb9a 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSNode.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSNode.java
@@ -42,22 +42,18 @@ import org.apache.uima.jcas.cas.StringArray;
import org.apache.uima.jcas.cas.TOP;
import org.apache.uima.jcas.tcas.Annotation;
-
/**
* A node in the FS Tree Model
*
- * A node is
- * - an Feature Structure array
- * -- elements may be other nodes
- * - a primitive value, including Strings
- * - a Feature Structure.
+ * A node is - an Feature Structure array -- elements may be other nodes - a primitive value,
+ * including Strings - a Feature Structure.
*/
public class FSNode extends FSTreeNode {
/** The Constant maxStringLength. */
private static final int maxStringLength = 100;
-
+
/** The s tree model. */
private final FSTreeModel fSTreeModel;
@@ -99,10 +95,10 @@ public class FSNode extends FSTreeNode {
/** The int or long like value. */
private final long intOrLongLikeValue;
-
+
/** The fs. */
private final TOP fs;
-
+
/** The string. */
private final String string;
@@ -114,45 +110,63 @@ public class FSNode extends FSTreeNode {
/** The is array elem. */
private final boolean isArrayElem;
-
+
/** The is shortened string. */
// Remember if we're displaying a shortened string.
private boolean isShortenedString = false;
-
+
/**
* K 2 nc.
*
- * @param kind the kind
+ * @param kind
+ * the kind
* @return the int
*/
private int k2nc(SlotKind kind) {
- switch(kind) {
- case Slot_Boolean:
- case Slot_BooleanRef: return BOOL_FS;
- case Slot_Byte:
- case Slot_ByteRef: return BYTE_FS;
- case Slot_Short:
- case Slot_ShortRef: return SHORT_FS;
- case Slot_Int: return INT_FS;
- case Slot_Float: return FLOAT_FS;
- case Slot_LongRef: return LONG_FS;
- case Slot_DoubleRef: return DOUBLE_FS;
- case Slot_StrRef: return STRING_FS;
- case Slot_HeapRef: return STD_FS;
- default: Misc.internalError(); return -1;
+ switch (kind) {
+ case Slot_Boolean:
+ case Slot_BooleanRef:
+ return BOOL_FS;
+ case Slot_Byte:
+ case Slot_ByteRef:
+ return BYTE_FS;
+ case Slot_Short:
+ case Slot_ShortRef:
+ return SHORT_FS;
+ case Slot_Int:
+ return INT_FS;
+ case Slot_Float:
+ return FLOAT_FS;
+ case Slot_LongRef:
+ return LONG_FS;
+ case Slot_DoubleRef:
+ return DOUBLE_FS;
+ case Slot_StrRef:
+ return STRING_FS;
+ case Slot_HeapRef:
+ return STD_FS;
+ default:
+ Misc.internalError();
+ return -1;
}
}
/**
* Instantiates a new FS node.
*
- * @param fSTreeModel the f S tree model
- * @param nodeClass the node class
- * @param fsOrString the fs or string
- * @param intOrLongLikeValue the int or long like value
- * @param feat the feat
+ * @param fSTreeModel
+ * the f S tree model
+ * @param nodeClass
+ * the node class
+ * @param fsOrString
+ * the fs or string
+ * @param intOrLongLikeValue
+ * the int or long like value
+ * @param feat
+ * the feat
*/
- FSNode(FSTreeModel fSTreeModel, int nodeClass, Object fsOrString, long intOrLongLikeValue, Feature feat) {
+ FSNode(FSTreeModel fSTreeModel, int nodeClass, Object fsOrString, long intOrLongLikeValue,
+ Feature feat) {
this.fSTreeModel = fSTreeModel;
this.nodeClass = nodeClass;
this.intOrLongLikeValue = intOrLongLikeValue;
@@ -166,13 +180,19 @@ public class FSNode extends FSTreeNode {
/**
* Instantiates a new FS node.
*
- * @param fSTreeModel the f S tree model
- * @param nodeClass the node class
- * @param fsOrString the fs or string
- * @param intOrLongLikeValue the int or long like value
- * @param elementIndex the element index
+ * @param fSTreeModel
+ * the f S tree model
+ * @param nodeClass
+ * the node class
+ * @param fsOrString
+ * the fs or string
+ * @param intOrLongLikeValue
+ * the int or long like value
+ * @param elementIndex
+ * the element index
*/
- FSNode(FSTreeModel fSTreeModel, int nodeClass, Object fsOrString, long intOrLongLikeValue, int elementIndex) {
+ FSNode(FSTreeModel fSTreeModel, int nodeClass, Object fsOrString, long intOrLongLikeValue,
+ int elementIndex) {
this.fSTreeModel = fSTreeModel;
this.nodeClass = nodeClass;
this.intOrLongLikeValue = intOrLongLikeValue;
@@ -192,7 +212,9 @@ public class FSNode extends FSTreeNode {
return this.nodeClass;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.cvd.FSTreeNode#initChildren()
*/
@Override
@@ -207,89 +229,93 @@ public class FSNode extends FSTreeNode {
if (this.fs == null) {
return;
}
-
+
TypeImpl type = getType();
-// CASImpl cas = this.fSTreeModel.getCas();
+ // CASImpl cas = this.fSTreeModel.getCas();
if (type.isArray()) {
- int arrayLength = ((CommonArrayFS)fs).size();
-// if (arrayLength > 20) {
-// arrayLength = 20;
-// }
-
-// FSNode node = null;
-// int arrayPos = cas.getArrayStartAddress((int) this.addr);
-// int nodeClass1;
-// if (cas.isIntArrayType(type)) {
-// nodeClass1 = FSNode.INT_FS;
-// } else if (cas.isFloatArrayType(type)) {
-// nodeClass1 = FSNode.FLOAT_FS;
-// } else if (cas.isStringArrayType(type)) {
-// nodeClass1 = FSNode.STRING_FS;
-// } else if (cas.isByteArrayType(type)) {
-// nodeClass1 = FSNode.BYTE_FS;
-// } else if (cas.isBooleanArrayType(type)) {
-// nodeClass1 = FSNode.BOOL_FS;
-// } else if (cas.isShortArrayType(type)) {
-// nodeClass1 = FSNode.SHORT_FS;
-// } else if (cas.isLongArrayType(type)) {
-// nodeClass1 = FSNode.LONG_FS;
-// } else if (cas.isDoubleArrayType(type)) {
-// nodeClass1 = FSNode.DOUBLE_FS;
-// } else {
-// nodeClass1 = FSNode.STD_FS;
-// }
+ int arrayLength = ((CommonArrayFS) fs).size();
+ // if (arrayLength > 20) {
+ // arrayLength = 20;
+ // }
+
+ // FSNode node = null;
+ // int arrayPos = cas.getArrayStartAddress((int) this.addr);
+ // int nodeClass1;
+ // if (cas.isIntArrayType(type)) {
+ // nodeClass1 = FSNode.INT_FS;
+ // } else if (cas.isFloatArrayType(type)) {
+ // nodeClass1 = FSNode.FLOAT_FS;
+ // } else if (cas.isStringArrayType(type)) {
+ // nodeClass1 = FSNode.STRING_FS;
+ // } else if (cas.isByteArrayType(type)) {
+ // nodeClass1 = FSNode.BYTE_FS;
+ // } else if (cas.isBooleanArrayType(type)) {
+ // nodeClass1 = FSNode.BOOL_FS;
+ // } else if (cas.isShortArrayType(type)) {
+ // nodeClass1 = FSNode.SHORT_FS;
+ // } else if (cas.isLongArrayType(type)) {
+ // nodeClass1 = FSNode.LONG_FS;
+ // } else if (cas.isDoubleArrayType(type)) {
+ // nodeClass1 = FSNode.DOUBLE_FS;
+ // } else {
+ // nodeClass1 = FSNode.STD_FS;
+ // }
List<FSNode> arrayNodes = new ArrayList<>(arrayLength);
SlotKind kind = type.getComponentSlotKind();
int nc = k2nc(kind);
switch (kind) {
- case Slot_Int: {
- int[] a = ((IntegerArray)fs)._getTheArray();
- makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, a[i], i));
- break;
+ case Slot_Int: {
+ int[] a = ((IntegerArray) fs)._getTheArray();
+ makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, a[i], i));
+ break;
}
- case Slot_Float: {
- float[] a = ((FloatArray)fs)._getTheArray();
- makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, CASImpl.float2int(a[i]), i));
- break;
+ case Slot_Float: {
+ float[] a = ((FloatArray) fs)._getTheArray();
+ makeNodes(arrayNodes, arrayLength,
+ i -> new FSNode(this.fSTreeModel, nc, null, CASImpl.float2int(a[i]), i));
+ break;
}
- case Slot_StrRef: {
- String[] a = ((StringArray)fs)._getTheArray();
- makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, a[i], 0, i));
- break;
+ case Slot_StrRef: {
+ String[] a = ((StringArray) fs)._getTheArray();
+ makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, a[i], 0, i));
+ break;
}
- case Slot_HeapRef: {
- TOP[] a = ((FSArray)fs)._getTheArray();
- makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, a[i], 0, i));
- break;
+ case Slot_HeapRef: {
+ TOP[] a = ((FSArray) fs)._getTheArray();
+ makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, a[i], 0, i));
+ break;
}
- case Slot_BooleanRef: {
- boolean[] a = ((BooleanArray)fs)._getTheArray();
- makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, a[i]? 1 : 0, i));
- break;
+ case Slot_BooleanRef: {
+ boolean[] a = ((BooleanArray) fs)._getTheArray();
+ makeNodes(arrayNodes, arrayLength,
+ i -> new FSNode(this.fSTreeModel, nc, null, a[i] ? 1 : 0, i));
+ break;
}
- case Slot_ByteRef: {
- byte[] a = ((ByteArray)fs)._getTheArray();
- makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, a[i], i));
- break;
+ case Slot_ByteRef: {
+ byte[] a = ((ByteArray) fs)._getTheArray();
+ makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, a[i], i));
+ break;
}
- case Slot_ShortRef: {
- short[] a = ((ShortArray)fs)._getTheArray();
- makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, a[i], i));
- break;
+ case Slot_ShortRef: {
+ short[] a = ((ShortArray) fs)._getTheArray();
+ makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, a[i], i));
+ break;
}
- case Slot_LongRef: {
- long[] a = ((LongArray)fs)._getTheArray();
- makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, a[i], i));
- break;
+ case Slot_LongRef: {
+ long[] a = ((LongArray) fs)._getTheArray();
+ makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, a[i], i));
+ break;
}
- case Slot_DoubleRef: {
- double[] a = ((DoubleArray)fs)._getTheArray();
- makeNodes(arrayNodes, arrayLength, i -> new FSNode(this.fSTreeModel, nc, null, CASImpl.double2long(a[i]), i));
- break;
+ case Slot_DoubleRef: {
+ double[] a = ((DoubleArray) fs)._getTheArray();
+ makeNodes(arrayNodes, arrayLength,
+ i -> new FSNode(this.fSTreeModel, nc, null, CASImpl.double2long(a[i]), i));
+ break;
}
- default: Misc.internalError();
- } // end of switch
-
+ default:
+ Misc.internalError();
+ } // end of switch
+
this.children = FSTreeModel.createArrayChildren(0, arrayLength, arrayNodes, this.fSTreeModel);
} else {
this.children = new ArrayList<>(type.getNumberOfFeatures());
@@ -297,17 +323,38 @@ public class FSNode extends FSTreeNode {
for (FeatureImpl f : feats) {
SlotKind kind = f.getSlotKind();
int nc = k2nc(kind);
- switch(kind) {
- case Slot_Boolean: children.add(new FSNode(this.fSTreeModel, nc, null, fs.getBooleanValue(f) ? 1 : 0, f)); break;
- case Slot_Byte: children.add(new FSNode(this.fSTreeModel, nc, null, fs.getByteValue(f), f)); break;
- case Slot_Short: children.add(new FSNode(this.fSTreeModel, nc, null, fs.getShortValue(f), f)); break;
- case Slot_Int: children.add(new FSNode(this.fSTreeModel, nc, null, fs.getIntValue(f), f)); break;
- case Slot_Float: children.add(new FSNode(this.fSTreeModel, nc, null, CASImpl.float2int(fs.getFloatValue(f)), f)); break;
- case Slot_LongRef: children.add(new FSNode(this.fSTreeModel, nc, null, fs.getLongValue(f), f)); break;
- case Slot_DoubleRef:children.add(new FSNode(this.fSTreeModel, nc, null, CASImpl.double2long(fs.getDoubleValue(f)), f)); break;
- case Slot_StrRef: children.add(new FSNode(this.fSTreeModel, nc, fs.getStringValue(f), 0, f)); break;
- case Slot_HeapRef: children.add(new FSNode(this.fSTreeModel, nc, fs.getFeatureValue(f), 0, f)); break;
- default: Misc.internalError();
+ switch (kind) {
+ case Slot_Boolean:
+ children.add(new FSNode(this.fSTreeModel, nc, null, fs.getBooleanValue(f) ? 1 : 0, f));
+ break;
+ case Slot_Byte:
+ children.add(new FSNode(this.fSTreeModel, nc, null, fs.getByteValue(f), f));
+ break;
+ case Slot_Short:
+ children.add(new FSNode(this.fSTreeModel, nc, null, fs.getShortValue(f), f));
+ break;
+ case Slot_Int:
+ children.add(new FSNode(this.fSTreeModel, nc, null, fs.getIntValue(f), f));
+ break;
+ case Slot_Float:
+ children.add(new FSNode(this.fSTreeModel, nc, null,
+ CASImpl.float2int(fs.getFloatValue(f)), f));
+ break;
+ case Slot_LongRef:
+ children.add(new FSNode(this.fSTreeModel, nc, null, fs.getLongValue(f), f));
+ break;
+ case Slot_DoubleRef:
+ children.add(new FSNode(this.fSTreeModel, nc, null,
+ CASImpl.double2long(fs.getDoubleValue(f)), f));
+ break;
+ case Slot_StrRef:
+ children.add(new FSNode(this.fSTreeModel, nc, fs.getStringValue(f), 0, f));
+ break;
+ case Slot_HeapRef:
+ children.add(new FSNode(this.fSTreeModel, nc, fs.getFeatureValue(f), 0, f));
+ break;
+ default:
+ Misc.internalError();
} // end of switch
}
}
@@ -316,16 +363,20 @@ public class FSNode extends FSTreeNode {
/**
* Make nodes.
*
- * @param arrayNodes the array nodes
- * @param newFSNode the new FS node
+ * @param arrayNodes
+ * the array nodes
+ * @param newFSNode
+ * the new FS node
*/
private void makeNodes(List<FSNode> arrayNodes, int size, IntFunction<FSNode> newFSNode) {
for (int idx = 0; idx < size; idx++) {
arrayNodes.add(newFSNode.apply(idx));
}
- }
-
- /* (non-Javadoc)
+ }
+
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#toString()
*/
@Override
@@ -356,7 +407,7 @@ public class FSNode extends FSTreeNode {
private String getFeatureString() {
return "<i>" + this.feat.getShortName() + "</i>";
}
-
+
/**
* Checks if is shortened string.
*
@@ -365,8 +416,8 @@ public class FSNode extends FSTreeNode {
boolean isShortenedString() {
return this.isShortenedString;
}
-
- /**
+
+ /**
* @return for string nodes, return the string value (so it can be displayed seperately
*/
String getFullString() {
@@ -382,7 +433,7 @@ public class FSNode extends FSTreeNode {
* @return the value string
*/
private String getValueString() {
-
+
switch (this.nodeClass) {
case INT_FS:
case BYTE_FS:
@@ -416,8 +467,8 @@ public class FSNode extends FSTreeNode {
if (this.fs == null) {
return getNullString();
}
- return "<font color=blue>" + getType().getName() + "</font>["
- + ((CommonArrayFS)fs).size() + "]";
+ return "<font color=blue>" + getType().getName() + "</font>[" + ((CommonArrayFS) fs).size()
+ + "]";
}
case STD_FS: {
if (fs == null) {
@@ -432,7 +483,8 @@ public class FSNode extends FSTreeNode {
/**
* Shorten string.
*
- * @param s the s
+ * @param s
+ * the s
* @return the string
*/
private static final String shortenString(String s) {
@@ -444,11 +496,12 @@ public class FSNode extends FSTreeNode {
buf.append("...");
return buf.toString();
}
-
+
/**
* Escape lt.
*
- * @param s the s
+ * @param s
+ * the s
* @return the string
*/
private static final String escapeLt(String s) {
@@ -456,7 +509,7 @@ public class FSNode extends FSTreeNode {
int i = 0;
while (i < max) {
if (s.charAt(i) == '<') {
- break;
+ break;
}
++i;
}
@@ -466,15 +519,15 @@ public class FSNode extends FSTreeNode {
StringBuffer buf = new StringBuffer(s.substring(0, i));
while (i < max) {
if (s.charAt(i) == '<') {
- buf.append("<");
+ buf.append("<");
} else {
- buf.append(s.charAt(i));
+ buf.append(s.charAt(i));
}
++i;
}
return buf.toString();
}
-
+
/**
* Gets the null string.
*
@@ -517,7 +570,7 @@ public class FSNode extends FSTreeNode {
* @return the start
*/
public int getStart() {
- return isAnnotation() ? ((Annotation)fs).getBegin() : -1;
+ return isAnnotation() ? ((Annotation) fs).getBegin() : -1;
}
/**
@@ -526,7 +579,7 @@ public class FSNode extends FSTreeNode {
* @return the end
*/
public int getEnd() {
- return isAnnotation() ? ((Annotation)fs).getEnd() : -1;
+ return isAnnotation() ? ((Annotation) fs).getEnd() : -1;
}
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSTreeModel.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSTreeModel.java
index 3c3a7ee..d331e11 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSTreeModel.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSTreeModel.java
@@ -37,7 +37,6 @@ import org.apache.uima.cas.impl.TypeImpl_string;
import org.apache.uima.cas.impl.TypeSystemConstants;
import org.apache.uima.jcas.cas.TOP;
-
/**
* Swing Tree Model for Feature Structures.
*/
@@ -74,9 +73,12 @@ public class FSTreeModel implements TreeModel {
/**
* Update.
*
- * @param indexName the index name
- * @param index the index
- * @param cas1 the cas 1
+ * @param indexName
+ * the index name
+ * @param index
+ * the index
+ * @param cas1
+ * the cas 1
*/
public void update(String indexName, FSIndex index, CAS cas1) {
// this.indexName = indexName;
@@ -141,8 +143,10 @@ public class FSTreeModel implements TreeModel {
/**
* Gets the child.
*
- * @param parent the parent
- * @param index the index
+ * @param parent
+ * the parent
+ * @param index
+ * the index
* @return the child
* @see javax.swing.tree.TreeModel#getChild(java.lang.Object, int)
*/
@@ -153,54 +157,64 @@ public class FSTreeModel implements TreeModel {
return node.getChildren().get(index);
}
-// int getNodeType(int addr, Feature feat) {
-// Type domType = feat.getRange();
-// if (this.cas.isStringType(domType)) {
-// return FSNode.STRING_FS;
-// } else if (this.cas.isIntType(domType)) {
-// return FSNode.INT_FS;
-// } else if (this.cas.isFloatType(domType)) {
-// return FSNode.FLOAT_FS;
-// } else if (this.cas.isByteType(domType)) {
-// return FSNode.BYTE_FS;
-// } else if (this.cas.isBooleanType(domType)) {
-// return FSNode.BOOL_FS;
-// } else if (this.cas.isShortType(domType)) {
-// return FSNode.SHORT_FS;
-// } else if (this.cas.isLongType(domType)) {
-// return FSNode.LONG_FS;
-// } else if (this.cas.isDoubleType(domType)) {
-// return FSNode.DOUBLE_FS;
-// } else if (this.cas.isArrayOfFsType(domType)) {
-// final int featAddr = this.cas.getFeatureValue(addr, ((FeatureImpl) feat).getCode());
-// if (this.cas.isArrayType(this.cas.getTypeSystemImpl()
-// .ll_getTypeForCode(this.cas.getHeapValue(featAddr)))) {
-// return FSNode.ARRAY_FS;
-// }
-// }
-// return FSNode.STD_FS;
-// }
+ // int getNodeType(int addr, Feature feat) {
+ // Type domType = feat.getRange();
+ // if (this.cas.isStringType(domType)) {
+ // return FSNode.STRING_FS;
+ // } else if (this.cas.isIntType(domType)) {
+ // return FSNode.INT_FS;
+ // } else if (this.cas.isFloatType(domType)) {
+ // return FSNode.FLOAT_FS;
+ // } else if (this.cas.isByteType(domType)) {
+ // return FSNode.BYTE_FS;
+ // } else if (this.cas.isBooleanType(domType)) {
+ // return FSNode.BOOL_FS;
+ // } else if (this.cas.isShortType(domType)) {
+ // return FSNode.SHORT_FS;
+ // } else if (this.cas.isLongType(domType)) {
+ // return FSNode.LONG_FS;
+ // } else if (this.cas.isDoubleType(domType)) {
+ // return FSNode.DOUBLE_FS;
+ // } else if (this.cas.isArrayOfFsType(domType)) {
+ // final int featAddr = this.cas.getFeatureValue(addr, ((FeatureImpl) feat).getCode());
+ // if (this.cas.isArrayType(this.cas.getTypeSystemImpl()
+ // .ll_getTypeForCode(this.cas.getHeapValue(featAddr)))) {
+ // return FSNode.ARRAY_FS;
+ // }
+ // }
+ // return FSNode.STD_FS;
+ // }
/**
- * Gets the node type.
- *
- * @param type the type
- * @return the node type
- */
-int getNodeType(Type type) {
+ * Gets the node type.
+ *
+ * @param type
+ * the type
+ * @return the node type
+ */
+ int getNodeType(Type type) {
if (type instanceof TypeImpl_string) {
return FSNode.STRING_FS;
} else {
- switch(((TypeImpl)type).getCode()) {
- case TypeSystemConstants.intTypeCode: return FSNode.INT_FS;
- case TypeSystemConstants.floatTypeCode: return FSNode.FLOAT_FS;
- case TypeSystemConstants.fsArrayTypeCode: return FSNode.ARRAY_FS;
- case TypeSystemConstants.byteArrayTypeCode: return FSNode.BYTE_FS;
- case TypeSystemConstants.booleanArrayTypeCode: return FSNode.BOOL_FS;
- case TypeSystemConstants.shortArrayTypeCode: return FSNode.SHORT_FS;
- case TypeSystemConstants.longArrayTypeCode: return FSNode.LONG_FS;
- case TypeSystemConstants.doubleArrayTypeCode: return FSNode.DOUBLE_FS;
- default: return FSNode.STD_FS;
+ switch (((TypeImpl) type).getCode()) {
+ case TypeSystemConstants.intTypeCode:
+ return FSNode.INT_FS;
+ case TypeSystemConstants.floatTypeCode:
+ return FSNode.FLOAT_FS;
+ case TypeSystemConstants.fsArrayTypeCode:
+ return FSNode.ARRAY_FS;
+ case TypeSystemConstants.byteArrayTypeCode:
+ return FSNode.BYTE_FS;
+ case TypeSystemConstants.booleanArrayTypeCode:
+ return FSNode.BOOL_FS;
+ case TypeSystemConstants.shortArrayTypeCode:
+ return FSNode.SHORT_FS;
+ case TypeSystemConstants.longArrayTypeCode:
+ return FSNode.LONG_FS;
+ case TypeSystemConstants.doubleArrayTypeCode:
+ return FSNode.DOUBLE_FS;
+ default:
+ return FSNode.STD_FS;
}
}
}
@@ -208,7 +222,8 @@ int getNodeType(Type type) {
/**
* Gets the child count.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the child count
* @see javax.swing.tree.TreeModel#getChildCount(java.lang.Object)
*/
@@ -220,7 +235,8 @@ int getNodeType(Type type) {
/**
* Checks if is leaf.
*
- * @param node the node
+ * @param node
+ * the node
* @return true, if is leaf
* @see javax.swing.tree.TreeModel#isLeaf(java.lang.Object)
*/
@@ -232,8 +248,10 @@ int getNodeType(Type type) {
/**
* Value for path changed.
*
- * @param path the path
- * @param newValue the new value
+ * @param path
+ * the path
+ * @param newValue
+ * the new value
* @see javax.swing.tree.TreeModel#valueForPathChanged(javax.swing.tree.TreePath,
* java.lang.Object)
*/
@@ -245,8 +263,10 @@ int getNodeType(Type type) {
/**
* Gets the index of child.
*
- * @param parent the parent
- * @param child the child
+ * @param parent
+ * the parent
+ * @param child
+ * the child
* @return the index of child
* @see javax.swing.tree.TreeModel#getIndexOfChild(java.lang.Object, java.lang.Object)
*/
@@ -260,7 +280,8 @@ int getNodeType(Type type) {
/**
* Adds the tree model listener.
*
- * @param arg0 the arg 0
+ * @param arg0
+ * the arg 0
* @see javax.swing.tree.TreeModel#addTreeModelListener(javax.swing.event.TreeModelListener)
*/
@Override
@@ -271,7 +292,8 @@ int getNodeType(Type type) {
/**
* Removes the tree model listener.
*
- * @param arg0 the arg 0
+ * @param arg0
+ * the arg 0
* @see javax.swing.tree.TreeModel#removeTreeModelListener(javax.swing.event.TreeModelListener)
*/
@Override
@@ -300,13 +322,18 @@ int getNodeType(Type type) {
/**
* Creates the array children.
*
- * @param start the start
- * @param end the end
- * @param array the array
- * @param model the model
+ * @param start
+ * the start
+ * @param end
+ * the end
+ * @param array
+ * the array
+ * @param model
+ * the model
* @return the list
*/
- static List<FSTreeNode> createArrayChildren(int start, int end, List<FSNode> array, FSTreeModel model) {
+ static List<FSTreeNode> createArrayChildren(int start, int end, List<FSNode> array,
+ FSTreeModel model) {
ArrayList<FSTreeNode> kids = new ArrayList<>();
final int size = end - start;
if (size <= ArrayNode.CUTOFF) {
@@ -347,7 +374,8 @@ int getNodeType(Type type) {
/**
* Path to node.
*
- * @param fsNum the fs num
+ * @param fsNum
+ * the fs num
* @return the tree path
*/
public TreePath pathToNode(int fsNum) {
@@ -361,9 +389,12 @@ int getNodeType(Type type) {
/**
* Gets the path to node.
*
- * @param n the n
- * @param dtrs the dtrs
- * @param path the path
+ * @param n
+ * the n
+ * @param dtrs
+ * the dtrs
+ * @param path
+ * the path
* @return the path to node
*/
private void getPathToNode(int n, List<FSTreeNode> dtrs, List<FSTreeNode> path) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSTreeNode.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSTreeNode.java
index a804995..15e434f 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSTreeNode.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/FSTreeNode.java
@@ -22,7 +22,6 @@ package org.apache.uima.tools.cvd;
import java.util.ArrayList;
import java.util.List;
-
/**
* TODO: add type comment for <code>FSTreeNode</code>.
*
@@ -33,7 +32,6 @@ public abstract class FSTreeNode {
/** The children. */
protected List<FSTreeNode> children = null;
-
/**
* Instantiates a new FS tree node.
*/
@@ -51,7 +49,8 @@ public abstract class FSTreeNode {
/**
* Sets the children.
*
- * @param children the new children
+ * @param children
+ * the new children
*/
void setChildren(List<FSTreeNode> children) {
this.children = children;
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/IndexTreeNode.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/IndexTreeNode.java
index a445dc0..8380b92 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/IndexTreeNode.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/IndexTreeNode.java
@@ -21,7 +21,6 @@ package org.apache.uima.tools.cvd;
import org.apache.uima.cas.Type;
-
/**
* Class comment for IndexTreeNode.java goes here.
*
@@ -41,9 +40,12 @@ public class IndexTreeNode {
/**
* Instantiates a new index tree node.
*
- * @param name the name
- * @param type the type
- * @param size the size
+ * @param name
+ * the name
+ * @param type
+ * the type
+ * @param size
+ * the size
*/
public IndexTreeNode(String name, Type type, int size) {
this.name = name;
@@ -60,7 +62,9 @@ public class IndexTreeNode {
this.size = 0;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#toString()
*/
@Override
@@ -86,7 +90,9 @@ public class IndexTreeNode {
return this.type;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
@@ -94,7 +100,9 @@ public class IndexTreeNode {
return (this == o);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#hashCode()
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/LogFileViewer.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/LogFileViewer.java
index de74e8c..c2c09ce 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/LogFileViewer.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/LogFileViewer.java
@@ -41,7 +41,6 @@ import javax.swing.text.DefaultEditorKit;
import org.apache.uima.util.FileUtils;
-
/**
* Simple file viewer for viewing log files.
*
@@ -49,144 +48,153 @@ import org.apache.uima.util.FileUtils;
*/
public class LogFileViewer extends JFrame {
- /** The Constant serialVersionUID. */
- private static final long serialVersionUID = 3599235286749804258L;
-
- /** The log file. */
- private File logFile;
-
- /** The scroll pane. */
- private JScrollPane scrollPane;
-
- /** The text area. */
- private JTextArea textArea;
-
- /**
- * Instantiates a new log file viewer.
- *
- * @throws java.awt.HeadlessException the java.awt. headless exception
- */
- public LogFileViewer() {
- }
-
- /**
- * Instantiates a new log file viewer.
- *
- * @param arg0 the arg 0
- */
- public LogFileViewer(GraphicsConfiguration arg0) {
- super(arg0);
- }
-
- /**
- * Instantiates a new log file viewer.
- *
- * @param arg0 the arg 0
- * @throws java.awt.HeadlessException the java.awt. headless exception
- */
- public LogFileViewer(String arg0) {
- super(arg0);
- }
-
- /**
- * Instantiates a new log file viewer.
- *
- * @param arg0 the arg 0
- * @param arg1 the arg 1
- */
- public LogFileViewer(String arg0, GraphicsConfiguration arg1) {
- super(arg0, arg1);
- }
-
- /**
- * Inits the.
- *
- * @param file the file
- * @param d the d
- */
- public void init(File file, Dimension d) {
- createMenus();
- this.logFile = file;
- this.textArea = new JTextArea();
- // Copy
- Action copyAction = this.textArea.getActionMap().get(DefaultEditorKit.copyAction);
- copyAction.putValue(Action.ACCELERATOR_KEY, KeyStroke.getKeyStroke(KeyEvent.VK_C,
- InputEvent.CTRL_MASK));
- copyAction.setEnabled(true);
- this.scrollPane = new JScrollPane(this.textArea);
- this.setContentPane(this.scrollPane);
- this.scrollPane.setPreferredSize(d);
- boolean doneLoadingFile = loadFile();
- if (!doneLoadingFile) {
- this.dispose();
- return;
- }
- this.pack();
- this.setVisible(true);
- }
-
- /**
- * Creates the menus.
- */
- private void createMenus() {
- JMenuBar menuBar = new JMenuBar();
- this.setJMenuBar(menuBar);
- JMenu fileMenu = new JMenu("File");
- menuBar.add(fileMenu);
- JMenuItem reload = new JMenuItem("Reload Log File");
- reload.addActionListener(new ActionListener() {
- @Override
+ /** The Constant serialVersionUID. */
+ private static final long serialVersionUID = 3599235286749804258L;
+
+ /** The log file. */
+ private File logFile;
+
+ /** The scroll pane. */
+ private JScrollPane scrollPane;
+
+ /** The text area. */
+ private JTextArea textArea;
+
+ /**
+ * Instantiates a new log file viewer.
+ *
+ * @throws java.awt.HeadlessException
+ * the java.awt. headless exception
+ */
+ public LogFileViewer() {
+ }
+
+ /**
+ * Instantiates a new log file viewer.
+ *
+ * @param arg0
+ * the arg 0
+ */
+ public LogFileViewer(GraphicsConfiguration arg0) {
+ super(arg0);
+ }
+
+ /**
+ * Instantiates a new log file viewer.
+ *
+ * @param arg0
+ * the arg 0
+ * @throws java.awt.HeadlessException
+ * the java.awt. headless exception
+ */
+ public LogFileViewer(String arg0) {
+ super(arg0);
+ }
+
+ /**
+ * Instantiates a new log file viewer.
+ *
+ * @param arg0
+ * the arg 0
+ * @param arg1
+ * the arg 1
+ */
+ public LogFileViewer(String arg0, GraphicsConfiguration arg1) {
+ super(arg0, arg1);
+ }
+
+ /**
+ * Inits the.
+ *
+ * @param file
+ * the file
+ * @param d
+ * the d
+ */
+ public void init(File file, Dimension d) {
+ createMenus();
+ this.logFile = file;
+ this.textArea = new JTextArea();
+ // Copy
+ Action copyAction = this.textArea.getActionMap().get(DefaultEditorKit.copyAction);
+ copyAction.putValue(Action.ACCELERATOR_KEY,
+ KeyStroke.getKeyStroke(KeyEvent.VK_C, InputEvent.CTRL_MASK));
+ copyAction.setEnabled(true);
+ this.scrollPane = new JScrollPane(this.textArea);
+ this.setContentPane(this.scrollPane);
+ this.scrollPane.setPreferredSize(d);
+ boolean doneLoadingFile = loadFile();
+ if (!doneLoadingFile) {
+ this.dispose();
+ return;
+ }
+ this.pack();
+ this.setVisible(true);
+ }
+
+ /**
+ * Creates the menus.
+ */
+ private void createMenus() {
+ JMenuBar menuBar = new JMenuBar();
+ this.setJMenuBar(menuBar);
+ JMenu fileMenu = new JMenu("File");
+ menuBar.add(fileMenu);
+ JMenuItem reload = new JMenuItem("Reload Log File");
+ reload.addActionListener(new ActionListener() {
+ @Override
public void actionPerformed(ActionEvent event) {
- loadFile();
- }
- });
- fileMenu.add(reload);
- JMenuItem exit = new JMenuItem("Close Window");
- exit.addActionListener(new ActionListener() {
- @Override
+ loadFile();
+ }
+ });
+ fileMenu.add(reload);
+ JMenuItem exit = new JMenuItem("Close Window");
+ exit.addActionListener(new ActionListener() {
+ @Override
public void actionPerformed(ActionEvent event) {
- LogFileViewer.this.dispose();
- }
- });
- fileMenu.add(exit);
- }
-
- /**
- * Load file.
- *
- * @return true, if successful
- */
- private boolean loadFile() {
- if (!this.logFile.exists()) {
- JOptionPane.showMessageDialog(this, "The log file \"" + this.logFile.getAbsolutePath()
- + "\" does not exist (yet).\nThis probably just means that nothing was logged yet.",
- "Information", JOptionPane.INFORMATION_MESSAGE);
- return false;
- }
- String text = null;
- try {
- text = FileUtils.file2String(this.logFile, "UTF-8");
- } catch (IOException e) {
- handleException(e);
- return false;
- }
- this.textArea.setText(text);
- return true;
- }
-
- /**
- * Handle exception.
- *
- * @param e the e
- */
- protected void handleException(Exception e) {
- boolean hasAsserts = false;
- // assert(hasAsserts = true);
- if (hasAsserts) {
- e.printStackTrace();
- }
- JOptionPane.showMessageDialog(this, e.getMessage(), "Exception", JOptionPane.ERROR_MESSAGE);
-
- }
+ LogFileViewer.this.dispose();
+ }
+ });
+ fileMenu.add(exit);
+ }
+
+ /**
+ * Load file.
+ *
+ * @return true, if successful
+ */
+ private boolean loadFile() {
+ if (!this.logFile.exists()) {
+ JOptionPane.showMessageDialog(this, "The log file \"" + this.logFile.getAbsolutePath()
+ + "\" does not exist (yet).\nThis probably just means that nothing was logged yet.",
+ "Information", JOptionPane.INFORMATION_MESSAGE);
+ return false;
+ }
+ String text = null;
+ try {
+ text = FileUtils.file2String(this.logFile, "UTF-8");
+ } catch (IOException e) {
+ handleException(e);
+ return false;
+ }
+ this.textArea.setText(text);
+ return true;
+ }
+
+ /**
+ * Handle exception.
+ *
+ * @param e
+ * the e
+ */
+ protected void handleException(Exception e) {
+ boolean hasAsserts = false;
+ // assert(hasAsserts = true);
+ if (hasAsserts) {
+ e.printStackTrace();
+ }
+ JOptionPane.showMessageDialog(this, e.getMessage(), "Exception", JOptionPane.ERROR_MESSAGE);
+
+ }
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MainFrame.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MainFrame.java
index c815639..348a5dd 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MainFrame.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MainFrame.java
@@ -160,7 +160,6 @@ import org.apache.uima.util.Logger;
import org.apache.uima.util.ProcessTrace;
import org.apache.uima.util.XMLInputSource;
-
/**
* Class comment for MainFrame.java goes here.
*
@@ -189,8 +188,7 @@ public class MainFrame extends JFrame {
private static final String loggerPropertiesFileName = "org/apache/uima/tools/annot_view/Logger.properties";
/** The Constant defaultText. */
- private static final String defaultText =
- "Load or edit text here.";
+ private static final String defaultText = "Load or edit text here.";
/** The Constant titleText. */
private static final String titleText = "CAS Visual Debugger (CVD)";
@@ -203,7 +201,7 @@ public class MainFrame extends JFrame {
/** The Constant noIndexReposLabel. */
private static final String noIndexReposLabel = "<html><b>" + htmlGrayColor
- + "CAS Index Repository</b></html>";
+ + "CAS Index Repository</b></html>";
/** The text area. */
// The content areas.
@@ -520,8 +518,10 @@ public class MainFrame extends JFrame {
/**
* Constructor for MainFrame.
*
- * @param iniFile the ini file
- * @throws HeadlessException -
+ * @param iniFile
+ * the ini file
+ * @throws HeadlessException
+ * -
*/
public MainFrame(File iniFile) {
this.iniFile = iniFile;
@@ -531,7 +531,8 @@ public class MainFrame extends JFrame {
/**
* Run AE.
*
- * @param doCasReset the do cas reset
+ * @param doCasReset
+ * the do cas reset
*/
public void runAE(boolean doCasReset) {
setStatusbarMessage("Running Annotator.");
@@ -544,7 +545,7 @@ public class MainFrame extends JFrame {
internalRunAE(doCasReset);
timer.stop();
setStatusbarMessage("Done running AE " + this.ae.getAnalysisEngineMetaData().getName() + " in "
- + timer.getTimeSpan() + ".");
+ + timer.getTimeSpan() + ".");
updateIndexTree(true);
this.allAnnotationViewerItem.setEnabled(false);
this.isDirty = false;
@@ -569,8 +570,8 @@ public class MainFrame extends JFrame {
}
this.showPerfReportItem.setEnabled(false);
timer.stop();
- setStatusbarMessage("Done running CPC on " + this.ae.getAnalysisEngineMetaData().getName() + " in "
- + timer.getTimeSpan() + ".");
+ setStatusbarMessage("Done running CPC on " + this.ae.getAnalysisEngineMetaData().getName()
+ + " in " + timer.getTimeSpan() + ".");
updateIndexTree(true);
this.allAnnotationViewerItem.setEnabled(false);
this.isDirty = false;
@@ -580,7 +581,8 @@ public class MainFrame extends JFrame {
/**
* Sets the data path.
*
- * @param dataPath the new data path
+ * @param dataPath
+ * the new data path
*/
public void setDataPath(String dataPath) {
this.dataPathName = dataPath;
@@ -589,7 +591,8 @@ public class MainFrame extends JFrame {
/**
* Load AE descriptor.
*
- * @param descriptorFile the descriptor file
+ * @param descriptorFile
+ * the descriptor file
*/
public void loadAEDescriptor(File descriptorFile) {
addRecentDescFile(descriptorFile);
@@ -629,9 +632,7 @@ public class MainFrame extends JFrame {
// TODO: properly handle CAS multiplication
if (this.ae != null) {
if (this.ae.getAnalysisEngineMetaData().getOperationalProperties().getOutputsNewCASes()) {
- JOptionPane
- .showMessageDialog(
- this,
+ JOptionPane.showMessageDialog(this,
"This analysis engine uses a CAS multiplier component.\nCAS multiplication/merging is not currently supported in CVD.\nYou can run the analysis engine, but will not see any results.",
"Warning: unsupported operation", JOptionPane.WARNING_MESSAGE);
}
@@ -642,7 +643,8 @@ public class MainFrame extends JFrame {
/**
* Handle exception.
*
- * @param e the e
+ * @param e
+ * the e
*/
public void handleException(Throwable e) {
StringBuffer msg = new StringBuffer();
@@ -652,8 +654,10 @@ public class MainFrame extends JFrame {
/**
* Handle exception.
*
- * @param e the e
- * @param msg the msg
+ * @param e
+ * the e
+ * @param msg
+ * the msg
*/
protected void handleException(Throwable e, StringBuffer msg) {
msg.append(e.getClass().getName() + ": ");
@@ -680,7 +684,8 @@ public class MainFrame extends JFrame {
/**
* Show error.
*
- * @param msg the msg
+ * @param msg
+ * the msg
*/
private void showError(String msg) {
JOptionPane.showMessageDialog(this, msg, "Error", JOptionPane.ERROR_MESSAGE);
@@ -702,8 +707,8 @@ public class MainFrame extends JFrame {
setTitle();
addRecentTextFile(this.textFile);
} else {
- handleException(new IOException("File does not exist or is not readable: "
- + this.textFile.getAbsolutePath()));
+ handleException(new IOException(
+ "File does not exist or is not readable: " + this.textFile.getAbsolutePath()));
}
// Add the loaded file to the recently used files list.
} catch (UnsupportedEncodingException e) {
@@ -717,7 +722,8 @@ public class MainFrame extends JFrame {
/**
* Load xmi file.
*
- * @param xmiCasFile the xmi cas file
+ * @param xmiCasFile
+ * the xmi cas file
*/
public void loadXmiFile(File xmiCasFile) {
try {
@@ -743,43 +749,45 @@ public class MainFrame extends JFrame {
}
}
-
/**
* Gets the mnemonic.
*
- * @param i the i
+ * @param i
+ * the i
* @return the mnemonic
*/
private static final int getMnemonic(int i) {
switch (i) {
- case 1:
- return KeyEvent.VK_1;
- case 2:
- return KeyEvent.VK_2;
- case 3:
- return KeyEvent.VK_3;
- case 4:
- return KeyEvent.VK_4;
- case 5:
- return KeyEvent.VK_5;
- case 6:
- return KeyEvent.VK_6;
- case 7:
- return KeyEvent.VK_7;
- case 8:
- return KeyEvent.VK_8;
- case 9:
- return KeyEvent.VK_9;
- default:
- return KeyEvent.VK_0;
+ case 1:
+ return KeyEvent.VK_1;
+ case 2:
+ return KeyEvent.VK_2;
+ case 3:
+ return KeyEvent.VK_3;
+ case 4:
+ return KeyEvent.VK_4;
+ case 5:
+ return KeyEvent.VK_5;
+ case 6:
+ return KeyEvent.VK_6;
+ case 7:
+ return KeyEvent.VK_7;
+ case 8:
+ return KeyEvent.VK_8;
+ case 9:
+ return KeyEvent.VK_9;
+ default:
+ return KeyEvent.VK_0;
}
}
/**
* Creates the recent text file item.
*
- * @param num the num
- * @param file the file
+ * @param num
+ * the num
+ * @param file
+ * the file
* @return the j menu item
*/
private final JMenuItem createRecentTextFileItem(int num, File file) {
@@ -793,7 +801,8 @@ public class MainFrame extends JFrame {
/**
* Adds the recent text file.
*
- * @param file the file
+ * @param file
+ * the file
*/
private void addRecentTextFile(File file) {
this.recentTextFiles.addFile(file);
@@ -808,8 +817,10 @@ public class MainFrame extends JFrame {
/**
* Creates the recent desc file item.
*
- * @param num the num
- * @param file the file
+ * @param num
+ * the num
+ * @param file
+ * the file
* @return the j menu item
*/
private final JMenuItem createRecentDescFileItem(int num, File file) {
@@ -823,7 +834,8 @@ public class MainFrame extends JFrame {
/**
* Adds the recent desc file.
*
- * @param file the file
+ * @param file
+ * the file
*/
private void addRecentDescFile(File file) {
this.recentDescFiles.addFile(file);
@@ -839,7 +851,7 @@ public class MainFrame extends JFrame {
* Set the text to be analyzed.
*
* @param text
- * The text.
+ * The text.
*/
public void setText(String text) {
this.textFile = null;
@@ -851,7 +863,7 @@ public class MainFrame extends JFrame {
* Load a text file.
*
* @param textFile1
- * The text file.
+ * The text file.
*/
public void loadTextFile(File textFile1) {
this.textFile = textFile1;
@@ -861,7 +873,8 @@ public class MainFrame extends JFrame {
/**
* Sets the text no title.
*
- * @param text the new text no title
+ * @param text
+ * the new text no title
*/
// Set the text.
public void setTextNoTitle(String text) {
@@ -925,26 +938,22 @@ public class MainFrame extends JFrame {
}
return true;
}
-
+
/**
* Confirm overwrite.
*
- * @param f the f
+ * @param f
+ * the f
* @return true, if successful
*/
public boolean confirmOverwrite(File f) {
if (f.exists()) {
- Object[] options = {"Yes, Overwrite.",
- "No"};
+ Object[] options = { "Yes, Overwrite.", "No" };
int n = JOptionPane.showOptionDialog(this,
- "File " + f.getAbsolutePath() + " exists.\nWould you like to overwrite it?",
-
- "Confirm Overwrite",
- JOptionPane.YES_NO_OPTION,
- JOptionPane.QUESTION_MESSAGE,
- null,
- options,
- options[1]);
+ "File " + f.getAbsolutePath() + " exists.\nWould you like to overwrite it?",
+
+ "Confirm Overwrite", JOptionPane.YES_NO_OPTION, JOptionPane.QUESTION_MESSAGE, null,
+ options, options[1]);
if (n == 1) {
return false;
}
@@ -994,8 +1003,8 @@ public class MainFrame extends JFrame {
// Cut
this.cutAction = actionMap.get(DefaultEditorKit.cutAction);
this.cutAction.putValue(Action.MNEMONIC_KEY, KeyEvent.VK_T);
- this.cutAction.putValue(Action.ACCELERATOR_KEY, KeyStroke.getKeyStroke(KeyEvent.VK_X,
- InputEvent.CTRL_MASK));
+ this.cutAction.putValue(Action.ACCELERATOR_KEY,
+ KeyStroke.getKeyStroke(KeyEvent.VK_X, InputEvent.CTRL_MASK));
this.cutAction.setEnabled(false);
JMenuItem cutItem = new JMenuItem(this.cutAction);
cutItem.setText("Cut");
@@ -1003,8 +1012,8 @@ public class MainFrame extends JFrame {
// Copy
this.copyAction = actionMap.get(DefaultEditorKit.copyAction);
this.copyAction.putValue(Action.MNEMONIC_KEY, KeyEvent.VK_C);
- this.copyAction.putValue(Action.ACCELERATOR_KEY, KeyStroke.getKeyStroke(KeyEvent.VK_C,
- InputEvent.CTRL_MASK));
+ this.copyAction.putValue(Action.ACCELERATOR_KEY,
+ KeyStroke.getKeyStroke(KeyEvent.VK_C, InputEvent.CTRL_MASK));
this.copyAction.setEnabled(false);
JMenuItem copyItem = new JMenuItem(this.copyAction);
copyItem.setText("Copy");
@@ -1012,8 +1021,8 @@ public class MainFrame extends JFrame {
// Paste
Action pasteAction = actionMap.get(DefaultEditorKit.pasteAction);
pasteAction.putValue(Action.MNEMONIC_KEY, KeyEvent.VK_P);
- pasteAction.putValue(Action.ACCELERATOR_KEY, KeyStroke.getKeyStroke(KeyEvent.VK_V,
- InputEvent.CTRL_MASK));
+ pasteAction.putValue(Action.ACCELERATOR_KEY,
+ KeyStroke.getKeyStroke(KeyEvent.VK_V, InputEvent.CTRL_MASK));
JMenuItem pasteItem = new JMenuItem(pasteAction);
pasteItem.setText("Paste");
this.editMenu.add(pasteItem);
@@ -1178,7 +1187,8 @@ public class MainFrame extends JFrame {
/**
* Adds the cursor owning component.
*
- * @param comp the comp
+ * @param comp
+ * the comp
*/
private final void addCursorOwningComponent(Component comp) {
this.cursorOwningComponents.add(comp);
@@ -1218,7 +1228,7 @@ public class MainFrame extends JFrame {
// Get supported encodings from JVM
Map<String, Charset> charsetMap = Charset.availableCharsets();
String sysCodePage = Charset.defaultCharset().name();
-
+
this.codePages = new ArrayList<>();
if (sysCodePage != null) {
@@ -1268,13 +1278,14 @@ public class MainFrame extends JFrame {
this.cpButtons.add(item);
this.cpMenu.add(item);
}
-
+
}
/**
* Adds the language.
*
- * @param language1 the language 1
+ * @param language1
+ * the language 1
*/
public void addLanguage(String language1) {
this.language = language1;
@@ -1366,8 +1377,8 @@ public class MainFrame extends JFrame {
this.reRunMenu.addActionListener(new AnnotatorRerunEventHandler(this));
this.reRunMenu.setEnabled(false);
this.runOnCasMenuItem = new JMenuItem("Run AE on CAS", KeyEvent.VK_Y);
- this.runOnCasMenuItem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_Y,
- ActionEvent.CTRL_MASK));
+ this.runOnCasMenuItem
+ .setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_Y, ActionEvent.CTRL_MASK));
runMenu.add(this.runOnCasMenuItem);
this.runOnCasMenuItem.addActionListener(new AnnotatorRunOnCasEventHandler(this));
this.runOnCasMenuItem.setEnabled(false);
@@ -1453,8 +1464,8 @@ public class MainFrame extends JFrame {
@Override
public void actionPerformed(ActionEvent event) {
- LogFileViewer viewer = new LogFileViewer("Log file: "
- + MainFrame.this.logFile.getAbsolutePath());
+ LogFileViewer viewer = new LogFileViewer(
+ "Log file: " + MainFrame.this.logFile.getAbsolutePath());
viewer.addWindowListener(new CloseLogViewHandler(MainFrame.this));
Dimension dim = getDimension(logViewSizePref);
if (dim == null) {
@@ -1476,15 +1487,15 @@ public class MainFrame extends JFrame {
// statusPanel.setBorder(BorderFactory.createLineBorder(Color.gray));
this.statusPanel.setLayout(new BoxLayout(this.statusPanel, BoxLayout.X_AXIS));
this.statusBar = new JTextField();
- Border innerCompound = BorderFactory.createCompoundBorder(BorderFactory.createBevelBorder(
- BevelBorder.LOWERED, Color.lightGray, Color.darkGray), BorderFactory.createEmptyBorder(0,
- 3, 0, 3));
- Border leftCompoundBorder = BorderFactory.createCompoundBorder(BorderFactory.createEmptyBorder(
- 0, 0, 0, 1), innerCompound);
- Border middleCompoundBorder = BorderFactory.createCompoundBorder(BorderFactory
- .createEmptyBorder(0, 1, 0, 1), innerCompound);
- Border rightCompoundBorder = BorderFactory.createCompoundBorder(BorderFactory
- .createEmptyBorder(0, 1, 0, 0), innerCompound);
+ Border innerCompound = BorderFactory.createCompoundBorder(
+ BorderFactory.createBevelBorder(BevelBorder.LOWERED, Color.lightGray, Color.darkGray),
+ BorderFactory.createEmptyBorder(0, 3, 0, 3));
+ Border leftCompoundBorder = BorderFactory
+ .createCompoundBorder(BorderFactory.createEmptyBorder(0, 0, 0, 1), innerCompound);
+ Border middleCompoundBorder = BorderFactory
+ .createCompoundBorder(BorderFactory.createEmptyBorder(0, 1, 0, 1), innerCompound);
+ Border rightCompoundBorder = BorderFactory
+ .createCompoundBorder(BorderFactory.createEmptyBorder(0, 1, 0, 0), innerCompound);
// statusBar.setBorder(BorderFactory.createEmptyBorder(0, 2, 0, 2));
this.statusBar.setBorder(leftCompoundBorder);
this.statusBar.setEditable(false);
@@ -1520,8 +1531,10 @@ public class MainFrame extends JFrame {
/**
* Sets the caret status.
*
- * @param dot the dot
- * @param mark the mark
+ * @param dot
+ * the dot
+ * @param mark
+ * the mark
*/
public void setCaretStatus(final int dot, final int mark) {
if (dot == mark) {
@@ -1552,8 +1565,8 @@ public class MainFrame extends JFrame {
textBorder = BorderFactory.createTitledBorder(this.textTitleBorder, "Text");
// textBorder.setTitleJustification(TitledBorder.ABOVE_TOP);
} else {
- textBorder = BorderFactory.createTitledBorder(this.textTitleBorder, this.textFile
- .getAbsolutePath());
+ textBorder = BorderFactory.createTitledBorder(this.textTitleBorder,
+ this.textFile.getAbsolutePath());
}
this.textScrollPane.setBorder(textBorder);
this.textScrollPane.revalidate();
@@ -1569,7 +1582,7 @@ public class MainFrame extends JFrame {
} else {
this.aeStatus.setText(this.aeDescriptorFile.getName());
this.aeStatus.setToolTipText("<html>Currently loaded AE descriptor file:<br>"
- + this.aeDescriptorFile.getAbsolutePath() + "</html>");
+ + this.aeDescriptorFile.getAbsolutePath() + "</html>");
}
this.statusPanel.revalidate();
}
@@ -1577,7 +1590,8 @@ public class MainFrame extends JFrame {
/**
* Sets the statusbar message.
*
- * @param message the new statusbar message
+ * @param message
+ * the new statusbar message
*/
public void setStatusbarMessage(String message) {
// Date date = new Date();
@@ -1626,12 +1640,12 @@ public class MainFrame extends JFrame {
InputStream ins = ClassLoader.getSystemResourceAsStream(loggerPropertiesFileName);
// Try the current class loader if system one cannot find the file
if (ins == null) {
- ins = this.getClass().getClassLoader().getResourceAsStream(loggerPropertiesFileName);
+ ins = this.getClass().getClassLoader().getResourceAsStream(loggerPropertiesFileName);
}
if (ins != null) {
- logManager.readConfiguration(ins);
+ logManager.readConfiguration(ins);
} else {
- System.out.println("WARNING: failed to load "+loggerPropertiesFileName);
+ System.out.println("WARNING: failed to load " + loggerPropertiesFileName);
}
} catch (SecurityException e) {
handleException(e);
@@ -1691,7 +1705,7 @@ public class MainFrame extends JFrame {
this.sofaSelectionPanel.setVisible(false);
this.sofaSelectionComboBox.addItemListener(new SofaSelectionListener(this));
this.sofaSelectionComboBox
- .setToolTipText("This CAS has multiple Views. Select the View to display.");
+ .setToolTipText("This CAS has multiple Views. Select the View to display.");
JSplitPane treePairPane = new JSplitPane(JSplitPane.VERTICAL_SPLIT);
treePairPane.setDividerSize(dividerSize);
@@ -1759,7 +1773,8 @@ public class MainFrame extends JFrame {
/**
* Setup AE.
*
- * @param aeFile the ae file
+ * @param aeFile
+ * the ae file
* @return true, if successful
*/
protected boolean setupAE(File aeFile) {
@@ -1837,7 +1852,8 @@ public class MainFrame extends JFrame {
/**
* Internal run AE.
*
- * @param doCasReset the do cas reset
+ * @param doCasReset
+ * the do cas reset
*/
protected void internalRunAE(boolean doCasReset) {
try {
@@ -1858,8 +1874,8 @@ public class MainFrame extends JFrame {
this.sofaSelectionComboBox.removeAllItems();
this.sofaSelectionComboBox.addItem(CAS.NAME_DEFAULT_SOFA);
Iterator<?> sofas = ((CASImpl) MainFrame.this.cas).getBaseCAS().getSofaIterator();
- Feature sofaIdFeat = MainFrame.this.cas.getTypeSystem().getFeatureByFullName(
- CAS.FEATURE_FULL_NAME_SOFAID);
+ Feature sofaIdFeat = MainFrame.this.cas.getTypeSystem()
+ .getFeatureByFullName(CAS.FEATURE_FULL_NAME_SOFAID);
boolean nonDefaultSofaFound = false;
while (sofas.hasNext()) {
SofaFS sofa = (SofaFS) sofas.next();
@@ -1933,7 +1949,8 @@ public class MainFrame extends JFrame {
/**
* Update index tree.
*
- * @param useCAS the use CAS
+ * @param useCAS
+ * the use CAS
*/
@SuppressWarnings("unchecked")
public void updateIndexTree(boolean useCAS) {
@@ -1960,7 +1977,7 @@ public class MainFrame extends JFrame {
DefaultTreeModel model = (DefaultTreeModel) this.indexTree.getModel();
// 1.3 workaround
TreeModelListener[] listeners = org.apache.uima.tools.cvd.tsview.MainFrame
- .getTreeModelListeners(model);
+ .getTreeModelListeners(model);
// TreeModelListener[] listeners = model.getTreeModelListeners();
// System.out.println("Number of tree model listeners: " +
// listeners.length);
@@ -1975,8 +1992,10 @@ public class MainFrame extends JFrame {
/**
* Update FS tree.
*
- * @param indexName the index name
- * @param index1 the index 1
+ * @param indexName
+ * the index name
+ * @param index1
+ * the index 1
*/
public void updateFSTree(String indexName, FSIndex index1) {
FSTreeModel treeModel = (FSTreeModel) this.fsTree.getModel();
@@ -1986,8 +2005,10 @@ public class MainFrame extends JFrame {
/**
* Gets the annotations at pos.
*
- * @param pos the pos
- * @param annots the annots
+ * @param pos
+ * the pos
+ * @param annots
+ * the annots
* @return the annotations at pos
*/
private ArrayList<FSNode> getAnnotationsAtPos(int pos, List<FSNode> annots) {
@@ -2009,10 +2030,14 @@ public class MainFrame extends JFrame {
/**
* Creates the type tree.
*
- * @param type the type
- * @param ts the ts
- * @param label the label
- * @param ir the ir
+ * @param type
+ * the type
+ * @param ts
+ * the ts
+ * @param label
+ * the label
+ * @param ir
+ * the ir
* @return the default mutable tree node
*/
private DefaultMutableTreeNode createTypeTree(org.apache.uima.cas.Type type, TypeSystem ts,
@@ -2021,7 +2046,7 @@ public class MainFrame extends JFrame {
TypeTreeNode typeNode = new TypeTreeNode(type, label, size);
DefaultMutableTreeNode node = new DefaultMutableTreeNode(typeNode);
// UIMA-2565 - Clash btw. cas.Type and Window.Type on JDK 7
- // also on method parameter "type"
+ // also on method parameter "type"
List<org.apache.uima.cas.Type> types = ts.getDirectSubtypes(type);
final int max = types.size();
for (int i = 0; i < max; i++) {
@@ -2037,7 +2062,8 @@ public class MainFrame extends JFrame {
/**
* Load program preferences.
*
- * @throws IOException Signals that an I/O exception has occurred.
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
private void loadProgramPreferences() throws IOException {
if (this.iniFile == null) {
@@ -2105,8 +2131,10 @@ public class MainFrame extends JFrame {
/**
* Sets the preferred size.
*
- * @param comp the comp
- * @param propPrefix the prop prefix
+ * @param comp
+ * the comp
+ * @param propPrefix
+ * the prop prefix
*/
public void setPreferredSize(JComponent comp, String propPrefix) {
// assert(comp != null);
@@ -2116,7 +2144,8 @@ public class MainFrame extends JFrame {
/**
* Gets the dimension.
*
- * @param propPrefix the prop prefix
+ * @param propPrefix
+ * the prop prefix
* @return the dimension
*/
public Dimension getDimension(String propPrefix) {
@@ -2145,7 +2174,8 @@ public class MainFrame extends JFrame {
/**
* String list to string.
*
- * @param list the list
+ * @param list
+ * the list
* @return the string
*/
private static final String stringListToString(List<String> list) {
@@ -2164,7 +2194,8 @@ public class MainFrame extends JFrame {
/**
* String to array list.
*
- * @param s the s
+ * @param s
+ * the s
* @return the list
*/
private static final List<String> stringToArrayList(String s) {
@@ -2181,7 +2212,8 @@ public class MainFrame extends JFrame {
/**
* Save program preferences.
*
- * @throws IOException Signals that an I/O exception has occurred.
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
public void saveProgramPreferences() throws IOException {
// File open dialog preferences.
@@ -2231,10 +2263,10 @@ public class MainFrame extends JFrame {
}
this.preferences.setProperty(langListPref, buf.toString());
}
- this.preferences.setProperty(textFileListPref, stringListToString(this.recentTextFiles
- .toStringList()));
- this.preferences.setProperty(descFileListPref, stringListToString(this.recentDescFiles
- .toStringList()));
+ this.preferences.setProperty(textFileListPref,
+ stringListToString(this.recentTextFiles.toStringList()));
+ this.preferences.setProperty(descFileListPref,
+ stringListToString(this.recentDescFiles.toStringList()));
// Write out preferences to file.
FileOutputStream out = new FileOutputStream(this.iniFile);
this.preferences.store(out, "Automatically generated preferences file for Annotation Viewer");
@@ -2243,8 +2275,10 @@ public class MainFrame extends JFrame {
/**
* Save color preferences.
*
- * @param file the file
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param file
+ * the file
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
public void saveColorPreferences(File file) throws IOException {
Properties prefs1 = new Properties();
@@ -2266,8 +2300,10 @@ public class MainFrame extends JFrame {
/**
* Load color preferences.
*
- * @param file the file
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param file
+ * the file
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
public void loadColorPreferences(File file) throws IOException {
Style parent = this.styleMap.get(CAS.TYPE_NAME_ANNOTATION);
@@ -2305,34 +2341,36 @@ public class MainFrame extends JFrame {
// Create a key map for focussing the index repository tree panel.
Action focusIRAction = new FocusIRAction(this);
String focusIRActionName = "focusIRAction";
- getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
- KeyStroke.getKeyStroke(KeyEvent.VK_I, InputEvent.CTRL_MASK), focusIRActionName);
+ getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW)
+ .put(KeyStroke.getKeyStroke(KeyEvent.VK_I, InputEvent.CTRL_MASK), focusIRActionName);
getRootPane().getActionMap().put(focusIRActionName, focusIRAction);
// Create a key map for focussing the FS tree panel.
Action focusFSAction = new FocusFSAction(this);
String focusFSActionName = "focusFSAction";
- getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
- KeyStroke.getKeyStroke(KeyEvent.VK_F, InputEvent.CTRL_MASK), focusFSActionName);
+ getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW)
+ .put(KeyStroke.getKeyStroke(KeyEvent.VK_F, InputEvent.CTRL_MASK), focusFSActionName);
getRootPane().getActionMap().put(focusFSActionName, focusFSAction);
// Create a key map for focussing the text area.
Action focusTextAction = new FocusTextAction(this);
String focusTextActionName = "focusTextAction";
- getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
- KeyStroke.getKeyStroke(KeyEvent.VK_T, InputEvent.CTRL_MASK), focusTextActionName);
+ getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW)
+ .put(KeyStroke.getKeyStroke(KeyEvent.VK_T, InputEvent.CTRL_MASK), focusTextActionName);
getRootPane().getActionMap().put(focusTextActionName, focusTextAction);
// Create a key map for bringing up the text area context menu.
Action textContextAction = new TextContextMenuAction(this);
String textContextActionName = "textContextAction";
this.textArea.getInputMap(JComponent.WHEN_FOCUSED).put(
- KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, InputEvent.ALT_MASK), textContextActionName);
+ KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, InputEvent.ALT_MASK), textContextActionName);
this.textArea.getActionMap().put(textContextActionName, textContextAction);
}
/**
* Show text popup.
*
- * @param x the x
- * @param y the y
+ * @param x
+ * the x
+ * @param y
+ * the y
*/
@SuppressWarnings("unchecked")
public void showTextPopup(int x, int y) {
@@ -2403,7 +2441,8 @@ public class MainFrame extends JFrame {
/**
* Sets the dirty.
*
- * @param isDirty the new dirty
+ * @param isDirty
+ * the new dirty
*/
public void setDirty(boolean isDirty) {
this.isDirty = isDirty;
@@ -2457,7 +2496,8 @@ public class MainFrame extends JFrame {
/**
* Sets the index label.
*
- * @param indexLabel the new index label
+ * @param indexLabel
+ * the new index label
*/
public void setIndexLabel(String indexLabel) {
this.indexLabel = indexLabel;
@@ -2475,7 +2515,8 @@ public class MainFrame extends JFrame {
/**
* Sets the annotation index.
*
- * @param isAnnotationIndex the new annotation index
+ * @param isAnnotationIndex
+ * the new annotation index
*/
public void setAnnotationIndex(boolean isAnnotationIndex) {
this.isAnnotationIndex = isAnnotationIndex;
@@ -2484,7 +2525,8 @@ public class MainFrame extends JFrame {
/**
* Sets the index.
*
- * @param index the new index
+ * @param index
+ * the new index
*/
public void setIndex(FSIndex index) {
this.index = index;
@@ -2493,7 +2535,8 @@ public class MainFrame extends JFrame {
/**
* Sets the all annotation viewer item enable.
*
- * @param enabled the new all annotation viewer item enable
+ * @param enabled
+ * the new all annotation viewer item enable
*/
public void setAllAnnotationViewerItemEnable(boolean enabled) {
this.allAnnotationViewerItem.setEnabled(enabled);
@@ -2511,7 +2554,8 @@ public class MainFrame extends JFrame {
/**
* Sets the file open dir.
*
- * @param fileOpenDir the new file open dir
+ * @param fileOpenDir
+ * the new file open dir
*/
public void setFileOpenDir(File fileOpenDir) {
this.fileOpenDir = fileOpenDir;
@@ -2529,7 +2573,8 @@ public class MainFrame extends JFrame {
/**
* Sets the text file.
*
- * @param textFile the new text file
+ * @param textFile
+ * the new text file
*/
public void setTextFile(File textFile) {
this.textFile = textFile;
@@ -2538,7 +2583,8 @@ public class MainFrame extends JFrame {
/**
* Sets the save text file enable.
*
- * @param enabled the new save text file enable
+ * @param enabled
+ * the new save text file enable
*/
public void setSaveTextFileEnable(boolean enabled) {
this.fileSaveItem.setEnabled(enabled);
@@ -2556,7 +2602,8 @@ public class MainFrame extends JFrame {
/**
* Sets the undo enabled.
*
- * @param enabled the new undo enabled
+ * @param enabled
+ * the new undo enabled
*/
public void setUndoEnabled(boolean enabled) {
this.undoItem.setEnabled(enabled);
@@ -2574,7 +2621,8 @@ public class MainFrame extends JFrame {
/**
* Sets the xcas file open dir.
*
- * @param xcasFileOpenDir the new xcas file open dir
+ * @param xcasFileOpenDir
+ * the new xcas file open dir
*/
public void setXcasFileOpenDir(File xcasFileOpenDir) {
this.xcasFileOpenDir = xcasFileOpenDir;
@@ -2583,7 +2631,8 @@ public class MainFrame extends JFrame {
/**
* Sets the cas.
*
- * @param cas the new cas
+ * @param cas
+ * the new cas
*/
public void setCas(CAS cas) {
this.cas = cas;
@@ -2611,7 +2660,8 @@ public class MainFrame extends JFrame {
/**
* Sets the rerun enabled.
*
- * @param enabled the new rerun enabled
+ * @param enabled
+ * the new rerun enabled
*/
public void setRerunEnabled(boolean enabled) {
this.reRunMenu.setEnabled(enabled);
@@ -2621,7 +2671,8 @@ public class MainFrame extends JFrame {
/**
* Sets the type system viewer enabled.
*
- * @param enabled the new type system viewer enabled
+ * @param enabled
+ * the new type system viewer enabled
*/
public void setTypeSystemViewerEnabled(boolean enabled) {
this.tsViewerItem.setEnabled(enabled);
@@ -2639,7 +2690,8 @@ public class MainFrame extends JFrame {
/**
* Sets the color settings dir.
*
- * @param colorSettingsDir the new color settings dir
+ * @param colorSettingsDir
+ * the new color settings dir
*/
public void setColorSettingsDir(File colorSettingsDir) {
this.colorSettingsDir = colorSettingsDir;
@@ -2657,7 +2709,8 @@ public class MainFrame extends JFrame {
/**
* Sets the color setting file.
*
- * @param colorSettingFile the new color setting file
+ * @param colorSettingFile
+ * the new color setting file
*/
public void setColorSettingFile(File colorSettingFile) {
this.colorSettingFile = colorSettingFile;
@@ -2675,7 +2728,8 @@ public class MainFrame extends JFrame {
/**
* Sets the annot open dir.
*
- * @param annotOpenDir the new annot open dir
+ * @param annotOpenDir
+ * the new annot open dir
*/
public void setAnnotOpenDir(File annotOpenDir) {
this.annotOpenDir = annotOpenDir;
@@ -2693,7 +2747,8 @@ public class MainFrame extends JFrame {
/**
* Sets the data path name.
*
- * @param dataPathName the new data path name
+ * @param dataPathName
+ * the new data path name
*/
public void setDataPathName(String dataPathName) {
this.dataPathName = dataPathName;
@@ -2711,7 +2766,8 @@ public class MainFrame extends JFrame {
/**
* Sets the code page.
*
- * @param codePage the new code page
+ * @param codePage
+ * the new code page
*/
public void setCodePage(String codePage) {
this.codePage = codePage;
@@ -2738,7 +2794,8 @@ public class MainFrame extends JFrame {
/**
* Sets the language.
*
- * @param language the new language
+ * @param language
+ * the new language
*/
public void setLanguage(String language) {
this.language = language;
@@ -2765,13 +2822,13 @@ public class MainFrame extends JFrame {
/**
* Sets the language prefs list.
*
- * @param languagePrefsList the new language prefs list
+ * @param languagePrefsList
+ * the new language prefs list
*/
public void setLanguagePrefsList(String languagePrefsList) {
this.languagePrefsList = languagePrefsList;
}
-
/**
* Handle sofas.
*/
@@ -2783,7 +2840,7 @@ public class MainFrame extends JFrame {
this.sofaSelectionComboBox.addItem(CAS.NAME_DEFAULT_SOFA);
Iterator<?> sofas = ((CASImpl) getCas()).getBaseCAS().getSofaIterator();
Feature sofaIdFeat = getCas().getTypeSystem()
- .getFeatureByFullName(CAS.FEATURE_FULL_NAME_SOFAID);
+ .getFeatureByFullName(CAS.FEATURE_FULL_NAME_SOFAID);
boolean nonDefaultSofaFound = false;
while (sofas.hasNext()) {
SofaFS sofa = (SofaFS) sofas.next();
@@ -2840,7 +2897,8 @@ public class MainFrame extends JFrame {
* window is being closed. Calling <code>setExitOnClose(false)</code> prevents that. It is then
* the caller's task to shut down the JVM.
*
- * @param exitOnClose the new exit on close
+ * @param exitOnClose
+ * the new exit on close
*/
public void setExitOnClose(boolean exitOnClose) {
this.exitOnClose = exitOnClose;
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MarkupExtent.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MarkupExtent.java
index cece6d2..c366350 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MarkupExtent.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MarkupExtent.java
@@ -19,7 +19,6 @@
package org.apache.uima.tools.cvd;
-
/**
* Represents an element in a list of markup extents. Knows about the length of the extent, as well
* as the depth of markup. Depth of markup means, how many annotations cover this extent?
@@ -37,13 +36,15 @@ public class MarkupExtent {
/** The markup depth. */
private int markupDepth;
-
/**
* Instantiates a new markup extent.
*
- * @param start the start
- * @param end the end
- * @param markupDepth the markup depth
+ * @param start
+ * the start
+ * @param end
+ * the end
+ * @param markupDepth
+ * the markup depth
*/
public MarkupExtent(int start, int end, int markupDepth) {
this.start = start;
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MultiAnnotViewerFrame.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MultiAnnotViewerFrame.java
index 7da3ee5..3052f0b 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MultiAnnotViewerFrame.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MultiAnnotViewerFrame.java
@@ -31,7 +31,6 @@ import javax.swing.text.Style;
import javax.swing.text.StyleConstants;
import javax.swing.text.StyleContext;
-
/**
* Class comment for MultiAnnotViewerFrame goes here.
*
@@ -45,7 +44,8 @@ public class MultiAnnotViewerFrame extends JFrame {
/**
* Instantiates a new multi annot viewer frame.
*
- * @throws java.awt.HeadlessException the java.awt. headless exception
+ * @throws java.awt.HeadlessException
+ * the java.awt. headless exception
*/
public MultiAnnotViewerFrame() {
// TODO Auto-generated constructor stub
@@ -54,7 +54,8 @@ public class MultiAnnotViewerFrame extends JFrame {
/**
* Instantiates a new multi annot viewer frame.
*
- * @param gc the gc
+ * @param gc
+ * the gc
*/
public MultiAnnotViewerFrame(GraphicsConfiguration gc) {
super(gc);
@@ -64,8 +65,10 @@ public class MultiAnnotViewerFrame extends JFrame {
/**
* Instantiates a new multi annot viewer frame.
*
- * @param title the title
- * @throws java.awt.HeadlessException the java.awt. headless exception
+ * @param title
+ * the title
+ * @throws java.awt.HeadlessException
+ * the java.awt. headless exception
*/
public MultiAnnotViewerFrame(String title) {
super(title);
@@ -75,8 +78,10 @@ public class MultiAnnotViewerFrame extends JFrame {
/**
* Instantiates a new multi annot viewer frame.
*
- * @param title the title
- * @param gc the gc
+ * @param title
+ * the title
+ * @param gc
+ * the gc
*/
public MultiAnnotViewerFrame(String title, GraphicsConfiguration gc) {
super(title, gc);
@@ -92,8 +97,10 @@ public class MultiAnnotViewerFrame extends JFrame {
/**
* Inits the.
*
- * @param text the text
- * @param extents the extents
+ * @param text
+ * the text
+ * @param extents
+ * the extents
*/
public void init(String text, MarkupExtent[] extents) {
this.textPane = new JTextPane();
@@ -138,9 +145,12 @@ public class MultiAnnotViewerFrame extends JFrame {
/**
* Inits the.
*
- * @param text the text
- * @param extents the extents
- * @param size the size
+ * @param text
+ * the text
+ * @param extents
+ * the extents
+ * @param size
+ * the size
*/
public void init(String text, AnnotationExtent[] extents, Dimension size) {
this.textPane = new JTextPane();
@@ -175,8 +185,10 @@ public class MultiAnnotViewerFrame extends JFrame {
/**
* Inits the html.
*
- * @param text the text
- * @param extents the extents
+ * @param text
+ * the text
+ * @param extents
+ * the extents
*/
public void initHtml(String text, MarkupExtent[] extents) {
this.textPane = new JTextPane();
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MultiMarkup.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MultiMarkup.java
index 1f5786d..e531ad9 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MultiMarkup.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/MultiMarkup.java
@@ -30,7 +30,6 @@ import org.apache.uima.cas.CAS;
import org.apache.uima.cas.FSIterator;
import org.apache.uima.cas.text.AnnotationFS;
-
/**
* TODO: add type comment for <code>MultiMarkup</code>.
*
@@ -55,9 +54,12 @@ public abstract class MultiMarkup {
/**
* Instantiates a new extent.
*
- * @param start the start
- * @param end the end
- * @param depth the depth
+ * @param start
+ * the start
+ * @param end
+ * the end
+ * @param depth
+ * the depth
*/
private Extent(int start, int end, int depth) {
this.start = start;
@@ -78,10 +80,14 @@ public abstract class MultiMarkup {
/**
* Instantiates a new annot extent.
*
- * @param start the start
- * @param end the end
- * @param depth the depth
- * @param annotName the annot name
+ * @param start
+ * the start
+ * @param end
+ * the end
+ * @param depth
+ * the depth
+ * @param annotName
+ * the annot name
*/
private AnnotExtent(int start, int end, int depth, String annotName) {
super(start, end, depth);
@@ -93,9 +99,12 @@ public abstract class MultiMarkup {
/**
* Creates the annotation markups.
*
- * @param it the it
- * @param textLen the text len
- * @param styleMap the style map
+ * @param it
+ * the it
+ * @param textLen
+ * the text len
+ * @param styleMap
+ * the style map
* @return the annotation extent[]
*/
public static AnnotationExtent[] createAnnotationMarkups(FSIterator it, int textLen,
@@ -199,8 +208,10 @@ public abstract class MultiMarkup {
/**
* Creates the markup extents.
*
- * @param it the it
- * @param textLen the text len
+ * @param it
+ * the it
+ * @param textLen
+ * the text len
* @return the markup extent[]
*/
public static MarkupExtent[] createMarkupExtents(FSIterator it, int textLen) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/RecentFilesList.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/RecentFilesList.java
index cac4ff9..bd82fc2 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/RecentFilesList.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/RecentFilesList.java
@@ -23,13 +23,12 @@ import java.io.File;
import java.util.ArrayList;
import java.util.List;
-
/**
* List of recently used files.
*
* <p>
* Provides functionality to keep a list of a certain max size. New files are added to the top. When
- * a file is added that is already in the list, it is shuffled to the top. When the maximum list
+ * a file is added that is already in the list, it is shuffled to the top. When the maximum list
* size has been reached, files start dropping off the end.
*/
public class RecentFilesList {
@@ -41,10 +40,12 @@ public class RecentFilesList {
/** The max. */
// The maximum size to which this list can grow
private final int max;
-
+
/**
* Constructor.
- * @param maxSize The maximum size to which the list can grow.
+ *
+ * @param maxSize
+ * The maximum size to which the list can grow.
*/
public RecentFilesList(int maxSize) {
this.list = new ArrayList<>();
@@ -53,6 +54,7 @@ public class RecentFilesList {
/**
* Get the internal list of files, in the proper order (most recent first).
+ *
* @return A recency-sorted list of files.
*/
public List<File> getFileList() {
@@ -61,7 +63,9 @@ public class RecentFilesList {
/**
* Append a file at the end of the list (useful for initialization).
- * @param file The file to be added.
+ *
+ * @param file
+ * The file to be added.
*/
public void appendFile(File file) {
if (this.list.size() < this.max) {
@@ -70,9 +74,11 @@ public class RecentFilesList {
}
/**
- * Add a file at the beginning. If maximum capacity is exceeded, drop last file. If
+ * Add a file at the beginning. If maximum capacity is exceeded, drop last file. If
* <code>file</code> is already in the list, move it to the front.
- * @param file The file to be added.
+ *
+ * @param file
+ * The file to be added.
*/
public void addFile(File file) {
// Check to see if list contains file already.
@@ -86,13 +92,13 @@ public class RecentFilesList {
// Set file to the beginning
this.list.set(0, file);
} else {
- // File is not contained in list. First, check if list is empty as shift code assumes
+ // File is not contained in list. First, check if list is empty as shift code assumes
// non-empty list.
if (this.list.isEmpty()) {
// To an empty list, we can just add the file.
this.list.add(file);
} else {
- // List is not empty. Shift list right by one, possibly dropping last file.
+ // List is not empty. Shift list right by one, possibly dropping last file.
shiftRight();
// Set file to beginning
this.list.set(0, file);
@@ -108,7 +114,7 @@ public class RecentFilesList {
// If max has not been reached, duplicate last file
this.list.add(this.list.get(this.list.size() - 1));
}
- // Last file has been taken care of (either duplicated or it will be dropped). Shift all
+ // Last file has been taken care of (either duplicated or it will be dropped). Shift all
// others to the right by one.
for (int i = this.list.size() - 2; i >= 0; i--) {
this.list.set(i + 1, this.list.get(i));
@@ -117,6 +123,7 @@ public class RecentFilesList {
/**
* Return the file list as a list of strings for persistence.
+ *
* @return The file list as a list of absolute file names.
*/
public List<String> toStringList() {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/StringFsPopupEventAdapter.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/StringFsPopupEventAdapter.java
index 1d9edd3..e927124 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/StringFsPopupEventAdapter.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/StringFsPopupEventAdapter.java
@@ -32,16 +32,15 @@ import javax.swing.JTextArea;
import javax.swing.JTree;
import javax.swing.tree.TreePath;
-
/**
- * Pop-up event adapter for string valued features in the FS display. Displays a pop-up for string
- * values that were shortened for display purposes. Users can display long strings in a separate
+ * Pop-up event adapter for string valued features in the FS display. Displays a pop-up for string
+ * values that were shortened for display purposes. Users can display long strings in a separate
* window.
*/
public class StringFsPopupEventAdapter extends MouseAdapter {
/**
- * ActionListener for the pop-up menu. Just shows text in a separate text window.
+ * ActionListener for the pop-up menu. Just shows text in a separate text window.
*/
private static class ShowStringHandler implements ActionListener {
@@ -51,13 +50,16 @@ public class StringFsPopupEventAdapter extends MouseAdapter {
/**
* Instantiates a new show string handler.
*
- * @param s the s
+ * @param s
+ * the s
*/
private ShowStringHandler(String s) {
this.string = s;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
@@ -80,7 +82,9 @@ public class StringFsPopupEventAdapter extends MouseAdapter {
public StringFsPopupEventAdapter() {
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseAdapter#mousePressed(java.awt.event.MouseEvent)
*/
@Override
@@ -88,7 +92,9 @@ public class StringFsPopupEventAdapter extends MouseAdapter {
showPopupMaybe(e);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseAdapter#mouseReleased(java.awt.event.MouseEvent)
*/
@Override
@@ -99,7 +105,8 @@ public class StringFsPopupEventAdapter extends MouseAdapter {
/**
* Show popup maybe.
*
- * @param e the e
+ * @param e
+ * the e
*/
private void showPopupMaybe(MouseEvent e) {
// Mouse event is pop-up trigger?
@@ -107,22 +114,22 @@ public class StringFsPopupEventAdapter extends MouseAdapter {
Object o = e.getSource();
// Event was triggered over the tree?
if (o instanceof javax.swing.JTree) {
- JTree tree = (JTree) o;
- TreePath path = tree.getPathForLocation(e.getX(), e.getY());
- // Get the node in the tree model where context click occurred.
- Object leafComponent = path.getLastPathComponent();
- if (leafComponent instanceof FSNode) {
- FSNode node = (FSNode) leafComponent;
- // FSNode is a string node and was shortened?
- if (node.getNodeClass() == FSNode.STRING_FS && node.isShortenedString()) {
- // Show pop-up
- JPopupMenu menu = new JPopupMenu();
- JMenuItem showStringItem = new JMenuItem("Show full string");
- showStringItem.addActionListener(new ShowStringHandler(node.getFullString()));
- menu.add(showStringItem);
- menu.show(e.getComponent(), e.getX(), e.getY());
- }
- }
+ JTree tree = (JTree) o;
+ TreePath path = tree.getPathForLocation(e.getX(), e.getY());
+ // Get the node in the tree model where context click occurred.
+ Object leafComponent = path.getLastPathComponent();
+ if (leafComponent instanceof FSNode) {
+ FSNode node = (FSNode) leafComponent;
+ // FSNode is a string node and was shortened?
+ if (node.getNodeClass() == FSNode.STRING_FS && node.isShortenedString()) {
+ // Show pop-up
+ JPopupMenu menu = new JPopupMenu();
+ JMenuItem showStringItem = new JMenuItem("Show full string");
+ showStringItem.addActionListener(new ShowStringHandler(node.getFullString()));
+ menu.add(showStringItem);
+ menu.show(e.getComponent(), e.getX(), e.getY());
+ }
+ }
}
}
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/TypeTreeNode.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/TypeTreeNode.java
index db03969..7415dfa 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/TypeTreeNode.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/TypeTreeNode.java
@@ -21,7 +21,6 @@ package org.apache.uima.tools.cvd;
import org.apache.uima.cas.Type;
-
/**
* Class comment for TypeTreeNode.java goes here.
*
@@ -50,9 +49,12 @@ public class TypeTreeNode {
/**
* Instantiates a new type tree node.
*
- * @param type the type
- * @param label the label
- * @param size the size
+ * @param type
+ * the type
+ * @param label
+ * the label
+ * @param size
+ * the size
*/
public TypeTreeNode(Type type, String label, int size) {
this.type = type;
@@ -60,7 +62,9 @@ public class TypeTreeNode {
this.size = size;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#toString()
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AboutHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AboutHandler.java
index ea78784..39c6f73 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AboutHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AboutHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -31,7 +30,6 @@ import org.apache.uima.impl.UimaVersion;
import org.apache.uima.tools.cvd.MainFrame;
import org.apache.uima.tools.images.Images;
-
/**
* The Class AboutHandler.
*/
@@ -43,13 +41,16 @@ public class AboutHandler implements ActionListener {
/**
* Instantiates a new about handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public AboutHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
@@ -64,15 +65,14 @@ public class AboutHandler implements ActionListener {
versionInfo = "Running Java " + javaVersion + " from " + javaVendor;
}
String msg = "CVD (CAS Visual Debugger)\n" + "Apache UIMA Version "
- + UIMAFramework.getVersionString()
- + " Copyright 2006, " + UimaVersion.getBuildYear() + " The Apache Software Foundation\n" + versionInfo + "\n";
+ + UIMAFramework.getVersionString() + " Copyright 2006, " + UimaVersion.getBuildYear()
+ + " The Apache Software Foundation\n" + versionInfo + "\n";
Icon icon = Images.getImageIcon(Images.UIMA_LOGO_SMALL);
if (icon == null) {
- JOptionPane.showMessageDialog(this.main, msg, "About CVD",
- JOptionPane.INFORMATION_MESSAGE);
+ JOptionPane.showMessageDialog(this.main, msg, "About CVD", JOptionPane.INFORMATION_MESSAGE);
} else {
- JOptionPane.showMessageDialog(this.main, msg, "About CVD",
- JOptionPane.INFORMATION_MESSAGE, icon);
+ JOptionPane.showMessageDialog(this.main, msg, "About CVD", JOptionPane.INFORMATION_MESSAGE,
+ icon);
}
}
}
\ No newline at end of file
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AboutUimaHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AboutUimaHandler.java
index f07c39d..2b4fee5 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AboutUimaHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AboutUimaHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -26,7 +25,6 @@ import java.awt.event.ActionListener;
import org.apache.uima.tools.cvd.MainFrame;
import org.apache.uima.tools.util.gui.AboutDialog;
-
/**
* The Class AboutUimaHandler.
*/
@@ -38,13 +36,16 @@ public class AboutUimaHandler implements ActionListener {
/**
* Instantiates a new about uima handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public AboutUimaHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AddLanguageHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AddLanguageHandler.java
index a29c801..84dc18b 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AddLanguageHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AddLanguageHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.JOptionPane;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class AddLanguageHandler.
*/
@@ -39,13 +37,16 @@ public class AddLanguageHandler implements ActionListener {
/**
* Instantiates a new adds the language handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public AddLanguageHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorOpenEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorOpenEventHandler.java
index 03fca0e..a252f18 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorOpenEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorOpenEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.JFileChooser;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class AnnotatorOpenEventHandler.
*/
@@ -39,7 +37,8 @@ public class AnnotatorOpenEventHandler implements ActionListener {
/**
* Instantiates a new annotator open event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public AnnotatorOpenEventHandler(MainFrame frame) {
this.main = frame;
@@ -48,7 +47,8 @@ public class AnnotatorOpenEventHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRerunEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRerunEventHandler.java
index 2034a70..d5f97b6 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRerunEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRerunEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -25,7 +24,6 @@ import java.awt.event.ActionListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class AnnotatorRerunEventHandler.
*/
@@ -37,7 +35,8 @@ public class AnnotatorRerunEventHandler implements ActionListener {
/**
* Instantiates a new annotator rerun event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public AnnotatorRerunEventHandler(MainFrame frame) {
this.main = frame;
@@ -46,7 +45,8 @@ public class AnnotatorRerunEventHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRunCPCEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRunCPCEventHandler.java
index cf0a400..b88c1c1 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRunCPCEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRunCPCEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -25,7 +24,6 @@ import java.awt.event.ActionListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class AnnotatorRunCPCEventHandler.
*/
@@ -37,7 +35,8 @@ public class AnnotatorRunCPCEventHandler implements ActionListener {
/**
* Instantiates a new annotator run CPC event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public AnnotatorRunCPCEventHandler(MainFrame frame) {
this.main = frame;
@@ -46,7 +45,8 @@ public class AnnotatorRunCPCEventHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRunOnCasEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRunOnCasEventHandler.java
index 5855c7a..01ccab3 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRunOnCasEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/AnnotatorRunOnCasEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -25,7 +24,6 @@ import java.awt.event.ActionListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class AnnotatorRunOnCasEventHandler.
*/
@@ -37,7 +35,8 @@ public class AnnotatorRunOnCasEventHandler implements ActionListener {
/**
* Instantiates a new annotator run on cas event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public AnnotatorRunOnCasEventHandler(MainFrame frame) {
this.main = frame;
@@ -46,7 +45,8 @@ public class AnnotatorRunOnCasEventHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CaretChangeHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CaretChangeHandler.java
index de7fce9..e04cace 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CaretChangeHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CaretChangeHandler.java
@@ -24,7 +24,6 @@ import javax.swing.event.CaretListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Caret change handler. Enable/disable cut/copy actions, depending on whether there's a non-empty
* text selection.
@@ -37,13 +36,16 @@ public class CaretChangeHandler implements CaretListener {
/**
* Instantiates a new caret change handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public CaretChangeHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.event.CaretListener#caretUpdate(javax.swing.event.CaretEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseAnnotationViewHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseAnnotationViewHandler.java
index 3f23b3c..a391126 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseAnnotationViewHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseAnnotationViewHandler.java
@@ -28,9 +28,8 @@ import javax.swing.JFrame;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
- * Window closing handler for annotation viewer. Remember window position on close.
+ * Window closing handler for annotation viewer. Remember window position on close.
*/
public class CloseAnnotationViewHandler extends WindowAdapter implements WindowListener {
@@ -40,13 +39,16 @@ public class CloseAnnotationViewHandler extends WindowAdapter implements WindowL
/**
* Instantiates a new close annotation view handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
CloseAnnotationViewHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.WindowAdapter#windowClosing(java.awt.event.WindowEvent)
*/
@Override
@@ -55,9 +57,9 @@ public class CloseAnnotationViewHandler extends WindowAdapter implements WindowL
final int x = tsContentPane.getWidth();
final int y = tsContentPane.getHeight();
this.main.getPreferences().setProperty(MainFrame.annotViewSizePref + MainFrame.widthSuffix,
- Integer.toString(x));
+ Integer.toString(x));
this.main.getPreferences().setProperty(MainFrame.annotViewSizePref + MainFrame.heightSuffix,
- Integer.toString(y));
+ Integer.toString(y));
}
}
\ No newline at end of file
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseLogViewHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseLogViewHandler.java
index 4b61cfc..956c1ad 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseLogViewHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseLogViewHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.WindowAdapter;
@@ -29,7 +28,6 @@ import javax.swing.JFrame;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class CloseLogViewHandler.
*/
@@ -41,13 +39,16 @@ public class CloseLogViewHandler extends WindowAdapter implements WindowListener
/**
* Instantiates a new close log view handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public CloseLogViewHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.WindowAdapter#windowClosing(java.awt.event.WindowEvent)
*/
@Override
@@ -55,8 +56,10 @@ public class CloseLogViewHandler extends WindowAdapter implements WindowListener
JComponent contentPane = (JComponent) ((JFrame) event.getComponent()).getContentPane();
final int x = contentPane.getWidth();
final int y = contentPane.getHeight();
- this.main.getPreferences().setProperty(MainFrame.logViewSizePref + MainFrame.widthSuffix, Integer.toString(x));
- this.main.getPreferences().setProperty(MainFrame.logViewSizePref + MainFrame.heightSuffix, Integer.toString(y));
+ this.main.getPreferences().setProperty(MainFrame.logViewSizePref + MainFrame.widthSuffix,
+ Integer.toString(x));
+ this.main.getPreferences().setProperty(MainFrame.logViewSizePref + MainFrame.heightSuffix,
+ Integer.toString(y));
}
}
\ No newline at end of file
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseTypeSystemHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseTypeSystemHandler.java
index 25229d6..e33a743 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseTypeSystemHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/CloseTypeSystemHandler.java
@@ -28,7 +28,6 @@ import javax.swing.JFrame;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class CloseTypeSystemHandler.
*/
@@ -40,13 +39,16 @@ public class CloseTypeSystemHandler extends WindowAdapter implements WindowListe
/**
* Instantiates a new close type system handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public CloseTypeSystemHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.WindowAdapter#windowClosing(java.awt.event.WindowEvent)
*/
@Override
@@ -55,9 +57,9 @@ public class CloseTypeSystemHandler extends WindowAdapter implements WindowListe
final int x = tsContentPane.getWidth();
final int y = tsContentPane.getHeight();
this.main.getPreferences().setProperty(MainFrame.tsWindowSizePref + MainFrame.widthSuffix,
- Integer.toString(x));
+ Integer.toString(x));
this.main.getPreferences().setProperty(MainFrame.tsWindowSizePref + MainFrame.heightSuffix,
- Integer.toString(y));
+ Integer.toString(y));
}
}
\ No newline at end of file
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ColorPrefsOpenHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ColorPrefsOpenHandler.java
index c39806e..e7c7dcc 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ColorPrefsOpenHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ColorPrefsOpenHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -29,7 +28,6 @@ import javax.swing.JFileChooser;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class ColorPrefsOpenHandler.
*/
@@ -41,7 +39,8 @@ public class ColorPrefsOpenHandler implements ActionListener {
/**
* Instantiates a new color prefs open handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public ColorPrefsOpenHandler(MainFrame frame) {
this.main = frame;
@@ -50,7 +49,8 @@ public class ColorPrefsOpenHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ColorPrefsSaveHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ColorPrefsSaveHandler.java
index 711fba1..eb0724b 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ColorPrefsSaveHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ColorPrefsSaveHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -29,7 +28,6 @@ import javax.swing.JFileChooser;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class ColorPrefsSaveHandler.
*/
@@ -41,7 +39,8 @@ public class ColorPrefsSaveHandler implements ActionListener {
/**
* Instantiates a new color prefs save handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public ColorPrefsSaveHandler(MainFrame frame) {
this.main = frame;
@@ -50,7 +49,8 @@ public class ColorPrefsSaveHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FSTreeSelectionListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FSTreeSelectionListener.java
index 0247f26..1964602 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FSTreeSelectionListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FSTreeSelectionListener.java
@@ -26,12 +26,11 @@ import org.apache.uima.tools.cvd.FSNode;
import org.apache.uima.tools.cvd.FSTreeNode;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Handle selection of annotations in annotation frame. If selected node represents an annotation,
* highlight the corresponding extent in the text.
*
-// * @see FSTreeSelectionEvent
+ * // * @see FSTreeSelectionEvent
*/
public class FSTreeSelectionListener implements TreeSelectionListener {
@@ -41,7 +40,8 @@ public class FSTreeSelectionListener implements TreeSelectionListener {
/**
* Instantiates a new FS tree selection listener.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public FSTreeSelectionListener(MainFrame frame) {
this.main = frame;
@@ -50,7 +50,8 @@ public class FSTreeSelectionListener implements TreeSelectionListener {
/**
* Value changed.
*
- * @param event the event
+ * @param event
+ * the event
* @see javax.swing.event.TreeSelectionListener#valueChanged(javax.swing.event.TreeSelectionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileOpenEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileOpenEventHandler.java
index fed4a6a..751fd44 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileOpenEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileOpenEventHandler.java
@@ -27,20 +27,19 @@ import javax.swing.JFileChooser;
import org.apache.uima.internal.util.Timer;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class FileOpenEventHandler.
*/
public class FileOpenEventHandler implements ActionListener {
-
/** The main. */
private final MainFrame main;
/**
* Instantiates a new file open event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public FileOpenEventHandler(MainFrame frame) {
this.main = frame;
@@ -49,7 +48,8 @@ public class FileOpenEventHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
@@ -75,7 +75,7 @@ public class FileOpenEventHandler implements ActionListener {
this.main.getUndoMgr().discardAllEdits();
this.main.setFileStatusMessage();
this.main.setStatusbarMessage("Done loading text file " + this.main.getTextFile().getName()
- + " in " + time.getTimeSpan() + ".");
+ + " in " + time.getTimeSpan() + ".");
}
}
}
\ No newline at end of file
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileSaveAsEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileSaveAsEventHandler.java
index acf8581..b6a73b0 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileSaveAsEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileSaveAsEventHandler.java
@@ -27,7 +27,6 @@ import javax.swing.JFileChooser;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class FileSaveAsEventHandler.
*/
@@ -39,7 +38,8 @@ public class FileSaveAsEventHandler implements ActionListener {
/**
* Instantiates a new file save as event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public FileSaveAsEventHandler(MainFrame frame) {
this.main = frame;
@@ -48,7 +48,8 @@ public class FileSaveAsEventHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
@@ -66,7 +67,7 @@ public class FileSaveAsEventHandler implements ActionListener {
File fileToSaveTo = fileChooser.getSelectedFile();
if (!this.main.confirmOverwrite(fileToSaveTo)) {
return;
- }
+ }
this.main.setTextFile(fileToSaveTo);
boolean fileSaved = this.main.saveFile();
if (fileSaved) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileSaveEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileSaveEventHandler.java
index 5465964..5c7dc0c 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileSaveEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FileSaveEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -25,7 +24,6 @@ import java.awt.event.ActionListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class FileSaveEventHandler.
*/
@@ -37,13 +35,16 @@ public class FileSaveEventHandler implements ActionListener {
/**
* Instantiates a new file save event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public FileSaveEventHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusFSAction.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusFSAction.java
index 727f8ec..5e867a0 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusFSAction.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusFSAction.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.Action;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Focus in annotation frame action handler.
*/
@@ -39,7 +37,8 @@ public class FocusFSAction extends AbstractAction implements Action {
/**
* Instantiates a new focus FS action.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public FocusFSAction(MainFrame frame) {
this.main = frame;
@@ -48,7 +47,9 @@ public class FocusFSAction extends AbstractAction implements Action {
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -8330075846211434833L;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusIRAction.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusIRAction.java
index ef09ca1..632a667 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusIRAction.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusIRAction.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.Action;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Action handler for focus in index repository frame.
*/
@@ -39,7 +37,8 @@ public class FocusIRAction extends AbstractAction implements Action {
/**
* Instantiates a new focus IR action.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public FocusIRAction(MainFrame frame) {
this.main = frame;
@@ -48,7 +47,9 @@ public class FocusIRAction extends AbstractAction implements Action {
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -8128067676842119411L;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusTextAction.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusTextAction.java
index 368b981..0378e7e 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusTextAction.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/FocusTextAction.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.Action;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Focus in text frame action handler.
*/
@@ -39,7 +37,8 @@ public class FocusTextAction extends AbstractAction implements Action {
/**
* Instantiates a new focus text action.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public FocusTextAction(MainFrame frame) {
this.main = frame;
@@ -48,7 +47,9 @@ public class FocusTextAction extends AbstractAction implements Action {
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -4867535661038776033L;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/HelpHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/HelpHandler.java
index 160f1ab..d583dfc 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/HelpHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/HelpHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.JOptionPane;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class HelpHandler.
*/
@@ -39,20 +37,23 @@ public class HelpHandler implements ActionListener {
/**
* Instantiates a new help handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public HelpHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
public void actionPerformed(ActionEvent event) {
String msg = "There is currently no online help."
- + "\nPlease find documentation on CVD and UIMA"
- + "\nin the doc directory of the UIMA installation";
+ + "\nPlease find documentation on CVD and UIMA"
+ + "\nin the doc directory of the UIMA installation";
JOptionPane.showMessageDialog(this.main, msg, "Help", JOptionPane.INFORMATION_MESSAGE);
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/IndexPopupListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/IndexPopupListener.java
index 462e4f5..2601fd4 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/IndexPopupListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/IndexPopupListener.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.MouseAdapter;
@@ -32,34 +31,32 @@ import org.apache.uima.tools.cvd.IndexTreeNode;
import org.apache.uima.tools.cvd.MainFrame;
import org.apache.uima.tools.cvd.TypeTreeNode;
-
/**
- * The listener interface for receiving indexPopup events.
- * The class that is interested in processing a indexPopup
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addIndexPopupListener</code> method. When
- * the indexPopup event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving indexPopup events. The class that is interested in
+ * processing a indexPopup event implements this interface, and the object created with that class
+ * is registered with a component using the component's <code>addIndexPopupListener</code> method.
+ * When the indexPopup event occurs, that object's appropriate method is invoked.
*
-// * @see IndexPopupEvent
+ * // * @see IndexPopupEvent
*/
public class IndexPopupListener extends MouseAdapter {
-
/** The main. */
private final MainFrame main;
/**
* Instantiates a new index popup listener.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public IndexPopupListener(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseAdapter#mousePressed(java.awt.event.MouseEvent)
*/
@Override
@@ -67,7 +64,9 @@ public class IndexPopupListener extends MouseAdapter {
maybeShowPopup(e);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseAdapter#mouseReleased(java.awt.event.MouseEvent)
*/
@Override
@@ -78,12 +77,13 @@ public class IndexPopupListener extends MouseAdapter {
/**
* Maybe show popup.
*
- * @param e the e
+ * @param e
+ * the e
*/
private void maybeShowPopup(MouseEvent e) {
if (e.isPopupTrigger()) {
DefaultMutableTreeNode node = (DefaultMutableTreeNode) this.main.getIndexTree()
- .getLastSelectedPathComponent();
+ .getLastSelectedPathComponent();
if (node == null) {
return;
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/IndexTreeSelectionListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/IndexTreeSelectionListener.java
index 694488d..4db02bb 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/IndexTreeSelectionListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/IndexTreeSelectionListener.java
@@ -30,11 +30,10 @@ import org.apache.uima.tools.cvd.IndexTreeNode;
import org.apache.uima.tools.cvd.MainFrame;
import org.apache.uima.tools.cvd.TypeTreeNode;
-
/**
* Change the display of the FSTree if a type in an index is selected.
*
-// * @see IndexTreeSelectionEvent
+ * // * @see IndexTreeSelectionEvent
*/
public class IndexTreeSelectionListener implements TreeSelectionListener {
@@ -44,7 +43,8 @@ public class IndexTreeSelectionListener implements TreeSelectionListener {
/**
* Instantiates a new index tree selection listener.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public IndexTreeSelectionListener(MainFrame frame) {
this.main = frame;
@@ -53,14 +53,15 @@ public class IndexTreeSelectionListener implements TreeSelectionListener {
/**
* Value changed.
*
- * @param arg0 the arg 0
+ * @param arg0
+ * the arg 0
* @see javax.swing.event.TreeSelectionListener#valueChanged(javax.swing.event.TreeSelectionEvent)
*/
@Override
public void valueChanged(TreeSelectionEvent arg0) {
// System.out.println("Tree selection value changed");
DefaultMutableTreeNode node = (DefaultMutableTreeNode) this.main.getIndexTree()
- .getLastSelectedPathComponent();
+ .getLastSelectedPathComponent();
if (node == null) {
return;
}
@@ -82,8 +83,8 @@ public class IndexTreeSelectionListener implements TreeSelectionListener {
this.main.setAnnotationIndex(label.equals(CAS.STD_ANNOTATION_INDEX));
this.main.setIndex(this.main.getCas().getIndexRepository().getIndex(label, type));
this.main.updateFSTree(label, this.main.getIndex());
- this.main.setAllAnnotationViewerItemEnable(((CASImpl) this.main.getCas())
- .isAnnotationType(type));
+ this.main.setAllAnnotationViewerItemEnable(
+ ((CASImpl) this.main.getCas()).isAnnotationType(type));
this.main.getTextArea().getCaret().setVisible(true);
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/LoadRecentDescFileEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/LoadRecentDescFileEventHandler.java
index 3dcfa86..23c8332 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/LoadRecentDescFileEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/LoadRecentDescFileEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -26,7 +25,6 @@ import java.io.File;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class LoadRecentDescFileEventHandler.
*/
@@ -34,22 +32,26 @@ public class LoadRecentDescFileEventHandler implements ActionListener {
/** The main. */
private final MainFrame main;
-
+
/** The file name. */
private final String fileName;
/**
* Instantiates a new load recent desc file event handler.
*
- * @param frame the frame
- * @param fileName the file name
+ * @param frame
+ * the frame
+ * @param fileName
+ * the file name
*/
public LoadRecentDescFileEventHandler(MainFrame frame, String fileName) {
this.main = frame;
this.fileName = fileName;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/LoadRecentTextFileEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/LoadRecentTextFileEventHandler.java
index 3f7a8f9..312def6 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/LoadRecentTextFileEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/LoadRecentTextFileEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -26,7 +25,6 @@ import java.io.File;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class LoadRecentTextFileEventHandler.
*/
@@ -34,22 +32,26 @@ public class LoadRecentTextFileEventHandler implements ActionListener {
/** The main. */
private final MainFrame main;
-
+
/** The file name. */
private final String fileName;
/**
* Instantiates a new load recent text file event handler.
*
- * @param frame the frame
- * @param fileName the file name
+ * @param frame
+ * the frame
+ * @param fileName
+ * the file name
*/
public LoadRecentTextFileEventHandler(MainFrame frame, String fileName) {
this.main = frame;
this.fileName = fileName;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/MainFrameClosing.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/MainFrameClosing.java
index ec5f3c1..7bf18b6 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/MainFrameClosing.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/MainFrameClosing.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.WindowAdapter;
@@ -26,7 +25,6 @@ import java.io.IOException;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Save preferences on closing CVD.
*/
@@ -38,13 +36,16 @@ public class MainFrameClosing extends WindowAdapter {
/**
* Instantiates a new main frame closing.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public MainFrameClosing(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.WindowAdapter#windowClosing(java.awt.event.WindowEvent)
*/
@Override
@@ -55,7 +56,8 @@ public class MainFrameClosing extends WindowAdapter {
/**
* Handle closing event.
*
- * @param main the main
+ * @param main
+ * the main
*/
public static void handleClosingEvent(MainFrame main) {
try {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ManualHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ManualHandler.java
index 49b63f5..d712c66 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ManualHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ManualHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.Dimension;
@@ -38,11 +37,10 @@ import javax.swing.text.html.HTMLFrameHyperlinkEvent;
import org.apache.uima.tools.cvd.CVD;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
- * Show the CVD manual in a Swing html widget. Unfortunately, the html we currently produce from
- * our docbook source is too advanced for the the simple html widget, and is virtually unreadable.
- * That makes this option relatively useless atm (it's better the more recent the Java version).
+ * Show the CVD manual in a Swing html widget. Unfortunately, the html we currently produce from our
+ * docbook source is too advanced for the the simple html widget, and is virtually unreadable. That
+ * makes this option relatively useless atm (it's better the more recent the Java version).
*/
public class ManualHandler implements ActionListener {
@@ -52,7 +50,8 @@ public class ManualHandler implements ActionListener {
/**
* Instantiates a new manual handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public ManualHandler(MainFrame frame) {
this.main = frame;
@@ -63,7 +62,9 @@ public class ManualHandler implements ActionListener {
*/
private class Hyperactive implements HyperlinkListener {
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.event.HyperlinkListener#hyperlinkUpdate(javax.swing.event.HyperlinkEvent)
*/
@Override
@@ -85,7 +86,9 @@ public class ManualHandler implements ActionListener {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
@@ -110,16 +113,16 @@ public class ManualHandler implements ActionListener {
msg += String.format("\n Directory doesn't exist");
}
JOptionPane.showMessageDialog(this.main, msg, "Error loading manual",
- JOptionPane.ERROR_MESSAGE);
+ JOptionPane.ERROR_MESSAGE);
return;
}
}
}
if (manURL == null) {
String msg = "Can't find manual. The manual is loaded via the classpath,\n"
- + "so make sure the manual folder is in the classpath.";
+ + "so make sure the manual folder is in the classpath.";
JOptionPane.showMessageDialog(this.main, msg, "Error loading manual",
- JOptionPane.ERROR_MESSAGE);
+ JOptionPane.ERROR_MESSAGE);
return;
}
editorPane.setPage(manURL);
@@ -130,7 +133,7 @@ public class ManualHandler implements ActionListener {
manFrame.setVisible(true);
URL cvdLinkUrl = new URL(manURL.toString() + "#ugr.tools.cvd");
HyperlinkEvent e = new HyperlinkEvent(editorPane, HyperlinkEvent.EventType.ACTIVATED,
- cvdLinkUrl);
+ cvdLinkUrl);
editorPane.fireHyperlinkUpdate(e);
} catch (Exception e) {
this.main.handleException(e);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/NewTextEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/NewTextEventHandler.java
index 3f50a37..bab5fed 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/NewTextEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/NewTextEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -25,7 +24,6 @@ import java.awt.event.ActionListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Clear text area.
*/
@@ -37,13 +35,16 @@ public class NewTextEventHandler implements ActionListener {
/**
* Instantiates a new new text event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public NewTextEventHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/PopupHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/PopupHandler.java
index b0ad389..d4f0bf0 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/PopupHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/PopupHandler.java
@@ -27,9 +27,8 @@ import javax.swing.tree.TreePath;
import org.apache.uima.tools.cvd.FSTreeModel;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
- * Action handler for text pop-up menu items. Select chosen annotation in FS tree, make visible.
+ * Action handler for text pop-up menu items. Select chosen annotation in FS tree, make visible.
*/
public class PopupHandler implements ActionListener {
@@ -42,15 +41,19 @@ public class PopupHandler implements ActionListener {
/**
* Instantiates a new popup handler.
*
- * @param frame the frame
- * @param n the n
+ * @param frame
+ * the frame
+ * @param n
+ * the n
*/
public PopupHandler(MainFrame frame, int n) {
this.main = frame;
this.node = n;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/PopupListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/PopupListener.java
index 8034867..9772323 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/PopupListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/PopupListener.java
@@ -24,12 +24,11 @@ import java.awt.event.MouseEvent;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Handle text pop-up (mouse) events. The actual logic for creating the text pop-up menu is not
* here.
*
-// * @see PopupEvent
+ * // * @see PopupEvent
*/
public class PopupListener extends MouseAdapter {
@@ -39,13 +38,16 @@ public class PopupListener extends MouseAdapter {
/**
* Instantiates a new popup listener.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public PopupListener(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseAdapter#mousePressed(java.awt.event.MouseEvent)
*/
@Override
@@ -53,7 +55,9 @@ public class PopupListener extends MouseAdapter {
maybeShowPopup(e);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseAdapter#mouseReleased(java.awt.event.MouseEvent)
*/
@Override
@@ -64,7 +68,8 @@ public class PopupListener extends MouseAdapter {
/**
* Maybe show popup.
*
- * @param e the e
+ * @param e
+ * the e
*/
private void maybeShowPopup(MouseEvent e) {
if (e.isPopupTrigger()) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/RemoveLanguageHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/RemoveLanguageHandler.java
index 0ee3ab8..6534856 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/RemoveLanguageHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/RemoveLanguageHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.JMenuItem;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class RemoveLanguageHandler.
*/
@@ -39,13 +37,16 @@ public class RemoveLanguageHandler implements ActionListener {
/**
* Instantiates a new removes the language handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public RemoveLanguageHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/RestoreLangDefaultsHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/RestoreLangDefaultsHandler.java
index f4f799d..166894e 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/RestoreLangDefaultsHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/RestoreLangDefaultsHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -25,7 +24,6 @@ import java.awt.event.ActionListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class RestoreLangDefaultsHandler.
*/
@@ -37,13 +35,16 @@ public class RestoreLangDefaultsHandler implements ActionListener {
/**
* Instantiates a new restore lang defaults handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public RestoreLangDefaultsHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetCodePageHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetCodePageHandler.java
index f835900..d8a116f 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetCodePageHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetCodePageHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.JRadioButtonMenuItem;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class SetCodePageHandler.
*/
@@ -39,13 +37,16 @@ public class SetCodePageHandler implements ActionListener {
/**
* Instantiates a new sets the code page handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public SetCodePageHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetDataPathHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetDataPathHandler.java
index d49955c..c80f038 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetDataPathHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetDataPathHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.JOptionPane;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class SetDataPathHandler.
*/
@@ -39,19 +37,22 @@ public class SetDataPathHandler implements ActionListener {
/**
* Instantiates a new sets the data path handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public SetDataPathHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
public void actionPerformed(ActionEvent arg0) {
String result = (String) JOptionPane.showInputDialog(this.main, "Specify the data path",
- "Set data path", JOptionPane.PLAIN_MESSAGE, null, null, this.main.getDataPathName());
+ "Set data path", JOptionPane.PLAIN_MESSAGE, null, null, this.main.getDataPathName());
if (result != null) {
this.main.setDataPath(result);
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetLanguageHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetLanguageHandler.java
index 97bcc3a..c404464 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetLanguageHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetLanguageHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -27,7 +26,6 @@ import javax.swing.JRadioButtonMenuItem;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class SetLanguageHandler.
*/
@@ -39,13 +37,16 @@ public class SetLanguageHandler implements ActionListener {
/**
* Instantiates a new sets the language handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public SetLanguageHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetLogConfigHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetLogConfigHandler.java
index 87877cf..ebde40a 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetLogConfigHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SetLogConfigHandler.java
@@ -28,7 +28,6 @@ import org.apache.uima.UIMAFramework;
import org.apache.uima.tools.cvd.MainFrame;
import org.apache.uima.util.Level;
-
/**
* The Class SetLogConfigHandler.
*/
@@ -40,7 +39,9 @@ public class SetLogConfigHandler implements ActionListener {
public SetLogConfigHandler() {
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowAnnotatedTextHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowAnnotatedTextHandler.java
index 66a9f26..f8daa34 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowAnnotatedTextHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowAnnotatedTextHandler.java
@@ -28,7 +28,6 @@ import org.apache.uima.tools.cvd.MainFrame;
import org.apache.uima.tools.cvd.MultiAnnotViewerFrame;
import org.apache.uima.tools.cvd.MultiMarkup;
-
/**
* Show the multi-annotation text window. Is anybody even using this? This is handled much better in
* the DocumentAnalyzer.
@@ -41,13 +40,16 @@ public class ShowAnnotatedTextHandler implements ActionListener {
/**
* Instantiates a new show annotated text handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public ShowAnnotatedTextHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
@@ -58,8 +60,8 @@ public class ShowAnnotatedTextHandler implements ActionListener {
FSIterator it = this.main.getIndex().iterator();
final String text = this.main.getCas().getDocumentText();
System.out.println("Creating extents.");
- AnnotationExtent[] extents = MultiMarkup.createAnnotationMarkups(it, text.length(), this.main
- .getStyleMap());
+ AnnotationExtent[] extents = MultiMarkup.createAnnotationMarkups(it, text.length(),
+ this.main.getStyleMap());
System.out.println("Initializing text frame.");
f.init(text, extents, this.main.getDimension(MainFrame.annotViewSizePref));
System.out.println("Done.");
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowAnnotationCustomizerHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowAnnotationCustomizerHandler.java
index bcc9d4a..1841902 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowAnnotationCustomizerHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowAnnotationCustomizerHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -26,7 +25,6 @@ import java.awt.event.ActionListener;
import org.apache.uima.tools.cvd.AnnotationDisplayCustomizationFrame;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class ShowAnnotationCustomizerHandler.
*/
@@ -38,19 +36,22 @@ public class ShowAnnotationCustomizerHandler implements ActionListener {
/**
* Instantiates a new show annotation customizer handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public ShowAnnotationCustomizerHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
public void actionPerformed(ActionEvent event) {
AnnotationDisplayCustomizationFrame acd = new AnnotationDisplayCustomizationFrame(
- "Customize Annotation Display");
+ "Customize Annotation Display");
acd.init(this.main.getStyleMap(), this.main.getCas());
acd.pack();
acd.setVisible(true);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowTypesystemHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowTypesystemHandler.java
index c95eeb6..0539067 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowTypesystemHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/ShowTypesystemHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -28,20 +27,19 @@ import javax.swing.WindowConstants;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class ShowTypesystemHandler.
*/
public class ShowTypesystemHandler implements ActionListener {
-
/** The main. */
private final MainFrame main;
/**
* Instantiates a new show typesystem handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public ShowTypesystemHandler(MainFrame frame) {
this.main = frame;
@@ -50,7 +48,8 @@ public class ShowTypesystemHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SofaSelectionListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SofaSelectionListener.java
index b0c0350..180a7cc 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SofaSelectionListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SofaSelectionListener.java
@@ -24,17 +24,13 @@ import java.awt.event.ItemListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
- * The listener interface for receiving sofaSelection events.
- * The class that is interested in processing a sofaSelection
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addSofaSelectionListener</code> method. When
- * the sofaSelection event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving sofaSelection events. The class that is interested in
+ * processing a sofaSelection event implements this interface, and the object created with that
+ * class is registered with a component using the component's <code>addSofaSelectionListener</code>
+ * method. When the sofaSelection event occurs, that object's appropriate method is invoked.
*
-// * @see SofaSelectionEvent
+ * // * @see SofaSelectionEvent
*/
public class SofaSelectionListener implements ItemListener {
@@ -44,13 +40,16 @@ public class SofaSelectionListener implements ItemListener {
/**
* Instantiates a new sofa selection listener.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public SofaSelectionListener(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SystemExitHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SystemExitHandler.java
index 129f58a..eb55d1d 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SystemExitHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/SystemExitHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -25,7 +24,6 @@ import java.awt.event.ActionListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class SystemExitHandler.
*/
@@ -37,13 +35,16 @@ public class SystemExitHandler implements ActionListener {
/**
* Instantiates a new system exit handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public SystemExitHandler(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextChangedListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextChangedListener.java
index 12e567c..169d189 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextChangedListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextChangedListener.java
@@ -24,13 +24,12 @@ import javax.swing.event.DocumentListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Listener for changes in text frame. When the text is changed, the CAS is removed as the text from
* the CAS does no longer correspond to the text that is displayed in the frame, hence annotation
* offsets are no longer correct.
*
-// * @see TextChangedEvent
+ * // * @see TextChangedEvent
*/
public class TextChangedListener implements DocumentListener {
@@ -40,13 +39,16 @@ public class TextChangedListener implements DocumentListener {
/**
* Instantiates a new text changed listener.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public TextChangedListener(MainFrame frame) {
this.main = frame;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.event.DocumentListener#changedUpdate(javax.swing.event.DocumentEvent)
*/
@Override
@@ -54,7 +56,9 @@ public class TextChangedListener implements DocumentListener {
// Do nothing.
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.event.DocumentListener#insertUpdate(javax.swing.event.DocumentEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextContextMenuAction.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextContextMenuAction.java
index 9b59eaf..f4ad2da 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextContextMenuAction.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextContextMenuAction.java
@@ -26,7 +26,6 @@ import javax.swing.AbstractAction;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Text pop-up action (for keyboard accessibility).
*/
@@ -38,7 +37,8 @@ public class TextContextMenuAction extends AbstractAction {
/**
* Instantiates a new text context menu action.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public TextContextMenuAction(MainFrame frame) {
this.main = frame;
@@ -47,7 +47,9 @@ public class TextContextMenuAction extends AbstractAction {
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -5518456467913617514L;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextFocusHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextFocusHandler.java
index 4000b11..1e8ac73 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextFocusHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TextFocusHandler.java
@@ -24,7 +24,6 @@ import java.awt.event.FocusListener;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* The Class TextFocusHandler.
*/
@@ -36,7 +35,8 @@ public class TextFocusHandler implements FocusListener {
/**
* Instantiates a new text focus handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public TextFocusHandler(MainFrame frame) {
this.main = frame;
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TreeFocusHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TreeFocusHandler.java
index fa147b9..e958f7f 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TreeFocusHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TreeFocusHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.FocusEvent;
@@ -26,7 +25,6 @@ import java.awt.event.FocusListener;
import javax.swing.JTree;
import javax.swing.tree.TreePath;
-
/**
* The Class TreeFocusHandler.
*/
@@ -38,13 +36,16 @@ public class TreeFocusHandler implements FocusListener {
/**
* Instantiates a new tree focus handler.
*
- * @param tree the tree
+ * @param tree
+ * the tree
*/
public TreeFocusHandler(JTree tree) {
this.tree = tree;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.FocusListener#focusGained(java.awt.event.FocusEvent)
*/
@Override
@@ -56,7 +57,9 @@ public class TreeFocusHandler implements FocusListener {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.FocusListener#focusLost(java.awt.event.FocusEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TypeSystemFileOpenEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TypeSystemFileOpenEventHandler.java
index 86abeb7..1c91e10 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TypeSystemFileOpenEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/TypeSystemFileOpenEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -34,9 +33,8 @@ import org.apache.uima.tools.cvd.MainFrame;
import org.apache.uima.util.CasCreationUtils;
import org.apache.uima.util.XMLInputSource;
-
/**
- * Load a type system file. Need to load type system before one can load XCAS.
+ * Load a type system file. Need to load type system before one can load XCAS.
*/
public class TypeSystemFileOpenEventHandler implements ActionListener {
@@ -46,7 +44,8 @@ public class TypeSystemFileOpenEventHandler implements ActionListener {
/**
* Instantiates a new type system file open event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public TypeSystemFileOpenEventHandler(MainFrame frame) {
this.main = frame;
@@ -55,7 +54,8 @@ public class TypeSystemFileOpenEventHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
@@ -79,8 +79,7 @@ public class TypeSystemFileOpenEventHandler implements ActionListener {
TypeSystemDescription tsDesc = (TypeSystemDescription) descriptor;
tsDesc.resolveImports();
this.main.destroyAe();
- this.main.setCas(CasCreationUtils
- .createCas(tsDesc, null, new FsIndexDescription[0]));
+ this.main.setCas(CasCreationUtils.createCas(tsDesc, null, new FsIndexDescription[0]));
this.main.setRunOnCasEnabled();
this.main.setRerunEnabled(false);
this.main.getTextArea().setText("");
@@ -88,7 +87,8 @@ public class TypeSystemFileOpenEventHandler implements ActionListener {
this.main.setTypeSystemViewerEnabled(true);
this.main.setEnableCasFileReadingAndWriting();
time.stop();
- this.main.setStatusbarMessage("Done loading type system file in " + time.getTimeSpan() + ".");
+ this.main.setStatusbarMessage(
+ "Done loading type system file in " + time.getTimeSpan() + ".");
} catch (Exception e) {
e.printStackTrace();
this.main.handleException(e);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/UndoMgr.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/UndoMgr.java
index fbfa097..4c815bb 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/UndoMgr.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/UndoMgr.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -28,7 +27,6 @@ import javax.swing.undo.UndoableEdit;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Undo manager for text area.
*/
@@ -40,7 +38,8 @@ public class UndoMgr extends UndoManager implements ActionListener {
/**
* Instantiates a new undo mgr.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public UndoMgr(MainFrame frame) {
this.main = frame;
@@ -49,7 +48,9 @@ public class UndoMgr extends UndoManager implements ActionListener {
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 7677701629555379146L;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
@@ -60,7 +61,9 @@ public class UndoMgr extends UndoManager implements ActionListener {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.undo.UndoManager#addEdit(javax.swing.undo.UndoableEdit)
*/
@Override
@@ -69,7 +72,9 @@ public class UndoMgr extends UndoManager implements ActionListener {
return super.addEdit(arg0);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.undo.UndoManager#discardAllEdits()
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASFileOpenEventHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASFileOpenEventHandler.java
index f69daba..8d6bc3c 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASFileOpenEventHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASFileOpenEventHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -33,7 +32,6 @@ import org.apache.uima.internal.util.Timer;
import org.apache.uima.internal.util.XMLUtils;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Load an XCAS file.
*/
@@ -45,7 +43,8 @@ public class XCASFileOpenEventHandler implements ActionListener {
/**
* Instantiates a new XCAS file open event handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public XCASFileOpenEventHandler(MainFrame frame) {
this.main = frame;
@@ -54,7 +53,8 @@ public class XCASFileOpenEventHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
@@ -74,8 +74,8 @@ public class XCASFileOpenEventHandler implements ActionListener {
time.start();
SAXParserFactory saxParserFactory = XMLUtils.createSAXParserFactory();
SAXParser parser = saxParserFactory.newSAXParser();
- XCASDeserializer xcasDeserializer = new XCASDeserializer(this.main.getCas()
- .getTypeSystem());
+ XCASDeserializer xcasDeserializer = new XCASDeserializer(
+ this.main.getCas().getTypeSystem());
this.main.getCas().reset();
parser.parse(xcasFile, xcasDeserializer.getXCASHandler(this.main.getCas()));
time.stop();
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASSaveHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASSaveHandler.java
index fa94b6f..be8b7b6 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASSaveHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASSaveHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -35,7 +34,6 @@ import org.apache.uima.tools.cvd.MainFrame;
import org.apache.uima.util.XMLSerializer;
import org.xml.sax.SAXException;
-
/**
* The Class XCASSaveHandler.
*/
@@ -47,7 +45,8 @@ public class XCASSaveHandler implements ActionListener {
/**
* Instantiates a new XCAS save handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public XCASSaveHandler(MainFrame frame) {
this.main = frame;
@@ -56,7 +55,8 @@ public class XCASSaveHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASSaveTSHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASSaveTSHandler.java
index 2b5210a..0fc0e2e 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASSaveTSHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XCASSaveTSHandler.java
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.uima.tools.cvd.control;
import java.awt.event.ActionEvent;
@@ -34,7 +33,6 @@ import org.apache.uima.cas.impl.TypeSystem2Xml;
import org.apache.uima.tools.cvd.MainFrame;
import org.xml.sax.SAXException;
-
/**
* The Class XCASSaveTSHandler.
*/
@@ -46,7 +44,8 @@ public class XCASSaveTSHandler implements ActionListener {
/**
* Instantiates a new XCAS save TS handler.
*
- * @param frame the frame
+ * @param frame
+ * the frame
*/
public XCASSaveTSHandler(MainFrame frame) {
this.main = frame;
@@ -55,7 +54,8 @@ public class XCASSaveTSHandler implements ActionListener {
/**
* Action performed.
*
- * @param event the event
+ * @param event
+ * the event
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XmiCasFileOpenHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XmiCasFileOpenHandler.java
index f73a98e..70e2325 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XmiCasFileOpenHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XmiCasFileOpenHandler.java
@@ -27,12 +27,11 @@ import javax.swing.JFileChooser;
import org.apache.uima.tools.cvd.MainFrame;
-
/**
* Load a CAS from an XMI file.
*/
public class XmiCasFileOpenHandler implements ActionListener {
-
+
/** The main. */
final MainFrame main;
@@ -48,13 +47,16 @@ public class XmiCasFileOpenHandler implements ActionListener {
/**
* Instantiates a new xmi cas file open handler.
*
- * @param main the main
+ * @param main
+ * the main
*/
public XmiCasFileOpenHandler(MainFrame main) {
this.main = main;
}
-
- /* (non-Javadoc)
+
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XmiCasSaveHandler.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XmiCasSaveHandler.java
index 60fe1bf..c872d78 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XmiCasSaveHandler.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/control/XmiCasSaveHandler.java
@@ -34,7 +34,6 @@ import org.apache.uima.tools.cvd.MainFrame;
import org.apache.uima.util.XMLSerializer;
import org.xml.sax.SAXException;
-
/**
* Save CAS to disk as XMI.
*/
@@ -42,7 +41,7 @@ public class XmiCasSaveHandler implements ActionListener {
/** The main. */
private final MainFrame main;
-
+
/**
* Instantiates a new xmi cas save handler.
*/
@@ -51,17 +50,20 @@ public class XmiCasSaveHandler implements ActionListener {
private XmiCasSaveHandler() {
this.main = null;
}
-
+
/**
* Instantiates a new xmi cas save handler.
*
- * @param main the main
+ * @param main
+ * the main
*/
public XmiCasSaveHandler(MainFrame main) {
this.main = main;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
@@ -81,7 +83,8 @@ public class XmiCasSaveHandler implements ActionListener {
try {
OutputStream outStream = new BufferedOutputStream(new FileOutputStream(xmiCasFile));
XMLSerializer xmlSerializer = new XMLSerializer(outStream);
- XmiCasSerializer xmiCasSerializer = new XmiCasSerializer(this.main.getCas().getTypeSystem());
+ XmiCasSerializer xmiCasSerializer = new XmiCasSerializer(
+ this.main.getCas().getTypeSystem());
xmiCasSerializer.serialize(this.main.getCas(), xmlSerializer.getContentHandler());
outStream.close();
} catch (IOException e) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/tsview/FeatureTableModel.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/tsview/FeatureTableModel.java
index 4b9be8f..44c6b89 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/tsview/FeatureTableModel.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/tsview/FeatureTableModel.java
@@ -49,7 +49,8 @@ public class FeatureTableModel extends AbstractTableModel {
/**
* Constructor for FeatureTableModel.
*
- * @param type the type
+ * @param type
+ * the type
*/
public FeatureTableModel(Type type) {
this.type = type;
@@ -58,14 +59,17 @@ public class FeatureTableModel extends AbstractTableModel {
/**
* Sets the type.
*
- * @param type the new type
+ * @param type
+ * the new type
*/
public void setType(Type type) {
this.type = type;
fireTableDataChanged();
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.table.AbstractTableModel#getColumnName(int)
*/
@Override
@@ -104,8 +108,10 @@ public class FeatureTableModel extends AbstractTableModel {
/**
* Gets the value at.
*
- * @param rowIndex the row index
- * @param columnIndex the column index
+ * @param rowIndex
+ * the row index
+ * @param columnIndex
+ * the column index
* @return the value at
* @see javax.swing.table.TableModel#getValueAt(int, int)
*/
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/tsview/MainFrame.java b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/tsview/MainFrame.java
index 6e81d03..285e1b9 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/tsview/MainFrame.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/cvd/tsview/MainFrame.java
@@ -48,7 +48,6 @@ import org.apache.uima.cas.TypeSystem;
import org.apache.uima.cas.admin.CASFactory;
import org.apache.uima.cas.admin.CASMgr;
-
/**
* Insert comment for enclosing_type here.
*
@@ -60,22 +59,21 @@ public class MainFrame extends JFrame {
private static final long serialVersionUID = 5606886216212480040L;
/**
- * The listener interface for receiving typeTreeSelection events.
- * The class that is interested in processing a typeTreeSelection
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addTypeTreeSelectionListener<code> method. When
- * the typeTreeSelection event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving typeTreeSelection events. The class that is interested in
+ * processing a typeTreeSelection event implements this interface, and the object created with
+ * that class is registered with a component using the component's
+ * <code>addTypeTreeSelectionListener<code> method. When the typeTreeSelection event occurs, that
+ * object's appropriate method is invoked.
*
* @see TypeTreeSelectionEvent
*/
private class TypeTreeSelectionListener implements TreeSelectionListener {
-
+
/**
* Value changed.
*
- * @param event the event
+ * @param event
+ * the event
* @see javax.swing.event.TreeSelectionListener#valueChanged(javax.swing.event.TreeSelectionEvent)
*/
@Override
@@ -111,7 +109,8 @@ public class MainFrame extends JFrame {
/**
* Constructor for MainFrame.
*
- * @throws HeadlessException -
+ * @throws HeadlessException
+ * -
*/
public MainFrame() {
init();
@@ -120,7 +119,8 @@ public class MainFrame extends JFrame {
/**
* Constructor for MainFrame.
*
- * @param gc the gc
+ * @param gc
+ * the gc
*/
public MainFrame(GraphicsConfiguration gc) {
super(gc);
@@ -130,8 +130,10 @@ public class MainFrame extends JFrame {
/**
* Constructor for MainFrame.
*
- * @param title the title
- * @throws HeadlessException -
+ * @param title
+ * the title
+ * @throws HeadlessException
+ * -
*/
public MainFrame(String title) {
super(title);
@@ -141,8 +143,10 @@ public class MainFrame extends JFrame {
/**
* Constructor for MainFrame.
*
- * @param title the title
- * @param gc the gc
+ * @param title
+ * the title
+ * @param gc
+ * the gc
*/
public MainFrame(String title, GraphicsConfiguration gc) {
super(title, gc);
@@ -220,7 +224,8 @@ public class MainFrame extends JFrame {
/**
* Creates the type tree.
*
- * @param type the type
+ * @param type
+ * the type
* @return the default mutable tree node
*/
private DefaultMutableTreeNode createTypeTree(org.apache.uima.cas.Type type) {
@@ -269,7 +274,8 @@ public class MainFrame extends JFrame {
/**
* Gets the tree model listeners.
*
- * @param model the model
+ * @param model
+ * the model
* @return the tree model listeners
*/
public static TreeModelListener[] getTreeModelListeners(DefaultTreeModel model) {
@@ -284,7 +290,8 @@ public class MainFrame extends JFrame {
/**
* Sets the type system.
*
- * @param ts the new type system
+ * @param ts
+ * the new type system
*/
public void setTypeSystem(TypeSystem ts) {
this.ts = ts;
@@ -294,7 +301,8 @@ public class MainFrame extends JFrame {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java
index a0810cc..b3c2c3e 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/AnnotationViewerDialog.java
@@ -99,7 +99,6 @@ import org.w3c.dom.NodeList;
import org.w3c.dom.Text;
import org.xml.sax.SAXException;
-
/**
* Dialog that loads analyzed documents stored in XMI or XCAS format and allows them to be viewed
* using the Java-based CAS viewer or a web browser, in either an HTML/Javascript format or in the
@@ -128,7 +127,7 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
/** the list of analyzed results */
JList<String> analyzedResultsList;
-
+
/** The input dir path. */
String inputDirPath = null;
@@ -155,26 +154,38 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
/** The processed style map. */
private boolean processedStyleMap = false;
-
+
/** The default cas view name. */
private String defaultCasViewName = CAS.NAME_DEFAULT_SOFA;
/**
* Create an AnnotationViewer Dialog.
*
- * @param aParentFrame frame containing this panel
- * @param aDialogTitle title to display for the dialog
- * @param med the med
- * @param aStyleMapFile filename of style map to be used to view files in HTML
- * @param aPerformanceStats string representaiton of performance statistics, optional.
- * @param aTypeSystem the CAS Type System to which the XCAS files must conform.
- * @param aTypesToDisplay array of types that should be highlighted in the viewer. This can be set to the output
+ * @param aParentFrame
+ * frame containing this panel
+ * @param aDialogTitle
+ * title to display for the dialog
+ * @param med
+ * the med
+ * @param aStyleMapFile
+ * filename of style map to be used to view files in HTML
+ * @param aPerformanceStats
+ * string representaiton of performance statistics, optional.
+ * @param aTypeSystem
+ * the CAS Type System to which the XCAS files must conform.
+ * @param aTypesToDisplay
+ * array of types that should be highlighted in the viewer. This can be set to the output
* types of the Analysis Engine. A value of null means to display all types.
- * @param interactiveTempFN the interactive temp FN
- * @param javaViewerRBisSelected the java viewer R bis selected
- * @param javaViewerUCRBisSelected the java viewer UCR bis selected
- * @param xmlRBisSelected the xml R bis selected
- * @param cas the cas
+ * @param interactiveTempFN
+ * the interactive temp FN
+ * @param javaViewerRBisSelected
+ * the java viewer R bis selected
+ * @param javaViewerUCRBisSelected
+ * the java viewer UCR bis selected
+ * @param xmlRBisSelected
+ * the xml R bis selected
+ * @param cas
+ * the cas
*/
public AnnotationViewerDialog(JFrame aParentFrame, String aDialogTitle, PrefsMediator med,
File aStyleMapFile, String aPerformanceStats, TypeSystem aTypeSystem,
@@ -196,8 +207,8 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
// Select documents via filter. JMP
final InteractiveFilter iFilter = new InteractiveFilter(filenameFilter);
String[] documents = dir.list(iFilter);
- //create an empty array to display
- if(documents == null) {
+ // create an empty array to display
+ if (documents == null) {
documents = new String[] {};
}
@@ -207,15 +218,24 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
/**
* Instantiates a new annotation viewer dialog.
*
- * @param aParentFrame the a parent frame
- * @param aDialogTitle the a dialog title
- * @param med the med
- * @param aStyleMapFile the a style map file
- * @param aPerformanceStats the a performance stats
- * @param aTypeSystem the a type system
- * @param aTypesToDisplay the a types to display
- * @param generatedStyleMap the generated style map
- * @param cas the cas
+ * @param aParentFrame
+ * the a parent frame
+ * @param aDialogTitle
+ * the a dialog title
+ * @param med
+ * the med
+ * @param aStyleMapFile
+ * the a style map file
+ * @param aPerformanceStats
+ * the a performance stats
+ * @param aTypeSystem
+ * the a type system
+ * @param aTypesToDisplay
+ * the a types to display
+ * @param generatedStyleMap
+ * the generated style map
+ * @param cas
+ * the cas
*/
public AnnotationViewerDialog(JFrame aParentFrame, String aDialogTitle, PrefsMediator med,
File aStyleMapFile, String aPerformanceStats, TypeSystem aTypeSystem,
@@ -248,8 +268,8 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
/*
* File[] documents = dir.listFiles(); Vector docVector = new Vector(); for (int i = 0; i <
- * documents.length; i++) { if (documents[i].isFile()) { docVector.add(documents[i].getName()); } }
- * final JList analyzedResultsList = new JList(docVector);
+ * documents.length; i++) { if (documents[i].isFile()) { docVector.add(documents[i].getName());
+ * } } final JList analyzedResultsList = new JList(docVector);
*/
JScrollPane scrollPane = new JScrollPane();
scrollPane.getViewport().add(analyzedResultsList, null);
@@ -386,7 +406,9 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
// unwound from small anonymous inner class
@@ -430,14 +452,16 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
* Filter to not show the two interactive-mode directories in the file list.
*/
static class InteractiveFilter implements FilenameFilter {
-
+
private final String filenameFilter;
public InteractiveFilter(String filenameFilter) {
this.filenameFilter = filenameFilter;
}
-
- /* (non-Javadoc)
+
+ /*
+ * (non-Javadoc)
+ *
* @see java.io.FilenameFilter#accept(java.io.File, java.lang.String)
*/
@Override
@@ -447,14 +471,13 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
if (name.equals("interactive_out"))
return false;
if (!name.isEmpty())
- return name.contains(filenameFilter);
+ return name.contains(filenameFilter);
return true;
}
}
/**
- * Gets the name of the CAS View that will be displayed first in
- * the annotation viewer.
+ * Gets the name of the CAS View that will be displayed first in the annotation viewer.
*
* @return the default cas view name
*/
@@ -463,15 +486,16 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
}
/**
- * Sets the name of the CAS View that will be displayed first in
- * the annotation viewer. It not set, defaults to {@link CAS#NAME_DEFAULT_SOFA}.
+ * Sets the name of the CAS View that will be displayed first in the annotation viewer. It not
+ * set, defaults to {@link CAS#NAME_DEFAULT_SOFA}.
*
- * @param defaultCasViewName the new default cas view name
+ * @param defaultCasViewName
+ * the new default cas view name
*/
public void setDefaultCasViewName(String defaultCasViewName) {
this.defaultCasViewName = defaultCasViewName;
}
-
+
// Common code to launch viewer for both the Run (file-based) and
// Interactive modes
// JMP
@@ -479,15 +503,24 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
/**
* Launch that viewer.
*
- * @param inputDirPath the input dir path
- * @param fileName the file name
- * @param typeSystem the type system
- * @param aTypesToDisplay the a types to display
- * @param javaViewerRBisSelected the java viewer R bis selected
- * @param javaViewerUCRBisSelected the java viewer UCR bis selected
- * @param xmlRBisSelected the xml R bis selected
- * @param styleMapFile the style map file
- * @param viewerDirectory the viewer directory
+ * @param inputDirPath
+ * the input dir path
+ * @param fileName
+ * the file name
+ * @param typeSystem
+ * the type system
+ * @param aTypesToDisplay
+ * the a types to display
+ * @param javaViewerRBisSelected
+ * the java viewer R bis selected
+ * @param javaViewerUCRBisSelected
+ * the java viewer UCR bis selected
+ * @param xmlRBisSelected
+ * the xml R bis selected
+ * @param styleMapFile
+ * the style map file
+ * @param viewerDirectory
+ * the viewer directory
*/
public void launchThatViewer(String inputDirPath, String fileName, TypeSystem typeSystem,
final String[] aTypesToDisplay, boolean javaViewerRBisSelected,
@@ -497,14 +530,14 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
File xcasFile = new File(inputDirPath, fileName);
// create a new CAS
- CAS cas = CasCreationUtils.createCas(Collections.EMPTY_LIST, typeSystem, UIMAFramework
- .getDefaultPerformanceTuningProperties());
+ CAS cas = CasCreationUtils.createCas(Collections.EMPTY_LIST, typeSystem,
+ UIMAFramework.getDefaultPerformanceTuningProperties());
// deserialize XCAS into CAS
try (InputStream xcasInStream = new FileInputStream(xcasFile)) {
XmlCasDeserializer.deserialize(xcasInStream, cas, true);
}
-
- //get the specified view
+
+ // get the specified view
cas = cas.getView(this.defaultCasViewName);
// launch appropriate viewer
@@ -521,8 +554,8 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
viewer.setHiddenTypes(new String[] { "uima.cpm.FileLocation" });
// launch viewer in a new dialog
viewer.setCAS(cas);
- JDialog dialog = new JDialog(AnnotationViewerDialog.this, "Annotation Results for "
- + fileName + " in " + inputDirPath); // JMP
+ JDialog dialog = new JDialog(AnnotationViewerDialog.this,
+ "Annotation Results for " + fileName + " in " + inputDirPath); // JMP
dialog.getContentPane().add(viewer);
dialog.setSize(850, 630);
dialog.pack();
@@ -530,7 +563,8 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
} else {
CAS defaultView = cas.getView(CAS.NAME_DEFAULT_SOFA);
if (defaultView.getDocumentText() == null) {
- displayError("The HTML and XML Viewers can only view the default text document, which was not found in this CAS.");
+ displayError(
+ "The HTML and XML Viewers can only view the default text document, which was not found in this CAS.");
return;
}
// generate inline XML
@@ -576,11 +610,11 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
}
}
-
/**
* Assumes node has a text field and extracts its value. JMP
*
- * @param node the node
+ * @param node
+ * the node
* @return the text value
*/
static public String getTextValue(Node node) {
@@ -595,8 +629,10 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
/**
* Gets the first child with a given name. JMP
*
- * @param node the node
- * @param name the name
+ * @param node
+ * the node
+ * @param name
+ * the name
* @return the first child by name
*/
static public Node getFirstChildByName(Node node, String name) {
@@ -613,8 +649,10 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
* Reads in annotation-color associations from stylemap file. JMP Also reads checked value if
* present.
*
- * @param viewer the viewer
- * @param aStyleMapFile the a style map file
+ * @param viewer
+ * the viewer
+ * @param aStyleMapFile
+ * the a style map file
*/
public void getColorsForTypesFromFile(CasAnnotationViewer viewer, File aStyleMapFile) {
@@ -769,17 +807,20 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
* AnalysisEngineDescription object.
*
* @return the selected AnalysisEngineDescription, null if the user cancelled
- * @throws IOException Signals that an I/O exception has occurred.
- * @throws InvalidXMLException the invalid XML exception
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
- protected AnalysisEngineDescription promptForAE() throws IOException, InvalidXMLException,
- ResourceInitializationException {
+ protected AnalysisEngineDescription promptForAE()
+ throws IOException, InvalidXMLException, ResourceInitializationException {
if (med1.getTAEfile() != null) {
File taeFile = new File(med1.getTAEfile());
XMLInputSource in = new XMLInputSource(taeFile);
- AnalysisEngineDescription aed = UIMAFramework.getXMLParser().parseAnalysisEngineDescription(
- in);
+ AnalysisEngineDescription aed = UIMAFramework.getXMLParser()
+ .parseAnalysisEngineDescription(in);
return aed;
} else {
String taeDir = med1.getTAEfile();
@@ -797,7 +838,7 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
}
/**
- * set default look and feel.
+ * set default look and feel.
*/
private static void setLF() {
// Force SwingApp to come up in the System L&F
@@ -810,7 +851,7 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
System.err.println("Error loading " + laf + ": " + exc);
}
}
-
+
/**
* Creates the temp dir.
*
@@ -828,7 +869,7 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
*/
// image icon
static class MyListCellRenderer extends JLabel implements ListCellRenderer {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 7231915634689270693L;
@@ -839,8 +880,11 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
setOpaque(true);
}
- /* (non-Javadoc)
- * @see javax.swing.ListCellRenderer#getListCellRendererComponent(javax.swing.JList, java.lang.Object, int, boolean, boolean)
+ /*
+ * (non-Javadoc)
+ *
+ * @see javax.swing.ListCellRenderer#getListCellRendererComponent(javax.swing.JList,
+ * java.lang.Object, int, boolean, boolean)
*/
@Override
public Component getListCellRendererComponent(JList analyzedResultsList, Object value,
@@ -859,7 +903,9 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
*/
class ListMouseAdapter extends MouseAdapter {
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.MouseAdapter#mouseClicked(java.awt.event.MouseEvent)
*/
@Override
@@ -870,9 +916,9 @@ public class AnnotationViewerDialog extends JDialog implements ActionListener {
if (fileName != null) {
analyzedResultsList.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
// Start LTV here
- launchThatViewer(inputDirPath, fileName, typeSystem, typesToDisplay, javaViewerRB
- .isSelected(), javaViewerUCRB.isSelected(), xmlRB.isSelected(), styleMapFile,
- tempDir);
+ launchThatViewer(inputDirPath, fileName, typeSystem, typesToDisplay,
+ javaViewerRB.isSelected(), javaViewerUCRB.isSelected(), xmlRB.isSelected(),
+ styleMapFile, tempDir);
analyzedResultsList.setCursor(Cursor.getDefaultCursor());
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java
index 7257f5e..044b815 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/DocumentAnalyzer.java
@@ -99,7 +99,6 @@ import org.apache.uima.util.FileUtils;
import org.apache.uima.util.InvalidXMLException;
import org.apache.uima.util.XMLInputSource;
-
/**
* A simple GUI for the RunTextAnalysis application library. Note that currently this will only run
* under Windows since it relies on Windows-specific commands for invoking a web browser to view the
@@ -109,7 +108,7 @@ import org.apache.uima.util.XMLInputSource;
*
*/
public class DocumentAnalyzer extends JFrame implements StatusCallbackListener, ActionListener {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 8795969283257780425L;
@@ -117,8 +116,7 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
private static final String HELP_MESSAGE = "Instructions for using UIMA Document Analyzer:\n\n"
+ "* In the \"Input Directory\" field, either type or use the browse\n"
+ "button to select a directory containing the documents that you want\n"
- + "to analyze.\n\n"
- + "* In the \"Input File Format\" field, type or use the browse\n"
+ + "to analyze.\n\n" + "* In the \"Input File Format\" field, type or use the browse\n"
+ "button to select \"text\", \"xcas\", or \"xmi\".\n"
+ "* If using \"xmi\" or \"xcas\", check the \"Lenient\" box to indicate if it's OK if the annotator's type system doesn't define all the types or features in the input CAS.\n\n"
+ "* In the \"Output Directory\" field, either type or use the browse\n"
@@ -140,10 +138,10 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/** The input file selector. */
private FileSelector inputFileSelector;
-
+
/** The input file format combo box. */
private JComboBox inputFileFormatComboBox;
-
+
/** The lenient checkbox. */
private JCheckBox lenientCheckbox;
@@ -255,7 +253,7 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/** The using xml detagger. */
private boolean usingXmlDetagger;
-
+
/**
* Constructor. Sets up the GUI.
*/
@@ -266,9 +264,12 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/**
* Instantiates a new document analyzer.
*
- * @param outputFileSelected the output file selected
- * @param interactiveDA the interactive DA
- * @param jvucrbis the jvucrbis
+ * @param outputFileSelected
+ * the output file selected
+ * @param interactiveDA
+ * the interactive DA
+ * @param jvucrbis
+ * the jvucrbis
*/
public DocumentAnalyzer(String outputFileSelected, boolean interactiveDA, boolean jvucrbis) {
super("Document Analyzer");
@@ -341,7 +342,7 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
// Create field label captions (right-aligned JLabel):
labelInputFile = new Caption(inputString);
-
+
labelInputFileFormat = new Caption(inputFileFormatString);
labelOutputFile = new Caption(outputString);
@@ -377,63 +378,60 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
inputFileSelector.addFileSelectorListener(fsl);
inputFileSelector.addDocumentListener(dl);
-
// UIMA-2305.
-
+
lenientCheckbox = new JCheckBox("Lenient deserialization");
- lenientCheckbox.setToolTipText("Allow extra types and features in the input CAS, not defined by the annotator type system, to be ignored");
+ lenientCheckbox.setToolTipText(
+ "Allow extra types and features in the input CAS, not defined by the annotator type system, to be ignored");
lenientCheckbox.setSelected(prefsMed.getLenient());
-
+
JPanel inputFileFormatPanel = new JPanel();
inputFileFormatPanel.setLayout(new FlowLayout(FlowLayout.LEFT));
-
+
inputFileFormatComboBox = new JComboBox(new Object[] { "text", "xmi", "xcas" });
inputFileFormatComboBox.setEditable(false);
inputFileFormatComboBox.setSelectedItem(prefsMed.getInputFileFormat());
- inputFileFormatComboBox.addActionListener(new ActionListener() {
+ inputFileFormatComboBox.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
String inputFileFormat = (String) inputFileFormatComboBox.getSelectedItem();
- lenientCheckbox.setEnabled(
- "xcas".equalsIgnoreCase(inputFileFormat) ||
- "xmi".equalsIgnoreCase(inputFileFormat));
+ lenientCheckbox.setEnabled("xcas".equalsIgnoreCase(inputFileFormat)
+ || "xmi".equalsIgnoreCase(inputFileFormat));
}
});
-
+
String inputFileFormat = (String) inputFileFormatComboBox.getSelectedItem();
lenientCheckbox.setEnabled(
- "xcas".equalsIgnoreCase(inputFileFormat) ||
- "xmi".equalsIgnoreCase(inputFileFormat));
+ "xcas".equalsIgnoreCase(inputFileFormat) || "xmi".equalsIgnoreCase(inputFileFormat));
+
+ inputFileFormatPanel.add(inputFileFormatComboBox);
-
- inputFileFormatPanel.add(inputFileFormatComboBox);
-
inputFileFormatPanel.add(lenientCheckbox);
-
+
Map<String, Charset> charsetMap = Charset.availableCharsets();
Set<String> charsets = charsetMap.keySet();
String[] charsetArr = charsets.toArray(new String[charsets.size()]);
encodingComboBox = new JComboBox(charsetArr);
encodingComboBox.setEditable(false);
encodingComboBox.setSelectedItem(prefsMed.getEncoding());
-
+
JPanel displayEncodingFormatPanel = new JPanel();
displayEncodingFormatPanel.setLayout(new FlowLayout(FlowLayout.LEFT));
- displayEncodingFormatPanel.setBorder(BorderFactory.createEmptyBorder(0, 0, 0, 0));
+ displayEncodingFormatPanel.setBorder(BorderFactory.createEmptyBorder(0, 0, 0, 0));
displayEncodingFormatPanel.add(labelEncoding);
displayEncodingFormatPanel.add(encodingComboBox);
-
+
inputFileFormatPanel.add(displayEncodingFormatPanel);
-
+
outputFileSelector = new FileSelector(prefsMed.getOutputDir(), "Output Directory",
JFileChooser.DIRECTORIES_ONLY, browserRootDir);
// outputFileSelector.addFocusListener( tlf);
outputFileSelector.addFileSelectorListener(fsl);
outputFileSelector.addDocumentListener(dl);
- xmlFileSelector = new FileSelector(prefsMed.getTAEfile(),
- "Analysis Engine Descriptor XML file", JFileChooser.FILES_ONLY, browserRootDir);
+ xmlFileSelector = new FileSelector(prefsMed.getTAEfile(), "Analysis Engine Descriptor XML file",
+ JFileChooser.FILES_ONLY, browserRootDir);
// xmlFileSelector.addFocusListener( tlf);
xmlFileSelector.addFileSelectorListener(fsl);
xmlFileSelector.addDocumentListener(dl);
@@ -454,7 +452,6 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
languagePanel.setLayout(new FlowLayout(FlowLayout.LEFT, 2, 2));
languagePanel.add(languageComboBox);
-
controlPanel.add(labelInputFile);
controlPanel.add(inputFileSelector);
controlPanel.add(labelInputFileFormat);
@@ -493,8 +490,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
helpMenuItem.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent evt) {
- JOptionPane.showMessageDialog(DocumentAnalyzer.this, HELP_MESSAGE,
- "Document Analyzer Help", JOptionPane.PLAIN_MESSAGE);
+ JOptionPane.showMessageDialog(DocumentAnalyzer.this, HELP_MESSAGE, "Document Analyzer Help",
+ JOptionPane.PLAIN_MESSAGE);
}
});
@@ -594,7 +591,9 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
// View button clicked
@@ -605,8 +604,7 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
aeSpecifierFile = new File(xmlFileSelector.getSelected());
interactive = false; // prevent re-viewing temp file
showAnalysisResults(outputDirectory);
- }
- catch (Exception ex) {
+ } catch (Exception ex) {
displayError(ex);
}
}
@@ -617,7 +615,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
* processing is complete, allows the user to view the results. JMP added arg for input text to
* analyze.
*
- * @param analysisText the analysis text
+ * @param analysisText
+ * the analysis text
*/
public void analyzeDocuments(String analysisText) {
// get field values from GUI
@@ -625,10 +624,9 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
File inputDir = new File(inputFileSelector.getSelected());
if (outputFileSelector.getSelected().length() > 0) {
- outputDirectory = new File(outputFileSelector.getSelected());
- }
- else {
- outputDirectory = null;
+ outputDirectory = new File(outputFileSelector.getSelected());
+ } else {
+ outputDirectory = null;
}
// reset file pointers in case of typed-in text. JMP
@@ -638,12 +636,12 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
inputDir = new File(tempFileDir);
if (!inputDir.exists()) {
inputDir.mkdirs();
- }
+ }
outputFileSelected = outputFileSelector.getSelected() + "/interactive_out";
prefsMed.setOutputDirForInteractiveMode(outputFileSelected, outputFileSelector.getSelected());
outputDirectory = new File(outputFileSelected);
} else {
- analysisText = null; //
+ analysisText = null; //
} // should just return
aeSpecifierFile = new File(xmlFileSelector.getSelected());
@@ -669,8 +667,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
} else if (inputDir.getName().equals("")) {
displayError("An Input Directory is Required");
} else if (!inputDir.exists()) {
- displayError("The input directory \"" + inputFileSelector.getSelected()
- + "\" does not exist.");
+ displayError(
+ "The input directory \"" + inputFileSelector.getSelected() + "\" does not exist.");
} else if (!inputDir.isDirectory()) {
displayError("The input directory (" + inputFileSelector.getSelected()
+ ") must be a directory, not a file.");
@@ -716,10 +714,11 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
filename = filename.substring(0, filename.length() - 4);
}
if (!new File(inputDir, filename).exists()) {
- int choice = JOptionPane.showConfirmDialog(DocumentAnalyzer.this, "All files in "
- + outputDirectory.getPath() + " will be deleted. These files don't "
- + "appear to match the files in the input directory. Is this OK?", "Confirm",
- JOptionPane.YES_NO_OPTION);
+ int choice = JOptionPane.showConfirmDialog(DocumentAnalyzer.this,
+ "All files in " + outputDirectory.getPath()
+ + " will be deleted. These files don't "
+ + "appear to match the files in the input directory. Is this OK?",
+ "Confirm", JOptionPane.YES_NO_OPTION);
if (choice == JOptionPane.NO_OPTION) {
return;
} else {
@@ -740,8 +739,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
// start separate thread to do component initialization and
// processing
- ProcessingThread thread = new ProcessingThread(inputDir, inputFileFormat, lenient, outputDirectory, aeSpecifierFile,
- xmlTag, language, encoding);
+ ProcessingThread thread = new ProcessingThread(inputDir, inputFileFormat, lenient,
+ outputDirectory, aeSpecifierFile, xmlTag, language, encoding);
thread.start();
}
}
@@ -761,8 +760,10 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/**
* Entity process complete.
*
- * @param aCas the a cas
- * @param aStatus the a status
+ * @param aCas
+ * the a cas
+ * @param aStatus
+ * the a status
* @see org.apache.uima.collection.StatusCallbackListener#entityProcessComplete(org.apache.uima.cas.CAS,
* org.apache.uima.collection.EntityProcessStatus)
*/
@@ -881,7 +882,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/**
* Show analysis results.
*
- * @param aOutputDir the a output dir
+ * @param aOutputDir
+ * the a output dir
*/
// this call is used when you click the "View" button
public void showAnalysisResults(File aOutputDir) {
@@ -894,10 +896,10 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
}
statsString = null;
-
+
// Not sure if the following code makes sense... If a style map file exists,
// this restricts the set of types displayed by the viewer to only the types
- // in that file. But why is this only done in "View" mode? It seems like this
+ // in that file. But why is this only done in "View" mode? It seems like this
// belongs in AnnotationViewerDialog with the other code that sets up the
// viewer (e.g., the colors) from the style map file.
if (prefsMed.getStylemapFile().exists()) {
@@ -917,16 +919,20 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
* Creates a CAS from an descriptor. Supports both local AE descriptors and remote service
* specifiers. In the latter case the service is contacted to obtain its type system.
*
- * @param aDescriptorFile the a descriptor file
+ * @param aDescriptorFile
+ * the a descriptor file
* @return the cas
- * @throws ResourceInitializationException -
- * @throws InvalidXMLException -
- * @throws IOException -
+ * @throws ResourceInitializationException
+ * -
+ * @throws InvalidXMLException
+ * -
+ * @throws IOException
+ * -
*/
protected CAS createCasFromDescriptor(String aDescriptorFile) // JMP
throws ResourceInitializationException, InvalidXMLException, IOException {
- ResourceSpecifier spec = UIMAFramework.getXMLParser().parseResourceSpecifier(
- new XMLInputSource(aDescriptorFile));
+ ResourceSpecifier spec = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(new XMLInputSource(aDescriptorFile));
if (spec instanceof AnalysisEngineDescription) {
return CasCreationUtils.createCas((AnalysisEngineDescription) spec);
} else {
@@ -938,7 +944,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/**
* Read stylemap file.
*
- * @param smapFile the smap file
+ * @param smapFile
+ * the smap file
* @return the string
*/
protected String readStylemapFile(File smapFile) // JMP
@@ -960,7 +967,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/**
* Show analysis.
*
- * @param outputDir the output dir
+ * @param outputDir
+ * the output dir
*/
private void show_analysis(File outputDir) {
File styleMapFile = getStyleMapFile();
@@ -980,9 +988,9 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
} else {
// this version of the AnnotationViewerDialog constructor does
// not automatically launch the viewer.
- AnnotationViewerDialog viewerDialog = new AnnotationViewerDialog(this,
- "Analysis Results", prefsMed, styleMapFile, statsString, currentTypeSystem,
- currentTaeOutputTypes, useGeneratedStyleMap, cas);
+ AnnotationViewerDialog viewerDialog = new AnnotationViewerDialog(this, "Analysis Results",
+ prefsMed, styleMapFile, statsString, currentTypeSystem, currentTaeOutputTypes,
+ useGeneratedStyleMap, cas);
if (usingXmlDetagger) {
viewerDialog.setDefaultCasViewName("plainTextDocument");
}
@@ -1080,7 +1088,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/**
* Runs the application.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
final DocumentAnalyzer frame = new DocumentAnalyzer();
@@ -1095,7 +1104,7 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
* Class for dialog in which user types in text to be analyzed, and sets browser parameters.
*/
class TextAreaViewer extends JPanel {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -7503162930412929062L;
@@ -1105,8 +1114,10 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/**
* Constructor for dialog.
*
- * @param aiDialog the ai dialog
- * @param generatedStyleMap the generated style map
+ * @param aiDialog
+ * the ai dialog
+ * @param generatedStyleMap
+ * the generated style map
*/
public TextAreaViewer(final JDialog aiDialog, boolean generatedStyleMap) {
@@ -1151,10 +1162,9 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
if (generatedStyleMap) {
javaViewerRB.setSelected(true);
- }
- else {
+ } else {
javaViewerUCRB.setSelected(true);
- }
+ }
ButtonGroup displayFormatButtonGroup = new ButtonGroup();
displayFormatButtonGroup.add(javaViewerRB);
@@ -1232,27 +1242,36 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/**
* Run processing thread.
*
- * @param inputDir the input dir
- * @param inputFileFormat the input file format
- * @param lenient the lenient
- * @param outputDir the output dir
- * @param aeSpecifierFile the ae specifier file
- * @param xmlTag the xml tag
- * @param language the language
- * @param encoding the encoding
+ * @param inputDir
+ * the input dir
+ * @param inputFileFormat
+ * the input file format
+ * @param lenient
+ * the lenient
+ * @param outputDir
+ * the output dir
+ * @param aeSpecifierFile
+ * the ae specifier file
+ * @param xmlTag
+ * the xml tag
+ * @param language
+ * the language
+ * @param encoding
+ * the encoding
*/
- public void runProcessingThread(File inputDir, String inputFileFormat, Boolean lenient, File outputDir, File aeSpecifierFile,
- String xmlTag, String language, String encoding) {
+ public void runProcessingThread(File inputDir, String inputFileFormat, Boolean lenient,
+ File outputDir, File aeSpecifierFile, String xmlTag, String language, String encoding) {
try {
// create and configure collection reader that will read input docs
CollectionReaderDescription collectionReaderDesc = FileSystemCollectionReader
.getDescription();
ConfigurationParameterSettings paramSettings = collectionReaderDesc.getMetaData()
.getConfigurationParameterSettings();
- paramSettings.setParameterValue(FileSystemCollectionReader.PARAM_INPUTDIR, inputDir
- .getAbsolutePath());
+ paramSettings.setParameterValue(FileSystemCollectionReader.PARAM_INPUTDIR,
+ inputDir.getAbsolutePath());
paramSettings.setParameterValue(FileSystemCollectionReader.PARAM_XCAS, inputFileFormat);
- paramSettings.setParameterValue(FileSystemCollectionReader.PARAM_LENIENT, lenient ? "true" : "false");
+ paramSettings.setParameterValue(FileSystemCollectionReader.PARAM_LENIENT,
+ lenient ? "true" : "false");
paramSettings.setParameterValue(FileSystemCollectionReader.PARAM_LANGUAGE, language);
paramSettings.setParameterValue(FileSystemCollectionReader.PARAM_ENCODING, encoding);
collectionReader = (FileSystemCollectionReader) UIMAFramework
@@ -1289,8 +1308,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
CasConsumerDescription casConsumerDesc = XmiWriterCasConsumer.getDescription();
ConfigurationParameterSettings consumerParamSettings = casConsumerDesc.getMetaData()
.getConfigurationParameterSettings();
- consumerParamSettings.setParameterValue(XmiWriterCasConsumer.PARAM_OUTPUTDIR, outputDir
- .getAbsolutePath());
+ consumerParamSettings.setParameterValue(XmiWriterCasConsumer.PARAM_OUTPUTDIR,
+ outputDir.getAbsolutePath());
// declare uima.cas.TOP as an input so that ResultSpec on user's AE will be set to produce all
// types
casConsumerDesc.getCasConsumerMetaData().getCapabilities()[0].addInputType("uima.cas.TOP",
@@ -1304,58 +1323,57 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
.getConfigurationParameterSettings();
xmlDetaggerParamSettings.setParameterValue(XmlDetagger.PARAM_TEXT_TAG, xmlTag);
usingXmlDetagger = true;
- }
- else {
+ } else {
usingXmlDetagger = false;
}
-
+
// create an aggregate AE that includes the XmlDetagger (if needed), followed by
- //th user's AE descriptor, followed by the XMI Writer CAS Consumer, using fixed flow.
- // We use an aggregate AE here, rather than just adding the CAS Consumer to the CPE, so
- //that we can support the user's AE being a CAS Multiplier and we can specify sofa mappings.
+ // th user's AE descriptor, followed by the XMI Writer CAS Consumer, using fixed flow.
+ // We use an aggregate AE here, rather than just adding the CAS Consumer to the CPE, so
+ // that we can support the user's AE being a CAS Multiplier and we can specify sofa mappings.
AnalysisEngineDescription aggDesc = UIMAFramework.getResourceSpecifierFactory()
.createAnalysisEngineDescription();
aggDesc.setPrimitive(false);
aggDesc.getDelegateAnalysisEngineSpecifiersWithImports().put("UserAE", aeSpecifier);
aggDesc.getDelegateAnalysisEngineSpecifiersWithImports().put("XmiWriter", casConsumerDesc);
- FixedFlow flow = UIMAFramework.getResourceSpecifierFactory().createFixedFlow();
-
+ FixedFlow flow = UIMAFramework.getResourceSpecifierFactory().createFixedFlow();
+
if (xmlDetaggerDesc != null) {
- aggDesc.getDelegateAnalysisEngineSpecifiersWithImports().put("XmlDetagger", xmlDetaggerDesc);
- flow.setFixedFlow(new String[] {"XmlDetagger", "UserAE", "XmiWriter"});
-
- //to run XmlDetagger we need sofa mappings
- //XmlDetagger's "xmlDocument" input sofa gets mapped to the default sofa
+ aggDesc.getDelegateAnalysisEngineSpecifiersWithImports().put("XmlDetagger",
+ xmlDetaggerDesc);
+ flow.setFixedFlow(new String[] { "XmlDetagger", "UserAE", "XmiWriter" });
+
+ // to run XmlDetagger we need sofa mappings
+ // XmlDetagger's "xmlDocument" input sofa gets mapped to the default sofa
SofaMapping sofaMapping1 = UIMAFramework.getResourceSpecifierFactory().createSofaMapping();
sofaMapping1.setComponentKey("XmlDetagger");
sofaMapping1.setComponentSofaName("xmlDocument");
sofaMapping1.setAggregateSofaName(CAS.NAME_DEFAULT_SOFA);
-
- //for UserAE and XmiWriter, may default sofa to the "plainTextDocument" produced by the XmlDetagger
+
+ // for UserAE and XmiWriter, may default sofa to the "plainTextDocument" produced by the
+ // XmlDetagger
SofaMapping sofaMapping2 = UIMAFramework.getResourceSpecifierFactory().createSofaMapping();
sofaMapping2.setComponentKey("UserAE");
sofaMapping2.setAggregateSofaName("plainTextDocument");
SofaMapping sofaMapping3 = UIMAFramework.getResourceSpecifierFactory().createSofaMapping();
sofaMapping3.setComponentKey("XmiWriter");
sofaMapping3.setAggregateSofaName("plainTextDocument");
-
- aggDesc.setSofaMappings(new SofaMapping[] {sofaMapping1, sofaMapping2, sofaMapping3});
- }
- else {
- //no XML detagger needed in the aggregate in flow
- flow.setFixedFlow(new String[] { "UserAE", "XmiWriter" });
+
+ aggDesc.setSofaMappings(new SofaMapping[] { sofaMapping1, sofaMapping2, sofaMapping3 });
+ } else {
+ // no XML detagger needed in the aggregate in flow
+ flow.setFixedFlow(new String[] { "UserAE", "XmiWriter" });
}
-
aggDesc.getAnalysisEngineMetaData().setName("DocumentAnalyzerAE");
aggDesc.getAnalysisEngineMetaData().setFlowConstraints(flow);
- aggDesc.getAnalysisEngineMetaData().getOperationalProperties().setMultipleDeploymentAllowed(
- false);
+ aggDesc.getAnalysisEngineMetaData().getOperationalProperties()
+ .setMultipleDeploymentAllowed(false);
progressMonitor.setProgress(1);
// instantiate AE
// keep this a local variable - so it doesn't hang on to the ae object
- // preventing gc (some ae objects are huge)
+ // preventing gc (some ae objects are huge)
AnalysisEngine ae = UIMAFramework.produceAnalysisEngine(aggDesc);
mCPM.setAnalysisEngine(ae);
@@ -1419,12 +1437,11 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
} catch (Throwable t) {
// special check for using XML detagger with remotes, which will generate an error
// since sofa mappings aren't supported for remotes
- if (usingXmlDetagger
- && (t instanceof UIMAException)
- && ((UIMAException) t)
- .hasMessageKey(ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE)) {
- displayError("The XML detagging feature is not supported for remote Analysis Engines or for Aggregates containing remotes. "
- + "If you are running a remote Analysis Engine the \"XML Tag Containing Text\" field must be left blank.");
+ if (usingXmlDetagger && (t instanceof UIMAException) && ((UIMAException) t).hasMessageKey(
+ ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE)) {
+ displayError(
+ "The XML detagging feature is not supported for remote Analysis Engines or for Aggregates containing remotes. "
+ + "If you are running a remote Analysis Engine the \"XML Tag Containing Text\" field must be left blank.");
} else {
displayError(t);
}
@@ -1436,13 +1453,13 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
* The Class ProcessingThread.
*/
class ProcessingThread extends Thread {
-
+
/** The input dir. */
File inputDir;
/** The input file format. */
String inputFileFormat;
-
+
/** The output dir. */
File outputDir;
@@ -1457,24 +1474,32 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/** The encoding. */
String encoding;
-
+
/** The lenient. */
Boolean lenient;
/**
* Instantiates a new processing thread.
*
- * @param inputDir the input dir
- * @param inputFileFormat the input file format
- * @param lenient the lenient
- * @param outputDir the output dir
- * @param taeSpecifierFile the tae specifier file
- * @param xmlTag the xml tag
- * @param language the language
- * @param encoding the encoding
+ * @param inputDir
+ * the input dir
+ * @param inputFileFormat
+ * the input file format
+ * @param lenient
+ * the lenient
+ * @param outputDir
+ * the output dir
+ * @param taeSpecifierFile
+ * the tae specifier file
+ * @param xmlTag
+ * the xml tag
+ * @param language
+ * the language
+ * @param encoding
+ * the encoding
*/
- ProcessingThread(File inputDir, String inputFileFormat, Boolean lenient, File outputDir, File taeSpecifierFile, String xmlTag,
- String language, String encoding) {
+ ProcessingThread(File inputDir, String inputFileFormat, Boolean lenient, File outputDir,
+ File taeSpecifierFile, String xmlTag, String language, String encoding) {
this.inputDir = inputDir;
this.inputFileFormat = inputFileFormat;
this.outputDir = outputDir;
@@ -1485,14 +1510,17 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
this.lenient = lenient;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Thread#run()
*/
@Override
public void run() {
// Code moved outside class to make accessible by programs that call
// DocumentAnalyzer. JMP
- runProcessingThread(inputDir, inputFileFormat, lenient, outputDir, taeSpecifierFile, xmlTag, language, encoding);
+ runProcessingThread(inputDir, inputFileFormat, lenient, outputDir, taeSpecifierFile, xmlTag,
+ language, encoding);
}
}
@@ -1511,7 +1539,8 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
/**
* Sets the style map file.
*
- * @param styleMapFile The styleMapFile to set.
+ * @param styleMapFile
+ * The styleMapFile to set.
*/
public void setStyleMapFile(File styleMapFile) {
this.userStyleMapFile = styleMapFile;
@@ -1522,9 +1551,9 @@ public class DocumentAnalyzer extends JFrame implements StatusCallbackListener,
*
* @see java.awt.Component#getPreferredSize()
*/
-// @Override
-// public Dimension getPreferredSize() {
-// return new Dimension(800, 350);
-// }
+ // @Override
+ // public Dimension getPreferredSize() {
+ // return new Dimension(800, 350);
+ // }
}
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/FileSelector.java b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/FileSelector.java
index a6627f3..1fa4422 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/FileSelector.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/FileSelector.java
@@ -39,7 +39,6 @@ import javax.swing.SwingUtilities;
import javax.swing.event.DocumentListener;
import javax.swing.filechooser.FileFilter;
-
/**
*
*
@@ -48,7 +47,7 @@ import javax.swing.filechooser.FileFilter;
*/
public class FileSelector extends JPanel implements FocusListener {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = -8710960143421949274L;
@@ -73,9 +72,12 @@ public class FileSelector extends JPanel implements FocusListener {
/**
* Instantiates a new file selector.
*
- * @param initialValue the initial value
- * @param fileChooserTitle the file chooser title
- * @param selectionMode the selection mode
+ * @param initialValue
+ * the initial value
+ * @param fileChooserTitle
+ * the file chooser title
+ * @param selectionMode
+ * the selection mode
*/
public FileSelector(String initialValue, String fileChooserTitle, int selectionMode) // Can be
// either
@@ -89,10 +91,14 @@ public class FileSelector extends JPanel implements FocusListener {
/**
* Instantiates a new file selector.
*
- * @param initialValue the initial value
- * @param fileChooserTitle the file chooser title
- * @param selectionMode the selection mode
- * @param currentDir the current dir
+ * @param initialValue
+ * the initial value
+ * @param fileChooserTitle
+ * the file chooser title
+ * @param selectionMode
+ * the selection mode
+ * @param currentDir
+ * the current dir
*/
public FileSelector(String initialValue, String fileChooserTitle, int selectionMode, // Can be
// either
@@ -213,13 +219,16 @@ public class FileSelector extends JPanel implements FocusListener {
/**
* Adds the file selector listener.
*
- * @param aFileSelectorListener the a file selector listener
+ * @param aFileSelectorListener
+ * the a file selector listener
*/
public void addFileSelectorListener(FileSelectorListener aFileSelectorListener) {
this.fileSelectorListener = aFileSelectorListener;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.Component#addFocusListener(java.awt.event.FocusListener)
*/
// added this to make focus change available to mediator
@@ -232,7 +241,8 @@ public class FileSelector extends JPanel implements FocusListener {
/**
* Adds the choosable file filter.
*
- * @param ff the ff
+ * @param ff
+ * the ff
*/
public void addChoosableFileFilter(FileFilter ff) {
fileChooser.addChoosableFileFilter(ff);
@@ -250,7 +260,8 @@ public class FileSelector extends JPanel implements FocusListener {
/**
* Sets the selected.
*
- * @param s the new selected
+ * @param s
+ * the new selected
*/
public void setSelected(String s) {
s = s.trim();
@@ -267,7 +278,9 @@ public class FileSelector extends JPanel implements FocusListener {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.JComponent#setEnabled(boolean)
*/
@Override
@@ -287,20 +300,23 @@ public class FileSelector extends JPanel implements FocusListener {
* The Class BrowseButton.
*/
static class BrowseButton extends JButton {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 7366026783079468609L;
/**
* Instantiates a new browse button.
*
- * @param s the s
+ * @param s
+ * the s
*/
public BrowseButton(String s) {
super(s);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.swing.JComponent#getInsets()
*/
@Override
@@ -332,7 +348,8 @@ public class FileSelector extends JPanel implements FocusListener {
}
File file = new File(path);
- if (this.fileChooser.getFileSelectionMode() == JFileChooser.FILES_ONLY && file.isDirectory()) {
+ if (this.fileChooser.getFileSelectionMode() == JFileChooser.FILES_ONLY
+ && file.isDirectory()) {
this.fileChooser.setCurrentDirectory(file);
} else {
this.fileChooser.setSelectedFile(file);
@@ -347,7 +364,8 @@ public class FileSelector extends JPanel implements FocusListener {
/**
* Adds the document listener.
*
- * @param l the l
+ * @param l
+ * the l
*/
/*
* (non-Javadoc)
@@ -361,7 +379,8 @@ public class FileSelector extends JPanel implements FocusListener {
/**
* Removes the document listener.
*
- * @param l the l
+ * @param l
+ * the l
*/
/*
* (non-Javadoc)
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/FileSelectorListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/FileSelectorListener.java
index d170b6c..500e1bf 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/FileSelectorListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/FileSelectorListener.java
@@ -21,25 +21,23 @@ package org.apache.uima.tools.docanalyzer;
import javax.swing.JComponent;
-
/**
- * The listener interface for receiving fileSelector events.
- * The class that is interested in processing a fileSelector
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addFileSelectorListener</code> method. When
- * the fileSelector event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving fileSelector events. The class that is interested in
+ * processing a fileSelector event implements this interface, and the object created with that class
+ * is registered with a component using the component's <code>addFileSelectorListener</code> method.
+ * When the fileSelector event occurs, that object's appropriate method is invoked.
*
-// * @see FileSelectorEvent
+ * // * @see FileSelectorEvent
*/
public interface FileSelectorListener {
-
+
/**
* File selected.
*
- * @param source the source
- * @param fileString the file string
+ * @param source
+ * the source
+ * @param fileString
+ * the file string
* @return true, if successful
*/
boolean fileSelected(JComponent source, String fileString);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java
index cb38133..a51e169 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/PrefsMediator.java
@@ -29,7 +29,6 @@ import java.util.prefs.Preferences;
import javax.swing.JButton;
-
/**
* The Class PrefsMediator.
*/
@@ -67,7 +66,7 @@ public class PrefsMediator {
/** The input file format. */
private String inputFileFormat;
-
+
/** The language. */
private String language;
@@ -79,7 +78,7 @@ public class PrefsMediator {
/** The xml tag. */
private String xmlTag;
-
+
/** The lenient. */
private boolean lenient;
@@ -92,7 +91,7 @@ public class PrefsMediator {
/** The Constant INPUTFILEFORMAT. */
private static final String INPUTFILEFORMAT = "inputFileFormat";
-
+
/** The Constant LANGUAGE. */
private static final String LANGUAGE = "language";
@@ -104,10 +103,10 @@ public class PrefsMediator {
/** The Constant INDIR. */
private static final String INDIR = "inDir";
-
+
/** The Constant XMLTAG. */
private static final String XMLTAG = "xmlTag";
-
+
/** The Constant LENIENT. */
private static final String LENIENT = "lenient";
@@ -163,7 +162,8 @@ public class PrefsMediator {
/**
* Sets the input dir.
*
- * @param inputDir The inputDir to set.
+ * @param inputDir
+ * The inputDir to set.
*/
public void setInputDir(String inputDir) {
this.inputDir = inputDir;
@@ -183,7 +183,8 @@ public class PrefsMediator {
/**
* Sets the output dir.
*
- * @param outputDir The outputDir to set.
+ * @param outputDir
+ * The outputDir to set.
*/
public void setOutputDir(String outputDir) {
this.outputDir = outputDir;
@@ -251,11 +252,12 @@ public class PrefsMediator {
}
/**
- * Gets index of last file separator character in a file path.
- * Supports File.separator but also / on Windows.
+ * Gets index of last file separator character in a file path. Supports File.separator but also /
+ * on Windows.
*
- * @param path the path
- * @return index of the last file separator char. Returns -1 if none.
+ * @param path
+ * the path
+ * @return index of the last file separator char. Returns -1 if none.
*/
private int indexOfLastFileSeparator(String path) {
int index = path.lastIndexOf(File.separator);
@@ -268,7 +270,8 @@ public class PrefsMediator {
/**
* Sets the TA efile.
*
- * @param edir set the TAE directory
+ * @param edir
+ * set the TAE directory
*/
public void setTAEfile(String edir) {
taeDir = edir;
@@ -287,13 +290,14 @@ public class PrefsMediator {
/**
* Sets the encoding.
*
- * @param encoding The encoding to set.
+ * @param encoding
+ * The encoding to set.
*/
public void setEncoding(String encoding) {
this.encoding = encoding;
prefs.put(ENCODING, encoding);
}
-
+
/**
* Gets the input file format.
*
@@ -306,7 +310,8 @@ public class PrefsMediator {
/**
* Sets the input file format.
*
- * @param inputFileFormat The input file format to set.
+ * @param inputFileFormat
+ * The input file format to set.
*/
public void setInputFileFormat(String inputFileFormat) {
this.inputFileFormat = inputFileFormat;
@@ -325,7 +330,8 @@ public class PrefsMediator {
/**
* Sets the language.
*
- * @param language The language to set.
+ * @param language
+ * The language to set.
*/
public void setLanguage(String language) {
this.language = language;
@@ -344,7 +350,8 @@ public class PrefsMediator {
/**
* Sets the view type.
*
- * @param viewType The view type to set.
+ * @param viewType
+ * The view type to set.
*/
public void setViewType(String viewType) {
this.viewType = viewType;
@@ -363,7 +370,8 @@ public class PrefsMediator {
/**
* Sets the xml tag.
*
- * @param xmlTag The xmlTag to set.
+ * @param xmlTag
+ * The xmlTag to set.
*/
public void setXmlTag(String xmlTag) {
this.xmlTag = xmlTag;
@@ -382,15 +390,16 @@ public class PrefsMediator {
/**
* Sets the lenient.
*
- * @param lenient The lenient to set.
+ * @param lenient
+ * The lenient to set.
*/
public void setLenient(Boolean lenient) {
this.lenient = lenient;
prefs.putBoolean(LENIENT, lenient);
}
-
+
/**
- * returns the new edited stylemap file.
+ * returns the new edited stylemap file.
*
* @return the stylemap file
*/
@@ -402,9 +411,12 @@ public class PrefsMediator {
/**
* Sets the doc buttons.
*
- * @param run the run
- * @param inter the inter
- * @param view the view
+ * @param run
+ * the run
+ * @param inter
+ * the inter
+ * @param view
+ * the view
*/
// gets copies of buttonreference se it can mediate their on-ness
public void setDocButtons(JButton run, JButton inter, JButton view) {
@@ -418,9 +430,12 @@ public class PrefsMediator {
/**
* Sets the file selectors.
*
- * @param input the input
- * @param output the output
- * @param xml the xml
+ * @param input
+ * the input
+ * @param output
+ * the output
+ * @param xml
+ * the xml
*/
// sets the File Seelctors
public void setFileSelectors(FileSelector input, FileSelector output, FileSelector xml) {
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfDocumentListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfDocumentListener.java
index 415a2cc..f682810 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfDocumentListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfDocumentListener.java
@@ -22,22 +22,22 @@ package org.apache.uima.tools.docanalyzer;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
-
/**
* * This class tells the Mediator to check the length of the 3 text fields and adjust whether the 3
* buttons are enabeld or not.
*
-// * @see TfDocumentEvent
+ * // * @see TfDocumentEvent
*/
public class TfDocumentListener implements DocumentListener {
-
+
/** The med. */
private PrefsMediator med;
/**
* Instantiates a new tf document listener.
*
- * @param med the med
+ * @param med
+ * the med
*/
public TfDocumentListener(PrefsMediator med) {
this.med = med;
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfFileSelectorListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfFileSelectorListener.java
index 4e5efe8..446a8bf 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfFileSelectorListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfFileSelectorListener.java
@@ -21,22 +21,22 @@ package org.apache.uima.tools.docanalyzer;
import javax.swing.JComponent;
-
/**
* * This class tells the Mediator to check the length of the 3 text fields and adjust whether the 3
* buttons are enabeld or not.
*
-// * @see TfFileSelectorEvent
+ * // * @see TfFileSelectorEvent
*/
public class TfFileSelectorListener implements FileSelectorListener {
-
+
/** The med. */
private PrefsMediator med;
/**
* Instantiates a new tf file selector listener.
*
- * @param med the med
+ * @param med
+ * the med
*/
public TfFileSelectorListener(PrefsMediator med) {
this.med = med;
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfFocusListener.java b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfFocusListener.java
index faabb09..009bb28 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfFocusListener.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/docanalyzer/TfFocusListener.java
@@ -22,22 +22,22 @@ package org.apache.uima.tools.docanalyzer;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
-
/**
* This class tells the Mediator to check the lenght of the 3 text fields and adjust whether the 3
* buttons are enabeld or not.
*
-// * @see TfFocusEvent
+ * // * @see TfFocusEvent
*/
public class TfFocusListener implements FocusListener {
-
+
/** The med. */
private PrefsMediator med;
/**
* Instantiates a new tf focus listener.
*
- * @param med the med
+ * @param med
+ * the med
*/
public TfFocusListener(PrefsMediator med) {
this.med = med;
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GUI.java b/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GUI.java
index 846c63e..304909d 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GUI.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GUI.java
@@ -46,12 +46,11 @@ import javax.swing.UnsupportedLookAndFeelException;
import org.apache.uima.tools.images.Images;
import org.apache.uima.tools.util.gui.AboutDialog;
-
/**
* The Class GUI.
*/
public class GUI extends JFrame {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 1L;
@@ -71,7 +70,7 @@ public class GUI extends JFrame {
* The Class G.
*/
class G extends JPanel implements ActionListener {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 1L;
@@ -144,7 +143,8 @@ public class GUI extends JFrame {
/**
* Instantiates a new g.
*
- * @param gui the gui
+ * @param gui
+ * the gui
*/
public G(GUI gui) {
this.gui = gui;
@@ -261,7 +261,9 @@ public class GUI extends JFrame {
add(lbResult);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/
@Override
@@ -284,7 +286,8 @@ public class GUI extends JFrame {
/**
* Browse file.
*
- * @param f the f
+ * @param f
+ * the f
*/
void browseFile(JTextArea f) {
String startingDir = f.getText();
@@ -306,7 +309,8 @@ public class GUI extends JFrame {
/**
* Browse dir.
*
- * @param f the f
+ * @param f
+ * the f
*/
void browseDir(JTextArea f) {
String startingDir = f.getText();
@@ -345,13 +349,14 @@ public class GUI extends JFrame {
/**
* Show in status.
*
- * @param message the message
+ * @param message
+ * the message
* @return the string
*/
String showInStatus(String message) {
taStatus.setText(taStatus.getText() + message + NL);
- areaScrollPane.getVerticalScrollBar().setValue(
- areaScrollPane.getVerticalScrollBar().getMaximum());
+ areaScrollPane.getVerticalScrollBar()
+ .setValue(areaScrollPane.getVerticalScrollBar().getMaximum());
gui.repaint();
return message;
}
@@ -363,7 +368,8 @@ public class GUI extends JFrame {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
// for testing only
public static void main(String args[]) {
@@ -380,7 +386,8 @@ public class GUI extends JFrame {
/**
* Instantiates a new gui.
*
- * @param jg the jg
+ * @param jg
+ * the jg
*/
public GUI(Jg jg) {
super("JCasGen");
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GuiErrorImpl.java b/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GuiErrorImpl.java
index 4c27270..2259e60 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GuiErrorImpl.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GuiErrorImpl.java
@@ -27,12 +27,11 @@ import org.apache.uima.tools.jcasgen.Jg.ErrorExit;
import org.apache.uima.util.Level;
import org.apache.uima.util.Logger;
-
/**
* The Class GuiErrorImpl.
*/
public class GuiErrorImpl implements IError {
-
+
/** The sev msg. */
private static String[] sevMsg = new String[] { "Info", "Warning", "Error" };
@@ -47,8 +46,8 @@ public class GuiErrorImpl implements IError {
@Override
public void newError(int severity, String message, Exception exception) {
Logger log = UIMAFramework.getLogger();
- log.log(logLevels[severity], GUI.theGUI.pnG.showInStatus("JCasGen " + sevMsg[severity] + ": "
- + message), exception);
+ log.log(logLevels[severity],
+ GUI.theGUI.pnG.showInStatus("JCasGen " + sevMsg[severity] + ": " + message), exception);
if (null != exception) {
ByteArrayOutputStream b = new ByteArrayOutputStream();
PrintStream ps = new PrintStream(b);
diff --git a/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GuiProgressMonitor.java b/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GuiProgressMonitor.java
index a9fc159..f12dde5 100644
--- a/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GuiProgressMonitor.java
+++ b/uimaj-tools/src/main/java/org/apache/uima/tools/jcasgen/GuiProgressMonitor.java
@@ -22,20 +22,23 @@ package org.apache.uima.tools.jcasgen;
... 7236 lines suppressed ...
[uima-uimaj] 02/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit 4ea1cae4f9b78068bacd848df0ff2ff95ae39809
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 14:57:55 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../uima/adapter/vinci/CASTransportable.java | 188 +++++++++++++--------
.../vinci/VinciAnalysisEngineServiceAdapter.java | 22 ++-
.../vinci/VinciAnalysisEngineServiceStub.java | 126 ++++++++------
.../vinci/VinciAnalysisEngineService_impl.java | 80 +++++----
.../VinciBinaryAnalysisEngineServiceStub.java | 93 +++++-----
.../VinciBinaryAnalysisEngineService_impl.java | 75 +++++---
.../apache/uima/adapter/vinci/util/Constants.java | 2 +-
.../apache/uima/adapter/vinci/util/Descriptor.java | 42 +++--
.../adapter/vinci/util/SaxVinciFrameBuilder.java | 51 +++---
.../apache/uima/adapter/vinci/util/Shutdown.java | 3 +-
.../vinci/util/UimaSaxVinciFrameBuilder.java | 20 ++-
.../uima/adapter/vinci/util/VinciSaxParser.java | 24 ++-
.../uima/adapter/vinci/util/VinciTAEClient.java | 3 +-
.../VinciAnalysisEngineServiceAdapterTest.java | 56 +++---
14 files changed, 469 insertions(+), 316 deletions(-)
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/CASTransportable.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/CASTransportable.java
index 4f220e5..d965c47 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/CASTransportable.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/CASTransportable.java
@@ -77,10 +77,14 @@ public class CASTransportable extends DefaultHandler implements Transportable {
* This constructor is used on the service side - a CAS Pool reference is provided. We don't check
* a CAS out of the pool until we get a request.
*
- * @param casPool the cas pool
- * @param outOfTypeSystemData the out of type system data
- * @param uimaContext the uima context
- * @param includeDocText the include doc text
+ * @param casPool
+ * the cas pool
+ * @param outOfTypeSystemData
+ * the out of type system data
+ * @param uimaContext
+ * the uima context
+ * @param includeDocText
+ * the include doc text
*/
public CASTransportable(CasPool casPool, OutOfTypeSystemData outOfTypeSystemData,
UimaContext uimaContext, boolean includeDocText) {
@@ -97,13 +101,17 @@ public class CASTransportable extends DefaultHandler implements Transportable {
* This constructor is used on the client side, where we have a dedicated CAS instance for the
* request.
*
- * @param cas the cas
- * @param outOfTypeSystemData the out of type system data
- * @param uimaContext the uima context
- * @param includeDocText the include doc text
+ * @param cas
+ * the cas
+ * @param outOfTypeSystemData
+ * the out of type system data
+ * @param uimaContext
+ * the uima context
+ * @param includeDocText
+ * the include doc text
*/
- public CASTransportable(CAS cas, OutOfTypeSystemData outOfTypeSystemData,
- UimaContext uimaContext, boolean includeDocText) {
+ public CASTransportable(CAS cas, OutOfTypeSystemData outOfTypeSystemData, UimaContext uimaContext,
+ boolean includeDocText) {
// Debug.p("Creating new CASTransportable.");
this.myCas = cas;
this.myCasPool = null;
@@ -143,7 +151,8 @@ public class CASTransportable extends DefaultHandler implements Transportable {
/**
* Sets the command.
*
- * @param command the new command
+ * @param command
+ * the new command
*/
public void setCommand(String command) {
this.command = command;
@@ -163,7 +172,7 @@ public class CASTransportable extends DefaultHandler implements Transportable {
* XCASSerializer.
*/
class XTalkSerializer extends DefaultHandler {
-
+
/** The os. */
OutputStream os;
@@ -174,15 +183,19 @@ public class CASTransportable extends DefaultHandler implements Transportable {
/**
* Instantiates a new x talk serializer.
*
- * @param os the os
- * @param s the s
+ * @param os
+ * the os
+ * @param s
+ * the s
*/
XTalkSerializer(OutputStream os, XCASSerializer s) {
this.os = os;
this.serializer = s;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.xml.sax.helpers.DefaultHandler#startDocument()
*/
@Override
@@ -228,8 +241,10 @@ public class CASTransportable extends DefaultHandler implements Transportable {
/**
* Attributes to X talk.
*
- * @param attributes the attributes
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param attributes
+ * the attributes
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
void attributesToXTalk(org.xml.sax.Attributes attributes) throws IOException {
int size = attributes.getLength();
@@ -241,8 +256,11 @@ public class CASTransportable extends DefaultHandler implements Transportable {
}
}
- /* (non-Javadoc)
- * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String, java.lang.String)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String,
+ * java.lang.String)
*/
@Override
public void endElement(String uri, String name, String qName) throws SAXException {
@@ -250,8 +268,11 @@ public class CASTransportable extends DefaultHandler implements Transportable {
// Debug.p("Ending element: " + qName);
}
- /* (non-Javadoc)
- * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String,
+ * java.lang.String, org.xml.sax.Attributes)
*/
@Override
public void startElement(String uri, String name, String qName, org.xml.sax.Attributes atts)
@@ -276,7 +297,9 @@ public class CASTransportable extends DefaultHandler implements Transportable {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int)
*/
@Override
@@ -291,7 +314,9 @@ public class CASTransportable extends DefaultHandler implements Transportable {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.vinci.transport.Transportable#fromStream(java.io.InputStream)
*/
@Override
@@ -305,9 +330,9 @@ public class CASTransportable extends DefaultHandler implements Transportable {
// Debug.p("...done parsing.");
done = true;
} catch (SAXException e) {
- //if SAXException wraps an IOException, throw the IOException. This is
- //important since different types of IOExceptions (e.g. SocketTimeoutExceptions)
- //are treated differently by Vinci
+ // if SAXException wraps an IOException, throw the IOException. This is
+ // important since different types of IOExceptions (e.g. SocketTimeoutExceptions)
+ // are treated differently by Vinci
throw convertToIOException(e);
} finally {
if (!done) {
@@ -325,8 +350,10 @@ public class CASTransportable extends DefaultHandler implements Transportable {
* Serialize the CAS to the stream in XTalk format. After serialization is complete the cas is
* returned to the pool (if it was allocated from a pool.)
*
- * @param os the os
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param os
+ * the os
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
@Override
public void toStream(OutputStream os) throws IOException {
@@ -340,9 +367,9 @@ public class CASTransportable extends DefaultHandler implements Transportable {
try {
xcasSerializer.serialize(myCas, s, includeDocText, outOfTypeSystemData);
} catch (org.xml.sax.SAXException e) {
- //if SAXException wraps an IOException, throw the IOException. This is
- //important since different types of IOExceptions (e.g. SocketTimeoutExceptions)
- //are treated differently by Vinci
+ // if SAXException wraps an IOException, throw the IOException. This is
+ // important since different types of IOExceptions (e.g. SocketTimeoutExceptions)
+ // are treated differently by Vinci
throw convertToIOException(e);
}
UIMAFramework.getLogger().log(Level.FINEST, "CAS Serialization Complete.");
@@ -368,7 +395,9 @@ public class CASTransportable extends DefaultHandler implements Transportable {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#finalize()
*/
@Override
@@ -383,8 +412,11 @@ public class CASTransportable extends DefaultHandler implements Transportable {
}
}
- /* (non-Javadoc)
- * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String,
+ * java.lang.String, org.xml.sax.Attributes)
*/
@Override
public void startElement(String uri, String name, String qName, org.xml.sax.Attributes atts)
@@ -404,8 +436,8 @@ public class CASTransportable extends DefaultHandler implements Transportable {
}
if (Constants.KEYS.equals(qName)) {
// the data inside the KEYS element is the contents of an incoming CAS.
- // So this is where we need to grab a CAS from the CasPool and initialize
- //the XCASDeserializer.
+ // So this is where we need to grab a CAS from the CasPool and initialize
+ // the XCASDeserializer.
if (myCas == null) {
myCas = myCasPool.getCas(0);
}
@@ -419,13 +451,16 @@ public class CASTransportable extends DefaultHandler implements Transportable {
}
handler.startDocument();
handler.startElement("", "CAS", "CAS", null);
- //set the ready flag to indicate that following elements are CAS data
+ // set the ready flag to indicate that following elements are CAS data
ready++;
}
}
- /* (non-Javadoc)
- * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String, java.lang.String)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String,
+ * java.lang.String)
*/
@Override
public void endElement(String uri, String name, String qName) throws SAXException {
@@ -442,7 +477,9 @@ public class CASTransportable extends DefaultHandler implements Transportable {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int)
*/
@Override
@@ -480,48 +517,51 @@ public class CASTransportable extends DefaultHandler implements Transportable {
@Override
public void endDocument() throws SAXException {
}
-
+
/**
- * Create a SAXException that wraps the given IOException.
- * The wrapping is done using the standard Java 1.4 mechanism,
- * so that getCause() will work. Note that new SAXException(Exception)
- * does NOT work.
- * @param e an IOException to wrap
+ * Create a SAXException that wraps the given IOException. The wrapping is done using the standard
+ * Java 1.4 mechanism, so that getCause() will work. Note that new SAXException(Exception) does
+ * NOT work.
+ *
+ * @param e
+ * an IOException to wrap
* @return a SAX exception for which <code>getCause()</code> will return <code>e</code>.
*/
public SAXException wrapAsSAXException(IOException e) {
- SAXException saxEx =new SAXException(e.getMessage());
+ SAXException saxEx = new SAXException(e.getMessage());
saxEx.initCause(e);
return saxEx;
}
-
+
/**
- * Converts a Throwable to an IOException. If <code>t</code> is an IOException,
- * then <code>t</code> is returned. If not, then if <code>t</code> was caused
- * by an IOException (directly or indirectly), then that IOException is returned.
- * Otherwise, a new IOException is created which wraps (is caused by) <code>t</code>.
- * @param t the throwable to convert
- * @return an IOException which is either t, one of the causes of t, or a new IOException
- * that wraps t.
+ * Converts a Throwable to an IOException. If <code>t</code> is an IOException, then
+ * <code>t</code> is returned. If not, then if <code>t</code> was caused by an IOException
+ * (directly or indirectly), then that IOException is returned. Otherwise, a new IOException is
+ * created which wraps (is caused by) <code>t</code>.
+ *
+ * @param t
+ * the throwable to convert
+ * @return an IOException which is either t, one of the causes of t, or a new IOException that
+ * wraps t.
*/
private IOException convertToIOException(Throwable t) {
- //if t is itself an IOException, just return it
- if (t instanceof IOException) {
- return (IOException)t;
- }
-
- //search for a cause that is an IOException. If one is found, return that.
- Throwable cause = t.getCause();
- while (cause != null) {
- if (cause instanceof IOException) {
- return (IOException)cause;
- }
- cause = cause.getCause();
- }
-
- //otherwise, wrap t in a new IOException
- IOException ioex = new IOException();
- ioex.initCause(t);
- return ioex;
- }
+ // if t is itself an IOException, just return it
+ if (t instanceof IOException) {
+ return (IOException) t;
+ }
+
+ // search for a cause that is an IOException. If one is found, return that.
+ Throwable cause = t.getCause();
+ while (cause != null) {
+ if (cause instanceof IOException) {
+ return (IOException) cause;
+ }
+ cause = cause.getCause();
+ }
+
+ // otherwise, wrap t in a new IOException
+ IOException ioex = new IOException();
+ ioex.initCause(t);
+ return ioex;
+ }
}
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceAdapter.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceAdapter.java
index d0cbb36..39bb6c9 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceAdapter.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceAdapter.java
@@ -38,10 +38,13 @@ public class VinciAnalysisEngineServiceAdapter extends AnalysisEngineServiceAdap
/**
* Initialize.
*
- * @param aSpecifier the a specifier
- * @param aAdditionalParams the a additional params
+ * @param aSpecifier
+ * the a specifier
+ * @param aAdditionalParams
+ * the a additional params
* @return true, if successful
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
* @see org.apache.uima.resource.Resource#initialize(ResourceSpecifier, Map)
*/
@Override
@@ -67,8 +70,8 @@ public class VinciAnalysisEngineServiceAdapter extends AnalysisEngineServiceAdap
setStub(new VinciAnalysisEngineServiceStub(uriSpec.getUri(), uriSpec.getTimeout(), this,
uriSpec.getParameters()));
} else {
- setStub(new VinciBinaryAnalysisEngineServiceStub(uriSpec.getUri(), uriSpec.getTimeout(),
- this, uriSpec.getParameters()));
+ setStub(new VinciBinaryAnalysisEngineServiceStub(uriSpec.getUri(), uriSpec.getTimeout(), this,
+ uriSpec.getParameters()));
}
// do superclass initialization, which among other things initializes UimaContext.
@@ -76,13 +79,14 @@ public class VinciAnalysisEngineServiceAdapter extends AnalysisEngineServiceAdap
// superclass initialization depends on having access to the component metadata.
super.initialize(aSpecifier, aAdditionalParams);
- // Sofa mappings are currently not implemented for remote AEs. Catch this
+ // Sofa mappings are currently not implemented for remote AEs. Catch this
// and report an error.
if (getUimaContextAdmin().getSofaMap().size() > 0) {
- throw new ResourceInitializationException(ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE,
- new Object[]{getMetaData().getName()});
+ throw new ResourceInitializationException(
+ ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE,
+ new Object[] { getMetaData().getName() });
}
-
+
return true;
}
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java
index 2580ceb..387a704 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceStub.java
@@ -53,18 +53,18 @@ import org.apache.vinci.transport.document.AFrame;
* The Class VinciAnalysisEngineServiceStub.
*/
public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub {
-
+
/** The m vinci client. */
private VinciClient mVinciClient;
/** The m owner. */
private Resource mOwner;
-
+
/**
* Timeout to use for process and collectionProcessComplete calls.
*/
private int mTimeout;
-
+
/**
* Timeout to use for getMetaData calls.
*/
@@ -72,20 +72,23 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
/** The Constant debug. */
private static final boolean debug = System.getProperty("DEBUG") != null;
-
+
/**
- * Value to return from callGetSupportedXCasVersions method for older services
- * that don't actually implement this method.
+ * Value to return from callGetSupportedXCasVersions method for older services that don't actually
+ * implement this method.
*/
- private static final List SUPPORT_XCAS_V1 = Collections.unmodifiableList(
- Arrays.asList(new String[]{"1"}));
-
+ private static final List SUPPORT_XCAS_V1 = Collections
+ .unmodifiableList(Arrays.asList(new String[] { "1" }));
+
/**
* Instantiates a new vinci analysis engine service stub.
*
- * @param endpointURI the endpoint URI
- * @param owner the owner
- * @throws ResourceInitializationException the resource initialization exception
+ * @param endpointURI
+ * the endpoint URI
+ * @param owner
+ * the owner
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
public VinciAnalysisEngineServiceStub(String endpointURI, Resource owner)
throws ResourceInitializationException {
@@ -95,11 +98,16 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
/**
* Instantiates a new vinci analysis engine service stub.
*
- * @param endpointURI the endpoint URI
- * @param timeout the timeout
- * @param owner the owner
- * @param parameters the parameters
- * @throws ResourceInitializationException the resource initialization exception
+ * @param endpointURI
+ * the endpoint URI
+ * @param timeout
+ * the timeout
+ * @param owner
+ * the owner
+ * @param parameters
+ * the parameters
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
public VinciAnalysisEngineServiceStub(String endpointURI, Integer timeout, Resource owner,
Parameter[] parameters) throws ResourceInitializationException {
@@ -110,30 +118,29 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
VinciContext vctx = new VinciContext(InetAddress.getLocalHost().getCanonicalHostName(), 0);
// Override vinci default VNS settings
String vnsHost = null;
- String vnsPort = null;
- String getMetaDataTimeout = null;
+ String vnsPort = null;
+ String getMetaDataTimeout = null;
if (parameters != null) {
- vnsHost =
- VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("VNS_HOST", parameters);
- vnsPort = VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("VNS_PORT",
- parameters);
- getMetaDataTimeout = VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("GetMetaDataTimeout", parameters);
+ vnsHost = VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("VNS_HOST", parameters);
+ vnsPort = VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("VNS_PORT", parameters);
+ getMetaDataTimeout = VinciBinaryAnalysisEngineServiceStub
+ .getParameterValueFor("GetMetaDataTimeout", parameters);
}
if (vnsHost == null) {
vnsHost = System.getProperty("VNS_HOST");
if (vnsHost == null) {
- vnsHost = Constants.DEFAULT_VNS_HOST;
+ vnsHost = Constants.DEFAULT_VNS_HOST;
}
}
if (vnsPort == null) {
vnsPort = System.getProperty("VNS_PORT");
if (vnsPort == null) {
- vnsPort = "9000";
+ vnsPort = "9000";
}
}
vctx.setVNSHost(vnsHost);
vctx.setVNSPort(Integer.parseInt(vnsPort));
-
+
// Override socket keepAlive setting
vctx.setSocketKeepAliveEnabled(isSocketKeepAliveEnabled());
@@ -141,22 +148,22 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
System.out.println("Establishing connnection to " + endpointURI + " using VNS_HOST:"
+ vctx.getVNSHost() + " and VNS_PORT=" + vctx.getVNSPort());
}
-
+
// establish connection to service
mVinciClient = new VinciClient(endpointURI, AFrame.getAFrameFactory(), vctx);
-
- //store timeout for use in later RPC calls
+
+ // store timeout for use in later RPC calls
if (timeout != null) {
mTimeout = timeout;
} else {
- mTimeout = mVinciClient.getSocketTimeout(); //default
+ mTimeout = mVinciClient.getSocketTimeout(); // default
}
if (getMetaDataTimeout != null) {
mGetMetaDataTimeout = Integer.parseInt(getMetaDataTimeout);
} else {
- mGetMetaDataTimeout = mVinciClient.getSocketTimeout(); //default
+ mGetMetaDataTimeout = mVinciClient.getSocketTimeout(); // default
}
-
+
if (debug) {
System.out.println("Success");
}
@@ -165,12 +172,12 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
}
}
-
/**
* Call get meta data.
*
* @return the resource meta data
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
* @see ResourceServiceStub#callGetMetaData()
*/
@Override
@@ -224,8 +231,10 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
/**
* Call process.
*
- * @param aCAS the a CAS
- * @throws ResourceServiceException the resource service exception
+ * @param aCAS
+ * the a CAS
+ * @throws ResourceServiceException
+ * the resource service exception
* @see AnalysisEngineServiceStub#callProcess(CAS)
*/
@Override
@@ -236,8 +245,10 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
/**
* Call process cas.
*
- * @param aCAS the a CAS
- * @throws ResourceServiceException the resource service exception
+ * @param aCAS
+ * the a CAS
+ * @throws ResourceServiceException
+ * the resource service exception
* @see CasObjectProcessor#processCas(CAS)
*/
public void callProcessCas(CAS aCAS) throws ResourceServiceException {
@@ -247,15 +258,18 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
/**
* The actual process call.
*
- * @param aCAS the a CAS
- * @throws ResourceServiceException the resource service exception
+ * @param aCAS
+ * the a CAS
+ * @throws ResourceServiceException
+ * the resource service exception
*/
private void doProcess(CAS aCAS) throws ResourceServiceException {
try {
aCAS = ((CASImpl) aCAS).getBaseCAS();
// create CASTransportable ... always send the base CAS
- final CASTransportable query = new CASTransportable(aCAS, null, mOwner.getUimaContext(), true);
+ final CASTransportable query = new CASTransportable(aCAS, null, mOwner.getUimaContext(),
+ true);
query.setCommand("Annotate");
mVinciClient.sendAndReceive(query, new TransportableFactory() {
@@ -292,7 +306,8 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
/**
* Call batch process complete.
*
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
* @see CasObjectProcessor#batchProcessComplete(org.apache.uima.util.ProcessTrace)
*/
@Override
@@ -312,7 +327,8 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
/**
* Call collection process complete.
*
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
* @see CasObjectProcessor#collectionProcessComplete(org.apache.uima.util.ProcessTrace)
*/
@Override
@@ -334,7 +350,8 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
* Call is read only.
*
* @return true, if successful
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
* @see CasObjectProcessor#isReadOnly()
*/
public boolean callIsReadOnly() throws ResourceServiceException {
@@ -357,7 +374,8 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
* Call is stateless.
*
* @return true, if successful
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
* @see CasObjectProcessor#isStateless()
*/
public boolean callIsStateless() throws ResourceServiceException {
@@ -380,7 +398,8 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
* Call get supported X cas versions.
*
* @return the list
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
*/
public List callGetSupportedXCasVersions() throws ResourceServiceException {
try {
@@ -395,8 +414,7 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
if (result != null) {
String[] versions = result.split("\\s+");
return Collections.unmodifiableList(Arrays.asList(versions));
- }
- else {
+ } else {
return SUPPORT_XCAS_V1;
}
} catch (Exception e) {
@@ -405,16 +423,16 @@ public class VinciAnalysisEngineServiceStub implements AnalysisEngineServiceStub
}
/**
- * Gets whether socket keepAlive is enabled, by consulting the
- * PerformanceTuningSettings. (If no setting specified, defaults
- * to true.)
+ * Gets whether socket keepAlive is enabled, by consulting the PerformanceTuningSettings. (If no
+ * setting specified, defaults to true.)
+ *
* @return if socketKeepAlive is enabled
*/
protected boolean isSocketKeepAliveEnabled() {
if (mOwner instanceof AnalysisEngine) {
- Properties settings = ((AnalysisEngine)mOwner).getPerformanceTuningSettings();
+ Properties settings = ((AnalysisEngine) mOwner).getPerformanceTuningSettings();
if (settings != null) {
- String enabledStr = (String)settings.get(UIMAFramework.SOCKET_KEEPALIVE_ENABLED);
+ String enabledStr = (String) settings.get(UIMAFramework.SOCKET_KEEPALIVE_ENABLED);
return !"false".equalsIgnoreCase(enabledStr);
}
}
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java
index 9dcd291..3e90d0c 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineService_impl.java
@@ -58,7 +58,7 @@ import org.apache.vinci.transport.document.AFrame;
* The main method takes one argument - the path to the service deployment descriptor.
*/
public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
-
+
/** The server. */
private VinciServer _server = null;
@@ -81,10 +81,14 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
/**
* Instantiate Analysis Engine from a given descriptor, debug mode, and instance Id.
*
- * @param serviceConfigPath descriptor location
- * @param debug the debug
- * @param instanceId the instance id
- * @throws Exception passthru
+ * @param serviceConfigPath
+ * descriptor location
+ * @param debug
+ * the debug
+ * @param instanceId
+ * the instance id
+ * @throws Exception
+ * passthru
*/
public VinciAnalysisEngineService_impl(String serviceConfigPath, boolean debug, String instanceId)
throws Exception {
@@ -95,9 +99,12 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
/**
* Instantiate Analysis Engine service from a given descriptor - possibly in debug mode.
*
- * @param serviceConfigPath descriptor location
- * @param debug the debug
- * @throws Exception the exception
+ * @param serviceConfigPath
+ * descriptor location
+ * @param debug
+ * the debug
+ * @throws Exception
+ * the exception
*/
public VinciAnalysisEngineService_impl(String serviceConfigPath, boolean debug) throws Exception {
this.debug = debug;
@@ -111,15 +118,15 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
UIMAFramework.getLogger().log(Level.CONFIG,
"Resource Specifier Path::" + aResourceSpecifierPath);
- ResourceSpecifier resourceSpecifier = UIMAFramework.getXMLParser().parseResourceSpecifier(
- new XMLInputSource(aResourceSpecifierPath));
+ ResourceSpecifier resourceSpecifier = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(new XMLInputSource(aResourceSpecifierPath));
// create CAS Object Processor
if (mAE == null) {
UIMAFramework.getLogger().log(Level.FINE,
"VinciAnalysisEngineService_impl: creating CAS Processor");
- mAE = UIMAFramework
- .produceAnalysisEngine(resourceSpecifier, descriptor.getInstanceCount(), 0);
+ mAE = UIMAFramework.produceAnalysisEngine(resourceSpecifier, descriptor.getInstanceCount(),
+ 0);
}
// create pool of CASes
if (mCasPool == null) {
@@ -138,8 +145,10 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
/**
* Instantiate Analysis Engine service from a given descriptor.
*
- * @param serviceConfigPath descriptor location
- * @throws Exception the exception
+ * @param serviceConfigPath
+ * descriptor location
+ * @throws Exception
+ * the exception
*/
public VinciAnalysisEngineService_impl(String serviceConfigPath) throws Exception {
this(serviceConfigPath, false);
@@ -149,7 +158,8 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
* Extracts AE metadata.
*
* @return Frame containing extracted meta data
- * @throws Exception the exception
+ * @throws Exception
+ * the exception
*/
private Frame getMetaData() throws Exception {
UIMAFramework.getLogger().log(Level.FINEST, "VinciAnalysisEngineService.getMetaData()");
@@ -179,9 +189,11 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
* containing XCAS translated into a set of Vinci subFrames. Each subframe containing one
* annotation with all its attributes.
*
- * @param ct the ct
+ * @param ct
+ * the ct
* @return VinciFrame containing XCAS translated into a set of Vinci subframes.
- * @exception Exception if there is an error during processing
+ * @exception Exception
+ * if there is an error during processing
*/
private Transportable analyze(CASTransportable ct) throws Exception {
CAS cas = ct.getCas();
@@ -219,11 +231,13 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
* VINCI:COMMAND. Currently, two such operations are supported: 1) Annotate - triggers document
* analysis 2) GetData - triggers return of the AE meta data ( descriptor)
*
- * @param doc {@link org.apache.vinci.transport.Transportable} -
- * a VinciFrame containing client request
+ * @param doc
+ * {@link org.apache.vinci.transport.Transportable} - a VinciFrame containing client
+ * request
* @return {@link org.apache.vinci.transport.Transportable} - a VinciFrame containg result of
* performing the service
- * @throws ServiceException the service exception
+ * @throws ServiceException
+ * the service exception
*/
@Override
public Transportable eval(Transportable doc) throws ServiceException {
@@ -293,15 +307,14 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
_server = new VinciServer(serviceName, serviceHost, this);
}
- UIMAFramework.getLogger().log(
- Level.FINEST,
+ UIMAFramework.getLogger().log(Level.FINEST,
"VinciAnalysisEngineService_impl: Starting Server with Socket Timeout:"
+ descriptor.getServerSocketTimeout());
- System.out
- .println("VinciAnalysisEngineService_impl: Starting Server with Socket Timeout:"
- + descriptor.getServerSocketTimeout());
+ System.out.println("VinciAnalysisEngineService_impl: Starting Server with Socket Timeout:"
+ + descriptor.getServerSocketTimeout());
_server.setSocketTimeout(descriptor.getServerSocketTimeout());
- _server.setThreadPoolSize(descriptor.getThreadPoolMinSize(), descriptor.getThreadPoolMaxSize());
+ _server.setThreadPoolSize(descriptor.getThreadPoolMinSize(),
+ descriptor.getThreadPoolMaxSize());
_server.serve();
} catch (ServiceDownException e) {
@@ -334,7 +347,8 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
try {
@@ -385,7 +399,8 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
/**
* Redirects all logger output for this JVM to the given output stream.
*
- * @param out the out
+ * @param out
+ * the out
*/
private static void redirectLoggerOutput(OutputStream out) {
// get root logger handlers - root logger is parent of all loggers
@@ -406,20 +421,23 @@ public class VinciAnalysisEngineService_impl extends VinciServableAdapter {
* Class that handles service shutdowns (including Ctrl-C).
*/
static class ShutdownHook extends Thread {
-
+
/** The server. */
VinciAnalysisEngineService_impl server;
/**
* Instantiates a new shutdown hook.
*
- * @param instance the instance
+ * @param instance
+ * the instance
*/
public ShutdownHook(VinciAnalysisEngineService_impl instance) {
server = instance;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Thread#run()
*/
@Override
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineServiceStub.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineServiceStub.java
index fd14d7b..6e6e433 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineServiceStub.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineServiceStub.java
@@ -66,32 +66,40 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
* Timeout to use for process and collectionProcessComplete calls.
*/
private int mTimeout;
-
+
/**
* Timeout to use for getMetaData calls.
*/
- private int mGetMetaDataTimeout;
-
+ private int mGetMetaDataTimeout;
+
/**
* Instantiates a new vinci binary analysis engine service stub.
*
- * @param endpointURI the endpoint URI
- * @param owner the owner
- * @throws ResourceInitializationException the resource initialization exception
+ * @param endpointURI
+ * the endpoint URI
+ * @param owner
+ * the owner
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
- public VinciBinaryAnalysisEngineServiceStub(String endpointURI, AnalysisEngineServiceAdapter owner)
- throws ResourceInitializationException {
+ public VinciBinaryAnalysisEngineServiceStub(String endpointURI,
+ AnalysisEngineServiceAdapter owner) throws ResourceInitializationException {
this(endpointURI, null, owner, null);
}
/**
* Instantiates a new vinci binary analysis engine service stub.
*
- * @param endpointURI the endpoint URI
- * @param timeout the timeout
- * @param owner the owner
- * @param parameters the parameters
- * @throws ResourceInitializationException the resource initialization exception
+ * @param endpointURI
+ * the endpoint URI
+ * @param timeout
+ * the timeout
+ * @param owner
+ * the owner
+ * @param parameters
+ * the parameters
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
public VinciBinaryAnalysisEngineServiceStub(String endpointURI, Integer timeout,
AnalysisEngineServiceAdapter owner, Parameter[] parameters)
@@ -103,14 +111,13 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
VinciContext vctx = new VinciContext(InetAddress.getLocalHost().getCanonicalHostName(), 0);
// Override vinci default VNS settings
String vnsHost = null;
- String vnsPort = null;
- String getMetaDataTimeout = null;
+ String vnsPort = null;
+ String getMetaDataTimeout = null;
if (parameters != null) {
- vnsHost =
- VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("VNS_HOST", parameters);
- vnsPort = VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("VNS_PORT",
- parameters);
- getMetaDataTimeout = VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("GetMetaDataTimeout", parameters);
+ vnsHost = VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("VNS_HOST", parameters);
+ vnsPort = VinciBinaryAnalysisEngineServiceStub.getParameterValueFor("VNS_PORT", parameters);
+ getMetaDataTimeout = VinciBinaryAnalysisEngineServiceStub
+ .getParameterValueFor("GetMetaDataTimeout", parameters);
}
if (vnsHost == null) {
vnsHost = System.getProperty("VNS_HOST");
@@ -124,7 +131,7 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
}
vctx.setVNSHost(vnsHost);
vctx.setVNSPort(Integer.parseInt(vnsPort));
-
+
// Override socket keepAlive setting
vctx.setSocketKeepAliveEnabled(isSocketKeepAliveEnabled());
@@ -132,22 +139,22 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
System.out.println("Establishing connnection to " + endpointURI + " using VNS_HOST:"
+ vctx.getVNSHost() + " and VNS_PORT=" + vctx.getVNSPort());
}
-
+
// establish connection to service
mVinciClient = new VinciClient(endpointURI, AFrame.getAFrameFactory(), vctx);
-
- //store timeout for use in later RPC calls
+
+ // store timeout for use in later RPC calls
if (timeout != null) {
mTimeout = timeout;
} else {
- mTimeout = mVinciClient.getSocketTimeout(); //default
+ mTimeout = mVinciClient.getSocketTimeout(); // default
}
if (getMetaDataTimeout != null) {
mGetMetaDataTimeout = Integer.parseInt(getMetaDataTimeout);
} else {
- mGetMetaDataTimeout = mVinciClient.getSocketTimeout(); //default
- }
-
+ mGetMetaDataTimeout = mVinciClient.getSocketTimeout(); // default
+ }
+
if (debug) {
System.out.println("Success");
}
@@ -159,8 +166,10 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
/**
* Gets the parameter value for.
*
- * @param aKey the a key
- * @param parameters the parameters
+ * @param aKey
+ * the a key
+ * @param parameters
+ * the parameters
* @return the parameter value for
*/
public static String getParameterValueFor(String aKey, Parameter[] parameters) {
@@ -178,7 +187,8 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
* Call get meta data.
*
* @return the resource meta data
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
* @see ResourceServiceStub#callGetMetaData()
*/
@Override
@@ -233,8 +243,10 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
/**
* Call process.
*
- * @param aCAS the a CAS
- * @throws ResourceServiceException the resource service exception
+ * @param aCAS
+ * the a CAS
+ * @throws ResourceServiceException
+ * the resource service exception
* @see AnalysisEngineServiceStub#callProcess(CAS)
*/
@Override
@@ -271,7 +283,8 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
/**
* Call batch process complete.
*
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
* @see AnalysisEngineServiceStub#callBatchProcessComplete()
*/
@Override
@@ -291,7 +304,8 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
/**
* Call collection process complete.
*
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
* @see AnalysisEngineServiceStub#callCollectionProcessComplete()
*/
@Override
@@ -319,17 +333,16 @@ public class VinciBinaryAnalysisEngineServiceStub implements AnalysisEngineServi
mVinciClient.close();
}
-
/**
- * Gets whether socket keepAlive is enabled, by consulting the
- * PerformanceTuningSettings. (If no setting specified, defaults
- * to true.)
+ * Gets whether socket keepAlive is enabled, by consulting the PerformanceTuningSettings. (If no
+ * setting specified, defaults to true.)
+ *
* @return if socketKeepAlive is enabled
*/
private boolean isSocketKeepAliveEnabled() {
Properties settings = mOwner.getPerformanceTuningSettings();
if (settings != null) {
- String enabledStr = (String)settings.get(UIMAFramework.SOCKET_KEEPALIVE_ENABLED);
+ String enabledStr = (String) settings.get(UIMAFramework.SOCKET_KEEPALIVE_ENABLED);
return !"false".equalsIgnoreCase(enabledStr);
}
return true;
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java
index dbd359c..4f80456 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/VinciBinaryAnalysisEngineService_impl.java
@@ -67,7 +67,7 @@ import org.apache.vinci.transport.document.AFrame;
*
*/
public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter {
-
+
/** The server. */
private VinciServer _server = null;
@@ -90,10 +90,14 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
/**
* Instantiate Analysis Engine from a given descriptor - possibly in debug mode.
*
- * @param serviceConfigPath descriptor location
- * @param debug the debug
- * @param instanceId the instance id
- * @throws Exception the exception
+ * @param serviceConfigPath
+ * descriptor location
+ * @param debug
+ * the debug
+ * @param instanceId
+ * the instance id
+ * @throws Exception
+ * the exception
*/
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath, boolean debug,
String instanceId) throws Exception {
@@ -105,9 +109,12 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
/**
* Instantiate Analysis Engine from a given descriptor - possibly in debug mode.
*
- * @param serviceConfigPath descriptor location
- * @param debug the debug
- * @throws Exception the exception
+ * @param serviceConfigPath
+ * descriptor location
+ * @param debug
+ * the debug
+ * @throws Exception
+ * the exception
*/
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath, boolean debug)
throws Exception {
@@ -122,15 +129,15 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
String aResourceSpecifierPath = descriptor.getResourceSpecifierPath();
UIMAFramework.getLogger().log(Level.FINE, "Resource Specifier Path::" + aResourceSpecifierPath);
- ResourceSpecifier resourceSpecifier = UIMAFramework.getXMLParser().parseResourceSpecifier(
- new XMLInputSource(aResourceSpecifierPath));
+ ResourceSpecifier resourceSpecifier = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(new XMLInputSource(aResourceSpecifierPath));
// create CAS Object Processor
if (mAE == null) {
UIMAFramework.getLogger().log(Level.FINEST,
"VinciBinaryAnalysisEngineService_impl: creating CAS Processor");
- mAE = UIMAFramework
- .produceAnalysisEngine(resourceSpecifier, descriptor.getInstanceCount(), 0);
+ mAE = UIMAFramework.produceAnalysisEngine(resourceSpecifier, descriptor.getInstanceCount(),
+ 0);
}
// create pool of CASes
if (mCasPool == null) {
@@ -141,8 +148,10 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
/**
* Instantiate Analysis Engine from a given descriptor.
*
- * @param serviceConfigPath descriptor location
- * @throws Exception the exception
+ * @param serviceConfigPath
+ * descriptor location
+ * @throws Exception
+ * the exception
*/
public VinciBinaryAnalysisEngineService_impl(String serviceConfigPath) throws Exception {
this(serviceConfigPath, false);
@@ -152,7 +161,8 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
* Extracts AE metadata.
*
* @return Frame containing extracted meta data
- * @throws Exception the exception
+ * @throws Exception
+ * the exception
*/
private Frame getMetaData() throws Exception {
UIMAFramework.getLogger().log(Level.FINEST, "getMetaData()");
@@ -182,9 +192,11 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
* VinciFrame containing XCAS translated into a set of Vinci subFrames. Each subframe containing
* one annotation with all its attributes.
*
- * @param aRequestFrame request frame
+ * @param aRequestFrame
+ * request frame
* @return VinciFrame containing XCAS translated into a set of Vinci subframes.
- * @throws ServiceException the service exception
+ * @throws ServiceException
+ * the service exception
*/
private Transportable analyze(AFrame aRequestFrame) throws ServiceException {
CAS cas = null;
@@ -244,11 +256,13 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
* VINCI:COMMAND. Currently, two such operations are supported: 1) Annotate - triggers document
* analysis 2) GetData - triggers return of the AE meta data ( descriptor)
*
- * @param doc {@link org.apache.vinci.transport.Transportable} -
- * a VinciFrame containing client request
+ * @param doc
+ * {@link org.apache.vinci.transport.Transportable} - a VinciFrame containing client
+ * request
* @return {@link org.apache.vinci.transport.Transportable} - a VinciFrame containg result of
* performing the service
- * @throws ServiceException the service exception
+ * @throws ServiceException
+ * the service exception
*/
@Override
@@ -316,15 +330,15 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
_server = new VinciServer(serviceName, serviceHost, this);
}
- UIMAFramework.getLogger().log(
- Level.FINEST,
+ UIMAFramework.getLogger().log(Level.FINEST,
"VinciBinaryAnalysisEngineService_impl: Starting Server with Socket Timeout:"
+ descriptor.getServerSocketTimeout());
System.out
.println("VinciBinaryAnalysisEngineService_impl: Starting Server with Socket Timeout:"
+ descriptor.getServerSocketTimeout());
_server.setSocketTimeout(descriptor.getServerSocketTimeout());
- _server.setThreadPoolSize(descriptor.getThreadPoolMinSize(), descriptor.getThreadPoolMaxSize());
+ _server.setThreadPoolSize(descriptor.getThreadPoolMinSize(),
+ descriptor.getThreadPoolMaxSize());
_server.serve();
} catch (ServiceDownException e) {
UIMAFramework.getLogger().log(Level.SEVERE, e.getMessage());
@@ -356,7 +370,8 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
try {
@@ -394,7 +409,8 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
/**
* Redirects all logger output for this JVM to the given output stream.
*
- * @param out the out
+ * @param out
+ * the out
*/
private static void redirectLoggerOutput(OutputStream out) {
// get root logger handlers - root logger is parent of all loggers
@@ -415,20 +431,23 @@ public class VinciBinaryAnalysisEngineService_impl extends VinciServableAdapter
* Class that handles service shutdowns (including Ctrl-C).
*/
static class ShutdownHook extends Thread {
-
+
/** The server. */
VinciBinaryAnalysisEngineService_impl server;
/**
* Instantiates a new shutdown hook.
*
- * @param instance the instance
+ * @param instance
+ * the instance
*/
public ShutdownHook(VinciBinaryAnalysisEngineService_impl instance) {
server = instance;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Thread#run()
*/
@Override
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Constants.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Constants.java
index 17d7a02..bceb567 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Constants.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Constants.java
@@ -79,7 +79,7 @@ public class Constants {
/** The Constant GET_SUPPORTED_XCAS_VERSIONS. */
public static final String GET_SUPPORTED_XCAS_VERSIONS = "GetSupportedXCasVersions";
-
+
/** The Constant SUPPORTED_XCAS_VERSIONS_RESPONSE. */
public static final String SUPPORTED_XCAS_VERSIONS_RESPONSE = "2";
}
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Descriptor.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Descriptor.java
index 8d73b03..dd89fd1 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Descriptor.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Descriptor.java
@@ -29,7 +29,6 @@ import org.w3c.dom.Document;
import org.xml.sax.Attributes;
import org.xml.sax.helpers.DefaultHandler;
-
// TODO: Auto-generated Javadoc
/**
* Instance of this class handles parsing of the xml descriptor files. It also retrieves values of
@@ -57,17 +56,18 @@ public class Descriptor extends DefaultHandler {
/** The server socket timeout. */
private int serverSocketTimeout = 300000; // 5 minute timeout on the service socket
-
+
/** The thread pool min size. */
private int threadPoolMinSize = 1;
-
+
/** The thread pool max size. */
private int threadPoolMaxSize = 20;
/**
* Constructor responsible for parsing the descriptor file named in filePath.
*
- * @param filePath Fully qualified path the xml descriptor.
+ * @param filePath
+ * Fully qualified path the xml descriptor.
*/
public Descriptor(String filePath) {
try {
@@ -80,7 +80,8 @@ public class Descriptor extends DefaultHandler {
/**
* Parses the.
*
- * @param configFile the config file
+ * @param configFile
+ * the config file
* @return the document
*/
private Document parse(String configFile) {
@@ -110,8 +111,10 @@ public class Descriptor extends DefaultHandler {
/**
* Gets the attribute.
*
- * @param attrName the attr name
- * @param attribs the attribs
+ * @param attrName
+ * the attr name
+ * @param attribs
+ * the attribs
* @return the attribute
*/
private String getAttribute(String attrName, Attributes attribs) {
@@ -131,8 +134,10 @@ public class Descriptor extends DefaultHandler {
/**
* Gets the name.
*
- * @param s1 the s 1
- * @param s2 the s 2
+ * @param s1
+ * the s 1
+ * @param s2
+ * the s 2
* @return the name
*/
private String getName(String s1, String s2) {
@@ -142,8 +147,11 @@ public class Descriptor extends DefaultHandler {
return s1;
}
- /* (non-Javadoc)
- * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String,
+ * java.lang.String, org.xml.sax.Attributes)
*/
@Override
public void startElement(String uri, String localName, String qName, Attributes attribs) {
@@ -206,7 +214,8 @@ public class Descriptor extends DefaultHandler {
/**
* Sets the thread pool max size.
*
- * @param threadPoolMaxSize the new thread pool max size
+ * @param threadPoolMaxSize
+ * the new thread pool max size
*/
public void setThreadPoolMaxSize(int threadPoolMaxSize) {
this.threadPoolMaxSize = threadPoolMaxSize;
@@ -224,7 +233,8 @@ public class Descriptor extends DefaultHandler {
/**
* Sets the thread pool min size.
*
- * @param threadPoolMinSize the new thread pool min size
+ * @param threadPoolMinSize
+ * the new thread pool min size
*/
public void setThreadPoolMinSize(int threadPoolMinSize) {
this.threadPoolMinSize = threadPoolMinSize;
@@ -318,7 +328,8 @@ public class Descriptor extends DefaultHandler {
/**
* Sets the naming service host.
*
- * @param namingServiceHost the new naming service host
+ * @param namingServiceHost
+ * the new naming service host
*/
public void setNamingServiceHost(String namingServiceHost) {
this.namingServiceHost = namingServiceHost;
@@ -336,7 +347,8 @@ public class Descriptor extends DefaultHandler {
/**
* Sets the server socket timeout.
*
- * @param serverSocketTimeout the new server socket timeout
+ * @param serverSocketTimeout
+ * the new server socket timeout
*/
public void setServerSocketTimeout(int serverSocketTimeout) {
this.serverSocketTimeout = serverSocketTimeout;
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/SaxVinciFrameBuilder.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/SaxVinciFrameBuilder.java
index fe503c7..09dffab 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/SaxVinciFrameBuilder.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/SaxVinciFrameBuilder.java
@@ -62,7 +62,8 @@ public class SaxVinciFrameBuilder extends DefaultHandler implements ContentHandl
/**
* Start document.
*
- * @throws SAXException the SAX exception
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#startDocument()
*/
@Override
@@ -75,13 +76,18 @@ public class SaxVinciFrameBuilder extends DefaultHandler implements ContentHandl
/**
* Called for each start tag encountered.
*
- * @param namespaceURI Required if the namespaces property is true.
- * @param localName The local name (without prefix), or the empty string if Namespace processing is not
+ * @param namespaceURI
+ * Required if the namespaces property is true.
+ * @param localName
+ * The local name (without prefix), or the empty string if Namespace processing is not
* being performed.
- * @param qualifiedName The qualified name (with prefix), or the empty string if qualified names are not
+ * @param qualifiedName
+ * The qualified name (with prefix), or the empty string if qualified names are not
* available.
- * @param attributes The specified or defaulted attributes.
- * @throws SAXException the SAX exception
+ * @param attributes
+ * The specified or defaulted attributes.
+ * @throws SAXException
+ * the SAX exception
*/
@Override
public void startElement(String namespaceURI, String localName, String qualifiedName,
@@ -106,8 +112,8 @@ public class SaxVinciFrameBuilder extends DefaultHandler implements ContentHandl
// set attributes
if (mCurrentFrameAttrs != null) {
for (int i = 0; i < mCurrentFrameAttrs.getLength(); i++) {
- String attrName = getName(mCurrentFrameAttrs.getLocalName(i), mCurrentFrameAttrs
- .getQName(i));
+ String attrName = getName(mCurrentFrameAttrs.getLocalName(i),
+ mCurrentFrameAttrs.getQName(i));
vinciAttrs.fadd(attrName, mCurrentFrameAttrs.getValue(i));
}
}
@@ -125,9 +131,12 @@ public class SaxVinciFrameBuilder extends DefaultHandler implements ContentHandl
/**
* Characters.
*
- * @param ch the ch
- * @param start the start
- * @param length the length
+ * @param ch
+ * the ch
+ * @param start
+ * the start
+ * @param length
+ * the length
* @see org.xml.sax.ContentHandler#characters(char[],int,int)
*/
@Override
@@ -138,9 +147,12 @@ public class SaxVinciFrameBuilder extends DefaultHandler implements ContentHandl
/**
* End element.
*
- * @param namespaceURI the namespace URI
- * @param localName the local name
- * @param qualifiedName the qualified name
+ * @param namespaceURI
+ * the namespace URI
+ * @param localName
+ * the local name
+ * @param qualifiedName
+ * the qualified name
* @see org.xml.sax.ContentHandler#endElement(String,String,String)
*/
@Override
@@ -152,18 +164,19 @@ public class SaxVinciFrameBuilder extends DefaultHandler implements ContentHandl
// the getLeafContent method just returns the contents of the
// mCharContentBuffer, but exists so subclasses can override for
// specialized behavior (such as supressing certain content).
- String leafContent = getLeafContent(mCurrentFrameName, mCurrentFrameAttrs, mCharContentBuffer);
+ String leafContent = getLeafContent(mCurrentFrameName, mCurrentFrameAttrs,
+ mCharContentBuffer);
// add leaf to parent frame
AFrame parent = (AFrame) mOpenFrames.peek();
- org.apache.vinci.transport.Attributes vinciAttrs = parent
- .aadd(mCurrentFrameName, leafContent);
+ org.apache.vinci.transport.Attributes vinciAttrs = parent.aadd(mCurrentFrameName,
+ leafContent);
// set attributes
if (mCurrentFrameAttrs != null) {
for (int i = 0; i < mCurrentFrameAttrs.getLength(); i++) {
- String attrName = getName(mCurrentFrameAttrs.getLocalName(i), mCurrentFrameAttrs
- .getQName(i));
+ String attrName = getName(mCurrentFrameAttrs.getLocalName(i),
+ mCurrentFrameAttrs.getQName(i));
vinciAttrs.fadd(attrName, mCurrentFrameAttrs.getValue(i));
}
}
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Shutdown.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Shutdown.java
index f9a0911..4114619 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Shutdown.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/Shutdown.java
@@ -31,7 +31,8 @@ public class Shutdown {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
System.out.println("Shutting down the service...");
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/UimaSaxVinciFrameBuilder.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/UimaSaxVinciFrameBuilder.java
index c84ffb2..1a99939 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/UimaSaxVinciFrameBuilder.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/UimaSaxVinciFrameBuilder.java
@@ -33,13 +33,16 @@ import org.xml.sax.Attributes;
*
*/
public class UimaSaxVinciFrameBuilder extends SaxVinciFrameBuilder {
-
+
/**
* Instantiates a new uima sax vinci frame builder.
*
- * @param aSupressDocumentText the a supress document text
- * @param aIncludeSpannedTextInAnnotations the a include spanned text in annotations
- * @param aDocText the a doc text
+ * @param aSupressDocumentText
+ * the a supress document text
+ * @param aIncludeSpannedTextInAnnotations
+ * the a include spanned text in annotations
+ * @param aDocText
+ * the a doc text
*/
public UimaSaxVinciFrameBuilder(boolean aSupressDocumentText,
boolean aIncludeSpannedTextInAnnotations, String aDocText) {
@@ -60,9 +63,12 @@ public class UimaSaxVinciFrameBuilder extends SaxVinciFrameBuilder {
/**
* Overridden to supress document content and include annotation spans.
*
- * @param aFrameName the a frame name
- * @param aAttributes the a attributes
- * @param aContentBuf the a content buf
+ * @param aFrameName
+ * the a frame name
+ * @param aAttributes
+ * the a attributes
+ * @param aContentBuf
+ * the a content buf
* @return the leaf content
* @see SaxVinciFrameBuilder#getLeafContent(String, Attributes, StringBuffer)
*/
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/VinciSaxParser.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/VinciSaxParser.java
index 7783cae..7ec934d 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/VinciSaxParser.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/VinciSaxParser.java
@@ -44,7 +44,8 @@ public class VinciSaxParser {
/**
* Sets the content handler.
*
- * @param aHandler the new content handler
+ * @param aHandler
+ * the new content handler
*/
public void setContentHandler(ContentHandler aHandler) {
mHandler = aHandler;
@@ -53,8 +54,10 @@ public class VinciSaxParser {
/**
* Parses the.
*
- * @param aFrame the a frame
- * @throws SAXException the SAX exception
+ * @param aFrame
+ * the a frame
+ * @throws SAXException
+ * the SAX exception
*/
public void parse(VinciFrame aFrame) throws SAXException {
parse(aFrame, true);
@@ -63,9 +66,12 @@ public class VinciSaxParser {
/**
* Parses the.
*
- * @param aFrame the a frame
- * @param aSendStartAndEndDocEvents the a send start and end doc events
- * @throws SAXException the SAX exception
+ * @param aFrame
+ * the a frame
+ * @param aSendStartAndEndDocEvents
+ * the a send start and end doc events
+ * @throws SAXException
+ * the SAX exception
*/
public void parse(VinciFrame aFrame, boolean aSendStartAndEndDocEvents) throws SAXException {
if (aSendStartAndEndDocEvents) {
@@ -82,8 +88,10 @@ public class VinciSaxParser {
/**
* Parses the.
*
- * @param aFrame the a frame
- * @throws SAXException the SAX exception
+ * @param aFrame
+ * the a frame
+ * @throws SAXException
+ * the SAX exception
*/
protected void _parse(VinciFrame aFrame) throws SAXException {
int count = aFrame.getKeyValuePairCount();
diff --git a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/VinciTAEClient.java b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/VinciTAEClient.java
index f3da27c..881ae28 100644
--- a/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/VinciTAEClient.java
+++ b/uimaj-adapter-vinci/src/main/java/org/apache/uima/adapter/vinci/util/VinciTAEClient.java
@@ -34,7 +34,8 @@ public class VinciTAEClient {
/**
* The main method.
*
- * @param args the arguments
+ * @param args
+ * the arguments
*/
public static void main(String[] args) {
System.out.println("Invoking the service...");
diff --git a/uimaj-adapter-vinci/src/test/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceAdapterTest.java b/uimaj-adapter-vinci/src/test/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceAdapterTest.java
index 054ff6e..59a7c8c 100644
--- a/uimaj-adapter-vinci/src/test/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceAdapterTest.java
+++ b/uimaj-adapter-vinci/src/test/java/org/apache/uima/adapter/vinci/VinciAnalysisEngineServiceAdapterTest.java
@@ -28,7 +28,6 @@ import org.apache.uima.resource.ResourceInitializationException;
import org.apache.uima.resource.URISpecifier;
import org.junit.jupiter.api.Test;
-
// TODO: Auto-generated Javadoc
/**
* The Class VinciAnalysisEngineServiceAdapterTest.
@@ -38,37 +37,38 @@ public class VinciAnalysisEngineServiceAdapterTest {
/**
* Test initialize.
*
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
- @Test
- public void testInitialize() throws ResourceInitializationException {
- // Don't want an actual network dependency so will test only with services that
- // don't exist. The tests just make sure that the AnalysisEngineServiceAdapter.initialize
- // method just returns false when passed an inappropriate specifier and throws an
- // exception when passed an appropriate specifier.
+ @Test
+ public void testInitialize() throws ResourceInitializationException {
+ // Don't want an actual network dependency so will test only with services that
+ // don't exist. The tests just make sure that the AnalysisEngineServiceAdapter.initialize
+ // method just returns false when passed an inappropriate specifier and throws an
+ // exception when passed an appropriate specifier.
- final String NON_EXISTENT_URI = "this.service.does.not.exit.at.least.i.hope.not";
- URISpecifier uriSpec = UIMAFramework.getResourceSpecifierFactory().createURISpecifier();
- uriSpec.setUri(NON_EXISTENT_URI);
+ final String NON_EXISTENT_URI = "this.service.does.not.exit.at.least.i.hope.not";
+ URISpecifier uriSpec = UIMAFramework.getResourceSpecifierFactory().createURISpecifier();
+ uriSpec.setUri(NON_EXISTENT_URI);
- // test incorrect protocol
- uriSpec.setProtocol(Constants.PROTOCOL_SOAP);
- VinciAnalysisEngineServiceAdapter adapter = new VinciAnalysisEngineServiceAdapter();
- boolean result = adapter.initialize(uriSpec, null);
- assertThat(result).isFalse();
+ // test incorrect protocol
+ uriSpec.setProtocol(Constants.PROTOCOL_SOAP);
+ VinciAnalysisEngineServiceAdapter adapter = new VinciAnalysisEngineServiceAdapter();
+ boolean result = adapter.initialize(uriSpec, null);
+ assertThat(result).isFalse();
- // test correct protocol
- VinciAnalysisEngineServiceAdapter adapter2 = new VinciAnalysisEngineServiceAdapter();
- uriSpec.setProtocol(Constants.PROTOCOL_VINCI);
- uriSpec.setResourceType(URISpecifier.RESOURCE_TYPE_ANALYSIS_ENGINE);
+ // test correct protocol
+ VinciAnalysisEngineServiceAdapter adapter2 = new VinciAnalysisEngineServiceAdapter();
+ uriSpec.setProtocol(Constants.PROTOCOL_VINCI);
+ uriSpec.setResourceType(URISpecifier.RESOURCE_TYPE_ANALYSIS_ENGINE);
- assertThatExceptionOfType(ResourceInitializationException.class)
- .isThrownBy(() -> adapter2.initialize(uriSpec, null));
+ assertThatExceptionOfType(ResourceInitializationException.class)
+ .isThrownBy(() -> adapter2.initialize(uriSpec, null));
- // test correct protocol and no component type
- uriSpec.setResourceType(null);
- VinciAnalysisEngineServiceAdapter adapter1 = new VinciAnalysisEngineServiceAdapter();
- assertThatExceptionOfType(ResourceInitializationException.class)
- .isThrownBy(() -> adapter1.initialize(uriSpec, null));
- }
+ // test correct protocol and no component type
+ uriSpec.setResourceType(null);
+ VinciAnalysisEngineServiceAdapter adapter1 = new VinciAnalysisEngineServiceAdapter();
+ assertThatExceptionOfType(ResourceInitializationException.class)
+ .isThrownBy(() -> adapter1.initialize(uriSpec, null));
+ }
}
[uima-uimaj] 10/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit 242371e62e8e9f004b42aa0e7f3b0df9c4b71645
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:17:32 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../uima/taeconfigurator/CDEpropertyPage.java | 57 +-
.../uima/taeconfigurator/InternalErrorCDE.java | 13 +-
.../org/apache/uima/taeconfigurator/Messages.java | 12 +-
.../uima/taeconfigurator/PreferencePage.java | 17 +-
.../uima/taeconfigurator/StandardStrings.java | 3 +-
.../taeconfigurator/TAEConfiguratorPlugin.java | 35 +-
.../uima/taeconfigurator/editors/Form2Panel.java | 10 +-
.../taeconfigurator/editors/MultiPageEditor.java | 1337 +++++++++++---------
.../editors/MultiPageEditorContributor.java | 169 +--
.../editors/point/IUimaEditorExtension.java | 47 +-
.../editors/point/IUimaMultiPageEditor.java | 20 +-
.../editors/ui/AbstractImportablePartSection.java | 107 +-
.../editors/ui/AbstractSection.java | 992 +++++++++------
.../editors/ui/AbstractSectionParm.java | 362 +++---
.../taeconfigurator/editors/ui/AggregatePage.java | 9 +-
.../editors/ui/AggregateSection.java | 165 +--
.../taeconfigurator/editors/ui/CapabilityPage.java | 7 +-
.../editors/ui/CapabilitySection.java | 300 +++--
.../editors/ui/ExtnlResBindSection.java | 111 +-
.../editors/ui/FileAndShortName.java | 14 +-
.../taeconfigurator/editors/ui/FlowSection.java | 131 +-
.../taeconfigurator/editors/ui/GeneralSection.java | 42 +-
.../taeconfigurator/editors/ui/HeaderPage.java | 90 +-
.../editors/ui/HeaderPageWithSash.java | 34 +-
.../editors/ui/ImportResBindSection.java | 48 +-
.../taeconfigurator/editors/ui/ImportSection.java | 123 +-
.../editors/ui/IndexImportSection.java | 51 +-
.../taeconfigurator/editors/ui/IndexSection.java | 93 +-
.../taeconfigurator/editors/ui/IndexesPage.java | 11 +-
.../editors/ui/MetaDataSection.java | 23 +-
.../taeconfigurator/editors/ui/OverviewPage.java | 14 +-
.../editors/ui/ParameterDelegatesSection.java | 167 ++-
.../taeconfigurator/editors/ui/ParameterPage.java | 11 +-
.../editors/ui/ParameterSection.java | 332 +++--
.../editors/ui/ParameterSettingsSection.java | 14 +-
.../editors/ui/PrimitiveSection.java | 40 +-
.../editors/ui/PriorityListSection.java | 44 +-
.../editors/ui/ResourceDependencySection.java | 102 +-
.../taeconfigurator/editors/ui/ResourcesPage.java | 11 +-
.../taeconfigurator/editors/ui/SettingsPage.java | 11 +-
.../taeconfigurator/editors/ui/SofaMapSection.java | 137 +-
.../editors/ui/TypeImportSection.java | 42 +-
.../uima/taeconfigurator/editors/ui/TypePage.java | 7 +-
.../editors/ui/TypePriorityImportSection.java | 51 +-
.../taeconfigurator/editors/ui/TypeSection.java | 451 ++++---
.../uima/taeconfigurator/editors/ui/Utility.java | 211 +--
.../taeconfigurator/editors/ui/ValueSection.java | 59 +-
.../editors/ui/dialogs/AbstractDialog.java | 390 +++---
.../ui/dialogs/AbstractDialogKeyVerify.java | 32 +-
.../dialogs/AbstractDialogKeyVerifyJavaNames.java | 31 +-
.../ui/dialogs/AbstractDialogMultiColTable.java | 78 +-
.../editors/ui/dialogs/AddAllowedValueDialog.java | 31 +-
.../ui/dialogs/AddCapabilityFeatureDialog.java | 44 +-
.../ui/dialogs/AddCapabilityTypeDialog.java | 72 +-
.../AddExternalResourceDependencyDialog.java | 41 +-
.../ui/dialogs/AddExternalResourceDialog.java | 49 +-
.../editors/ui/dialogs/AddFeatureDialog.java | 87 +-
.../editors/ui/dialogs/AddIndexDialog.java | 92 +-
.../editors/ui/dialogs/AddIndexKeyDialog.java | 59 +-
.../editors/ui/dialogs/AddParameterDialog.java | 53 +-
.../editors/ui/dialogs/AddRemoteServiceDialog.java | 182 +--
.../editors/ui/dialogs/AddSofaDialog.java | 91 +-
.../editors/ui/dialogs/AddTypeDialog.java | 39 +-
.../ui/dialogs/AddTypeToPriorityListDialog.java | 33 +-
.../editors/ui/dialogs/CommonInputDialog.java | 56 +-
.../editors/ui/dialogs/ContentAssistField32.java | 20 +-
.../editors/ui/dialogs/EditSofaBindingsDialog.java | 28 +-
.../ui/dialogs/ExportImportablePartDialog.java | 58 +-
.../editors/ui/dialogs/FindComponentDialog.java | 46 +-
.../editors/ui/dialogs/PickTaeForTypesDialog.java | 76 +-
.../editors/ui/dialogs/ResourcePickerDialog.java | 118 +-
.../editors/ui/dialogs/SearchMonitoringThread.java | 13 +-
.../editors/ui/dialogs/SearchThread.java | 91 +-
.../editors/ui/dialogs/SelectTypeDialog.java | 105 +-
.../editors/ui/dialogs/TypesWithNameSpaces.java | 8 +-
.../editors/ui/dialogs/TypesWithNameSpaces32.java | 114 +-
.../taeconfigurator/editors/xml/ColorManager.java | 4 +-
.../editors/xml/IXMLColorConstants.java | 3 +-
.../editors/xml/NonRuleBasedDamagerRepairer.java | 40 +-
.../uima/taeconfigurator/editors/xml/TagRule.java | 14 +-
.../editors/xml/XMLConfiguration.java | 60 +-
.../editors/xml/XMLDocumentProvider.java | 5 +-
.../editors/xml/XMLDoubleClickStrategy.java | 22 +-
.../taeconfigurator/editors/xml/XMLEditor.java | 34 +-
.../editors/xml/XMLPartitionScanner.java | 3 +-
.../taeconfigurator/editors/xml/XMLScanner.java | 7 +-
.../taeconfigurator/editors/xml/XMLTagScanner.java | 4 +-
.../editors/xml/XMLWhitespaceDetector.java | 5 +-
.../files/ContextForPartDialog.java | 158 +--
.../files/MultiResourceSelectionDialog.java | 232 ++--
...MultiResourceSelectionDialogWithFlowOption.java | 35 +-
.../files/PickOverrideKeysAndParmName.java | 438 +++----
.../taeconfigurator/model/AbstractModelPart.java | 4 +-
.../uima/taeconfigurator/model/AllTypes.java | 4 +-
.../uima/taeconfigurator/model/BuiltInTypes.java | 1 -
.../uima/taeconfigurator/model/ConfigGroup.java | 16 +-
.../model/DefinedTypesWithSupers.java | 4 +-
.../taeconfigurator/model/DescriptorMetaData.java | 16 +-
.../uima/taeconfigurator/model/DescriptorTCAS.java | 13 +-
.../uima/taeconfigurator/model/FlowNodes.java | 9 +-
.../taeconfigurator/wizards/AbstractNewWizard.java | 117 +-
.../wizards/AbstractNewWizardPage.java | 27 +-
.../wizards/CasConsumerNewWizard.java | 61 +-
.../wizards/CasConsumerNewWizardPage.java | 4 +-
.../wizards/CasInitializerNewWizard.java | 63 +-
.../wizards/CasInitializerNewWizardPage.java | 4 +-
.../wizards/CollectionReaderNewWizard.java | 63 +-
.../wizards/CollectionReaderNewWizardPage.java | 4 +-
.../wizards/FlowControllerNewWizard.java | 65 +-
.../wizards/FlowControllerNewWizardPage.java | 4 +-
.../wizards/FsIndexCollectionNewWizard.java | 54 +-
.../wizards/FsIndexCollectionNewWizardPage.java | 4 +-
.../ResourceManagerConfigurationNewWizard.java | 54 +-
.../ResourceManagerConfigurationNewWizardPage.java | 8 +-
.../wizards/TAEConfiguratorNewWizard.java | 65 +-
.../wizards/TAEConfiguratorNewWizardPage.java | 4 +-
.../wizards/TypePrioritiesNewWizard.java | 52 +-
.../wizards/TypePrioritiesNewWizardPage.java | 4 +-
.../wizards/TypeSystemNewWizard.java | 41 +-
.../wizards/TypeSystemNewWizardPage.java | 4 +-
120 files changed, 5857 insertions(+), 4250 deletions(-)
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/CDEpropertyPage.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/CDEpropertyPage.java
index 4a6293e..8646c14 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/CDEpropertyPage.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/CDEpropertyPage.java
@@ -32,7 +32,6 @@ import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.dialogs.PropertyPage;
-
/**
* The Class CDEpropertyPage.
*/
@@ -67,7 +66,8 @@ public class CDEpropertyPage extends PropertyPage {
/**
* Creates the contents.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the control
* @see PreferencePage#createContents(Composite)
*/
@@ -76,10 +76,9 @@ public class CDEpropertyPage extends PropertyPage {
Composite composite = create2ColComposite(parent);
Label instructions = new Label(composite, SWT.WRAP);
- instructions
- .setText("Enter the data path to use for finding resources by name;\n"
- + "This is a series of absolute paths, separated by\n"
- + "whatever character this platform uses for path separation (similar to class paths).\n\n");
+ instructions.setText("Enter the data path to use for finding resources by name;\n"
+ + "This is a series of absolute paths, separated by\n"
+ + "whatever character this platform uses for path separation (similar to class paths).\n\n");
GridData gd = new GridData(GridData.FILL_HORIZONTAL);
gd.horizontalSpan = 2;
gd.grabExcessHorizontalSpace = true;
@@ -92,8 +91,8 @@ public class CDEpropertyPage extends PropertyPage {
dataPathUI.setLayoutData(gd);
try {
- String dataPath = ((IResource) getElement()).getPersistentProperty(new QualifiedName("",
- DATAPATH_PROPERTY_KEY));
+ String dataPath = ((IResource) getElement())
+ .getPersistentProperty(new QualifiedName("", DATAPATH_PROPERTY_KEY));
dataPathUI.setText((dataPath != null) ? dataPath : DEFAULT_DATAPATH);
} catch (CoreException e) {
dataPathUI.setText(DEFAULT_DATAPATH);
@@ -104,7 +103,8 @@ public class CDEpropertyPage extends PropertyPage {
/**
* Creates the 2 col composite.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
private Composite create2ColComposite(Composite parent) {
@@ -121,7 +121,9 @@ public class CDEpropertyPage extends PropertyPage {
return composite;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.PreferencePage#performDefaults()
*/
@Override
@@ -129,15 +131,17 @@ public class CDEpropertyPage extends PropertyPage {
dataPathUI.setText(DEFAULT_DATAPATH);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.PreferencePage#performOk()
*/
@Override
public boolean performOk() {
// store the value in the owner text field
try {
- ((IResource) getElement()).setPersistentProperty(
- new QualifiedName("", DATAPATH_PROPERTY_KEY), dataPathUI.getText());
+ ((IResource) getElement()).setPersistentProperty(new QualifiedName("", DATAPATH_PROPERTY_KEY),
+ dataPathUI.getText());
} catch (CoreException e) {
return false;
}
@@ -147,7 +151,8 @@ public class CDEpropertyPage extends PropertyPage {
/**
* Gets the data path.
*
- * @param project the project
+ * @param project
+ * the project
* @return the data path
*/
public static String getDataPath(IProject project) {
@@ -165,8 +170,10 @@ public class CDEpropertyPage extends PropertyPage {
/**
* Sets the data path.
*
- * @param project the project
- * @param dataPath the data path
+ * @param project
+ * the project
+ * @param dataPath
+ * the data path
*/
public static void setDataPath(IProject project, String dataPath) {
try {
@@ -179,7 +186,8 @@ public class CDEpropertyPage extends PropertyPage {
/**
* Gets the import by default.
*
- * @param project the project
+ * @param project
+ * the project
* @return the import by default
*/
public static String getImportByDefault(IProject project) {
@@ -197,8 +205,10 @@ public class CDEpropertyPage extends PropertyPage {
/**
* Sets the import by default.
*
- * @param project the project
- * @param byDefault the by default
+ * @param project
+ * the project
+ * @param byDefault
+ * the by default
*/
public static void setImportByDefault(IProject project, String byDefault) {
try {
@@ -211,7 +221,8 @@ public class CDEpropertyPage extends PropertyPage {
/**
* Gets the adds the to flow.
*
- * @param project the project
+ * @param project
+ * the project
* @return the adds the to flow
*/
public static String getAddToFlow(IProject project) {
@@ -229,8 +240,10 @@ public class CDEpropertyPage extends PropertyPage {
/**
* Sets the add to flow.
*
- * @param project the project
- * @param byDefault the by default
+ * @param project
+ * the project
+ * @param byDefault
+ * the by default
*/
public static void setAddToFlow(IProject project, String byDefault) {
try {
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/InternalErrorCDE.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/InternalErrorCDE.java
index 0d2e24b..f69df63 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/InternalErrorCDE.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/InternalErrorCDE.java
@@ -24,7 +24,6 @@ package org.apache.uima.taeconfigurator;
*/
public class InternalErrorCDE extends RuntimeException {
-
/**
* Instantiates a new internal error CDE.
*/
@@ -34,7 +33,8 @@ public class InternalErrorCDE extends RuntimeException {
/**
* Instantiates a new internal error CDE.
*
- * @param message the message
+ * @param message
+ * the message
*/
public InternalErrorCDE(String message) {
super(message + " - Please see Eclipse Error Log for more information.");
@@ -43,8 +43,10 @@ public class InternalErrorCDE extends RuntimeException {
/**
* Instantiates a new internal error CDE.
*
- * @param message the message
- * @param cause the cause
+ * @param message
+ * the message
+ * @param cause
+ * the cause
*/
public InternalErrorCDE(String message, Throwable cause) {
super(message + " - Please see Eclipse Error Log for more information.", cause);
@@ -53,7 +55,8 @@ public class InternalErrorCDE extends RuntimeException {
/**
* Instantiates a new internal error CDE.
*
- * @param cause the cause
+ * @param cause
+ * the cause
*/
public InternalErrorCDE(Throwable cause) {
super(cause);
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/Messages.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/Messages.java
index 9f48185..5212b2b 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/Messages.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/Messages.java
@@ -23,12 +23,11 @@ import java.text.MessageFormat;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
-
/**
* The Class Messages.
*/
public class Messages {
-
+
/** The Constant BUNDLE_NAME. */
private static final String BUNDLE_NAME = "org.apache.uima.taeconfigurator.messages";//$NON-NLS-1$
@@ -44,7 +43,8 @@ public class Messages {
/**
* Gets the string.
*
- * @param key the key
+ * @param key
+ * the key
* @return the string
*/
public static String getString(String key) {
@@ -58,8 +58,10 @@ public class Messages {
/**
* Gets the formatted string.
*
- * @param key the key
- * @param args the args
+ * @param key
+ * the key
+ * @param args
+ * the args
* @return the formatted string
*/
public static String getFormattedString(String key, String[] args) {
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/PreferencePage.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/PreferencePage.java
index df094dc..6a7c94a 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/PreferencePage.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/PreferencePage.java
@@ -27,15 +27,14 @@ import org.eclipse.jface.preference.StringFieldEditor;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
-
/**
* The Class PreferencePage.
*/
public class PreferencePage extends FieldEditorPreferencePage implements IWorkbenchPreferencePage {
-
+
/** The Constant P_JCAS. */
public static final String P_JCAS = "org.apache.uima.cde.autojcasgen";
-
+
/** The Constant P_JCAS_LIMIT_TO_PROJECT_SCOPE. */
public static final String P_JCAS_LIMIT_TO_PROJECT_SCOPE = "org.apache.uima.cde.jcasgen.limittoprojectscope";
@@ -74,7 +73,9 @@ public class PreferencePage extends FieldEditorPreferencePage implements IWorkbe
// store.setDefault(P_DATA_PATH, "");
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.FieldEditorPreferencePage#createFieldEditors()
*/
@Override
@@ -82,8 +83,8 @@ public class PreferencePage extends FieldEditorPreferencePage implements IWorkbe
addField(new BooleanFieldEditor(P_JCAS, "&Automatically run JCasGen when Types change",
getFieldEditorParent()));
- addField(new BooleanFieldEditor(P_JCAS_LIMIT_TO_PROJECT_SCOPE, "&Limit JCasGen to types defined in this project",
- getFieldEditorParent()));
+ addField(new BooleanFieldEditor(P_JCAS_LIMIT_TO_PROJECT_SCOPE,
+ "&Limit JCasGen to types defined in this project", getFieldEditorParent()));
addField(new BooleanFieldEditor(P_SHOW_FULLY_QUALIFIED_NAMES, "&Show fully qualified names",
getFieldEditorParent()));
@@ -97,7 +98,9 @@ public class PreferencePage extends FieldEditorPreferencePage implements IWorkbe
getFieldEditorParent()));
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.ui.IWorkbenchPreferencePage#init(org.eclipse.ui.IWorkbench)
*/
@Override
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/StandardStrings.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/StandardStrings.java
index e4cf89a..2adb701 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/StandardStrings.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/StandardStrings.java
@@ -19,12 +19,11 @@
package org.apache.uima.taeconfigurator;
-
/**
* The Interface StandardStrings.
*/
public interface StandardStrings {
-
+
/** The Constant S_ADD. */
String S_ADD = "Add...";
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/TAEConfiguratorPlugin.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/TAEConfiguratorPlugin.java
index 66be48a..e4185d9 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/TAEConfiguratorPlugin.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/TAEConfiguratorPlugin.java
@@ -33,7 +33,6 @@ import org.eclipse.ui.forms.FormColors;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.osgi.framework.BundleContext;
-
/**
* The main plugin class to be used in the desktop.
*/
@@ -64,8 +63,6 @@ public class TAEConfiguratorPlugin extends AbstractUIPlugin {
/** The resource bundle. */
// Resource bundle.
private ResourceBundle resourceBundle;
-
-
/** The form colors. */
private static FormColors formColors;
@@ -119,7 +116,7 @@ public class TAEConfiguratorPlugin extends AbstractUIPlugin {
public final static String IMAGE_NOMREF = "one_arrow.gif";
/** The plugin id. */
- public static String pluginId ;
+ public static String pluginId;
/**
* The constructor, version 3.
@@ -148,7 +145,7 @@ public class TAEConfiguratorPlugin extends AbstractUIPlugin {
imageRegistry.put(IMAGE_MREFOK, getImageDescriptor("arrows.gif"));
imageRegistry.put(IMAGE_NOMREF, getImageDescriptor("one_arrow.gif"));
}
-
+
/**
* Returns the shared instance.
*
@@ -157,7 +154,7 @@ public class TAEConfiguratorPlugin extends AbstractUIPlugin {
public static TAEConfiguratorPlugin getDefault() {
return plugin;
}
-
+
/**
* Returns the workspace instance.
*
@@ -170,7 +167,8 @@ public class TAEConfiguratorPlugin extends AbstractUIPlugin {
/**
* Returns the string from the plugin's resource bundle, or 'key' if not found.
*
- * @param key the key
+ * @param key
+ * the key
* @return the resource string
*/
public static String getResourceString(String key) {
@@ -181,19 +179,21 @@ public class TAEConfiguratorPlugin extends AbstractUIPlugin {
return key;
}
}
-
+
/**
* This method is called when the plug-in is stopped.
*
- * @param context the context
- * @throws Exception -
+ * @param context
+ * the context
+ * @throws Exception
+ * -
*/
@Override
public void stop(BundleContext context) throws Exception {
try {
if (null != formColors) {
formColors.dispose();
- }
+ }
} finally {
formColors = null;
@@ -204,8 +204,9 @@ public class TAEConfiguratorPlugin extends AbstractUIPlugin {
/**
* On first call, gets a formColors instance; on subsequent calls, returns that instance.
*
- * @param display the display
- * @return a formColors instance
+ * @param display
+ * the display
+ * @return a formColors instance
*/
public FormColors getFormColors(Display display) {
if (null == formColors) {
@@ -228,7 +229,8 @@ public class TAEConfiguratorPlugin extends AbstractUIPlugin {
/**
* Gets the image.
*
- * @param imageFile the image file
+ * @param imageFile
+ * the image file
* @return the image
*/
public static Image getImage(String imageFile) {
@@ -238,11 +240,12 @@ public class TAEConfiguratorPlugin extends AbstractUIPlugin {
/**
* Gets the image descriptor.
*
- * @param imageFile the image file
+ * @param imageFile
+ * the image file
* @return the image descriptor
*/
public ImageDescriptor getImageDescriptor(String imageFile) {
- URL url = getBundle().getEntry("icons/" + imageFile);
+ URL url = getBundle().getEntry("icons/" + imageFile);
return ImageDescriptor.createFromURL(url);
}
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/Form2Panel.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/Form2Panel.java
index 00380b3..7cbda43 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/Form2Panel.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/Form2Panel.java
@@ -21,7 +21,6 @@ package org.apache.uima.taeconfigurator.editors;
import org.eclipse.swt.widgets.Composite;
-
/**
* 3 element return value for 2 panel forms.
*/
@@ -39,9 +38,12 @@ public class Form2Panel {
/**
* Instantiates a new form 2 panel.
*
- * @param form the form
- * @param left the left
- * @param right the right
+ * @param form
+ * the form
+ * @param left
+ * the left
+ * @param right
+ * the right
*/
public Form2Panel(Composite form, Composite left, Composite right) {
this.form = form;
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditor.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditor.java
index 737348a..2485acd 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditor.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditor.java
@@ -161,7 +161,6 @@ import org.w3c.dom.Node;
import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;
-
/**
* Main class implementing the multi page editor. In Eclipse 3, we extend FormEditor, which extends
* in turn MultiPageEditorPart.
@@ -176,13 +175,13 @@ import org.xml.sax.SAXException;
* SuperSuperclass (MultiPageEditorPart) holds array of editors (we only have 1 "editor" - the xml
* source editor - the rest are views into that model / data).
*
- * Stale = model (on disk, saved) is ahead of widgets Dirty = widgets are ahead of model
+ * Stale = model (on disk, saved) is ahead of widgets Dirty = widgets are ahead of model
* <<< NOT USED HERE
*
- * Each page of the multipage editor has its own class. ownclass -%gt; HeaderPage -%gt; FormPage (impl
- * IFormPage) has instance of PageForm -%gt; ManagedForm ManagedForm (impl IManagedForm): has instance
- * of ScrolledForm has subparts (IFormPart - which live on the scrolled form) A part can be a
- * section. A part can implement IPartSelectionListener to get selectionChanged(IFormPart,
+ * Each page of the multipage editor has its own class. ownclass -%gt; HeaderPage -%gt; FormPage
+ * (impl IFormPage) has instance of PageForm -%gt; ManagedForm ManagedForm (impl IManagedForm): has
+ * instance of ScrolledForm has subparts (IFormPart - which live on the scrolled form) A part can be
+ * a section. A part can implement IPartSelectionListener to get selectionChanged(IFormPart,
* ISelection) calls. initialize() call propagated to all parts. dispose() call propagated to all
* parts. refresh() propagated to all parts (if part.isStale()) (Not Used) commit() propagated to
* all parts (if part.isDirty()) setInput() propagated to all parts setFocus() propagated to 1st
@@ -191,7 +190,7 @@ import org.xml.sax.SAXException;
* fireSelectionChanged(IFormPart, ISelection) - can be used to notify other parts that implement
* IPartSelectionListener about selection changes
*
- * Each page has one or more sections. sectionSpecific -> (AbstractTableSection) ->
+ * Each page has one or more sections. sectionSpecific -> (AbstractTableSection) ->
* AbstractSection -> SectionPart -> AbstractFormPart (impl IFormPart, see above)
*
* AbstractFormPart holds back ref to managed form, a dirty and stale bit. Stale = model is ahead of
@@ -212,7 +211,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/** The initial size feature collections. */
public final int INITIAL_SIZE_FEATURE_COLLECTIONS = 40;
-
+
/** The preserve comments. */
public final boolean PRESERVE_COMMENTS = true;
@@ -230,7 +229,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/** The merged type system description. */
private TypeSystemDescription mergedTypeSystemDescription = null;
-
+
/** The merged types adding features. */
private Map<String, Set<String>> mergedTypesAddingFeatures = new TreeMap<>();
@@ -238,7 +237,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
private TypeSystemDescription importedTypeSystemDescription = null;
/** The xml infoset. */
- private Node xmlInfoset = null; // captures comments and ignorableWhitespace
+ private Node xmlInfoset = null; // captures comments and ignorableWhitespace
/**
* Key = unique ID of included AE in aggregate Value = AnalysisEngineSpecification or URISpecifier
* if remote This value is obtained from aeDescription.getDelegateAnalysisEngineSpecifiers() for
@@ -424,8 +423,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
/** The limit J cas gen to project scope. */
- private boolean limitJCasGenToProjectScope = MultiPageEditorContributor.getLimitJCasGenToProjectScope();
-
+ private boolean limitJCasGenToProjectScope = MultiPageEditorContributor
+ .getLimitJCasGenToProjectScope();
+
/**
* Gets the limit J cas gen to project scope.
*
@@ -434,11 +434,12 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
public boolean getLimitJCasGenToProjectScope() {
return limitJCasGenToProjectScope;
}
-
+
/**
* Sets the limit J cas gen to project scope.
*
- * @param v the new limit J cas gen to project scope
+ * @param v
+ * the new limit J cas gen to project scope
*/
public void setLimitJCasGenToProjectScope(boolean v) {
limitJCasGenToProjectScope = v;
@@ -487,28 +488,37 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Descriptor type string.
*
- * @param pDescriptorType the descriptor type
+ * @param pDescriptorType
+ * the descriptor type
* @return the string
*/
public String descriptorTypeString(int pDescriptorType) {
String r;
switch (pDescriptorType) {
case DESCRIPTOR_AE:
- r = Messages.getString("MultiPageEditor.0");break; //$NON-NLS-1$
+ r = Messages.getString("MultiPageEditor.0"); //$NON-NLS-1$
+ break;
case DESCRIPTOR_TYPESYSTEM:
- r = Messages.getString("MultiPageEditor.1");break; //$NON-NLS-1$
+ r = Messages.getString("MultiPageEditor.1"); //$NON-NLS-1$
+ break;
case DESCRIPTOR_INDEX:
- r = Messages.getString("MultiPageEditor.2");break; //$NON-NLS-1$
+ r = Messages.getString("MultiPageEditor.2"); //$NON-NLS-1$
+ break;
case DESCRIPTOR_TYPEPRIORITY:
- r = Messages.getString("MultiPageEditor.3");break; //$NON-NLS-1$
+ r = Messages.getString("MultiPageEditor.3"); //$NON-NLS-1$
+ break;
case DESCRIPTOR_EXTRESANDBINDINGS:
- r = Messages.getString("MultiPageEditor.4");break; //$NON-NLS-1$
+ r = Messages.getString("MultiPageEditor.4"); //$NON-NLS-1$
+ break;
case DESCRIPTOR_COLLECTIONREADER:
- r = Messages.getString("MultiPageEditor.5");break; //$NON-NLS-1$
+ r = Messages.getString("MultiPageEditor.5"); //$NON-NLS-1$
+ break;
case DESCRIPTOR_CASINITIALIZER:
- r = Messages.getString("MultiPageEditor.6");break; //$NON-NLS-1$
+ r = Messages.getString("MultiPageEditor.6"); //$NON-NLS-1$
+ break;
case DESCRIPTOR_CASCONSUMER:
- r = Messages.getString("MultiPageEditor.7");break; //$NON-NLS-1$
+ r = Messages.getString("MultiPageEditor.7"); //$NON-NLS-1$
+ break;
case DESCRIPTOR_FLOWCONTROLLER:
r = "Flow Controller";
break;
@@ -650,42 +660,42 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/** The Constant typeDescriptionArray0. */
public static final TypeDescription[] typeDescriptionArray0 = new TypeDescription[0];
-
+
/** The type systems to merge. */
private List typeSystemsToMerge;
-
+
/** The type priorities to merge. */
private List typePrioritiesToMerge;
-
+
/** The fs indexes to merge. */
private List fsIndexesToMerge;
-
+
/** The failed remotes. */
private Map failedRemotes = new TreeMap();
-
+
/** The failed remotes already known. */
private Set failedRemotesAlreadyKnown = new TreeSet();
/** The external editor configurations. */
private static List<IConfigurationElement> externalEditorConfigurations = null;
-
+
/** The current editor. */
private IUimaMultiPageEditor currentEditor; // can be CDE or another editor
-
+
/**
* Instantiates a new multi page editor.
*/
public MultiPageEditor() {
currentEditor = this; // default
- initCDE (); // specific for CDE
+ initCDE(); // specific for CDE
}
-
+
/**
*
- * Note: Try to move these codes out of constructor MultiPageEditor().
- * Too much of impacts. Put it back into constructor MultiPageEditor()
+ * Note: Try to move these codes out of constructor MultiPageEditor(). Too much of impacts. Put it
+ * back into constructor MultiPageEditor()
*/
- private void initCDE () {
+ private void initCDE() {
// Model initialization
fileDirty = false;
dirtyTypeNameHash = new HashSet();
@@ -705,23 +715,24 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
/** The Constant EXTENSION_TAG_CLASS_ATTRIB. */
- private static final String EXTENSION_TAG_CLASS_ATTRIB = "class";
+ private static final String EXTENSION_TAG_CLASS_ATTRIB = "class";
-
/**
* Gets the required editor.
*
- * @param parsedResult the parsed result
+ * @param parsedResult
+ * the parsed result
* @return the required editor
*/
private IUimaEditorExtension getRequiredEditor(XMLizable parsedResult) {
return getRequiredEditor(null, parsedResult.getClass().getName());
}
-
+
/**
* Gets the required editor.
*
- * @param topElementName the top element name
+ * @param topElementName
+ * the top element name
* @return the required editor
*/
private IUimaEditorExtension getRequiredEditor(String topElementName) {
@@ -732,29 +743,35 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the required editor.
*
- * @param topElementName the top element name
- * @param parsedResultClassName the parsed result class name
+ * @param topElementName
+ * the top element name
+ * @param parsedResultClassName
+ * the parsed result class name
* @return the required editor
*/
// otherwise instantiates a new editor
- private IUimaEditorExtension getRequiredEditor(String topElementName, String parsedResultClassName) {
+ private IUimaEditorExtension getRequiredEditor(String topElementName,
+ String parsedResultClassName) {
IUimaEditorExtension editor;
// load external editor configurations if not already loaded
if (null == externalEditorConfigurations) {
getExternalEditorConfigurations();
}
-
+
for (IConfigurationElement xeditor : externalEditorConfigurations) {
for (IConfigurationElement canEdit : xeditor.getChildren()) {
String elementName = canEdit.getAttribute("elementName");
String parseResultName = canEdit.getAttribute("internalParseClass");
- if ( ( (null != topElementName) && topElementName.equals(elementName)) ||
- ( (null != parsedResultClassName) && parsedResultClassName.equals(parseResultName)) ) {
+ if (((null != topElementName) && topElementName.equals(elementName))
+ || ((null != parsedResultClassName)
+ && parsedResultClassName.equals(parseResultName))) {
try {
- editor = (IUimaEditorExtension) xeditor.createExecutableExtension(EXTENSION_TAG_CLASS_ATTRIB);
+ editor = (IUimaEditorExtension) xeditor
+ .createExecutableExtension(EXTENSION_TAG_CLASS_ATTRIB);
} catch (CoreException e) {
- Utility.popMessage("Unexpected Exception", "While trying to load an editor extension"
- + getMessagesToRootCause(e), MessageDialog.ERROR);
+ Utility.popMessage("Unexpected Exception",
+ "While trying to load an editor extension" + getMessagesToRootCause(e),
+ MessageDialog.ERROR);
return null;
}
editor.init();
@@ -764,33 +781,33 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
return null;
}
-
+
/** The Constant EXTENSION_POINT_ID. */
- private static final String EXTENSION_POINT_ID = "externalEditor";
-
+ private static final String EXTENSION_POINT_ID = "externalEditor";
+
// load all of the external editor xml data
/**
* Gets the external editor configurations.
*
* @return the external editor configurations
*/
- // (but don't load the actual editors, yet)
- private void getExternalEditorConfigurations () {
+ // (but don't load the actual editors, yet)
+ private void getExternalEditorConfigurations() {
// Get extension point from Registry
IExtensionPoint point = Platform.getExtensionRegistry()
- .getExtensionPoint(TAEConfiguratorPlugin.pluginId, EXTENSION_POINT_ID);
-
+ .getExtensionPoint(TAEConfiguratorPlugin.pluginId, EXTENSION_POINT_ID);
+
externalEditorConfigurations = new ArrayList<>();
-
+
// check: Any <extension> tags for our extension-point?
if (point != null) {
for (IExtension extension : point.getExtensions()) {
Bundle b = Platform.getBundle(extension.getContributor().getName());
if (b == null) {
- Utility.popMessage(
- "Problem with Editor Extension",
- "Editor '" + extension.getContributor().getName() + "' is present, but can't be loaded, probably because of unsatisfied dependencies\n",
- MessageDialog.ERROR);
+ Utility.popMessage("Problem with Editor Extension", "Editor '"
+ + extension.getContributor().getName()
+ + "' is present, but can't be loaded, probably because of unsatisfied dependencies\n",
+ MessageDialog.ERROR);
continue;
}
for (IConfigurationElement ces : extension.getConfigurationElements()) {
@@ -799,39 +816,40 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
} else {
// Error - no such extension point
- Utility.popMessage(
- "Internal Error",
- "CDE's extension point is missing",
- MessageDialog.ERROR);
+ Utility.popMessage("Internal Error", "CDE's extension point is missing", MessageDialog.ERROR);
}
}
// *************************************************************************
- // Expose "protected" methods and methods from Super
- // *************************************************************************
-
+ // Expose "protected" methods and methods from Super
+ // *************************************************************************
+
/**
- * @param site the site
- * @param editorInput the editor input
- * @throws PartInitException the part init exception
+ * @param site
+ * the site
+ * @param editorInput
+ * the editor input
+ * @throws PartInitException
+ * the part init exception
*/
public void initSuper(IEditorSite site, IEditorInput editorInput) throws PartInitException {
super.init(site, editorInput);
}
-
+
/**
* Gets the current page super.
*
* @return the current page super
*/
- public int getCurrentPageSuper () {
+ public int getCurrentPageSuper() {
return getCurrentPage();
}
-
+
/**
* Sets the part name super.
*
- * @param partName the new part name super
+ * @param partName
+ * the new part name super
*/
public void setPartNameSuper(String partName) {
super.setPartName(partName);
@@ -840,17 +858,20 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the page text super.
*
- * @param pageIndex the page index
- * @param text the text
+ * @param pageIndex
+ * the page index
+ * @param text
+ * the text
*/
public void setPageTextSuper(int pageIndex, String text) {
super.setPageText(pageIndex, text);
}
-
+
/**
* Page change super.
*
- * @param newPageIndex the new page index
+ * @param newPageIndex
+ * the new page index
*/
public void pageChangeSuper(int newPageIndex) {
super.pageChange(newPageIndex);
@@ -859,30 +880,33 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the active page super.
*
- * @param pageIndex the new active page super
+ * @param pageIndex
+ * the new active page super
*/
- public void setActivePageSuper (int pageIndex) {
+ public void setActivePageSuper(int pageIndex) {
super.setActivePage(pageIndex);
}
-
+
/**
* Fire property change super.
*
- * @param propertyId the property id
+ * @param propertyId
+ * the property id
*/
public void firePropertyChangeSuper(final int propertyId) {
super.firePropertyChange(propertyId);
}
-
+
/**
* Sets the input super.
*
- * @param input the new input super
+ * @param input
+ * the new input super
*/
public void setInputSuper(IEditorInput input) {
super.setInput(input);
}
-
+
// XML source editor is opened by CDE when the source is "initially" invalid.
/**
* Gets the source editor.
@@ -890,17 +914,18 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
* @return the source editor
*/
// Called by DDE when the source becomes valid and it is DD.
- public XMLEditor getSourceEditor () {
+ public XMLEditor getSourceEditor() {
return sourceTextEditor;
}
-
+
/**
* ************************************************************************.
*
- * @param display the display
+ * @param display
+ * the display
* @return the form toolkit
*/
-
+
/**
* override the createToolkit method in FormEditor - to use a shared colors resource.
*
@@ -918,15 +943,19 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Adds the page and set tab title.
*
- * @param page the page
- * @param keyTabTitle the key tab title
+ * @param page
+ * the page
+ * @param keyTabTitle
+ * the key tab title
* @return the int
- * @throws PartInitException the part init exception
+ * @throws PartInitException
+ * the part init exception
*/
/*
* Two forms of addPage - one for non-source-editors, and one for source-editor
*/
- protected int addPageAndSetTabTitle(HeaderPage page, String keyTabTitle) throws PartInitException {
+ protected int addPageAndSetTabTitle(HeaderPage page, String keyTabTitle)
+ throws PartInitException {
int pageIndex = addPage(page);
// set the text on the tab used to select the page in the multipage editor
setPageText(pageIndex, keyTabTitle);
@@ -936,11 +965,15 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Adds the page and set tab title.
*
- * @param page the page
- * @param input the input
- * @param keyTabTitle the key tab title
+ * @param page
+ * the page
+ * @param input
+ * the input
+ * @param keyTabTitle
+ * the key tab title
* @return the int
- * @throws PartInitException the part init exception
+ * @throws PartInitException
+ * the part init exception
*/
protected int addPageAndSetTabTitle(IEditorPart page, IEditorInput input, String keyTabTitle)
throws PartInitException {
@@ -963,47 +996,49 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
protected void addPages() {
currentEditor.addPagesForCurrentEditor();
}
-
- /* (non-Javadoc)
- * @see org.apache.uima.taeconfigurator.editors.point.IUimaMultiPageEditor#addPagesForCurrentEditor()
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.taeconfigurator.editors.point.IUimaMultiPageEditor#addPagesForCurrentEditor()
*/
@Override
public void addPagesForCurrentEditor() {
boolean allPages = isLocalProcessingDescriptor();
try {
- overviewIndex = addPageAndSetTabTitle(overviewPage = new OverviewPage(this), Messages
- .getString("MultiPageEditor.overviewTab")); //$NON-NLS-1$
-
+ overviewIndex = addPageAndSetTabTitle(overviewPage = new OverviewPage(this),
+ Messages.getString("MultiPageEditor.overviewTab")); //$NON-NLS-1$
+
if (allPages) {
- if (isAeDescriptor())
- {
- aggregateIndex = addPageAndSetTabTitle(aggregatePage = new AggregatePage(this), Messages
- .getString("MultiPageEditor.aggregateTab")); //$NON-NLS-1$
+ if (isAeDescriptor()) {
+ aggregateIndex = addPageAndSetTabTitle(aggregatePage = new AggregatePage(this),
+ Messages.getString("MultiPageEditor.aggregateTab")); //$NON-NLS-1$
}
- parameterIndex = addPageAndSetTabTitle(parameterPage = new ParameterPage(this), Messages
- .getString("MultiPageEditor.parameterTab")); //$NON-NLS-1$
- settingsIndex = addPageAndSetTabTitle(settingsPage = new SettingsPage(this), Messages
- .getString("MultiPageEditor.settingsTab")); //$NON-NLS-1$
+ parameterIndex = addPageAndSetTabTitle(parameterPage = new ParameterPage(this),
+ Messages.getString("MultiPageEditor.parameterTab")); //$NON-NLS-1$
+ settingsIndex = addPageAndSetTabTitle(settingsPage = new SettingsPage(this),
+ Messages.getString("MultiPageEditor.settingsTab")); //$NON-NLS-1$
}
if (allPages || isTypeSystemDescriptor()) {
- typeIndex = addPageAndSetTabTitle(typePage = new TypePage(this), Messages
- .getString("MultiPageEditor.typeTab")); //$NON-NLS-1$
+ typeIndex = addPageAndSetTabTitle(typePage = new TypePage(this),
+ Messages.getString("MultiPageEditor.typeTab")); //$NON-NLS-1$
}
if (allPages) {
- capabilityIndex = addPageAndSetTabTitle(capabilityPage = new CapabilityPage(this), Messages
- .getString("MultiPageEditor.capabilityTab")); //$NON-NLS-1$
+ capabilityIndex = addPageAndSetTabTitle(capabilityPage = new CapabilityPage(this),
+ Messages.getString("MultiPageEditor.capabilityTab")); //$NON-NLS-1$
}
if (allPages || isTypePriorityDescriptor() || isFsIndexCollection()) {
- indexesIndex = addPageAndSetTabTitle(indexesPage = new IndexesPage(this), Messages
- .getString("MultiPageEditor.indexesTab")); //$NON-NLS-1$
+ indexesIndex = addPageAndSetTabTitle(indexesPage = new IndexesPage(this),
+ Messages.getString("MultiPageEditor.indexesTab")); //$NON-NLS-1$
}
if (allPages || isExtResAndBindingsDescriptor()) {
- resourcesIndex = addPageAndSetTabTitle(resourcesPage = new ResourcesPage(this), Messages
- .getString("MultiPageEditor.resourcesTab")); //$NON-NLS-1$
+ resourcesIndex = addPageAndSetTabTitle(resourcesPage = new ResourcesPage(this),
+ Messages.getString("MultiPageEditor.resourcesTab")); //$NON-NLS-1$
}
sourceIndex = addPageAndSetTabTitle(sourceTextEditor = new XMLEditor(this), getEditorInput(),
@@ -1020,7 +1055,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Jcas gen.
*
- * @param monitor the monitor
+ * @param monitor
+ * the monitor
*/
public void jcasGen(IProgressMonitor monitor) {
if (MultiPageEditorContributor.getAutoJCasGen()) {
@@ -1031,11 +1067,12 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Do J cas gen chk src.
*
- * @param monitor the monitor
+ * @param monitor
+ * the monitor
*/
public void doJCasGenChkSrc(IProgressMonitor monitor) {
if (isSourceFolderValid()) {
- doJCasGen(monitor);
+ doJCasGen(monitor);
}
}
@@ -1076,7 +1113,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Checks if is valid AE.
*
- * @param aAe the a ae
+ * @param aAe
+ * the a ae
* @return true, if is valid AE
*/
public boolean isValidAE(AnalysisEngineDescription aAe) {
@@ -1092,11 +1130,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
} catch (Throwable e) { // all these are Throwable to catch errors like
// UnsupportedClassVersionError, which happens if the annotator
// class is compiled for Java 5.0, but the CDE is running Java 1.4.2
- Utility
- .popMessage(
- Messages.getString("MultiPageEditor.failedCollRdrValidation"), //$NON-NLS-1$
- Messages.getString("MultiPageEditor.failedCollRdrValidationMsg") + "\n" + getMessagesToRootCause(e), //$NON-NLS-1$ //$NON-NLS-2$
- MessageDialog.ERROR);
+ Utility.popMessage(Messages.getString("MultiPageEditor.failedCollRdrValidation"), //$NON-NLS-1$
+ Messages.getString("MultiPageEditor.failedCollRdrValidationMsg") + "\n" //$NON-NLS-1$ //$NON-NLS-2$
+ + getMessagesToRootCause(e), MessageDialog.ERROR);
return false;
}
} else if (isCasInitializerDescriptor()) {
@@ -1105,11 +1141,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
try {
casInit.doFullValidation(createResourceManager());
} catch (Throwable e) {
- Utility
- .popMessage(
- Messages.getString("MultiPageEditor.failedCasInitValidation"), //$NON-NLS-1$
- Messages.getString("MultiPageEditor.failedCasInitValidationMsg") + "\n" + getMessagesToRootCause(e), //$NON-NLS-1$ //$NON-NLS-2$
- MessageDialog.ERROR);
+ Utility.popMessage(Messages.getString("MultiPageEditor.failedCasInitValidation"), //$NON-NLS-1$
+ Messages.getString("MultiPageEditor.failedCasInitValidationMsg") + "\n" //$NON-NLS-1$ //$NON-NLS-2$
+ + getMessagesToRootCause(e), MessageDialog.ERROR);
return false;
}
} else if (isCasConsumerDescriptor()) {
@@ -1117,11 +1151,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
try {
casCons.doFullValidation(createResourceManager());
} catch (Throwable e) {
- Utility
- .popMessage(
- Messages.getString("MultiPageEditor.failedCasConsValidation"), //$NON-NLS-1$
- Messages.getString("MultiPageEditor.failedCasConsValidationMsg") + "\n" + getMessagesToRootCause(e), //$NON-NLS-1$ //$NON-NLS-2$
- MessageDialog.ERROR);
+ Utility.popMessage(Messages.getString("MultiPageEditor.failedCasConsValidation"), //$NON-NLS-1$
+ Messages.getString("MultiPageEditor.failedCasConsValidationMsg") + "\n" //$NON-NLS-1$ //$NON-NLS-2$
+ + getMessagesToRootCause(e), MessageDialog.ERROR);
return false;
}
@@ -1132,7 +1164,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
} catch (Throwable e) {
Utility.popMessage("Error in Flow Controller Descriptor",
"The Descriptor is invalid for the following reason:" + "\n"
- + getMessagesToRootCause(e), MessageDialog.ERROR);
+ + getMessagesToRootCause(e),
+ MessageDialog.ERROR);
return false;
}
} else {
@@ -1151,11 +1184,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
try {
ae.doFullValidation(createResourceManager());
} catch (Throwable e) {
- Utility
- .popMessage(
- Messages.getString("MultiPageEditor.failedAeValidation"), //$NON-NLS-1$
- Messages.getString("MultiPageEditor.failedAeValidationMsg") + "\n" + getMessagesToRootCause(e), //$NON-NLS-1$ //$NON-NLS-2$
- MessageDialog.ERROR);
+ Utility.popMessage(Messages.getString("MultiPageEditor.failedAeValidation"), //$NON-NLS-1$
+ Messages.getString("MultiPageEditor.failedAeValidationMsg") + "\n" //$NON-NLS-1$ //$NON-NLS-2$
+ + getMessagesToRootCause(e), MessageDialog.ERROR);
return false;
}
}
@@ -1165,15 +1196,20 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Saves the multi-page editor's document.
*
- * @param monitor the monitor
+ * @param monitor
+ * the monitor
*/
@Override
public void doSave(IProgressMonitor monitor) {
currentEditor.doSaveForCurrentEditor(monitor);
}
-
- /* (non-Javadoc)
- * @see org.apache.uima.taeconfigurator.editors.point.IUimaMultiPageEditor#doSaveForCurrentEditor(org.eclipse.core.runtime.IProgressMonitor)
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.taeconfigurator.editors.point.IUimaMultiPageEditor#doSaveForCurrentEditor(org.
+ * eclipse.core.runtime.IProgressMonitor)
*/
@Override
public void doSaveForCurrentEditor(IProgressMonitor monitor) {
@@ -1185,14 +1221,16 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Finish save.
*
- * @param monitor the monitor
- * @param modelOK the model OK
+ * @param monitor
+ * the monitor
+ * @param modelOK
+ * the model OK
*/
private void finishSave(IProgressMonitor monitor, boolean modelOK) {
if (modelOK) {
if (dirtyTypeNameHash.size() > 0) {
jcasGen(monitor);
- }
+ }
dirtyTypeNameHash.clear();
}
fileDirty = false;
@@ -1210,9 +1248,12 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
public void doSaveAs() {
currentEditor.doSaveAsForCurrentEditor();
}
-
- /* (non-Javadoc)
- * @see org.apache.uima.taeconfigurator.editors.point.IUimaMultiPageEditor#doSaveAsForCurrentEditor()
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.taeconfigurator.editors.point.IUimaMultiPageEditor#doSaveAsForCurrentEditor()
*/
@Override
public void doSaveAsForCurrentEditor() {
@@ -1238,7 +1279,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
finishSave(null, modelOK);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.ui.forms.editor.FormEditor#isDirty()
*/
@Override
@@ -1246,7 +1289,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
return fileDirty;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.ui.part.EditorPart#isSaveOnCloseNeeded()
*/
@Override
@@ -1264,11 +1309,12 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
this.firePropertyChange(ISaveablePart.PROP_DIRTY);
}
}
-
+
/**
* Sets the file dirty flag.
*
- * @param value the new file dirty flag
+ * @param value
+ * the new file dirty flag
*/
// Called by External Editor extensions when doSave or doSaveAs is called
public void setFileDirtyFlag(boolean value) {
@@ -1284,9 +1330,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
public void init(IEditorSite site, IEditorInput editorInput) throws PartInitException {
XMLInputSource input;
- if (!(editorInput instanceof IFileEditorInput))
- {
- throw new PartInitException(Messages.getString("MultiPageEditor.invalidInputClass")); //$NON-NLS-1$
+ if (!(editorInput instanceof IFileEditorInput)) {
+ throw new PartInitException(Messages.getString("MultiPageEditor.invalidInputClass")); //$NON-NLS-1$
}
fileNeedingContext = file = ((IFileEditorInput) editorInput).getFile();
String filePathName = file.getLocation().toOSString();
@@ -1303,7 +1348,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
super.init(site, editorInput); // to allow other editors to get site and editorInput
-
+
// leaves isBadXML set, if it can't parse but isn't throwing
isContextLoaded = false;
try {
@@ -1324,29 +1369,39 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/** The extension editor. */
private IUimaEditorExtension extensionEditor;
-
+
/**
* Parses the source.
*
- * @param input the input
- * @param filePathName the file path name
- * @param preserveComments the preserve comments
- * @throws PartInitException the part init exception
+ * @param input
+ * the input
+ * @param filePathName
+ * the file path name
+ * @param preserveComments
+ * the preserve comments
+ * @throws PartInitException
+ * the part init exception
*/
- private void parseSource(XMLInputSource input, String filePathName, boolean preserveComments) throws PartInitException {
+ private void parseSource(XMLInputSource input, String filePathName, boolean preserveComments)
+ throws PartInitException {
extensionEditor = null;
parseSourceInner(input, filePathName, preserveComments);
}
-
+
/**
* Parses the source inner.
*
- * @param input the input
- * @param filePathName the file path name
- * @param preserveComments the preserve comments
- * @throws PartInitException the part init exception
+ * @param input
+ * the input
+ * @param filePathName
+ * the file path name
+ * @param preserveComments
+ * the preserve comments
+ * @throws PartInitException
+ * the part init exception
*/
- private void parseSourceInner(XMLInputSource input, String filePathName, boolean preserveComments) throws PartInitException {
+ private void parseSourceInner(XMLInputSource input, String filePathName, boolean preserveComments)
+ throws PartInitException {
XMLizable inputDescription = null;
try {
inputDescription = AbstractSection.parseDescriptor(input, preserveComments);
@@ -1382,36 +1437,37 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
extensionEditor = getRequiredEditor(inputDescription);
}
if (null == extensionEditor) {
- throw new PartInitException(Messages.getFormattedString(
- "MultiPageEditor.unrecognizedDescType", //$NON-NLS-1$
- new String[] { AbstractSection.maybeShortenFileName(filePathName) })
- + Messages.getString("MultiPageEditor.11")); //$NON-NLS-1$
+ throw new PartInitException(
+ Messages.getFormattedString("MultiPageEditor.unrecognizedDescType", //$NON-NLS-1$
+ new String[] { AbstractSection.maybeShortenFileName(filePathName) })
+ + Messages.getString("MultiPageEditor.11")); //$NON-NLS-1$
} else {
extensionEditor.activateEditor(getEditorSite(), getEditorInput(), this, inputDescription);
- currentEditor = (IUimaMultiPageEditor)extensionEditor;
+ currentEditor = (IUimaMultiPageEditor) extensionEditor;
}
}
isBadXML = false;
} catch (InvalidXMLException e) {
if (InvalidXMLException.INVALID_DESCRIPTOR_FILE.equals(e.getMessageKey())) {
Throwable cause = e.getCause();
- if ((cause instanceof InvalidXMLException) &&
- InvalidXMLException.UNKNOWN_ELEMENT.equals(((InvalidXMLException)cause).getMessageKey()) &&
- (null == extensionEditor)) {
+ if ((cause instanceof InvalidXMLException)
+ && InvalidXMLException.UNKNOWN_ELEMENT
+ .equals(((InvalidXMLException) cause).getMessageKey())
+ && (null == extensionEditor)) {
// try loading extension editors and reparsing
- extensionEditor = getRequiredEditor((String)((InvalidXMLException)cause).getArguments()[0]);
+ extensionEditor = getRequiredEditor(
+ (String) ((InvalidXMLException) cause).getArguments()[0]);
if (null != extensionEditor) {
// the act of finding the right editor calls that editors init() method
// which could install another parse target result, which would make this
// exception go away - so try reparsing.
-
+
try {
parseSourceInner(new XMLInputSource(input.getURL()), filePathName, preserveComments);
} catch (IOException e1) {
- Utility.popMessage(
- "Internal Error",
- "While parsing input for extension editor: " + getMessagesToRootCause(e1),
- MessageDialog.ERROR);
+ Utility.popMessage("Internal Error",
+ "While parsing input for extension editor: " + getMessagesToRootCause(e1),
+ MessageDialog.ERROR);
throw new InternalErrorCDE(e1);
}
return;
@@ -1420,8 +1476,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
e.printStackTrace();
Utility.popMessage(Messages.getString("MultiPageEditor.XMLerrorInDescriptorTitle"), //$NON-NLS-1$
- Messages.getString("MultiPageEditor.XMLerrorInDescriptor") + "\n" + getMessagesToRootCause(e), //$NON-NLS-1$ //$NON-NLS-2$
- MessageDialog.ERROR);
+ Messages.getString("MultiPageEditor.XMLerrorInDescriptor") + "\n" //$NON-NLS-1$ //$NON-NLS-2$
+ + getMessagesToRootCause(e), MessageDialog.ERROR);
} catch (ResourceInitializationException e) {
// occurs if bad xml
@@ -1435,17 +1491,20 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Validate descriptor type.
*
- * @param newDescriptorType the new descriptor type
- * @throws ResourceInitializationException the resource initialization exception
+ * @param newDescriptorType
+ * the new descriptor type
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
- private void validateDescriptorType(int newDescriptorType) throws ResourceInitializationException {
+ private void validateDescriptorType(int newDescriptorType)
+ throws ResourceInitializationException {
if (0 != descriptorType && !openingContext && ((descriptorType & newDescriptorType) == 0)) {
- throw new ResourceInitializationException(Messages.getString("MultiPageEditor.12"), //$NON-NLS-1$
- Messages.getString("MultiPageEditor.13"), //$NON-NLS-1$
- new String[] { descriptorTypeString(), descriptorTypeString(newDescriptorType) });
+ throw new ResourceInitializationException(Messages.getString("MultiPageEditor.12"), //$NON-NLS-1$
+ Messages.getString("MultiPageEditor.13"), //$NON-NLS-1$
+ new String[] { descriptorTypeString(), descriptorTypeString(newDescriptorType) });
}
if (!openingContext) {
- descriptorType = newDescriptorType;
+ descriptorType = newDescriptorType;
}
}
@@ -1457,7 +1516,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
* have made to any classes that could have been loaded.
*
* @return a resource manager that has a class loader that will search the compiled output of the
- * current project, in addition to the plug-in's classpath
+ * current project, in addition to the plug-in's classpath
*/
public ResourceManager createResourceManager() {
// long time = System.currentTimeMillis();
@@ -1467,15 +1526,16 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
/** The cached R mclass path. */
- private String cachedRMclassPath = null;
-
+ private String cachedRMclassPath = null;
+
/** The cached R mcl. */
private SoftReference<UIMAClassLoader> cachedRMcl = new SoftReference<>(null);
/**
* Creates the resource manager.
*
- * @param classPath the class path
+ * @param classPath
+ * the class path
* @return the resource manager
*/
public ResourceManager createResourceManager(String classPath) {
@@ -1484,33 +1544,31 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
try {
if (null == classPath) {
classPath = getProjectClassPath();
- }
+ }
String dataPath = CDEpropertyPage.getDataPath(getProject());
-
+
// first try to get the value of the class loader from the last (cached)
// value - should succeed frequently because the class loader is only dependent
// on the value of the classpath
-
+
UIMAClassLoader uimaCL = null;
- if (cachedRMclassPath != null &&
- cachedRMclassPath.equals(classPath)) {
+ if (cachedRMclassPath != null && cachedRMclassPath.equals(classPath)) {
uimaCL = cachedRMcl.get();
}
-
+
if (uimaCL != null) {
- ((ResourceManager_impl)resourceManager).setExtensionClassPath(uimaCL, true);
+ ((ResourceManager_impl) resourceManager).setExtensionClassPath(uimaCL, true);
} else {
- // first arg in next is the parent of the class loader. Make it be the
- // uima framework's class loader (not this class's class loader)
- // so the validation tests work properly (that test isAssignableFrom)
- resourceManager.setExtensionClassPath(
- Class_TCCL.get_parent_cl(), // UIMAFramework.class.getClassLoader(),
- classPath,
- true);
+ // first arg in next is the parent of the class loader. Make it be the
+ // uima framework's class loader (not this class's class loader)
+ // so the validation tests work properly (that test isAssignableFrom)
+ resourceManager.setExtensionClassPath(Class_TCCL.get_parent_cl(), // UIMAFramework.class.getClassLoader(),
+ classPath, true);
cachedRMclassPath = classPath;
- cachedRMcl = new SoftReference<>((UIMAClassLoader) resourceManager.getExtensionClassLoader());
+ cachedRMcl = new SoftReference<>(
+ (UIMAClassLoader) resourceManager.getExtensionClassLoader());
}
-
+
// in any case, set the data path
resourceManager.setDataPath(dataPath);
} catch (MalformedURLException e1) {
@@ -1529,16 +1587,22 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
return true;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.ui.forms.editor.FormEditor#pageChange(int)
*/
@Override
protected void pageChange(int newPageIndex) {
currentEditor.pageChangeForCurrentEditor(newPageIndex);
}
-
- /* (non-Javadoc)
- * @see org.apache.uima.taeconfigurator.editors.point.IUimaMultiPageEditor#pageChangeForCurrentEditor(int)
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.taeconfigurator.editors.point.IUimaMultiPageEditor#pageChangeForCurrentEditor(
+ * int)
*/
@Override
public void pageChangeForCurrentEditor(int newPageIndex) {
@@ -1555,16 +1619,15 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
} else if (oldPageIndex == indexesIndex &&
// could be the same page if users chose to
- // edit current descriptor when validateIndexes detected a
- // bad type priorities set
+ // edit current descriptor when validateIndexes detected a
+ // bad type priorities set
newPageIndex != indexesIndex) {
if (!validateIndexes()) {
- return;
- }
- else if (newPageIndex != indexesIndex) {
+ return;
+ } else if (newPageIndex != indexesIndex) {
saveGoodVersionOfTypePriorities();
}
- }
+ }
}
super.pageChange(newPageIndex);
@@ -1578,10 +1641,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
} else if (newPageIndex == sourceIndex) {
if (!isBadXML) {
updateSourceFromModel();
- }
- else {
+ } else {
setActivePageWhileBlockingRecursion(sourceIndex);
- }
+ }
// set sourceChanged if badXML to redo error notification if nothing changed
// in case XML was bad
sourceChanged = (isBadXML || isRevertingIndex) ? true : false;
@@ -1591,7 +1653,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the active page while blocking recursion.
*
- * @param sourceIndex the new active page while blocking recursion
+ * @param sourceIndex
+ * the new active page while blocking recursion
*/
protected void setActivePageWhileBlockingRecursion(int sourceIndex) {
try {
@@ -1618,8 +1681,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Revert to last valid.
*
- * @param msg the msg
- * @param msgDetails the msg details
+ * @param msg
+ * the msg
+ * @param msgDetails
+ * the msg details
* @return true, if successful
*/
private boolean revertToLastValid(String msg, String msgDetails) {
@@ -1673,15 +1738,15 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the char set.
*
- * @param text the text
+ * @param text
+ * the text
* @return the char set
*/
public String getCharSet(String text) {
final String key = Messages.getString("MultiPageEditor.16"); //$NON-NLS-1$
int i = text.indexOf(key);
- if (i == -1)
- {
- return Messages.getString("MultiPageEditor.17"); //$NON-NLS-1$
+ if (i == -1) {
+ return Messages.getString("MultiPageEditor.17"); //$NON-NLS-1$
}
i += key.length();
int end = text.indexOf(Messages.getString("MultiPageEditor.18"), i); //$NON-NLS-1$
@@ -1696,10 +1761,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
private boolean validateSource() {
if (!sourceChanged)
return true;
-
+
isBadXML = true; // preset
- IDocument doc = sourceTextEditor.getDocumentProvider().getDocument(
- sourceTextEditor.getEditorInput());
+ IDocument doc = sourceTextEditor.getDocumentProvider()
+ .getDocument(sourceTextEditor.getEditorInput());
String text = doc.get();
InputStream is;
try {
@@ -1727,15 +1792,15 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
if (isBadXML) {
- return false;
+ return false;
}
if (isPrimitive()) {
- checkForNewlyDirtyTypes(oldTsdWithResolvedImports);
+ checkForNewlyDirtyTypes(oldTsdWithResolvedImports);
}
- checkForNewlyStaleSections(oldAe.getAnalysisEngineMetaData(), aeDescription
- .getAnalysisEngineMetaData());
+ checkForNewlyStaleSections(oldAe.getAnalysisEngineMetaData(),
+ aeDescription.getAnalysisEngineMetaData());
return true;
}
@@ -1749,8 +1814,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Check for newly stale sections.
*
- * @param previous the previous
- * @param current the current
+ * @param previous
+ * the previous
+ * @param current
+ * the current
*/
private void checkForNewlyStaleSections(MetaDataObject previous, MetaDataObject current) {
@@ -1761,40 +1828,42 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
// for now, mark everything as stale
// index tests during development - some pages not done
if (overviewIndex >= 0) {
- ((HeaderPage) pages.get(overviewIndex)).markStale();
+ ((HeaderPage) pages.get(overviewIndex)).markStale();
}
if (aggregateIndex >= 0) {
- ((HeaderPage) pages.get(aggregateIndex)).markStale();
+ ((HeaderPage) pages.get(aggregateIndex)).markStale();
}
if (parameterIndex >= 0) {
- ((HeaderPage) pages.get(parameterIndex)).markStale();
+ ((HeaderPage) pages.get(parameterIndex)).markStale();
}
if (settingsIndex >= 0) {
- ((HeaderPage) pages.get(settingsIndex)).markStale();
+ ((HeaderPage) pages.get(settingsIndex)).markStale();
}
if (typeIndex >= 0) {
- ((HeaderPage) pages.get(typeIndex)).markStale();
+ ((HeaderPage) pages.get(typeIndex)).markStale();
}
if (capabilityIndex >= 0) {
- ((HeaderPage) pages.get(capabilityIndex)).markStale();
+ ((HeaderPage) pages.get(capabilityIndex)).markStale();
}
if (indexesIndex >= 0) {
- ((HeaderPage) pages.get(indexesIndex)).markStale();
+ ((HeaderPage) pages.get(indexesIndex)).markStale();
}
if (resourcesIndex >= 0) {
- ((HeaderPage) pages.get(resourcesIndex)).markStale();
+ ((HeaderPage) pages.get(resourcesIndex)).markStale();
}
}
/**
* Check for newly dirty types.
*
- * @param oldTsd the old tsd
+ * @param oldTsd
+ * the old tsd
*/
private void checkForNewlyDirtyTypes(TypeSystemDescription oldTsd) {
// an array of TypeDescription objects (not CAS), including imported ones
- TypeDescription[] oldTypes = (null == oldTsd || null == oldTsd.getTypes()) ? new TypeDescription[0]
+ TypeDescription[] oldTypes = (null == oldTsd || null == oldTsd.getTypes())
+ ? new TypeDescription[0]
: oldTsd.getTypes();
HashMap oldTypeHash = new HashMap(oldTypes.length);
@@ -1838,21 +1907,16 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
private XMLizable getTrueDescriptor() {
XMLizable thing;
if (isAeDescriptor()) {
- thing = aeDescription;
- }
- else if (isTypeSystemDescriptor()) {
- thing = typeSystemDescription;
- }
- else if (isTypePriorityDescriptor()) {
- thing = aeDescription.getAnalysisEngineMetaData().getTypePriorities();
- }
- else if (isExtResAndBindingsDescriptor()) {
- thing = aeDescription.getResourceManagerConfiguration();
- }
- else if (isFsIndexCollection()) {
- thing = aeDescription.getAnalysisEngineMetaData().getFsIndexCollection();
- }
- else if (isCollectionReaderDescriptor()) {
+ thing = aeDescription;
+ } else if (isTypeSystemDescriptor()) {
+ thing = typeSystemDescription;
+ } else if (isTypePriorityDescriptor()) {
+ thing = aeDescription.getAnalysisEngineMetaData().getTypePriorities();
+ } else if (isExtResAndBindingsDescriptor()) {
+ thing = aeDescription.getResourceManagerConfiguration();
+ } else if (isFsIndexCollection()) {
+ thing = aeDescription.getAnalysisEngineMetaData().getFsIndexCollection();
+ } else if (isCollectionReaderDescriptor()) {
thing = collectionReaderDescription;
linkLocalProcessingDescriptorsFromAe(collectionReaderDescription);
} else if (isCasInitializerDescriptor()) {
@@ -1864,9 +1928,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
} else if (isFlowControllerDescriptor()) {
thing = flowControllerDescription;
linkLocalProcessingDescriptorsFromAe(flowControllerDescription);
- }
- else {
- throw new InternalErrorCDE(Messages.getString("MultiPageEditor.21")); //$NON-NLS-1$
+ } else {
+ throw new InternalErrorCDE(Messages.getString("MultiPageEditor.21")); //$NON-NLS-1$
}
return thing;
}
@@ -1881,8 +1944,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
String parsedText = null;
try {
XMLSerializer xmlSerializer = new XMLSerializer(true);
- xmlSerializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", Integer.valueOf(
- MultiPageEditorContributor.getXMLindent()).toString());
+ xmlSerializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount",
+ Integer.valueOf(MultiPageEditorContributor.getXMLindent()).toString());
xmlSerializer.setIndent(true);
xmlSerializer.setWriter(writer);
ContentHandler contentHandler = xmlSerializer.getContentHandler();
@@ -1891,10 +1954,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
if (trueDescriptor instanceof AnalysisEngineDescription) {
AnalysisEngineDescription aed = (AnalysisEngineDescription) trueDescriptor;
aed.toXML(contentHandler, true, true);
- }
- else {
+ } else {
trueDescriptor.toXML(contentHandler, true);
- }
+ }
contentHandler.endDocument();
writer.close();
parsedText = writer.toString();
@@ -1912,8 +1974,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
*/
public void updateSourceFromModel() {
sourceTextEditor.setIgnoreTextEvent(true);
- IDocument doc = sourceTextEditor.getDocumentProvider().getDocument(
- sourceTextEditor.getEditorInput());
+ IDocument doc = sourceTextEditor.getDocumentProvider()
+ .getDocument(sourceTextEditor.getEditorInput());
doc.set(prettyPrintModel());
sourceTextEditor.setIgnoreTextEvent(false);
}
@@ -1930,26 +1992,27 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the ae description.
*
- * @param aAnalysisEngineDescription the new ae description
- * @throws ResourceInitializationException -
+ * @param aAnalysisEngineDescription
+ * the new ae description
+ * @throws ResourceInitializationException
+ * -
*/
public void setAeDescription(AnalysisEngineDescription aAnalysisEngineDescription)
throws ResourceInitializationException {
- if (null == aAnalysisEngineDescription)
- {
- throw new InternalErrorCDE(Messages.getString("MultiPageEditor.24")); //$NON-NLS-1$
+ if (null == aAnalysisEngineDescription) {
+ throw new InternalErrorCDE(Messages.getString("MultiPageEditor.24")); //$NON-NLS-1$
}
aeDescription = aAnalysisEngineDescription;
try {
// we do this to keep resolvedDelegates update-able
// The value from getDeletageAESpecs is an unmodifiable hash map
- resolvedDelegates.putAll(aeDescription
- .getDelegateAnalysisEngineSpecifiers(createResourceManager()));
+ resolvedDelegates
+ .putAll(aeDescription.getDelegateAnalysisEngineSpecifiers(createResourceManager()));
} catch (InvalidXMLException e) {
throw new ResourceInitializationException(e);
}
- // get the metadata once, because it can be expensive to do
+ // get the metadata once, because it can be expensive to do
AnalysisEngineMetaData md = aeDescription.getAnalysisEngineMetaData();
// These come before setTypeSystemDescription call because that call
@@ -1960,8 +2023,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
resolvedExternalResourcesAndBindings = aeDescription.getResourceManagerConfiguration();
resolvedFlowControllerDeclaration = aeDescription.getFlowControllerDeclaration();
- setTypeSystemDescription(aeDescription.isPrimitive() ? md.getTypeSystem() : null);
- // aggregates have null type system descriptors.
+ setTypeSystemDescription(aeDescription.isPrimitive() ? md.getTypeSystem() : null);
+ // aggregates have null type system descriptors.
// If passed in one that isn't null, make it null.
// These come after setTypeSystemDescription call, even though
@@ -1988,8 +2051,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the type system description.
*
- * @param typeSystemDescription the new type system description
- * @throws ResourceInitializationException the resource initialization exception
+ * @param typeSystemDescription
+ * the new type system description
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
// Also called for aggregate TAEs
public void setTypeSystemDescription(TypeSystemDescription typeSystemDescription)
@@ -2009,16 +2074,16 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
setMergedTypeSystemDescription();
-
+
// setImportedTypeSystemDescription(); // done in above call
if (aeDescription == null) {
- aeDescription = UIMAFramework.getResourceSpecifierFactory().createAnalysisEngineDescription();
+ aeDescription = UIMAFramework.getResourceSpecifierFactory().createAnalysisEngineDescription();
}
aeDescription.getAnalysisEngineMetaData().setTypeSystem(this.typeSystemDescription);
if (doValidation) {
- descriptorCAS.validate();
+ descriptorCAS.validate();
}
}
@@ -2027,7 +2092,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Link local processing descriptors from ae.
*
- * @param d the d
+ * @param d
+ * the d
*/
// **************************************************************
private void linkLocalProcessingDescriptorsFromAe(CollectionReaderDescription d) {
@@ -2039,7 +2105,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Link local processing descriptors from ae.
*
- * @param d the d
+ * @param d
+ * the d
*/
private void linkLocalProcessingDescriptorsFromAe(CasInitializerDescription d) {
d.setImplementationName(aeDescription.getAnnotatorImplementationName());
@@ -2050,7 +2117,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Link local processing descriptors from ae.
*
- * @param d the d
+ * @param d
+ * the d
*/
private void linkLocalProcessingDescriptorsFromAe(CasConsumerDescription d) {
d.setImplementationName(aeDescription.getAnnotatorImplementationName());
@@ -2061,7 +2129,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Link local processing descriptors from ae.
*
- * @param d the d
+ * @param d
+ * the d
*/
private void linkLocalProcessingDescriptorsFromAe(FlowControllerDescription d) {
d.setImplementationName(aeDescription.getAnnotatorImplementationName());
@@ -2072,7 +2141,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Link common collection descriptors from ae.
*
- * @param r the r
+ * @param r
+ * the r
*/
private void linkCommonCollectionDescriptorsFromAe(ResourceCreationSpecifier r) {
r.setExternalResourceDependencies(aeDescription.getExternalResourceDependencies());
@@ -2087,8 +2157,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Creates the and link local processing descriptors to ae.
*
- * @param d the d
- * @throws ResourceInitializationException the resource initialization exception
+ * @param d
+ * the d
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void createAndLinkLocalProcessingDescriptorsToAe(CollectionReaderDescription d)
throws ResourceInitializationException {
@@ -2101,8 +2173,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Creates the and link local processing descriptors to ae.
*
- * @param d the d
- * @throws ResourceInitializationException the resource initialization exception
+ * @param d
+ * the d
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void createAndLinkLocalProcessingDescriptorsToAe(CasInitializerDescription d)
throws ResourceInitializationException {
@@ -2115,8 +2189,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Creates the and link local processing descriptors to ae.
*
- * @param d the d
- * @throws ResourceInitializationException the resource initialization exception
+ * @param d
+ * the d
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void createAndLinkLocalProcessingDescriptorsToAe(CasConsumerDescription d)
throws ResourceInitializationException {
@@ -2129,8 +2205,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Creates the and link local processing descriptors to ae.
*
- * @param d the d
- * @throws ResourceInitializationException the resource initialization exception
+ * @param d
+ * the d
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void createAndLinkLocalProcessingDescriptorsToAe(FlowControllerDescription d)
throws ResourceInitializationException {
@@ -2143,8 +2221,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Link local processing descriptors to ae.
*
- * @param r the r
- * @throws ResourceInitializationException the resource initialization exception
+ * @param r
+ * the r
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void linkLocalProcessingDescriptorsToAe(ResourceCreationSpecifier r)
throws ResourceInitializationException {
@@ -2158,7 +2238,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Convert to ae meta data.
*
- * @param r the r
+ * @param r
+ * the r
* @return the analysis engine meta data
*/
private AnalysisEngineMetaData convertToAeMetaData(ResourceMetaData r) {
@@ -2177,14 +2258,15 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
d.setVendor(p.getVendor());
d.setVersion(p.getVersion());
d.setOperationalProperties(p.getOperationalProperties());
- ((AnalysisEngineMetaData_impl)d).setInfoset(((MetaDataObject_impl)r).getInfoset());
+ ((AnalysisEngineMetaData_impl) d).setInfoset(((MetaDataObject_impl) r).getInfoset());
return d;
}
/**
* Convert from ae meta data.
*
- * @param p the p
+ * @param p
+ * the p
* @return the processing resource meta data
*/
private ProcessingResourceMetaData convertFromAeMetaData(AnalysisEngineMetaData p) {
@@ -2202,15 +2284,17 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
d.setVendor(p.getVendor());
d.setVersion(p.getVersion());
d.setOperationalProperties(p.getOperationalProperties());
- ((MetaDataObject_impl)d).setInfoset(((MetaDataObject_impl)p).getInfoset());
+ ((MetaDataObject_impl) d).setInfoset(((MetaDataObject_impl) p).getInfoset());
return d;
}
/**
* Sets the collection reader description.
*
- * @param d the new collection reader description
- * @throws ResourceInitializationException the resource initialization exception
+ * @param d
+ * the new collection reader description
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void setCollectionReaderDescription(CollectionReaderDescription d)
throws ResourceInitializationException {
@@ -2221,8 +2305,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the cas initializer description.
*
- * @param d the new cas initializer description
- * @throws ResourceInitializationException the resource initialization exception
+ * @param d
+ * the new cas initializer description
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void setCasInitializerDescription(CasInitializerDescription d)
throws ResourceInitializationException {
@@ -2233,8 +2319,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the cas consumer description.
*
- * @param d the new cas consumer description
- * @throws ResourceInitializationException the resource initialization exception
+ * @param d
+ * the new cas consumer description
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void setCasConsumerDescription(CasConsumerDescription d)
throws ResourceInitializationException {
@@ -2245,8 +2333,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the flow controller description.
*
- * @param d the new flow controller description
- * @throws ResourceInitializationException the resource initialization exception
+ * @param d
+ * the new flow controller description
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void setFlowControllerDescription(FlowControllerDescription d)
throws ResourceInitializationException {
@@ -2257,8 +2347,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the type priorities.
*
- * @param typePriorities the new type priorities
- * @throws ResourceInitializationException the resource initialization exception
+ * @param typePriorities
+ * the new type priorities
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void setTypePriorities(TypePriorities typePriorities)
throws ResourceInitializationException {
@@ -2273,7 +2365,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
* The Class MultilevelCancel.
*/
private static class MultilevelCancel extends RuntimeException {
-
+
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 1L;
}
@@ -2281,12 +2373,13 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Load context.
*
- * @param thing the thing
+ * @param thing
+ * the thing
*/
private void loadContext(XMLizable thing) {
// try to load a context that has the types
if (isContextLoaded) {
- return;
+ return;
}
String contextFile = null;
XMLInputSource input = null;
@@ -2299,22 +2392,21 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
} catch (CoreException e) {
throw new InternalErrorCDE("unexpected exception", e);
}
- ContextForPartDialog dialog = new ContextForPartDialog(PlatformUI.getWorkbench().getDisplay()
- .getShells()[0], // ok in Eclipse 3.0
- getFile().getProject().getParent(), thing, getFile().getLocation(), this, contextFile);
+ ContextForPartDialog dialog = new ContextForPartDialog(
+ PlatformUI.getWorkbench().getDisplay().getShells()[0], // ok in Eclipse 3.0
+ getFile().getProject().getParent(), thing, getFile().getLocation(), this,
+ contextFile);
dialog.setTitle("File specifying context for editing importable part");
if (dialog.open() == Window.CANCEL) {
throw new MultilevelCancel();
- }
+ }
contextFile = dialog.contextPath;
if (null == contextFile) {
- Utility
- .popMessage(
- "Context Info",
- "A context is required to edit this part. However no context was supplied. Editing will be cancelled",
- MessageDialog.INFORMATION);
+ Utility.popMessage("Context Info",
+ "A context is required to edit this part. However no context was supplied. Editing will be cancelled",
+ MessageDialog.INFORMATION);
throw new MultilevelCancel();
} else {
try {
@@ -2324,12 +2416,12 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
throw new MultilevelCancel();
}
if (null != input) {
- try {
- parseSource(input, contextFile, !PRESERVE_COMMENTS);
- } catch (PartInitException e) {
- showContextLoadFailureMessage(e, contextFile);
- throw new MultilevelCancel();
- }
+ try {
+ parseSource(input, contextFile, !PRESERVE_COMMENTS);
+ } catch (PartInitException e) {
+ showContextLoadFailureMessage(e, contextFile);
+ throw new MultilevelCancel();
+ }
}
}
} finally {
@@ -2342,8 +2434,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
file.setPersistentProperty(new QualifiedName(AbstractSection.PLUGIN_ID,
AbstractSection.IMPORTABLE_PART_CONTEXT), contextFile);
} catch (CoreException e) {
- Utility.popMessage("Unexpected Exception", "While loading Context"
- + getMessagesToRootCause(e), MessageDialog.ERROR);
+ Utility.popMessage("Unexpected Exception",
+ "While loading Context" + getMessagesToRootCause(e), MessageDialog.ERROR);
throw new InternalErrorCDE("Unexpected Exception:" + getMessagesToRootCause(e), e);
}
}
@@ -2352,8 +2444,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the fs index collection.
*
- * @param indexCollection the new fs index collection
- * @throws ResourceInitializationException the resource initialization exception
+ * @param indexCollection
+ * the new fs index collection
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void setFsIndexCollection(FsIndexCollection indexCollection)
throws ResourceInitializationException {
@@ -2367,23 +2461,28 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Show context load failure message.
*
- * @param e the e
- * @param contextFile the context file
+ * @param e
+ * the e
+ * @param contextFile
+ * the context file
*/
private void showContextLoadFailureMessage(Exception e, String contextFile) {
String m = Messages.getFormattedString("MultiPageEditor.IOError", //$NON-NLS-1$
new String[] { AbstractSection.maybeShortenFileName(contextFile) })
+ Messages.getString("MultiPageEditor.10") + getMessagesToRootCause(e); //$NON-NLS-1$
- Utility.popMessage("Cannot load context", m
- + "\nCannot load the context file for this importable part due to an I/O exception"
- + " - proceeding without context", MessageDialog.WARNING);
+ Utility.popMessage("Cannot load context",
+ m + "\nCannot load the context file for this importable part due to an I/O exception"
+ + " - proceeding without context",
+ MessageDialog.WARNING);
}
/**
* Only called when editing a resources/bindings descriptor.
*
- * @param rb the new ext res and bindings
- * @throws ResourceInitializationException -
+ * @param rb
+ * the new ext res and bindings
+ * @throws ResourceInitializationException
+ * -
*/
private void setExtResAndBindings(ResourceManagerConfiguration rb)
throws ResourceInitializationException {
@@ -2401,7 +2500,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the absolute path from import.
*
- * @param importItem the import item
+ * @param importItem
+ * the import item
* @return the absolute path from import
*/
public String getAbsolutePathFromImport(Import importItem) {
@@ -2412,7 +2512,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the absolute UR lfrom import.
*
- * @param importItem the import item
+ * @param importItem
+ * the import item
* @return the absolute UR lfrom import
*/
private URL getAbsoluteURLfromImport(Import importItem) {
@@ -2529,7 +2630,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
* gets the Hash Map of resolved AE delegates Clones the description first because the getting
* updates it in some cases.
*
- * @param aed the aed
+ * @param aed
+ * the aed
* @return the Map of resolved AE delegates
*/
public Map getDelegateAEdescriptions(AnalysisEngineDescription aed) {
@@ -2570,8 +2672,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
public IProject getProject() {
IFile iFile = getFile();
if (null == iFile) {
- // call
- return null;
+ // call
+ return null;
}
return getFile().getProject();
}
@@ -2592,7 +2694,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the descriptor relative path.
*
- * @param aFullOrRelativePath the a full or relative path
+ * @param aFullOrRelativePath
+ * the a full or relative path
* @return the descriptor relative path
*/
public String getDescriptorRelativePath(String aFullOrRelativePath) {
@@ -2628,8 +2731,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the common parent folder.
*
- * @param sFile1 the s file 1
- * @param sFile2 the s file 2
+ * @param sFile1
+ * the s file 1
+ * @param sFile2
+ * the s file 2
* @return the common parent folder
*/
private static String getCommonParentFolder(String sFile1, String sFile2) {
@@ -2658,7 +2763,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Checks if is file in workspace.
*
- * @param aFileRelPath the a file rel path
+ * @param aFileRelPath
+ * the a file rel path
* @return true, if is file in workspace
*/
public boolean isFileInWorkspace(String aFileRelPath) {
@@ -2669,7 +2775,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the full path from descriptor relative path.
*
- * @param aDescRelPath the a desc rel path
+ * @param aDescRelPath
+ * the a desc rel path
* @return the full path from descriptor relative path
*/
public String getFullPathFromDescriptorRelativePath(String aDescRelPath) {
@@ -2723,14 +2830,14 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
return sEditorFileFullPath.substring(0,
- subDirMarkerLocs[nSubDirCount - nCountDirsToBackup - 1] + 1)
- + sFinalFragment;
+ subDirMarkerLocs[nSubDirCount - nCountDirsToBackup - 1] + 1) + sFinalFragment;
}
/**
* Open.
*
- * @param fileToOpen the file to open
+ * @param fileToOpen
+ * the file to open
*/
public void open(IFile fileToOpen) {
final IFile ffile = fileToOpen;
@@ -2751,7 +2858,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Open text editor.
*
- * @param fileToOpen the file to open
+ * @param fileToOpen
+ * the file to open
*/
public void openTextEditor(IFile fileToOpen) {
final IFile ffile = fileToOpen;
@@ -2772,7 +2880,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the i file or file.
*
- * @param relOrAbsPath the rel or abs path
+ * @param relOrAbsPath
+ * the rel or abs path
* @return the i file or file
*/
public Object getIFileOrFile(String relOrAbsPath) {
@@ -2790,7 +2899,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Open.
*
- * @param fullPath the full path
+ * @param fullPath
+ * the full path
*/
public void open(String fullPath) {
Path path = new Path(fullPath);
@@ -2801,7 +2911,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Open text editor.
*
- * @param fullPath the full path
+ * @param fullPath
+ * the full path
*/
public void openTextEditor(String fullPath) {
Path path = new Path(fullPath);
@@ -2812,7 +2923,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Adds the dirty type name.
*
- * @param typeName the type name
+ * @param typeName
+ * the type name
*/
public void addDirtyTypeName(String typeName) {
dirtyTypeNameHash.add(typeName);
@@ -2831,7 +2943,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Removes the dirty type name.
*
- * @param typeName the type name
+ * @param typeName
+ * the type name
*/
public void removeDirtyTypeName(String typeName) {
dirtyTypeNameHash.remove(typeName);
@@ -2841,22 +2954,22 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Do J cas gen.
*
- * @param monitor the monitor
+ * @param monitor
+ * the monitor
*/
public void doJCasGen(IProgressMonitor monitor) {
if (0 < mergedTypesAddingFeatures.size()) {
- if (Window.CANCEL ==
- Utility.popOkCancel("Type feature merging extended features",
- "Before generating the JCas classes for the CAS types, please note that " +
- "the following types were generated by merging different type descriptors, " +
- "where the resulting number of features is larger than that of the components. " +
- "Although the resulting generated JCas classes are correct, " +
- "doing this kind of merging makes reuse of this component more difficult." +
- makeMergeMessage(mergedTypesAddingFeatures) +
- "\n Press OK to generate the JCas classes anyway, or cancel to skip generating the JCas classes.",
+ if (Window.CANCEL == Utility.popOkCancel("Type feature merging extended features",
+ "Before generating the JCas classes for the CAS types, please note that "
+ + "the following types were generated by merging different type descriptors, "
+ + "where the resulting number of features is larger than that of the components. "
+ + "Although the resulting generated JCas classes are correct, "
+ + "doing this kind of merging makes reuse of this component more difficult."
+ + makeMergeMessage(mergedTypesAddingFeatures)
+ + "\n Press OK to generate the JCas classes anyway, or cancel to skip generating the JCas classes.",
MessageDialog.WARNING)) {
return;
- }
+ }
}
final JCasGenThrower jCasGenThrower = new JCasGenThrower();
@@ -2873,14 +2986,15 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
try {
jg.mainForCde(new MergerImpl(), new JCasGenProgressMonitor(progressMonitor),
jCasGenThrower, inputFile, outputDirectory, types, (CASImpl) getCurrentView(),
- getProject().getLocation().toString(), // https://issues.apache.org/jira/browse/UIMA-5715
- // getLocationURI().getPath(), // on linux/mars, was returning /default/project.name etc
- limitJCasGenToProjectScope,
- mergedTypesAddingFeatures);
+ getProject().getLocation().toString(), // https://issues.apache.org/jira/browse/UIMA-5715
+ // getLocationURI().getPath(), // on linux/mars, was returning
+ // /default/project.name etc
+ limitJCasGenToProjectScope, mergedTypesAddingFeatures);
} catch (IOException e) {
Utility.popMessage(Messages.getString("MultiPageEditor.25"), //$NON-NLS-1$
Messages.getString("MultiPageEditor.26") //$NON-NLS-1$
- + getMessagesToRootCause(e), MessageDialog.ERROR);
+ + getMessagesToRootCause(e),
+ MessageDialog.ERROR);
}
}
};
@@ -2891,13 +3005,15 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
if (null != jcasMsg && jcasMsg.length() > 0) {
Utility.popMessage(Messages.getString("MultiPageEditor.JCasGenErrorTitle"), //$NON-NLS-1$
Messages.getFormattedString("MultiPageEditor.jcasGenErr", //$NON-NLS-1$
- new String[] { jcasMsg }), MessageDialog.ERROR);
+ new String[] { jcasMsg }),
+ MessageDialog.ERROR);
System.out.println(jcasMsg);
}
} catch (Exception ex) {
Utility.popMessage(Messages.getString("MultiPageEditor.JCasGenErrorTitle"), //$NON-NLS-1$
Messages.getFormattedString("MultiPageEditor.jcasGenErr", //$NON-NLS-1$
- new String[] { jCasGenThrower.getMessage() }), MessageDialog.ERROR);
+ new String[] { jCasGenThrower.getMessage() }),
+ MessageDialog.ERROR);
ex.printStackTrace();
}
}
@@ -2905,25 +3021,26 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Make merge message.
*
- * @param m the m
+ * @param m
+ * the m
* @return the string
*/
// message: TypeName = ".....", URLs defining this type = "xxxx", "xxxx", ....
private String makeMergeMessage(Map m) {
- StringBuffer sb = new StringBuffer();
+ StringBuffer sb = new StringBuffer();
for (Iterator it = m.entrySet().iterator(); it.hasNext();) {
- Map.Entry entry = (Map.Entry)it.next();
- String typeName =(String)entry.getKey();
+ Map.Entry entry = (Map.Entry) it.next();
+ String typeName = (String) entry.getKey();
sb.append("\n ");
- sb.append("TypeName having merged features = ").append(typeName).append("\n URLs defining this type =");
- Set urls = (Set)entry.getValue();
+ sb.append("TypeName having merged features = ").append(typeName)
+ .append("\n URLs defining this type =");
+ Set urls = (Set) entry.getValue();
boolean afterFirst = false;
for (Iterator itUrls = urls.iterator(); itUrls.hasNext();) {
if (afterFirst) {
- sb.append(",\n ");
- }
- else {
- sb.append("\n ");
+ sb.append(",\n ");
+ } else {
+ sb.append("\n ");
}
afterFirst = true;
String url = (String) itUrls.next();
@@ -2946,18 +3063,21 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
* Gets the project class path.
*
* @return the project class path
- * @throws CoreException the core exception
+ * @throws CoreException
+ * the core exception
*/
public String getProjectClassPath() throws CoreException {
return getFilteredProjectClassPath(true);
}
-
+
/**
* Gets the filtered project class path.
*
- * @param filterCoreResources the filter core resources
+ * @param filterCoreResources
+ * the filter core resources
* @return the filtered project class path
- * @throws CoreException the core exception
+ * @throws CoreException
+ * the core exception
*/
public String getFilteredProjectClassPath(boolean filterCoreResources) throws CoreException {
IProject project = getProject();
@@ -2971,7 +3091,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
IResource classFileResource = projectRoot.findMember(".classpath"); //$NON-NLS-1$
long stamp = classFileResource.getModificationStamp();
if (stamp == cachedStamp && filterCoreResources) {
- return cachedClassPath;
+ return cachedClassPath;
}
StringBuffer result = new StringBuffer(1000);
@@ -2993,13 +3113,13 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
if (null == checker ||
// || null != checker.findResource("java/lang/Object.class")
// //$NON-NLS-1$
- null != checker.findResource("org/apache/uima/impl/UIMAFramework_impl.class")) { //$NON-NLS-1$
+ null != checker.findResource("org/apache/uima/impl/UIMAFramework_impl.class")) { //$NON-NLS-1$
continue;
}
}
if (result.length() > 0) {
result = result.append(PATH_SEPARATOR);
- }
+ }
result = result.append(classPath);
}
if (filterCoreResources) {
@@ -3008,7 +3128,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
return cachedClassPath;
}
return result.toString();
-
+
}
/**
@@ -3042,7 +3162,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the save as status.
*
- * @param nStatus the new save as status
+ * @param nStatus
+ * the new save as status
*/
public void setSaveAsStatus(int nStatus) {
m_nSaveAsStatus = nStatus;
@@ -3090,7 +3211,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Validate inputs.
*
- * @param typeNameHash the type name hash
+ * @param typeNameHash
+ * the type name hash
* @return true, if successful
*/
// returns true if no inputs were removed, false otherwise
@@ -3101,7 +3223,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Validate outputs.
*
- * @param typeNameHash the type name hash
+ * @param typeNameHash
+ * the type name hash
* @return true, if successful
*/
// returns true if no outputs were removed, false otherwise
@@ -3112,8 +3235,10 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Validate I os.
*
- * @param isValidateInputs the is validate inputs
- * @param typeNameHash the type name hash
+ * @param isValidateInputs
+ * the is validate inputs
+ * @param typeNameHash
+ * the type name hash
* @return true, if successful
*/
public boolean validateIOs(boolean isValidateInputs, Map typeNameHash) {
@@ -3125,8 +3250,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
return true;
}
- TypeOrFeature[] oldIOs = (isValidateInputs) ? capabilities[0].getInputs() : capabilities[0]
- .getOutputs();
+ TypeOrFeature[] oldIOs = (isValidateInputs) ? capabilities[0].getInputs()
+ : capabilities[0].getOutputs();
Vector validIOs = new Vector();
for (int i = 0; i < oldIOs.length; i++) {
String typeName;
@@ -3150,10 +3275,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
if (isValidateInputs) {
- capabilities[0].setInputs(newIOs);
- }
- else {
- capabilities[0].setOutputs(newIOs);
+ capabilities[0].setInputs(newIOs);
+ } else {
+ capabilities[0].setOutputs(newIOs);
}
}
}
@@ -3164,7 +3288,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Validate type priorities.
*
- * @param typeNameHash the type name hash
+ * @param typeNameHash
+ * the type name hash
* @return true, if successful
*/
// returns true if no type priorities were modified, false otherwise
@@ -3204,12 +3329,14 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/** The Constant previewSize. */
private static final int previewSize = 1024 * 16;
-
+
/**
* Used by code to get lists of delegate components by input/output type specs.
*
- * @param iFile the i file
- * @param componentHeaders the component headers
+ * @param iFile
+ * the i file
+ * @param componentHeaders
+ * the component headers
* @return the delegate resource specifier
*/
public static ResourceSpecifier getDelegateResourceSpecifier(IFile iFile,
@@ -3230,11 +3357,11 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
while (true) {
int tempCharsRead = fileReader.read(acBuffer, nCharsRead, previewSize - nCharsRead);
if (-1 == tempCharsRead) {
- break;
+ break;
}
nCharsRead = nCharsRead + tempCharsRead;
if (nCharsRead >= previewSize) {
- break;
+ break;
}
}
} catch (FileNotFoundException e) {
@@ -3247,19 +3374,19 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
fileReader.close();
} catch (IOException e1) {
}
- }
+ }
}
if (-1 == nCharsRead) {
- return null;
+ return null;
}
String sBuffer = (new String(acBuffer, 0, nCharsRead)).toLowerCase();
for (int i = 0; i < componentHeaders.length; i++) {
if (-1 != sBuffer.indexOf(componentHeaders[i])) {
break;
- }
+ }
if (i == (componentHeaders.length - 1)) {
return null;
- }
+ }
}
try {
@@ -3269,10 +3396,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
|| inputDescription instanceof CasConsumerDescription
|| inputDescription instanceof FlowControllerDescription) {
return (ResourceCreationSpecifier) inputDescription;
- }
- else if (inputDescription instanceof ResourceServiceSpecifier) {
+ } else if (inputDescription instanceof ResourceServiceSpecifier) {
return (ResourceSpecifier) inputDescription;
- }
+ }
return null;
} catch (IOException e) {
return null;
@@ -3286,7 +3412,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the messages to root cause.
*
- * @param e the e
+ * @param e
+ * the e
* @return the messages to root cause
*/
// **************************************************
@@ -3294,19 +3421,19 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
boolean wantStackTrace = false;
StringBuffer b = new StringBuffer(200);
String messagePart = e.getMessage();
-
+
// messages for noClassDef found and NPE don't say what the problem was,
// so always include the exception class also
-
+
formatMessageWithClass(e, b, messagePart);
if (null == messagePart) {
wantStackTrace = true;
}
-// if (null == messagePart) {
-// b.append(e.getClass().getName());
-// wantStackTrace = true;
-// } else
-// b.append(messagePart);
+ // if (null == messagePart) {
+ // b.append(e.getClass().getName());
+ // wantStackTrace = true;
+ // } else
+ // b.append(messagePart);
Throwable cur = e;
Throwable next;
@@ -3338,15 +3465,18 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Format message with class.
*
- * @param e the e
- * @param b the b
- * @param messagePart the message part
+ * @param e
+ * the e
+ * @param b
+ * the b
+ * @param messagePart
+ * the message part
*/
private void formatMessageWithClass(Throwable e, StringBuffer b, String messagePart) {
String name = e.getClass().getName();
- //because this is a message for ordinary users, and
+ // because this is a message for ordinary users, and
// because the exceptions are more easily readable without their package prefixes,
- // remove the package prefix from the displayed name
+ // remove the package prefix from the displayed name
int lastDot = name.lastIndexOf('.');
if (lastDot >= 0) {
name = name.substring(lastDot + 1);
@@ -3356,20 +3486,21 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
b.append(": ").append(messagePart);
}
}
-
+
/**
* The Class JCasGenProgressMonitor.
*/
- public static class JCasGenProgressMonitor implements
- org.apache.uima.tools.jcasgen.IProgressMonitor {
-
+ public static class JCasGenProgressMonitor
+ implements org.apache.uima.tools.jcasgen.IProgressMonitor {
+
/** The m progress monitor. */
IProgressMonitor m_progressMonitor;
/**
* Instantiates a new j cas gen progress monitor.
*
- * @param progressMonitor the progress monitor
+ * @param progressMonitor
+ * the progress monitor
*/
public JCasGenProgressMonitor(IProgressMonitor progressMonitor) {
m_progressMonitor = progressMonitor;
@@ -3441,7 +3572,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
+ message);
if (null != ex) {
ex.printStackTrace();
- }
+ }
if (IError.WARN < severity) {
m_message = message;
throw new Jg.ErrorExit();
@@ -3465,8 +3596,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
*/
public Color getFadeColor() {
if (null == fadeColor) {
- // COLOR_WIDGET_DARK_SHADOW is the same as black on SUSE KDE
- fadeColor = getSite().getShell().getDisplay().getSystemColor(SWT.COLOR_WIDGET_NORMAL_SHADOW);
+ // COLOR_WIDGET_DARK_SHADOW is the same as black on SUSE KDE
+ fadeColor = getSite().getShell().getDisplay().getSystemColor(SWT.COLOR_WIDGET_NORMAL_SHADOW);
}
return fadeColor;
}
@@ -3476,7 +3607,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the merged type system description.
*
- * @param saved the new merged type system description
+ * @param saved
+ * the new merged type system description
*/
// **********************
public void setMergedTypeSystemDescription(TypeSystemDescription saved) {
@@ -3486,7 +3618,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the imported type system description.
*
- * @param saved the new imported type system description
+ * @param saved
+ * the new imported type system description
*/
public void setImportedTypeSystemDescription(TypeSystemDescription saved) {
importedTypeSystemDescription = saved;
@@ -3495,7 +3628,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the imported type system description.
*
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void setImportedTypeSystemDescription() throws ResourceInitializationException {
Collection tsdc = new ArrayList(1);
@@ -3506,23 +3640,23 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
tsdc.clear();
tsdc.add(tsd);
- importedTypeSystemDescription = CasCreationUtils
- .mergeTypeSystems(tsdc, createResourceManager());
+ importedTypeSystemDescription = CasCreationUtils.mergeTypeSystems(tsdc,
+ createResourceManager());
}
/**
* Sets the merged type system description.
*
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
public void setMergedTypeSystemDescription() throws ResourceInitializationException {
mergedTypesAddingFeatures.clear();
if (isAggregate()) {
- mergedTypeSystemDescription = mergeDelegateAnalysisEngineTypeSystems(
- (AnalysisEngineDescription) aeDescription.clone(), createResourceManager(),
- mergedTypesAddingFeatures);
- }
- else {
+ mergedTypeSystemDescription = mergeDelegateAnalysisEngineTypeSystems(
+ (AnalysisEngineDescription) aeDescription.clone(), createResourceManager(),
+ mergedTypesAddingFeatures);
+ } else {
if (null == typeSystemDescription) {
mergedTypeSystemDescription = null;
} else {
@@ -3561,7 +3695,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the merged fs index collection.
*
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
public void setMergedFsIndexCollection() throws ResourceInitializationException {
mergedFsIndexCollection = mergeDelegateAnalysisEngineFsIndexCollections(
@@ -3571,7 +3706,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the merged fs index collection.
*
- * @param saved the new merged fs index collection
+ * @param saved
+ * the new merged fs index collection
*/
public void setMergedFsIndexCollection(FsIndexCollection saved) {
mergedFsIndexCollection = saved;
@@ -3589,11 +3725,12 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the merged type priorities.
*
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
// full merge - including locally defined and imported ones
public void setMergedTypePriorities() throws ResourceInitializationException {
-
+
mergedTypePriorities = mergeDelegateAnalysisEngineTypePriorities(
(AnalysisEngineDescription) aeDescription.clone(), createResourceManager());
}
@@ -3601,7 +3738,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the merged type priorities.
*
- * @param saved the new merged type priorities
+ * @param saved
+ * the new merged type priorities
*/
public void setMergedTypePriorities(TypePriorities saved) {
mergedTypePriorities = saved;
@@ -3619,16 +3757,16 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the resolved flow controller declaration.
*
- * @throws InvalidXMLException the invalid XML exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
*/
public void setResolvedFlowControllerDeclaration() throws InvalidXMLException {
FlowControllerDeclaration fcDecl = aeDescription.getFlowControllerDeclaration();
if (null != fcDecl) {
resolvedFlowControllerDeclaration = (FlowControllerDeclaration) fcDecl.clone();
resolvedFlowControllerDeclaration.resolveImports(createResourceManager());
- }
- else {
- resolvedFlowControllerDeclaration = null;
+ } else {
+ resolvedFlowControllerDeclaration = null;
}
}
@@ -3647,13 +3785,14 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
*
* But: resolving does fit. So we name this differently
*
- * @throws InvalidXMLException -
+ * @throws InvalidXMLException
+ * -
*/
public void setResolvedExternalResourcesAndBindings() throws InvalidXMLException {
AnalysisEngineDescription clonedAe = (AnalysisEngineDescription) aeDescription.clone();
ResourceManagerConfiguration rmc = clonedAe.getResourceManagerConfiguration();
if (null != rmc) {
- rmc.resolveImports(createResourceManager());
+ rmc.resolveImports(createResourceManager());
}
resolvedExternalResourcesAndBindings = rmc;
}
@@ -3661,7 +3800,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the resolved external resources and bindings.
*
- * @param saved the new resolved external resources and bindings
+ * @param saved
+ * the new resolved external resources and bindings
*/
public void setResolvedExternalResourcesAndBindings(ResourceManagerConfiguration saved) {
resolvedExternalResourcesAndBindings = saved;
@@ -3679,13 +3819,14 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the imported fs index collection.
*
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private void setImportedFsIndexCollection() throws ResourceInitializationException {
AnalysisEngineDescription localAe = (AnalysisEngineDescription) aeDescription.clone();
localAe.getAnalysisEngineMetaData().setFsIndexCollection(null);
- importedFsIndexCollection = CasCreationUtils.mergeDelegateAnalysisEngineFsIndexCollections(
- localAe, createResourceManager());
+ importedFsIndexCollection = CasCreationUtils
+ .mergeDelegateAnalysisEngineFsIndexCollections(localAe, createResourceManager());
}
/**
@@ -3702,7 +3843,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Sets the imported type priorities.
*
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
// (only locally defined ones can be edited)
private void setImportedTypePriorities() throws ResourceInitializationException {
@@ -3749,9 +3891,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
public ITextEditor getSourcePageEditor() {
if (getCurrentPage() == sourceIndex) {
return sourceTextEditor;
- }
- else {
- return null;
+ } else {
+ return null;
}
}
@@ -3773,7 +3914,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Gets the type from project.
*
- * @param typename the typename
+ * @param typename
+ * the typename
* @return the type from project
*/
public IType getTypeFromProject(String typename) {
@@ -3782,9 +3924,11 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
try {
return jp.findType(typename);
} catch (JavaModelException e) {
- Utility.popMessage("Unexpected Exception", MessageFormat.format(
- "Unexpected exception while getting type information for type ''{0}''. {1}",
- new Object[] { typename, getMessagesToRootCause(e) }), MessageDialog.ERROR);
+ Utility.popMessage("Unexpected Exception",
+ MessageFormat.format(
+ "Unexpected exception while getting type information for type ''{0}''. {1}",
+ new Object[] { typename, getMessagesToRootCause(e) }),
+ MessageDialog.ERROR);
throw new InternalErrorCDE("unexpected exception", e);
}
return null;
@@ -3815,7 +3959,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
*/
public IType getAnalysisComponentIType() {
if (null == analysisComponentIType) {
- analysisComponentIType = getTypeFromProject("org.apache.uima.analysis_component.AnalysisComponent");
+ analysisComponentIType = getTypeFromProject(
+ "org.apache.uima.analysis_component.AnalysisComponent");
}
return analysisComponentIType;
}
@@ -3827,7 +3972,8 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
*/
public IType getBaseAnnotatorIType() {
if (null == baseAnnotatorIType) {
- baseAnnotatorIType = getTypeFromProject("org.apache.uima.analysis_engine.annotator.BaseAnnotator");
+ baseAnnotatorIType = getTypeFromProject(
+ "org.apache.uima.analysis_engine.annotator.BaseAnnotator");
}
return baseAnnotatorIType;
}
@@ -3839,7 +3985,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
*/
public IType getCollectionReaderIType() {
if (null == collectionReaderIType) {
- collectionReaderIType = getTypeFromProject("org.apache.uima.collection.CollectionReader");
+ collectionReaderIType = getTypeFromProject("org.apache.uima.collection.CollectionReader");
}
return collectionReaderIType;
}
@@ -3851,7 +3997,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
*/
public IType getCasInitializerIType() {
if (null == casInitializerIType) {
- casInitializerIType = getTypeFromProject("org.apache.uima.collection.CasInitializer");
+ casInitializerIType = getTypeFromProject("org.apache.uima.collection.CasInitializer");
}
return casInitializerIType;
}
@@ -3863,7 +4009,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
*/
public IType getCasConsumerIType() {
if (null == casConsumerIType) {
- casConsumerIType = getTypeFromProject("org.apache.uima.collection.CasConsumer");
+ casConsumerIType = getTypeFromProject("org.apache.uima.collection.CasConsumer");
}
return casConsumerIType;
}
@@ -3875,7 +4021,7 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
*/
public IType getFlowControllerIType() {
if (null == flowControllerIType) {
- flowControllerIType = getTypeFromProject("org.apache.uima.flow.FlowController");
+ flowControllerIType = getTypeFromProject("org.apache.uima.flow.FlowController");
}
return flowControllerIType;
}
@@ -3903,13 +4049,16 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Adds the scope.
*
- * @param newScope the new scope
+ * @param newScope
+ * the new scope
*/
public void addScope(IJavaSearchScope newScope) {
subScopes[nbrScopes++] = newScope;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jdt.core.search.IJavaSearchScope#encloses(java.lang.String)
*/
@Override
@@ -3922,11 +4071,13 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
if (!resourcePath.startsWith("C:\\p\\j")) {
System.out.println(MessageFormat.format(" FALSE encloses resourcepath: ''{0}''",
new Object[] { resourcePath }));
- }
+ }
return false;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jdt.core.search.IJavaSearchScope#encloses(org.eclipse.jdt.core.IJavaElement)
*/
@Override
@@ -3934,13 +4085,15 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
for (int i = 0; i < nbrScopes; i++) {
if (subScopes[i].encloses(element)) {
- return true;
+ return true;
}
}
return false;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jdt.core.search.IJavaSearchScope#enclosingProjectsAndJars()
*/
@Override
@@ -3949,17 +4102,19 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
for (int i = 0; i < nbrScopes; i++) {
IPath[] pjs = subScopes[i].enclosingProjectsAndJars();
if (null != pjs) {
- for (int j = 0; j < pjs.length; j++) {
- if (!result.contains(pjs[j])) {
- result.add(pjs[j]);
- }
- }
+ for (int j = 0; j < pjs.length; j++) {
+ if (!result.contains(pjs[j])) {
+ result.add(pjs[j]);
+ }
+ }
}
}
return (IPath[]) result.toArray(new IPath[result.size()]);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jdt.core.search.IJavaSearchScope#includesBinaries()
*/
@Override
@@ -3968,7 +4123,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
return true;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jdt.core.search.IJavaSearchScope#includesClasspaths()
*/
@Override
@@ -3977,7 +4134,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
return true;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jdt.core.search.IJavaSearchScope#setIncludesBinaries(boolean)
*/
@Override
@@ -3985,7 +4144,9 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
// implements interface method
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jdt.core.search.IJavaSearchScope#setIncludesClasspaths(boolean)
*/
@Override
@@ -4023,52 +4184,63 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
}
return null;
}
-
+
/**
* Merge delegate analysis engine type systems.
*
- * @param aAeDescription the a ae description
- * @param aResourceManager the a resource manager
- * @param aOutputMergedTypes the a output merged types
+ * @param aAeDescription
+ * the a ae description
+ * @param aResourceManager
+ * the a resource manager
+ * @param aOutputMergedTypes
+ * the a output merged types
* @return the type system description
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private TypeSystemDescription mergeDelegateAnalysisEngineTypeSystems(
AnalysisEngineDescription aAeDescription, ResourceManager aResourceManager,
Map aOutputMergedTypes) throws ResourceInitializationException {
-
+
getMergeInput(aAeDescription, aResourceManager);
- return CasCreationUtils.mergeTypeSystems(typeSystemsToMerge, aResourceManager, aOutputMergedTypes);
+ return CasCreationUtils.mergeTypeSystems(typeSystemsToMerge, aResourceManager,
+ aOutputMergedTypes);
}
-
+
/**
* Merge delegate analysis engine type priorities.
*
- * @param aAeDescription the a ae description
- * @param aResourceManager the a resource manager
+ * @param aAeDescription
+ * the a ae description
+ * @param aResourceManager
+ * the a resource manager
* @return the type priorities
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private TypePriorities mergeDelegateAnalysisEngineTypePriorities(
- AnalysisEngineDescription aAeDescription, ResourceManager aResourceManager)
- throws ResourceInitializationException {
-
- getMergeInput(aAeDescription, aResourceManager);
+ AnalysisEngineDescription aAeDescription, ResourceManager aResourceManager)
+ throws ResourceInitializationException {
+
+ getMergeInput(aAeDescription, aResourceManager);
return CasCreationUtils.mergeTypePriorities(typePrioritiesToMerge, aResourceManager);
}
/**
* Merge delegate analysis engine fs index collections.
*
- * @param aAeDescription the a ae description
- * @param aResourceManager the a resource manager
+ * @param aAeDescription
+ * the a ae description
+ * @param aResourceManager
+ * the a resource manager
* @return the fs index collection
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
private FsIndexCollection mergeDelegateAnalysisEngineFsIndexCollections(
- AnalysisEngineDescription aAeDescription, ResourceManager aResourceManager)
- throws ResourceInitializationException {
-
+ AnalysisEngineDescription aAeDescription, ResourceManager aResourceManager)
+ throws ResourceInitializationException {
+
getMergeInput(aAeDescription, aResourceManager);
return CasCreationUtils.mergeFsIndexes(fsIndexesToMerge, aResourceManager);
}
@@ -4076,47 +4248,55 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
/**
* Creates the cas.
*
- * @param aAeDescription the a ae description
- * @param aPerformanceTuningSettings the a performance tuning settings
- * @param aResourceManager the a resource manager
+ * @param aAeDescription
+ * the a ae description
+ * @param aPerformanceTuningSettings
+ * the a performance tuning settings
+ * @param aResourceManager
+ * the a resource manager
* @return the cas
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
public CAS createCas(AnalysisEngineDescription aAeDescription,
Properties aPerformanceTuningSettings, ResourceManager aResourceManager)
throws ResourceInitializationException {
-
+
getMergeInput(aAeDescription, aResourceManager);
// merge
- TypeSystemDescription aggTypeDesc = CasCreationUtils.mergeTypeSystems(typeSystemsToMerge, aResourceManager);
- TypePriorities aggTypePriorities = CasCreationUtils.mergeTypePriorities(typePrioritiesToMerge, aResourceManager);
- FsIndexCollection aggIndexColl = CasCreationUtils.mergeFsIndexes(fsIndexesToMerge, aResourceManager);
+ TypeSystemDescription aggTypeDesc = CasCreationUtils.mergeTypeSystems(typeSystemsToMerge,
+ aResourceManager);
+ TypePriorities aggTypePriorities = CasCreationUtils.mergeTypePriorities(typePrioritiesToMerge,
+ aResourceManager);
+ FsIndexCollection aggIndexColl = CasCreationUtils.mergeFsIndexes(fsIndexesToMerge,
+ aResourceManager);
return CasCreationUtils.createCas(aggTypeDesc, aggTypePriorities, aggIndexColl.getFsIndexes(),
aPerformanceTuningSettings, aResourceManager);
}
-
+
/**
* Gets the merge input.
*
- * @param aAggregateDescription the a aggregate description
- * @param aResourceManager the a resource manager
+ * @param aAggregateDescription
+ * the a aggregate description
+ * @param aResourceManager
+ * the a resource manager
* @return the merge input
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
*/
- private void getMergeInput (
- AnalysisEngineDescription aAggregateDescription,
- ResourceManager aResourceManager)
- throws ResourceInitializationException {
-
+ private void getMergeInput(AnalysisEngineDescription aAggregateDescription,
+ ResourceManager aResourceManager) throws ResourceInitializationException {
+
// expand the aggregate AE description into the individual delegates
ArrayList l = new ArrayList();
l.add(aAggregateDescription);
List mdList = CasCreationUtils.getMetaDataList(l, aResourceManager, failedRemotes);
-
+
maybeShowRemoteFailure();
-
+
// extract type systems and merge
typeSystemsToMerge = new ArrayList();
typePrioritiesToMerge = new ArrayList();
@@ -4126,16 +4306,16 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
ProcessingResourceMetaData md = (ProcessingResourceMetaData) it.next();
if (md.getTypeSystem() != null) {
typeSystemsToMerge.add(md.getTypeSystem());
- }
+ }
if (md.getTypePriorities() != null) {
typePrioritiesToMerge.add(md.getTypePriorities());
- }
+ }
if (md.getFsIndexCollection() != null) {
fsIndexesToMerge.add(md.getFsIndexCollection());
- }
+ }
}
}
-
+
/**
* Maybe show remote failure.
*/
@@ -4143,46 +4323,45 @@ public class MultiPageEditor extends FormEditor implements IUimaMultiPageEditor
if (failedRemotes.size() == 0) {
return;
}
-
+
List names = new ArrayList();
List exceptions = new ArrayList();
-
+
for (Iterator it = failedRemotes.entrySet().iterator(); it.hasNext();) {
Map.Entry entry = (Map.Entry) it.next();
- String component = (String)entry.getKey();
-
+ String component = (String) entry.getKey();
+
if (failedRemotesAlreadyKnown.contains(component)) {
continue;
}
-
+
failedRemotesAlreadyKnown.add(component);
names.add(component);
exceptions.add(entry.getValue());
}
-
+
if (names.size() == 0) {
return;
}
-
+
StringBuffer sb = new StringBuffer(100);
for (int i = 0; i < names.size(); i++) {
- sb.append("Component key-name(s): ").append(names.get(i))
- .append(": ")
- .append(getMessagesToRootCause((Exception)exceptions.get(i)))
- .append("\n---------------\n");
+ sb.append("Component key-name(s): ").append(names.get(i)).append(": ")
+ .append(getMessagesToRootCause((Exception) exceptions.get(i)))
+ .append("\n---------------\n");
}
-
- Utility.popMessage("Remotes Unavailable", "Note: This message is only shown once.\n\n" +
- "Some Remote components (see error message below) could not be accessed.\n" +
- "This is not an error; perhaps the remote components are not currently running.\n\n" +
- "WARNING: The Types, Type Priorities, and Indexes created by \"merging\"\n" +
- "information from the imported remote types may be incomplete\n" +
- "(because the editor can't read this information at the moment).\n" +
- "However, this doesn't affect the editing operations; you can continue\n" +
- "(but with perhaps less complete error checking in the editor,\n" +
- "and JCasGen, if used, may be missing some type information that\n" +
- "would have come from the remote components, had they been available.\n\n" +
- sb, MessageDialog.WARNING);
- }
-
+
+ Utility.popMessage("Remotes Unavailable", "Note: This message is only shown once.\n\n"
+ + "Some Remote components (see error message below) could not be accessed.\n"
+ + "This is not an error; perhaps the remote components are not currently running.\n\n"
+ + "WARNING: The Types, Type Priorities, and Indexes created by \"merging\"\n"
+ + "information from the imported remote types may be incomplete\n"
+ + "(because the editor can't read this information at the moment).\n"
+ + "However, this doesn't affect the editing operations; you can continue\n"
+ + "(but with perhaps less complete error checking in the editor,\n"
+ + "and JCasGen, if used, may be missing some type information that\n"
+ + "would have come from the remote components, had they been available.\n\n" + sb,
+ MessageDialog.WARNING);
+ }
+
}
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditorContributor.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditorContributor.java
index bb6e496..afd1d92 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditorContributor.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/MultiPageEditorContributor.java
@@ -41,7 +41,6 @@ import org.eclipse.ui.part.MultiPageEditorPart;
import org.eclipse.ui.texteditor.ITextEditor;
import org.eclipse.ui.texteditor.ITextEditorActionConstants;
-
// import org.eclipse.jdt.launching.IVMRunner;
// import org.apache.uima.jcas.jcasgen.Prefs;
@@ -52,13 +51,13 @@ import org.eclipse.ui.texteditor.ITextEditorActionConstants;
* 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;
@@ -78,8 +77,10 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
/**
* Returns the action registed with the given text editor.
*
- * @param editor the editor
- * @param actionID the action ID
+ * @param editor
+ * the editor
+ * @param actionID
+ * the action ID
* @return IAction or null if editor is null.
*/
protected IAction getAction(MultiPageEditorPart editor, String actionID) {
@@ -90,16 +91,21 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
/**
* Gets the action 1.
*
- * @param editor the editor
- * @param actionID the action ID
+ * @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));
}
- /* (non-Javadoc)
- * @see org.eclipse.ui.part.MultiPageEditorActionBarContributor#setActiveEditor(org.eclipse.ui.IEditorPart)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.eclipse.ui.part.MultiPageEditorActionBarContributor#setActiveEditor(org.eclipse.ui.
+ * IEditorPart)
*/
@Override
public void setActiveEditor(IEditorPart part) {
@@ -107,7 +113,7 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
return;
if (null == part) {
- return;
+ return;
}
activeEditorPart = part;
@@ -116,24 +122,24 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
MultiPageEditorPart editor = (MultiPageEditorPart) part;
- actionBars.setGlobalActionHandler(ActionFactory.DELETE.getId(), getAction(editor,
- ITextEditorActionConstants.DELETE));
- actionBars.setGlobalActionHandler(ActionFactory.UNDO.getId(), getAction(editor,
- ITextEditorActionConstants.UNDO));
- actionBars.setGlobalActionHandler(ActionFactory.REDO.getId(), getAction(editor,
- ITextEditorActionConstants.REDO));
- actionBars.setGlobalActionHandler(ActionFactory.CUT.getId(), getAction(editor,
- ITextEditorActionConstants.CUT));
- actionBars.setGlobalActionHandler(ActionFactory.COPY.getId(), getAction(editor,
- ITextEditorActionConstants.COPY));
- actionBars.setGlobalActionHandler(ActionFactory.PASTE.getId(), getAction(editor,
- ITextEditorActionConstants.PASTE));
- actionBars.setGlobalActionHandler(ActionFactory.SELECT_ALL.getId(), getAction(editor,
- ITextEditorActionConstants.SELECT_ALL));
- actionBars.setGlobalActionHandler(ActionFactory.FIND.getId(), getAction(editor,
- ITextEditorActionConstants.FIND));
- actionBars.setGlobalActionHandler(IDEActionFactory.BOOKMARK.getId(), getAction(editor,
- IDEActionFactory.BOOKMARK.getId()));
+ actionBars.setGlobalActionHandler(ActionFactory.DELETE.getId(),
+ getAction(editor, ITextEditorActionConstants.DELETE));
+ actionBars.setGlobalActionHandler(ActionFactory.UNDO.getId(),
+ getAction(editor, ITextEditorActionConstants.UNDO));
+ actionBars.setGlobalActionHandler(ActionFactory.REDO.getId(),
+ getAction(editor, ITextEditorActionConstants.REDO));
+ actionBars.setGlobalActionHandler(ActionFactory.CUT.getId(),
+ getAction(editor, ITextEditorActionConstants.CUT));
+ actionBars.setGlobalActionHandler(ActionFactory.COPY.getId(),
+ getAction(editor, ITextEditorActionConstants.COPY));
+ actionBars.setGlobalActionHandler(ActionFactory.PASTE.getId(),
+ getAction(editor, ITextEditorActionConstants.PASTE));
+ actionBars.setGlobalActionHandler(ActionFactory.SELECT_ALL.getId(),
+ getAction(editor, ITextEditorActionConstants.SELECT_ALL));
+ actionBars.setGlobalActionHandler(ActionFactory.FIND.getId(),
+ getAction(editor, ITextEditorActionConstants.FIND));
+ actionBars.setGlobalActionHandler(IDEActionFactory.BOOKMARK.getId(),
+ getAction(editor, IDEActionFactory.BOOKMARK.getId()));
actionBars.updateActionBars();
}
}
@@ -141,7 +147,8 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
/*
* (non-Javadoc)
*
- * @see org.eclipse.ui.part.MultiPageEditorActionBarContributor#setActivePage(org.eclipse.ui.IEditorPart)
+ * @see org.eclipse.ui.part.MultiPageEditorActionBarContributor#setActivePage(org.eclipse.ui.
+ * IEditorPart)
*/
@Override
public void setActivePage(IEditorPart part) {
@@ -151,24 +158,24 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
ITextEditor textEditor = (part instanceof XMLEditor) ? (ITextEditor) part : null;
- actionBars.setGlobalActionHandler(ActionFactory.DELETE.getId(), getAction1(textEditor,
- ITextEditorActionConstants.DELETE));
- actionBars.setGlobalActionHandler(ActionFactory.UNDO.getId(), getAction1(textEditor,
- ITextEditorActionConstants.UNDO));
- actionBars.setGlobalActionHandler(ActionFactory.REDO.getId(), getAction1(textEditor,
- ITextEditorActionConstants.REDO));
- actionBars.setGlobalActionHandler(ActionFactory.CUT.getId(), getAction1(textEditor,
- ITextEditorActionConstants.CUT));
- actionBars.setGlobalActionHandler(ActionFactory.COPY.getId(), getAction1(textEditor,
- ITextEditorActionConstants.COPY));
- actionBars.setGlobalActionHandler(ActionFactory.PASTE.getId(), getAction1(textEditor,
- ITextEditorActionConstants.PASTE));
- actionBars.setGlobalActionHandler(ActionFactory.SELECT_ALL.getId(), getAction1(textEditor,
- ITextEditorActionConstants.SELECT_ALL));
- actionBars.setGlobalActionHandler(ActionFactory.FIND.getId(), getAction1(textEditor,
- ITextEditorActionConstants.FIND));
- actionBars.setGlobalActionHandler(IDEActionFactory.BOOKMARK.getId(), getAction1(textEditor,
- IDEActionFactory.BOOKMARK.getId()));
+ actionBars.setGlobalActionHandler(ActionFactory.DELETE.getId(),
+ getAction1(textEditor, ITextEditorActionConstants.DELETE));
+ actionBars.setGlobalActionHandler(ActionFactory.UNDO.getId(),
+ getAction1(textEditor, ITextEditorActionConstants.UNDO));
+ actionBars.setGlobalActionHandler(ActionFactory.REDO.getId(),
+ getAction1(textEditor, ITextEditorActionConstants.REDO));
+ actionBars.setGlobalActionHandler(ActionFactory.CUT.getId(),
+ getAction1(textEditor, ITextEditorActionConstants.CUT));
+ actionBars.setGlobalActionHandler(ActionFactory.COPY.getId(),
+ getAction1(textEditor, ITextEditorActionConstants.COPY));
+ actionBars.setGlobalActionHandler(ActionFactory.PASTE.getId(),
+ getAction1(textEditor, ITextEditorActionConstants.PASTE));
+ actionBars.setGlobalActionHandler(ActionFactory.SELECT_ALL.getId(),
+ getAction1(textEditor, ITextEditorActionConstants.SELECT_ALL));
+ actionBars.setGlobalActionHandler(ActionFactory.FIND.getId(),
+ getAction1(textEditor, ITextEditorActionConstants.FIND));
+ actionBars.setGlobalActionHandler(IDEActionFactory.BOOKMARK.getId(),
+ getAction1(textEditor, IDEActionFactory.BOOKMARK.getId()));
actionBars.updateActionBars();
}
}
@@ -180,27 +187,27 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
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
+ // 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);
+ boolean bAutoJCasGen = !prefs.getBoolean(PreferencePage.P_JCAS);
autoJCasAction.setChecked(bAutoJCasGen);
- prefs.setValue(PreferencePage.P_JCAS, bAutoJCasGen);
+ prefs.setValue(PreferencePage.P_JCAS, bAutoJCasGen);
}
};
-
- limitJCasGenToProject = new Action () {
+
+ 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
+ // 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);
+ boolean bJCasLimit = !prefs.getBoolean(PreferencePage.P_JCAS_LIMIT_TO_PROJECT_SCOPE);
limitJCasGenToProject.setChecked(bJCasLimit);
- prefs.setValue(PreferencePage.P_JCAS_LIMIT_TO_PROJECT_SCOPE, bJCasLimit);
+ prefs.setValue(PreferencePage.P_JCAS_LIMIT_TO_PROJECT_SCOPE, bJCasLimit);
}
};
@@ -218,9 +225,9 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
TAEConfiguratorPlugin plugin = TAEConfiguratorPlugin.getDefault();
Preferences prefs = plugin.getPluginPreferences();
boolean bFullyQualifiedTypeNames = !prefs
- .getBoolean(PreferencePage.P_SHOW_FULLY_QUALIFIED_NAMES);
+ .getBoolean(PreferencePage.P_SHOW_FULLY_QUALIFIED_NAMES);
qualifiedTypesAction.setChecked(bFullyQualifiedTypeNames);
- prefs.setValue(PreferencePage.P_SHOW_FULLY_QUALIFIED_NAMES, bFullyQualifiedTypeNames);
+ 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();
@@ -237,19 +244,23 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
};
autoJCasAction.setText(Messages.getString("MultiPageEditorContributor.autoGenJCas")); //$NON-NLS-1$
- autoJCasAction.setChecked(getAutoJCasGen());
-
- limitJCasGenToProject.setText(Messages.getString("MultiPageEditorContributor.limitJCasGenToProjectScope"));
+ autoJCasAction.setChecked(getAutoJCasGen());
+
+ limitJCasGenToProject
+ .setText(Messages.getString("MultiPageEditorContributor.limitJCasGenToProjectScope"));
limitJCasGenToProject.setChecked(getLimitJCasGenToProjectScope());
qualifiedTypesAction.setText(Messages.getString("MultiPageEditorContributor.showFullNames")); //$NON-NLS-1$
- qualifiedTypesAction.setChecked(getUseQualifiedTypes());
+ qualifiedTypesAction.setChecked(getUseQualifiedTypes());
runJCasGenAction.setText("Run JCasGen");
}
- /* (non-Javadoc)
- * @see org.eclipse.ui.part.EditorActionBarContributor#contributeToMenu(org.eclipse.jface.action.IMenuManager)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.eclipse.ui.part.EditorActionBarContributor#contributeToMenu(org.eclipse.jface.action.
+ * IMenuManager)
*/
@Override
public void contributeToMenu(IMenuManager manager) {
@@ -281,7 +292,7 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
public static boolean getUseQualifiedTypes() {
return getUimaPrefBoolean(PreferencePage.P_SHOW_FULLY_QUALIFIED_NAMES, true);
}
-
+
/**
* Gets the limit J cas gen to project scope.
*
@@ -321,7 +332,8 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
/**
* Sets the vns host.
*
- * @param v the new vns host
+ * @param v
+ * the new vns host
*/
public static void setVnsHost(String v) {
System.setProperty("VNS_HOST", v);
@@ -330,7 +342,8 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
/**
* Sets the vns port.
*
- * @param v the new vns port
+ * @param v
+ * the new vns port
*/
public static void setVnsPort(String v) {
System.setProperty("VNS_PORT", v);
@@ -353,8 +366,10 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
/**
* Gets the uima pref string.
*
- * @param key the key
- * @param defaultValue the default value
+ * @param key
+ * the key
+ * @param defaultValue
+ * the default value
* @return the uima pref string
*/
private static String getUimaPrefString(String key, String defaultValue) {
@@ -362,7 +377,7 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
Preferences prefs = plugin.getPluginPreferences();
boolean isDefault = prefs.isDefault(key);
if (isDefault) {
- prefs.setDefault(key, defaultValue);
+ prefs.setDefault(key, defaultValue);
}
return prefs.getString(key);
}
@@ -370,8 +385,10 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
/**
* Gets the uima pref boolean.
*
- * @param key the key
- * @param defaultValue the default value
+ * @param key
+ * the key
+ * @param defaultValue
+ * the default value
* @return the uima pref boolean
*/
private static boolean getUimaPrefBoolean(String key, boolean defaultValue) {
@@ -379,7 +396,7 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
Preferences prefs = plugin.getPluginPreferences();
boolean isDefault = prefs.isDefault(key);
if (isDefault) {
- prefs.setDefault(key, defaultValue);
+ prefs.setDefault(key, defaultValue);
}
return prefs.getBoolean(key);
}
@@ -387,8 +404,10 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
/**
* Gets the uima pref int.
*
- * @param key the key
- * @param defaultValue the default value
+ * @param key
+ * the key
+ * @param defaultValue
+ * the default value
* @return the uima pref int
*/
private static int getUimaPrefInt(String key, int defaultValue) {
@@ -396,7 +415,7 @@ public class MultiPageEditorContributor extends MultiPageEditorActionBarContribu
Preferences prefs = plugin.getPluginPreferences();
boolean isDefault = prefs.isDefault(key);
if (isDefault) {
- prefs.setDefault(key, defaultValue);
+ prefs.setDefault(key, defaultValue);
}
return prefs.getInt(key);
}
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaEditorExtension.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaEditorExtension.java
index 13941c0..7151756 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaEditorExtension.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaEditorExtension.java
@@ -24,43 +24,44 @@ import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorSite;
import org.eclipse.ui.PartInitException;
-
/**
* The interface implemented by an external editor.
*/
public interface IUimaEditorExtension {
-
+
/**
- * The first method called by the CDE after the implementation class of this
- * interface is instantiated.
+ * The first method called by the CDE after the implementation class of this interface is
+ * instantiated.
*
*/
- void init ();
-
+ void init();
+
/**
- * When a new type of descriptor is encountered and cannot edit, CDE will
- * called this method to test if the external editor can edit this new type of descriptor.
+ * When a new type of descriptor is encountered and cannot edit, CDE will called this method to
+ * test if the external editor can edit this new type of descriptor.
*
- * @param cde An instance of CDE
- * @param xmlizable New type of descriptor to be edited
+ * @param cde
+ * An instance of CDE
+ * @param xmlizable
+ * New type of descriptor to be edited
* @return true if the external editor can edit the specified type of descriptor
*/
- boolean canEdit (MultiPageEditor cde, XMLizable xmlizable);
-
+ boolean canEdit(MultiPageEditor cde, XMLizable xmlizable);
+
/**
- * Called by CDE to activate the external editor for editing the new type of descriptor.
- * *
+ * Called by CDE to activate the external editor for editing the new type of descriptor. *
+ *
* @param site
- * The site for which this part is being created; must not be
- * <code>null</code>.
+ * The site for which this part is being created; must not be <code>null</code>.
* @param editorInput
- * The input on which this editor should be created; must not be
- * <code>null</code>.
- * @param cde An instance of CDE
- * @param xmlizable New type of descriptor to be edited
+ * The input on which this editor should be created; must not be <code>null</code>.
+ * @param cde
+ * An instance of CDE
+ * @param xmlizable
+ * New type of descriptor to be edited
* @throws PartInitException
- * If the initialization of the part fails
+ * If the initialization of the part fails
*/
- void activateEditor(IEditorSite site, IEditorInput editorInput,
- MultiPageEditor cde, XMLizable xmlizable) throws PartInitException;
+ void activateEditor(IEditorSite site, IEditorInput editorInput, MultiPageEditor cde,
+ XMLizable xmlizable) throws PartInitException;
}
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaMultiPageEditor.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaMultiPageEditor.java
index f0c5f83..8191cb8 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaMultiPageEditor.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/point/IUimaMultiPageEditor.java
@@ -20,33 +20,33 @@ package org.apache.uima.taeconfigurator.editors.point;
import org.eclipse.core.runtime.IProgressMonitor;
-
-
/**
- * This interface is used to redirect the editing functions from CDE
- * to the external editor for a new type of Resource Specifier.
+ * This interface is used to redirect the editing functions from CDE to the external editor for a
+ * new type of Resource Specifier.
*/
public interface IUimaMultiPageEditor {
-
+
/**
* Adds the pages for current editor.
*/
void addPagesForCurrentEditor();
-
+
/**
* Page change for current editor.
*
- * @param newPageIndex the new page index
+ * @param newPageIndex
+ * the new page index
*/
void pageChangeForCurrentEditor(int newPageIndex);
-
+
/**
* Do save for current editor.
*
- * @param monitor the monitor
+ * @param monitor
+ * the monitor
*/
void doSaveForCurrentEditor(IProgressMonitor monitor);
-
+
/**
* Do save as for current editor.
*/
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractImportablePartSection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractImportablePartSection.java
index b5a9382..e20595e 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractImportablePartSection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractImportablePartSection.java
@@ -28,7 +28,6 @@ import org.apache.uima.taeconfigurator.model.BuiltInTypes;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.TreeItem;
-
/**
* The Class AbstractImportablePartSection.
*/
@@ -37,13 +36,17 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* 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
+ * @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) {
+ public AbstractImportablePartSection(MultiPageEditor aEditor, Composite parent, String headerText,
+ String description) {
super(aEditor, parent, headerText, description);
}
@@ -52,7 +55,8 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is local item.
*
- * @param item the item
+ * @param item
+ * the item
* @return true, if is local item
*/
// ********************************
@@ -66,8 +70,10 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* returns null if no feature by this name.
*
- * @param name the name
- * @param td the td
+ * @param name
+ * the name
+ * @param td
+ * the td
* @return the feature from type description
*/
public FeatureDescription getFeatureFromTypeDescription(String name, TypeDescription td) {
@@ -84,8 +90,10 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Gets the allowed value.
*
- * @param value the value
- * @param td the td
+ * @param value
+ * the value
+ * @param td
+ * the td
* @return the allowed value
*/
public AllowedValue getAllowedValue(String value, TypeDescription td) {
@@ -106,7 +114,8 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Gets the local type definition.
*
- * @param td the td
+ * @param td
+ * the td
* @return the local type definition
*/
protected TypeDescription getLocalTypeDefinition(TypeDescription td) {
@@ -119,19 +128,24 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Gets the local feature definition.
*
- * @param td the td
- * @param fd the fd
+ * @param td
+ * the td
+ * @param fd
+ * the fd
* @return the local feature definition
*/
- protected FeatureDescription getLocalFeatureDefinition(TypeDescription td, FeatureDescription fd) {
+ 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
+ * @param td
+ * the td
+ * @param featureName
+ * the feature name
* @return the local feature definition
*/
protected FeatureDescription getLocalFeatureDefinition(TypeDescription td, String featureName) {
@@ -144,8 +158,10 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Gets the local allowed value.
*
- * @param td the td
- * @param unchangedAv the unchanged av
+ * @param td
+ * the td
+ * @param unchangedAv
+ * the unchanged av
* @return the local allowed value
*/
protected AllowedValue getLocalAllowedValue(TypeDescription td, AllowedValue unchangedAv) {
@@ -161,7 +177,8 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Gets the built in type description.
*
- * @param td the td
+ * @param td
+ * the td
* @return the built in type description
*/
// ********************************
@@ -174,7 +191,8 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is local type.
*
- * @param td the td
+ * @param td
+ * the td
* @return true, if is local type
*/
// ********************************
@@ -185,7 +203,8 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is local type.
*
- * @param typeName the type name
+ * @param typeName
+ * the type name
* @return true, if is local type
*/
protected boolean isLocalType(String typeName) {
@@ -195,8 +214,10 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is local feature.
*
- * @param featureName the feature name
- * @param td the td
+ * @param featureName
+ * the feature name
+ * @param td
+ * the td
* @return true, if is local feature
*/
protected boolean isLocalFeature(String featureName, TypeDescription td) {
@@ -206,8 +227,10 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is local allowed value.
*
- * @param avString the av string
- * @param td the td
+ * @param avString
+ * the av string
+ * @param td
+ * the td
* @return true, if is local allowed value
*/
protected boolean isLocalAllowedValue(String avString, TypeDescription td) {
@@ -224,7 +247,8 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is imported type.
*
- * @param typeName the type name
+ * @param typeName
+ * the type name
* @return true, if is imported type
*/
public boolean isImportedType(String typeName) {
@@ -234,7 +258,8 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is imported type.
*
- * @param td the td
+ * @param td
+ * the td
* @return true, if is imported type
*/
protected boolean isImportedType(TypeDescription td) {
@@ -244,8 +269,10 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is imported feature.
*
- * @param name the name
- * @param td the td
+ * @param name
+ * the name
+ * @param td
+ * the td
* @return true, if is imported feature
*/
protected boolean isImportedFeature(String name, TypeDescription td) {
@@ -258,8 +285,10 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is imported allowed value.
*
- * @param td the td
- * @param av the av
+ * @param td
+ * the td
+ * @param av
+ * the av
* @return true, if is imported allowed value
*/
protected boolean isImportedAllowedValue(TypeDescription td, AllowedValue av) {
@@ -274,7 +303,8 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is built in type.
*
- * @param td the td
+ * @param td
+ * the td
* @return true, if is built in type
*/
// ********************************
@@ -285,7 +315,8 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is built in type.
*
- * @param typeName the type name
+ * @param typeName
+ * the type name
* @return true, if is built in type
*/
protected boolean isBuiltInType(String typeName) {
@@ -295,8 +326,10 @@ public abstract class AbstractImportablePartSection extends AbstractSection {
/**
* Checks if is built in feature.
*
- * @param name the name
- * @param td the td
+ * @param name
+ * the name
+ * @param td
+ * the td
* @return true, if is built in feature
*/
protected boolean isBuiltInFeature(String name, TypeDescription td) {
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java
index 45f3b19..8e7a06d 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSection.java
@@ -117,12 +117,11 @@ import org.eclipse.ui.forms.widgets.ExpandableComposite;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.Section;
-
/**
* The Class AbstractSection.
*/
public abstract class AbstractSection extends SectionPart /* extends FormSection */
-implements Listener, StandardStrings {
+ implements Listener, StandardStrings {
/** The toolkit. */
protected FormToolkit toolkit;
@@ -196,10 +195,14 @@ implements Listener, StandardStrings {
/**
* Instantiates a new abstract section.
*
- * @param aEditor the a editor
- * @param parent the parent
- * @param headerText the header text
- * @param description the description
+ * @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) {
@@ -210,12 +213,14 @@ implements Listener, StandardStrings {
getSection().setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
toolkit.createCompositeSeparator(getSection());
if (null != description) {
- getSection().setDescription(description);
+ getSection().setDescription(description);
}
editor = aEditor;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.ui.forms.AbstractFormPart#initialize(org.eclipse.ui.forms.IManagedForm)
*/
@Override
@@ -248,7 +253,8 @@ implements Listener, StandardStrings {
/**
* New composite.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
// **************************************************
@@ -259,7 +265,8 @@ implements Listener, StandardStrings {
/**
* New 2 column composite.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
public Composite new2ColumnComposite(Composite parent) {
@@ -269,7 +276,8 @@ implements Listener, StandardStrings {
/**
* New 3 column composite.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
public Composite new3ColumnComposite(Composite parent) {
@@ -279,7 +287,8 @@ implements Listener, StandardStrings {
/**
* New 4 column composite.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
public Composite new4ColumnComposite(Composite parent) {
@@ -289,14 +298,16 @@ implements Listener, StandardStrings {
/**
* New ncolumn composite.
*
- * @param parent the parent
- * @param cols the cols
+ * @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) {
- ((ExpandableComposite) parent).setClient(composite);
+ ((ExpandableComposite) parent).setClient(composite);
}
GridLayout layout = new GridLayout(cols, !EQUAL_WIDTH);
layout.marginHeight = 0;
@@ -309,9 +320,12 @@ implements Listener, StandardStrings {
/**
* Sets the margins.
*
- * @param composite the composite
- * @param height the height
- * @param width the width
+ * @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();
@@ -322,15 +336,16 @@ implements Listener, StandardStrings {
/**
* Enable borders.
*
- * @param composite the composite
+ * @param composite
+ * the composite
*/
public void enableBorders(Composite composite) {
GridLayout g = (GridLayout) composite.getLayout();
if (g.marginHeight < 2) {
- g.marginHeight = 2;
+ g.marginHeight = 2;
}
if (g.marginWidth < 1) {
- g.marginWidth = 1;
+ g.marginWidth = 1;
}
}
@@ -346,7 +361,8 @@ implements Listener, StandardStrings {
/**
* New button container.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
public Composite newButtonContainer(Composite parent) {
@@ -356,9 +372,12 @@ implements Listener, StandardStrings {
/**
* New button container.
*
- * @param parent the parent
- * @param style the style
- * @param widthMin the width min
+ * @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) {
@@ -409,9 +428,12 @@ implements Listener, StandardStrings {
/**
* New labeled text field.
*
- * @param parent the parent
- * @param label the label
- * @param tip the tip
+ * @param parent
+ * the parent
+ * @param label
+ * the label
+ * @param tip
+ * the tip
* @return the text
*/
protected Text newLabeledTextField(Composite parent, String label, String tip) {
@@ -421,10 +443,14 @@ implements Listener, StandardStrings {
/**
* New labeled text field.
*
- * @param parent the parent
- * @param labelKey the label key
- * @param textToolTip the text tool tip
- * @param style the style
+ * @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,
@@ -441,9 +467,12 @@ implements Listener, StandardStrings {
/**
* New text with tip.
*
- * @param parent the parent
- * @param initialTxt the initial txt
- * @param tip the 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) {
@@ -453,10 +482,14 @@ implements Listener, StandardStrings {
/**
* New text with tip.
*
- * @param parent the parent
- * @param text the text
- * @param style the style
- * @param tip the 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) {
@@ -474,8 +507,10 @@ implements Listener, StandardStrings {
/**
* New label with data.
*
- * @param parent the parent
- * @param text the text
+ * @param parent
+ * the parent
+ * @param text
+ * the text
* @return the label
*/
public Label newLabelWithData(Composite parent, String text) {
@@ -485,9 +520,12 @@ implements Listener, StandardStrings {
/**
* New label with tip.
*
- * @param parent the parent
- * @param text the text
- * @param tip the 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) {
@@ -497,9 +535,12 @@ implements Listener, StandardStrings {
/**
* New un updatable text with tip.
*
- * @param parent the parent
- * @param text the text
- * @param tip the 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) {
@@ -511,16 +552,20 @@ implements Listener, StandardStrings {
/**
* New label with tip.
*
- * @param parent the parent
- * @param text the text
- * @param tip the tip
- * @param style the style
+ * @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) {
- t.setToolTipText(tip);
+ t.setToolTipText(tip);
}
return t;
}
@@ -528,9 +573,12 @@ implements Listener, StandardStrings {
/**
* New labeled C combo with tip.
*
- * @param parent the parent
- * @param labelKey the label key
- * @param tip the 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) {
@@ -541,8 +589,10 @@ implements Listener, StandardStrings {
/**
* New C combo with tip.
*
- * @param parent the parent
- * @param tip the tip
+ * @param parent
+ * the parent
+ * @param tip
+ * the tip
* @return the c combo
*/
protected CCombo newCComboWithTip(Composite parent, String tip) {
@@ -553,7 +603,7 @@ implements Listener, StandardStrings {
ccombo.addListener(SWT.Selection, this);
// Make the CCombo's border visible since CCombo is NOT a widget supported
// by FormToolkit.
- // needed apparently by RedHat Linux
+ // needed apparently by RedHat Linux
ccombo.setData(FormToolkit.KEY_DRAW_BORDER, FormToolkit.TREE_BORDER);
return ccombo;
}
@@ -561,8 +611,10 @@ implements Listener, StandardStrings {
/**
* New description text box.
*
- * @param parent the parent
- * @param tip the tip
+ * @param parent
+ * the parent
+ * @param tip
+ * the tip
* @return the text
*/
protected Text newDescriptionTextBox(Composite parent, String tip) {
@@ -574,10 +626,14 @@ implements Listener, StandardStrings {
/**
* New radio button.
*
- * @param parent the parent
- * @param label the label
- * @param toolTip the tool tip
- * @param selected the selected
+ * @param parent
+ * the parent
+ * @param label
+ * the label
+ * @param toolTip
+ * the tool tip
+ * @param selected
+ * the selected
* @return the button
*/
// **************************************************
@@ -592,9 +648,12 @@ implements Listener, StandardStrings {
/**
* add pushbutton to container, set enabled, add listener for it.
*
- * @param parent the parent
- * @param label the label
- * @param tip the tip
+ * @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) {
@@ -604,10 +663,14 @@ implements Listener, StandardStrings {
/**
* 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
+ * @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) {
@@ -617,14 +680,20 @@ implements Listener, StandardStrings {
/**
* New push button.
*
- * @param parent the parent
- * @param label the label
- * @param tip the tip
- * @param enabled the enabled
- * @param style the style
+ * @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) {
+ 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);
button.setLayoutData(gd);
@@ -641,15 +710,18 @@ implements Listener, StandardStrings {
/**
* New check box.
*
- * @param parent the parent
- * @param label the label
- * @param tip the tip
+ * @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
- | GridData.HORIZONTAL_ALIGN_FILL));
+ button.setLayoutData(
+ new GridData(GridData.VERTICAL_ALIGN_BEGINNING | GridData.HORIZONTAL_ALIGN_FILL));
button.pack();
button.setToolTipText(tip);
button.addListener(SWT.Selection, this);
@@ -659,7 +731,8 @@ implements Listener, StandardStrings {
/**
* Spacer.
*
- * @param container the container
+ * @param container
+ * the container
*/
public static void spacer(Composite container) {
Label label = new Label(container, SWT.NONE);
@@ -689,7 +762,8 @@ implements Listener, StandardStrings {
/**
* New table.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the table
*/
protected Table newTable(Composite parent) {
@@ -699,9 +773,12 @@ implements Listener, StandardStrings {
/**
* New table.
*
- * @param parent the parent
- * @param style the style
- * @param minHeight the min height
+ * @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) {
@@ -711,17 +788,21 @@ implements Listener, StandardStrings {
/**
* New table.
*
- * @param parent the parent
- * @param style the style
- * @param minHeight the min height
- * @param flags the flags
+ * @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);
if (minHeight != NO_MIN_HEIGHT) {
- gd.heightHint = minHeight;
+ gd.heightHint = minHeight;
}
table.setLayoutData(gd);
@@ -735,7 +816,8 @@ implements Listener, StandardStrings {
/**
* New tree.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the tree
*/
protected Tree newTree(Composite parent) {
@@ -749,8 +831,10 @@ implements Listener, StandardStrings {
/**
* Gets the previous selection.
*
- * @param items the items
- * @param nextItem the next item
+ * @param items
+ * the items
+ * @param nextItem
+ * the next item
* @return the previous selection
*/
protected TreeItem getPreviousSelection(TreeItem[] items, TreeItem nextItem) {
@@ -758,7 +842,7 @@ implements Listener, StandardStrings {
for (int i = 0; i < items.length; i++) {
if (nextItem == items[i]) {
return prevItem;
- }
+ }
prevItem = items[i];
}
return prevItem;
@@ -767,15 +851,17 @@ implements Listener, StandardStrings {
/**
* Gets the item index.
*
- * @param items the items
- * @param item the item
+ * @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) {
return i;
- }
+ }
}
return -1;
}
@@ -783,8 +869,10 @@ implements Listener, StandardStrings {
/**
* New tree.
*
- * @param parent the parent
- * @param style SWT.SINGLE SWT.MULTI SWT.CHECK SWT.FULL_SELECTION
+ * @param parent
+ * the parent
+ * @param style
+ * SWT.SINGLE SWT.MULTI SWT.CHECK SWT.FULL_SELECTION
* @return the TableTree
*/
protected Tree newTree(Composite parent, int style) {
@@ -796,9 +884,9 @@ implements Listener, StandardStrings {
tt.addListener(SWT.MouseDoubleClick, this); // for edit
tt.addListener(SWT.Expand, this);
tt.addListener(SWT.Collapse, this);
-
+
// Make the TableTree's border visible since TableTree is NOT a widget supported
- // by FormToolkit. Needed by RedHat Linux
+ // by FormToolkit. Needed by RedHat Linux
tt.setData(FormToolkit.KEY_DRAW_BORDER, FormToolkit.TREE_BORDER);
return tt;
}
@@ -806,7 +894,8 @@ implements Listener, StandardStrings {
/**
* Pack table.
*
- * @param table the table
+ * @param table
+ * the table
*/
public void packTable(Table table) {
TableColumn[] columns = table.getColumns();
@@ -815,11 +904,11 @@ implements Listener, StandardStrings {
}
}
-
/**
* Pack tree.
*
- * @param p_tree the tree
+ * @param p_tree
+ * the tree
*/
public void packTree(Tree p_tree) {
TreeColumn[] columns = p_tree.getColumns();
@@ -831,7 +920,8 @@ implements Listener, StandardStrings {
/**
* Gets the index.
*
- * @param item the item
+ * @param item
+ * the item
* @return the index
*/
public static int getIndex(TableItem item) {
@@ -840,7 +930,7 @@ implements Listener, StandardStrings {
for (int i = items.length - 1; i >= 0; i--) {
if (items[i] == item) {
return i;
- }
+ }
}
throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
}
@@ -848,7 +938,8 @@ implements Listener, StandardStrings {
/**
* Gets the index.
*
- * @param item the item
+ * @param item
+ * the item
* @return the index
*/
public static int getIndex(TreeItem item) {
@@ -857,35 +948,36 @@ implements Listener, StandardStrings {
for (int i = items.length - 1; i >= 0; i--) {
if (items[i] == item) {
return i;
- }
+ }
}
throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
}
-// /**
-// * Removes the children.
-// *
-// * @param item the item
-// */
-// protected void removeChildren(TreeItem item) {
-// TreeItem[] items = item.getItems();
-// if (null != items)
-// for (int i = 0; i < items.length; i++) {
-// items[i].dispose();
-// }
-// }
+ // /**
+ // * Removes the children.
+ // *
+ // * @param item the item
+ // */
+ // protected void removeChildren(TreeItem item) {
+ // TreeItem[] items = item.getItems();
+ // if (null != items)
+ // for (int i = 0; i < items.length; i++) {
+ // items[i].dispose();
+ // }
+ // }
/**
* Removes the children.
*
- * @param item the item
+ * @param item
+ * the item
*/
protected void removeChildren(TreeItem item) {
TreeItem[] items = item.getItems();
if (null != items) {
- for (int i = 0; i < items.length; i++) {
- items[i].dispose();
- }
+ for (int i = 0; i < items.length; i++) {
+ items[i].dispose();
+ }
}
}
@@ -894,18 +986,20 @@ implements Listener, StandardStrings {
/**
* New table column.
*
- * @param table the table
+ * @param table
+ * the table
* @return the table column
*/
// **********************************
protected TableColumn newTableColumn(Table table) {
return newTableColumn(table, ""); //$NON-NLS-1$
}
-
+
/**
* New tree column.
*
- * @param p_tree the tree
+ * @param p_tree
+ * the tree
* @return the tree column
*/
// **********************************
@@ -913,37 +1007,43 @@ implements Listener, StandardStrings {
return newTreeColumn(p_tree, ""); //$NON-NLS-1$
}
-
/**
* New table column.
*
- * @param container the container
- * @param header the header
+ * @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 tree column.
*
- * @param container the container
- * @param header the header
+ * @param container
+ * the container
+ * @param header
+ * the header
* @return the tree column
*/
protected TreeColumn newTreeColumn(Tree container, String header) {
return newTreeColumn(container, 50, SWT.LEFT, header);
}
-
/**
* New table column.
*
- * @param container the container
- * @param width the width
- * @param alignment the alignment
- * @param header the header
+ * @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) {
@@ -954,14 +1054,18 @@ implements Listener, StandardStrings {
tc.setWidth(width);
return tc;
}
-
+
/**
* New tree column.
*
- * @param container the container
- * @param width the width
- * @param alignment the alignment
- * @param header the header
+ * @param container
+ * the container
+ * @param width
+ * the width
+ * @param alignment
+ * the alignment
+ * @param header
+ * the header
* @return the tree column
*/
protected TreeColumn newTreeColumn(Tree container, int width, int alignment, String header) {
@@ -972,13 +1076,14 @@ implements Listener, StandardStrings {
tc.setWidth(width);
return tc;
}
-
/**
* New table column.
*
- * @param container the container
- * @param width the width
+ * @param container
+ * the container
+ * @param width
+ * the width
* @return the table column
*/
protected TableColumn newTableColumn(Table container, int width) {
@@ -988,8 +1093,10 @@ implements Listener, StandardStrings {
/**
* New tree column.
*
- * @param container the container
- * @param width the width
+ * @param container
+ * the container
+ * @param width
+ * the width
* @return the tree column
*/
protected TreeColumn newTreeColumn(Tree container, int width) {
@@ -1129,7 +1236,8 @@ implements Listener, StandardStrings {
/**
* Sets the flow controller declaration.
*
- * @param fcd the new flow controller declaration
+ * @param fcd
+ * the new flow controller declaration
*/
public void setFlowControllerDeclaration(FlowControllerDeclaration fcd) {
editor.getAeDescription().setFlowControllerDeclaration(fcd);
@@ -1157,7 +1265,8 @@ implements Listener, StandardStrings {
/**
* Gets the sofa mappings.
*
- * @param pEditor the editor
+ * @param pEditor
+ * the editor
* @return the sofa mappings
*/
public static SofaMapping[] getSofaMappings(MultiPageEditor pEditor) {
@@ -1182,7 +1291,7 @@ implements Listener, StandardStrings {
public Capability[] getCapabilities() {
Capability[] c = getAnalysisEngineMetaData().getCapabilities();
if (null == c) {
- return capabilityArray0;
+ return capabilityArray0;
}
return c;
}
@@ -1234,7 +1343,8 @@ implements Listener, StandardStrings {
/**
* Gets the available type names.
*
- * @param excluded the excluded
+ * @param excluded
+ * the excluded
* @return the available type names
*/
public String[] getAvailableTypeNames(Set excluded) {
@@ -1245,7 +1355,7 @@ implements Listener, StandardStrings {
String item = (String) it.next();
if (!excluded.contains(item)) {
availableTypes.add(item);
- }
+ }
}
return (String[]) availableTypes.toArray(stringArray0);
}
@@ -1314,8 +1424,8 @@ implements Listener, StandardStrings {
public ExternalResourceBinding[] getExternalResourceBindings() {
ExternalResourceBinding[] erb = getResourceManagerConfiguration().getExternalResourceBindings();
if (null == erb) {
- getResourceManagerConfiguration().setExternalResourceBindings(
- erb = new ExternalResourceBinding[0]);
+ getResourceManagerConfiguration()
+ .setExternalResourceBindings(erb = new ExternalResourceBinding[0]);
}
return erb;
}
@@ -1328,8 +1438,8 @@ implements Listener, StandardStrings {
public ExternalResourceDescription[] getExternalResources() {
ExternalResourceDescription[] erd = getResourceManagerConfiguration().getExternalResources();
if (null == erd) {
- getResourceManagerConfiguration().setExternalResources(
- erd = new ExternalResourceDescription[0]);
+ getResourceManagerConfiguration()
+ .setExternalResources(erd = new ExternalResourceDescription[0]);
}
return erd;
}
@@ -1339,7 +1449,8 @@ implements Listener, StandardStrings {
/**
* Adds the listener for pastable widget.
*
- * @param w the w
+ * @param w
+ * the w
*/
// **************************************************
protected void addListenerForPastableWidget(Widget w) {
@@ -1357,16 +1468,17 @@ implements Listener, StandardStrings {
/**
* Sets the value changed.
*
- * @param newValue the new value
- * @param oldValue the old value
+ * @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);
- }
- else if (!newValue.equals(oldValue)) {
- valueChanged = true;
+ valueChanged = valueChanged || (null != oldValue);
+ } else if (!newValue.equals(oldValue)) {
+ valueChanged = true;
}
return newValue;
}
@@ -1374,13 +1486,15 @@ implements Listener, StandardStrings {
/**
* Sets the value changed int.
*
- * @param newValue the new value
- * @param oldValue the old value
+ * @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;
+ valueChanged = true;
}
return newValue;
}
@@ -1388,13 +1502,15 @@ implements Listener, StandardStrings {
/**
* Sets the value changed boolean.
*
- * @param newValue the new value
- * @param oldValue the old value
+ * @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;
+ valueChanged = true;
}
return newValue;
}
@@ -1402,8 +1518,10 @@ implements Listener, StandardStrings {
/**
* Sets the value changed capital boolean.
*
- * @param newValue the new value
- * @param oldValue the old value
+ * @param newValue
+ * the new value
+ * @param oldValue
+ * the old value
* @return the boolean
*/
protected Boolean setValueChangedCapitalBoolean(Boolean newValue, Boolean oldValue) {
@@ -1412,7 +1530,7 @@ implements Listener, StandardStrings {
} else if (null == oldValue) {
valueChanged = true;
} else if (newValue.booleanValue() != oldValue.booleanValue()) {
- valueChanged = true;
+ valueChanged = true;
}
return newValue;
}
@@ -1420,8 +1538,10 @@ implements Listener, StandardStrings {
/**
* Sets the value changed keys.
*
- * @param newKeys the new keys
- * @param oldKeys the old keys
+ * @param newKeys
+ * the new keys
+ * @param oldKeys
+ * the old keys
* @return the fs index key description[]
*/
protected FsIndexKeyDescription[] setValueChangedKeys(FsIndexKeyDescription[] newKeys,
@@ -1431,9 +1551,8 @@ implements Listener, StandardStrings {
} else if (oldKeys != null && Arrays.equals(oldKeys, newKeys)) {
} else if (Arrays.equals(newKeys, oldKeys)) // newKeys must be non-null here
{
- }
- else {
- valueChanged = true;
+ } else {
+ valueChanged = true;
}
return newKeys;
@@ -1446,7 +1565,7 @@ implements Listener, StandardStrings {
*/
protected boolean isValidAe() {
if (editor.isValidAE(editor.getAeDescription())) {
- return true;
+ return true;
}
return false;
}
@@ -1454,7 +1573,8 @@ implements Listener, StandardStrings {
/**
* Revert type system.
*
- * @param tsd the tsd
+ * @param tsd
+ * the tsd
*/
protected void revertTypeSystem(TypeSystemDescription tsd) {
try {
@@ -1466,9 +1586,12 @@ implements Listener, StandardStrings {
/**
* Revert msg.
*
- * @param msgTitle the msg title
- * @param msgTxt the msg txt
- * @param exceptionMessage the exception message
+ * @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$
@@ -1479,16 +1602,17 @@ implements Listener, StandardStrings {
/**
* Revert or continue.
*
- * @param msg the msg
- * @param msgDetails the msg details
+ * @param msg
+ * the msg
+ * @param msgDetails
+ * the msg details
* @return true to revert, false to continue
*/
public static boolean revertOrContinue(String msg, String msgDetails) {
- if (Window.CANCEL == Utility.popMessage(msg, msgDetails
- + "\nDo you want to continue, or Abort the last action?", MessageDialog.QUESTION,
- new String[] { "Continue", "Abort" }))
- {
- return true; // for closing the window or hitting Undo
+ if (Window.CANCEL == Utility.popMessage(msg,
+ msgDetails + "\nDo you want to continue, or Abort the last action?",
+ MessageDialog.QUESTION, new String[] { "Continue", "Abort" })) {
+ return true; // for closing the window or hitting Undo
}
return false;
}
@@ -1496,23 +1620,26 @@ implements Listener, StandardStrings {
/**
* Mark stale.
*
- * @param section the section
+ * @param section
+ * the section
*/
public void markStale(IFormPart section) {
if (section != null) {
- ((AbstractFormPart) section).markStale();
+ ((AbstractFormPart) section).markStale();
}
}
/**
* Mark rest of page stale.
*
- * @param mform the mform
- * @param section the section
+ * @param mform
+ * the mform
+ * @param section
+ * the section
*/
protected void markRestOfPageStale(IManagedForm mform, AbstractSection section) {
if (null == mform) {
- return;
+ return;
}
IFormPart[] parts = mform.getParts();
for (int i = 0; i < parts.length; i++) {
@@ -1523,24 +1650,27 @@ implements Listener, StandardStrings {
/**
* Mark stale if different.
*
- * @param thisOne the this one
- * @param otherOne the other one
+ * @param thisOne
+ * the this one
+ * @param otherOne
+ * the other one
*/
protected void markStaleIfDifferent(IFormPart thisOne, IFormPart otherOne) {
if (thisOne != otherOne) {
- markStale(otherOne);
+ markStale(otherOne);
}
}
/**
* Multi line fix.
*
- * @param s the s
+ * @param s
+ * the s
* @return the string
*/
protected String multiLineFix(String s) {
if (null == s) {
- return null;
+ return null;
}
return s.replaceAll("\\r\\n", "\n"); //$NON-NLS-1$ //$NON-NLS-2$
}
@@ -1550,14 +1680,16 @@ implements Listener, StandardStrings {
* Augment arrays (make new array, add one item to it at end
* *********************************************************.
*
- * @param a the a
- * @param s the s
+ * @param a
+ * the a
+ * @param s
+ * the s
* @return the string[]
*/
public String[] stringArrayAdd(String[] a, String s) {
if (a == null) {
- return new String[] { s };
+ return new String[] { s };
}
String[] newA = new String[a.length + 1];
@@ -1569,8 +1701,10 @@ implements Listener, StandardStrings {
/**
* String array remove.
*
- * @param a the a
- * @param s the s
+ * @param a
+ * the a
+ * @param s
+ * the s
* @return the string[]
*/
public String[] stringArrayRemove(String[] a, String s) {
@@ -1578,7 +1712,7 @@ implements Listener, StandardStrings {
for (int i = 0, j = 0; i < a.length; i++) {
if (!a[i].equals(s)) {
result[j++] = a[i];
- }
+ }
}
return result;
}
@@ -1586,13 +1720,15 @@ implements Listener, StandardStrings {
/**
* Type or feature array add.
*
- * @param a the a
- * @param item the item
+ * @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 };
+ return new TypeOrFeature[] { item };
}
TypeOrFeature[] result = new TypeOrFeature[a.length + 1];
@@ -1604,8 +1740,10 @@ implements Listener, StandardStrings {
/**
* Type or feature array remove.
*
- * @param a the a
- * @param item the item
+ * @param a
+ * the a
+ * @param item
+ * the item
* @return the type or feature[]
*/
public TypeOrFeature[] typeOrFeatureArrayRemove(TypeOrFeature[] a, TypeOrFeature item) {
@@ -1613,7 +1751,7 @@ implements Listener, StandardStrings {
for (int i = 0, j = 0; i < a.length; i++) {
if (a[i] != item) {
result[j++] = a[i];
- }
+ }
}
return result;
}
@@ -1621,8 +1759,10 @@ implements Listener, StandardStrings {
/**
* Type or feature array remove.
*
- * @param a the a
- * @param s the s
+ * @param a
+ * the a
+ * @param s
+ * the s
* @return the type or feature[]
*/
public TypeOrFeature[] typeOrFeatureArrayRemove(TypeOrFeature[] a, String s) {
@@ -1631,7 +1771,7 @@ implements Listener, StandardStrings {
if (!a[i].getName().equals(s)) {
// debug
if (j == a.length - 1) {
- throw new InternalErrorCDE("feature or type not found: looking for " + s);
+ throw new InternalErrorCDE("feature or type not found: looking for " + s);
}
result[j++] = a[i];
}
@@ -1642,18 +1782,20 @@ implements Listener, StandardStrings {
/**
* Gets the type or feature.
*
- * @param a the a
- * @param name the name
+ * @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;
+ return null;
}
for (int i = 0; i < a.length; i++) {
if (a[i].getName().equals(name)) {
return a[i];
- }
+ }
}
return null;
}
@@ -1661,13 +1803,14 @@ implements Listener, StandardStrings {
/**
* Parses the to fit in tool tips.
*
- * @param text the text
+ * @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) {
- return "";
+ return "";
}
StringBuffer buffer = new StringBuffer();
final int MAGIC_LENGTH = 65;
@@ -1692,16 +1835,16 @@ implements Listener, StandardStrings {
/**
* Format name.
*
- * @param name the name
+ * @param name
+ * the name
* @return the string
*/
public String formatName(String name) {
- if (null == name)
- {
- return ""; //$NON-NLS-1$
+ if (null == name) {
+ return ""; //$NON-NLS-1$
}
if (MultiPageEditorContributor.getUseQualifiedTypes()) {
- return name;
+ return name;
}
return getShortName(name);
}
@@ -1709,17 +1852,17 @@ implements Listener, StandardStrings {
/**
* Gets the short name.
*
- * @param name the name
+ * @param name
+ * the name
* @return the short name
*/
public static String getShortName(String name) {
- if (null == name)
- {
- return ""; //$NON-NLS-1$
+ if (null == name) {
+ return ""; //$NON-NLS-1$
}
int i = name.lastIndexOf('.');
if (i < 0) {
- return name;
+ return name;
}
return name.substring(i + 1);
}
@@ -1727,7 +1870,8 @@ implements Listener, StandardStrings {
/**
* Gets the short feature name.
*
- * @param name the name
+ * @param name
+ * the name
* @return the short feature name
*/
public static String getShortFeatureName(String name) {
@@ -1737,7 +1881,8 @@ implements Listener, StandardStrings {
/**
* Gets the type from full feature name.
*
- * @param name the name
+ * @param name
+ * the name
* @return the type from full feature name
*/
public static String getTypeFromFullFeatureName(String name) {
@@ -1747,13 +1892,14 @@ implements Listener, StandardStrings {
/**
* Gets the name space.
*
- * @param name the name
+ * @param name
+ * the name
* @return the name space
*/
public static String getNameSpace(String name) {
int i = name.lastIndexOf('.');
if (i < 0) {
- return "";
+ return "";
}
return (name.substring(0, i));
}
@@ -1761,28 +1907,30 @@ implements Listener, StandardStrings {
/**
* gets a feature description for a type, including supertypes.
*
- * @param td the td
- * @param featureName the feature name
+ * @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) {
FeatureDescription[] features = td.getFeatures();
String supertypeName;
if (null != features) {
- for (int i = 0; i < features.length; i++) {
- if (featureName.equals(features[i].getName())) {
- return features[i];
- }
- }
+ for (int i = 0; i < features.length; i++) {
+ if (featureName.equals(features[i].getName())) {
+ return features[i];
+ }
+ }
}
if (null != (supertypeName = td.getSupertypeName())) {
- if (!CAS.TYPE_NAME_TOP.equals(supertypeName)) {
- TypeDescription supertype = getMergedTypeSystemDescription().getType(supertypeName);
- if (null == supertype) {
- supertype = (TypeDescription) BuiltInTypes.typeDescriptions.get(supertypeName);
- }
- return getFeature(supertype, featureName);
- }
+ if (!CAS.TYPE_NAME_TOP.equals(supertypeName)) {
+ TypeDescription supertype = getMergedTypeSystemDescription().getType(supertypeName);
+ if (null == supertype) {
+ supertype = (TypeDescription) BuiltInTypes.typeDescriptions.get(supertypeName);
+ }
+ return getFeature(supertype, featureName);
+ }
}
return null;
}
@@ -1790,7 +1938,8 @@ implements Listener, StandardStrings {
/**
* Checks if is indexable range.
*
- * @param rangeName the range name
+ * @param rangeName
+ * the range name
* @return true, if is indexable range
*/
// means is this range allowed in the UIMA Index Spec as a Key
@@ -1804,19 +1953,22 @@ implements Listener, StandardStrings {
/**
* Sets the tool tip text.
*
- * @param w the w
- * @param text the text
+ * @param w
+ * the w
+ * @param text
+ * the text
*/
public static void setToolTipText(Control w, String text) {
if (null != text) {
- w.setToolTipText(parseToFitInToolTips(text));
+ w.setToolTipText(parseToFitInToolTips(text));
}
}
/**
* Maybe shorten file name.
*
- * @param filePathName the file path name
+ * @param filePathName
+ * the file path name
* @return the string
*/
public static String maybeShortenFileName(String filePathName) {
@@ -1832,13 +1984,15 @@ implements Listener, StandardStrings {
/**
* Swap tree items.
*
- * @param itemBelow the item below
- * @param newSelection the new selection
+ * @param itemBelow
+ * the item below
+ * @param newSelection
+ * the new selection
*/
public static void swapTreeItems(TreeItem itemBelow, int newSelection) {
TreeItem parent = itemBelow.getParentItem();
if (null == parent) {
- throw new InternalErrorCDE("invalid arg");
+ throw new InternalErrorCDE("invalid arg");
}
int i = getIndex(itemBelow);
TreeItem itemAbove = parent.getItems()[i - 1];
@@ -1854,8 +2008,10 @@ implements Listener, StandardStrings {
/**
* Copy table tree item.
*
- * @param target the target
- * @param source the source
+ * @param target
+ * the target
+ * @param source
+ * the source
*/
public static void copyTreeItem(TreeItem target, TreeItem source) {
int columnCount = target.getParent().getColumnCount();
@@ -1863,7 +2019,7 @@ implements Listener, StandardStrings {
String text = source.getText(i);
if (null != text) {
target.setText(i, text);
- }
+ }
}
target.setData(source.getData());
}
@@ -1871,8 +2027,10 @@ implements Listener, StandardStrings {
/**
* Swap index keys.
*
- * @param itemBelow the item below
- * @param newSelection the new selection
+ * @param itemBelow
+ * the item below
+ * @param newSelection
+ * the new selection
*/
public static void swapIndexKeys(TreeItem itemBelow, int newSelection) {
TreeItem parent = itemBelow.getParentItem();
@@ -1890,8 +2048,10 @@ implements Listener, StandardStrings {
/**
* Swap table items.
*
- * @param itemBelow the item below
- * @param newSelection the new selection
+ * @param itemBelow
+ * the item below
+ * @param newSelection
+ * the new selection
*/
public static void swapTableItems(TableItem itemBelow, int newSelection) {
Table parent = itemBelow.getParent();
@@ -1909,8 +2069,10 @@ implements Listener, StandardStrings {
/**
* Copy table item.
*
- * @param target the target
- * @param source the source
+ * @param target
+ * the target
+ * @param source
+ * the source
*/
public static void copyTableItem(TableItem target, TableItem source) {
int columnCount = target.getParent().getColumnCount();
@@ -1918,7 +2080,7 @@ implements Listener, StandardStrings {
String text = source.getText(i);
if (null != text) {
target.setText(i, text);
- }
+ }
}
target.setData(source.getData());
}
@@ -1926,7 +2088,8 @@ implements Listener, StandardStrings {
/**
* Gets the fs index description from table tree item.
*
- * @param item the item
+ * @param item
+ * the item
* @return the fs index description from table tree item
*/
public static FsIndexDescription getFsIndexDescriptionFromTableTreeItem(TreeItem item) {
@@ -1952,13 +2115,14 @@ implements Listener, StandardStrings {
/**
* Gets the capabilities.
*
- * @param rs the rs
+ * @param rs
+ * the rs
* @return the capabilities
*/
public static Capability[] getCapabilities(ResourceSpecifier rs) {
if (rs instanceof ResourceCreationSpecifier) {
- return ((ProcessingResourceMetaData) ((ResourceCreationSpecifier) rs).getMetaData())
- .getCapabilities();
+ return ((ProcessingResourceMetaData) ((ResourceCreationSpecifier) rs).getMetaData())
+ .getCapabilities();
}
return null;
}
@@ -1966,8 +2130,10 @@ implements Listener, StandardStrings {
/**
* Gets the capability sofa names.
*
- * @param rs the rs
- * @param componentKey the component key
+ * @param rs
+ * the rs
+ * @param componentKey
+ * the component key
* @return the capability sofa names
*/
protected static Set[] getCapabilitySofaNames(ResourceCreationSpecifier rs, String componentKey) {
@@ -1985,22 +2151,24 @@ implements Listener, StandardStrings {
/**
* Merge sofa names.
*
- * @param set the set
- * @param items the items
- * @param componentKey the component key
+ * @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++) {
if (null != componentKey) {
- set.add(componentKey + '/' + items[i]);
- }
- else {
- set.add(items[i]);
+ set.add(componentKey + '/' + items[i]);
+ } else {
+ set.add(items[i]);
}
}
} else if (null != componentKey) {
- set.add(componentKey);
+ set.add(componentKey);
}
}
@@ -2015,9 +2183,8 @@ implements Listener, StandardStrings {
AnalysisEngineMetaData md = getAnalysisEngineMetaData();
Capability[] c = getCapabilities();
if (c == null) {
- md.setCapabilities(new Capability[] { newCset });
- }
- else {
+ md.setCapabilities(new Capability[] { newCset });
+ } else {
Capability[] newC = new Capability[c.length + 1];
System.arraycopy(c, 0, newC, 0, c.length);
newC[c.length] = newCset;
@@ -2051,15 +2218,17 @@ implements Listener, StandardStrings {
ae.destroy();
return aemd;
}
-
+
throw new InternalErrorCDE("invalid call");
}
/**
* Sets the vns host and port.
*
- * @param vnsHost the vns host
- * @param vnsPort the vns port
+ * @param vnsHost
+ * the vns host
+ * @param vnsPort
+ * the vns port
*/
public static void setVnsHostAndPort(String vnsHost, String vnsPort) {
MultiPageEditorContributor.setVnsHost(vnsHost);
@@ -2069,7 +2238,8 @@ implements Listener, StandardStrings {
/**
* Sets the vns host and port.
*
- * @param descriptor the new vns host and port
+ * @param descriptor
+ * the new vns host and port
*/
public static void setVnsHostAndPort(Object descriptor) {
String vnsHost = MultiPageEditorContributor.getCDEVnsHost();
@@ -2095,16 +2265,19 @@ implements Listener, StandardStrings {
/**
* Request pop up over import.
*
- * @param importItem the import item
- * @param control the control
- * @param event the event
+ * @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);
IFile[] files = editor.getProject().getWorkspace().getRoot().findFilesForLocation(iPath);
if (null == files || files.length != 1) {
- return;
+ return;
}
String filePathName = files[0].getLocation().toOSString();
@@ -2128,34 +2301,36 @@ implements Listener, StandardStrings {
// code to open selected file, by location or by name
if (null != res) {
- if ((inputDescription instanceof URISpecifier) ||
- isJmsDescriptor(inputDescription)) {
+ if ((inputDescription instanceof URISpecifier) || isJmsDescriptor(inputDescription)) {
editor.openTextEditor(path);
- }
- else {
+ } else {
editor.open(path);
- }
+ }
}
}
-
+
/**
* Checks if is jms descriptor.
*
- * @param inputDescription the input description
+ * @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()));
+ 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
+ * @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) {
@@ -2172,12 +2347,13 @@ implements Listener, StandardStrings {
/**
* Convert null.
*
- * @param s the s
+ * @param s
+ * the s
* @return the string
*/
public static String convertNull(String s) {
if (null == s) {
- return "";
+ return "";
}
return s;
}
@@ -2185,29 +2361,32 @@ implements Listener, StandardStrings {
/**
* Creates the import.
*
- * @param fileName the file name
- * @param isByName the is by name
+ * @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);
- }
- else {
- try {
- return createLocationImport(fileName);
- } catch (MalformedURLException e1) {
- throw new InternalErrorCDE("unhandled exception", e1);
- }
+ } else {
+ try {
+ return createLocationImport(fileName);
+ } catch (MalformedURLException e1) {
+ throw new InternalErrorCDE("unhandled exception", e1);
+ }
}
}
/**
* Creates the location import.
*
- * @param location the location
+ * @param location
+ * the location
* @return a location import
- * @throws MalformedURLException -
+ * @throws MalformedURLException
+ * -
*/
public Import createLocationImport(String location) throws MalformedURLException {
@@ -2235,21 +2414,22 @@ implements Listener, StandardStrings {
/**
* Creates the by name import.
*
- * @param fileName the file name
+ * @param fileName
+ * the file name
* @return the import
*/
public Import createByNameImport(String fileName) {
if (fileName.endsWith(".xml")) {
- fileName = fileName.substring(0, fileName.length() - 4);
+ fileName = fileName.substring(0, fileName.length() - 4);
}
fileName = fileName.replace('\\', '/');
fileName = fileName.replace('/', '.');
int i = fileName.indexOf(":");
if (i >= 0) {
- fileName = fileName.substring(i + 1);
+ fileName = fileName.substring(i + 1);
}
if (fileName.charAt(0) == '.') {
- fileName = fileName.substring(1);
+ fileName = fileName.substring(1);
}
int partStart = 0;
@@ -2262,9 +2442,8 @@ implements Listener, StandardStrings {
imp.findAbsoluteUrl(rm);
} catch (InvalidXMLException e) {
partStart = fileName.indexOf('.', partStart) + 1;
- if (0 == partStart)
- {
- return imp; // not found -outer code will catch error later
+ if (0 == partStart) {
+ return imp; // not found -outer code will catch error later
}
continue;
}
@@ -2275,7 +2454,8 @@ implements Listener, StandardStrings {
/**
* Checks if is FS array or list type.
*
- * @param type the type
+ * @param type
+ * the type
* @return true, if is FS array or list type
*/
// subtype of FSLists should not match
@@ -2287,24 +2467,19 @@ implements Listener, StandardStrings {
/**
* Checks if is array or list type.
*
- * @param type the 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)
- || type.equals(CAS.TYPE_NAME_STRING_LIST)
- || type.equals(CAS.TYPE_NAME_FLOAT_LIST)
- || type.equals(CAS.TYPE_NAME_INTEGER_LIST)
- || type.equals(CAS.TYPE_NAME_STRING_ARRAY)
- || type.equals(CAS.TYPE_NAME_FLOAT_ARRAY)
+ return (null != type) && (type.equals(CAS.TYPE_NAME_FS_ARRAY)
+ || type.equals(CAS.TYPE_NAME_FS_LIST) || type.equals(CAS.TYPE_NAME_STRING_LIST)
+ || type.equals(CAS.TYPE_NAME_FLOAT_LIST) || type.equals(CAS.TYPE_NAME_INTEGER_LIST)
+ || type.equals(CAS.TYPE_NAME_STRING_ARRAY) || type.equals(CAS.TYPE_NAME_FLOAT_ARRAY)
- || type.equals(CAS.TYPE_NAME_BOOLEAN_ARRAY)
- || type.equals(CAS.TYPE_NAME_BYTE_ARRAY)
- || type.equals(CAS.TYPE_NAME_SHORT_ARRAY)
- || type.equals(CAS.TYPE_NAME_INTEGER_ARRAY)
- || type.equals(CAS.TYPE_NAME_LONG_ARRAY) || type
- .equals(CAS.TYPE_NAME_DOUBLE_ARRAY));
+ || type.equals(CAS.TYPE_NAME_BOOLEAN_ARRAY) || type.equals(CAS.TYPE_NAME_BYTE_ARRAY)
+ || type.equals(CAS.TYPE_NAME_SHORT_ARRAY) || type.equals(CAS.TYPE_NAME_INTEGER_ARRAY)
+ || type.equals(CAS.TYPE_NAME_LONG_ARRAY) || type.equals(CAS.TYPE_NAME_DOUBLE_ARRAY));
}
/** The Constant RIDICULOUSLY_LARGE. */
@@ -2313,7 +2488,8 @@ implements Listener, StandardStrings {
/**
* Produce Unique key for a newly added descriptor file.
*
- * @param fileName the file name
+ * @param fileName
+ * the file name
* @return Unique key for a newly added descriptor file
*/
protected String produceUniqueComponentKey(String fileName) {
@@ -2321,7 +2497,7 @@ implements Listener, StandardStrings {
Set existingKeyNames = new HashSet(getDelegateAnalysisEngineSpecifiersWithImports().keySet());
FlowControllerDeclaration fcd = getFlowControllerDeclaration();
if (null != fcd && null != fcd.getKey() && !"".equals(fcd.getKey())) {
- existingKeyNames.add(fcd.getKey());
+ existingKeyNames.add(fcd.getKey());
}
String keyName = fileName;
String keyNameLowerCase = keyName.toLowerCase();
@@ -2336,9 +2512,9 @@ implements Listener, StandardStrings {
return sKeyName;
}
}
- Utility.popMessage("Failed to create unique key", "The Flow Controller name, '" + fileName
- + "', could not be "
- + "converted to a unique key name -- tried with 10000 different suffixes",
+ Utility.popMessage("Failed to create unique key",
+ "The Flow Controller name, '" + fileName + "', could not be "
+ + "converted to a unique key name -- tried with 10000 different suffixes",
MessageDialog.ERROR);
return null;
}
@@ -2356,23 +2532,29 @@ implements Listener, StandardStrings {
/**
* Parses the descriptor.
*
- * @param input the input
+ * @param input
+ * the input
* @return the XM lizable
- * @throws InvalidXMLException the invalid XML exception
+ * @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
+ * @param input
+ * the input
+ * @param preserveComments
+ * the preserve comments
* @return the XM lizable
- * @throws InvalidXMLException the invalid XML exception
+ * @throws InvalidXMLException
+ * the invalid XML exception
*/
- public static XMLizable parseDescriptor(XMLInputSource input, boolean preserveComments) throws InvalidXMLException {
+ public static XMLizable parseDescriptor(XMLInputSource input, boolean preserveComments)
+ throws InvalidXMLException {
// turn off environment variable expansion
XMLParser.ParsingOptions parsingOptions = new XMLParser.ParsingOptions(false);
parsingOptions.preserveComments = preserveComments;
@@ -2386,13 +2568,13 @@ implements Listener, StandardStrings {
/**
* Show exception reading imported descriptor.
*
- * @param e the e
+ * @param e
+ * the e
*/
protected void showExceptionReadingImportedDescriptor(Exception e) {
StringBuffer msg = new StringBuffer(1000);
- msg
- .append("There was an exception raised while reading and parsing an imported descriptor. "
- + "If this is a ''not found'' message for a remote descriptor imported by name, insure that the class path or data path includes an entry where this file should be found.\n");
+ msg.append("There was an exception raised while reading and parsing an imported descriptor. "
+ + "If this is a ''not found'' message for a remote descriptor imported by name, insure that the class path or data path includes an entry where this file should be found.\n");
msg.append(editor.getMessagesToRootCause(e));
Utility.popMessage("Exception reading Imported File", msg.toString(), MessageDialog.ERROR);
}
@@ -2405,13 +2587,11 @@ implements Listener, StandardStrings {
protected boolean isValidAggregateChange() {
// doing this check here is expensive, but gives the best error location information
- if (!editor.isValidAE(editor.getAeDescription()))
- {
- if (revertOrContinue("Continue or Abort",
- "Because of errors in validating the resulting Analysis Engine:\n"))
- {
- return false; // want to revert
- }
+ if (!editor.isValidAE(editor.getAeDescription())) {
+ if (revertOrContinue("Continue or Abort",
+ "Because of errors in validating the resulting Analysis Engine:\n")) {
+ return false; // want to revert
+ }
}
try {
@@ -2454,7 +2634,7 @@ implements Listener, StandardStrings {
editor.getCapabilityPage().markStale();
SectionPart s = editor.getParameterPage().getParameterDelegatesSection();
if (null != s) {
- s.markStale();
+ s.markStale();
}
editor.getResourcesPage().markStale();
}
@@ -2462,9 +2642,12 @@ implements Listener, StandardStrings {
/**
* Read import.
*
- * @param imp the imp
- * @param fileName the file name
- * @param isImportByName the is import by name
+ * @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) {
@@ -2479,8 +2662,8 @@ implements Listener, StandardStrings {
}
try {
- input = new XMLInputSource(byNameURL.openStream(), new File(byNameURL.getFile())
- .getParentFile());
+ input = new XMLInputSource(byNameURL.openStream(),
+ new File(byNameURL.getFile()).getParentFile());
} catch (IOException e) {
showExceptionReadingImportedDescriptor(e);
return null;
@@ -2506,24 +2689,28 @@ implements Listener, StandardStrings {
/**
* Enable ctrl.
*
- * @param c the c
- * @param enabled the enabled
+ * @param c
+ * the c
+ * @param enabled
+ * the enabled
*/
protected static void enableCtrl(Control c, boolean enabled) {
if (null != c) {
- c.setEnabled(enabled);
+ c.setEnabled(enabled);
}
}
/**
* Sets the button selection.
*
- * @param c the c
- * @param selected the selected
+ * @param c
+ * the c
+ * @param selected
+ * the selected
*/
protected static void setButtonSelection(Button c, boolean selected) {
if (null != c) {
- c.setSelection(selected);
+ c.setSelection(selected);
}
}
@@ -2546,13 +2733,15 @@ implements Listener, StandardStrings {
/**
* Gets the description for descriptor.
*
- * @param fileRef the file ref
- * @param rs the rs
+ * @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 "";
+ return "";
}
String sDesc;
long lCurrentTimeInMillis = System.currentTimeMillis();
@@ -2571,10 +2760,9 @@ implements Listener, StandardStrings {
String description = resourceMetaData.getDescription();
if (null != description && !description.equals("")) {
sDesc += parseToFitInToolTips(description);
- }
- else {
+ } else {
sDesc += "(No Description)";
- }
+ }
}
}
lastResourceForDescription = rs;
@@ -2587,16 +2775,17 @@ implements Listener, StandardStrings {
/**
* Setup to print file.
*
- * @param filePath the file path
+ * @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(
- "The file ''{0}'' exists. Press OK if it can be replaced; otherwise press Cancel.",
- new Object[] { filePath }), MessageDialog.WARNING)) {
- return null;
- }
+ if (Window.CANCEL == Utility.popOkCancel("File exists, OK to replace?", MessageFormat.format(
+ "The file ''{0}'' exists. Press OK if it can be replaced; otherwise press Cancel.",
+ new Object[] { filePath }), MessageDialog.WARNING)) {
+ return null;
+ }
}
FileOutputStream fos = null;
try {
@@ -2616,8 +2805,8 @@ implements Listener, StandardStrings {
protected FsIndexCollection getFsIndexCollection() {
FsIndexCollection fsic = getAnalysisEngineMetaData().getFsIndexCollection();
if (null == fsic) {
- getAnalysisEngineMetaData().setFsIndexCollection(
- fsic = UIMAFramework.getResourceSpecifierFactory().createFsIndexCollection());
+ getAnalysisEngineMetaData().setFsIndexCollection(
+ fsic = UIMAFramework.getResourceSpecifierFactory().createFsIndexCollection());
}
return fsic;
}
@@ -2625,28 +2814,31 @@ implements Listener, StandardStrings {
/**
* Handle default index kind.
*
- * @param indexKind the index kind
+ * @param indexKind
+ * the index kind
* @return the string
*/
public static String handleDefaultIndexKind(String indexKind) {
if (null == indexKind) {
- return "sorted";
+ return "sorted";
}
return indexKind;
}
-
+
/**
- * Set the selection one above this item, unless it's the top one already.
- * Used when removing the item.
+ * Set the selection one above this item, unless it's the top one already. Used when removing the
+ * item.
*
- * @param tt tree
- * @param item context item
+ * @param tt
+ * tree
+ * @param item
+ * context item
*/
public static void setSelectionOneUp(Tree tt, TreeItem item) {
int itemIndex = tt.indexOf(item);
maybeSetSelection(tt, itemIndex - 1);
}
-
+
public static void maybeSetSelection(Tree tt, int itemIndex) {
TreeItem[] items = tt.getItems();
if (itemIndex >= 0 && itemIndex < items.length) {
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSectionParm.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSectionParm.java
index 3f780b8..d5bbf43 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSectionParm.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AbstractSectionParm.java
@@ -44,7 +44,6 @@ import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
-
/**
* The Class AbstractSectionParm.
*/
@@ -89,7 +88,7 @@ public abstract class AbstractSectionParm extends AbstractSection {
// //$NON-NLS-1$
/** The Constant MULTI_VALUE_INDICATOR. */
- protected final static String MULTI_VALUE_INDICATOR = "Multi "; //$NON-NLS-1$
+ 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$
@@ -99,24 +98,23 @@ public abstract class AbstractSectionParm extends AbstractSection {
/** 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$
-
+ 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<>(4);
+ protected final static Map<String, String> typeNamesW = new HashMap<>(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$
- typeNamesW.put("String", "String "); //$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-2$
+ typeNamesW.put("String", "String "); //$NON-NLS-1$ //$NON-NLS-2$
}
/** The tree. */
@@ -150,7 +148,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Sets the settings.
*
- * @param v the new settings
+ * @param v
+ * the new settings
*/
public void setSettings(ParameterSettingsSection v) {
settings = v;
@@ -160,10 +159,14 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Instantiates a new abstract section parm.
*
- * @param aEditor the a editor
- * @param parent the parent
- * @param header the header
- * @param description the description
+ * @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) {
@@ -188,14 +191,17 @@ public abstract class AbstractSectionParm extends AbstractSection {
@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
+ *
+ * @param usingGroups
+ * the using groups
*/
protected void clearAndRefillTree(boolean usingGroups) {
cpd = getConfigurationParameterDeclarations();
@@ -218,13 +224,13 @@ public abstract class AbstractSectionParm extends AbstractSection {
// first is the <Not in any group>, 2nd is the <Common>
if (null == cpd.getConfigurationParameters()) {
cpd.setConfigurationParameters(configurationParameterArray0);
- }
+ }
fillGroup(cpd.getConfigurationParameters(), NOT_IN_ANY_GROUP, null);
if (null == cpd.getCommonParameters()) {
cpd.setCommonParameters(configurationParameterArray0);
- }
+ }
if (usingGroups) {
fillGroup(cpd.getCommonParameters(), COMMON_GROUP, null);
@@ -234,14 +240,14 @@ public abstract class AbstractSectionParm extends AbstractSection {
for (int i = 0; i < groups.length; i++) {
ConfigurationParameter[] cps = groups[i].getConfigurationParameters();
if (null == cps) {
- groups[i].setConfigurationParameters(cps = configurationParameterArray0);
+ groups[i].setConfigurationParameters(cps = configurationParameterArray0);
}
fillGroup(groups[i].getConfigurationParameters(), groups[i].getNames(), groups[i]);
}
if (splitGroupNames) {
fillGroupsFromGroupParms();
- }
+ }
expandAllItems(tree.getItems()); // expand for overrides or groups
@@ -254,7 +260,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Expand all items.
*
- * @param items the items
+ * @param items
+ * the items
*/
private void expandAllItems(TreeItem[] items) {
TreeItem[] containedItems;
@@ -263,18 +270,22 @@ public abstract class AbstractSectionParm extends AbstractSection {
containedItems = items[i].getItems();
if (null != containedItems) {
expandAllItems(containedItems);
- }
+ }
}
}
/**
* 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
+ * @param parms
+ * the parms
+ * @param names
+ * the names
+ * @param modelCG
+ * the model CG
*/
- private void fillGroup(ConfigurationParameter[] parms, String[] names, ConfigurationGroup modelCG) {
+ private void fillGroup(ConfigurationParameter[] parms, String[] names,
+ ConfigurationGroup modelCG) {
fillGroup(parms, groupNameArrayToString(names), modelCG);
}
@@ -282,9 +293,12 @@ public abstract class AbstractSectionParm extends AbstractSection {
* called by refresh() for <Common> and refresh() for named, via another path with names as array
* first converted to concatenated string.
*
- * @param parms the parms
- * @param names the names
- * @param modelCG the model CG
+ * @param parms
+ * the parms
+ * @param names
+ * the names
+ * @param modelCG
+ * the model CG
*/
private void fillGroup(ConfigurationParameter[] parms, String names, ConfigurationGroup modelCG) {
if (splitGroupNames) {
@@ -295,22 +309,21 @@ public abstract class AbstractSectionParm extends AbstractSection {
if (nameArray.length == 1 && nameArray[0].equals(NOT_IN_ANY_GROUP)) {
TreeItem groupItem = addGroupToGUI(nameArray[0], modelCG);
fill(parms, groupItem);
- }
- else {
- for (int i = 0; i < nameArray.length; i++) {
- List g = (List) groupParms.get(nameArray[i]);
- if (null == g) {
- g = new ArrayList();
- groupParms.put(nameArray[i], g);
- }
- g.add(new Object[] { modelCG, parms });
- }
+ } else {
+ for (int i = 0; i < nameArray.length; i++) {
+ List g = (List) groupParms.get(nameArray[i]);
+ if (null == g) {
+ g = new ArrayList();
+ groupParms.put(nameArray[i], g);
+ }
+ g.add(new Object[] { modelCG, parms });
+ }
}
}
} else {
if (names.equals(COMMON_GROUP)) {
commonParms = parms;
- }
+ }
TreeItem groupItem = addGroupToGUI(names, modelCG);
fill(parms, groupItem);
}
@@ -337,12 +350,14 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* 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
+ * @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) {
- return;
+ return;
}
for (int i = 0; i < parms.length; i++) {
addNewConfigurationParameterToGUI(parms[i], group);
@@ -352,16 +367,16 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Group name array to string.
*
- * @param strings the strings
+ * @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++) {
- if (i > 0)
- {
+ if (i > 0) {
b.append(" "); //$NON-NLS-1$
- }
+ }
b.append(strings[i]);
}
return b.toString();
@@ -370,12 +385,13 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Group names to array.
*
- * @param names the names
+ * @param names
+ * the names
* @return the string[]
*/
protected String[] groupNamesToArray(String names) {
if (names.equals(NOT_IN_ANY_GROUP)) {
- return new String[] { names };
+ return new String[] { names };
}
AbstractList items = new ArrayList();
@@ -383,7 +399,7 @@ public abstract class AbstractSectionParm extends AbstractSection {
int end;
while (start < names.length() && (names.charAt(start) == ' ')) {
- start++;
+ start++;
}
for (; start < names.length();) {
@@ -396,7 +412,7 @@ public abstract class AbstractSectionParm extends AbstractSection {
start = end;
while (start < names.length() && names.charAt(start) == ' ') {
start++;
- }
+ }
}
return (String[]) items.toArray(stringArray0);
}
@@ -406,8 +422,10 @@ public abstract class AbstractSectionParm extends AbstractSection {
* addNewConfigurationParameter, alterExistingConfigurationParamater (editing), fill (bulk update
* from refresh)
*
- * @param item the item
- * @param parm the parm
+ * @param item
+ * the item
+ * @param parm
+ * the parm
*/
protected void fillParmItem(TreeItem item, ConfigurationParameter parm) {
item.setText(parmGuiString(parm));
@@ -421,42 +439,46 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Parm gui string.
*
- * @param parm the parm
+ * @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();
+ + ((parm.getExternalOverrideName() == null) ? NO_EXTERNAL_OVERRIDE_INDICATOR
+ : EXTERNAL_OVERRIDE_INDICATOR)
+ + nameHeader + parm.getName();
}
/**
* Sets the group text.
*
- * @param groupItem the group item
- * @param names the names
+ * @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);
- }
- else if (names.equals(NOT_IN_ANY_GROUP)) {
- groupItem.setText(NOT_IN_ANY_GROUP_HEADER);
- }
- else {
- // next line formats the names with the right number of spaces and makes it
- // possible to do future equal compares
- groupItem.setText(GROUP_HEADER + groupNameArrayToString(groupNamesToArray(names)));
+ groupItem.setText(COMMON_GROUP_HEADER);
+ } else if (names.equals(NOT_IN_ANY_GROUP)) {
+ groupItem.setText(NOT_IN_ANY_GROUP_HEADER);
+ } else {
+ // next line formats the names with the right number of spaces and makes it
+ // possible to do future equal compares
+ groupItem.setText(GROUP_HEADER + groupNameArrayToString(groupNamesToArray(names)));
}
}
/**
* Adds the group to GUI.
*
- * @param names the names
- * @param cg the cg
+ * @param names
+ * the names
+ * @param cg
+ * the cg
* @return the tree item
*/
protected TreeItem addGroupToGUI(String names, ConfigurationGroup cg) {
@@ -464,13 +486,11 @@ public abstract class AbstractSectionParm extends AbstractSection {
setGroupText(groupItem, names);
ConfigGroup mcg;
if (names.equals(COMMON_GROUP)) {
- mcg = new ConfigGroup(cpd, ConfigGroup.COMMON);
- }
- else if (names.equals(NOT_IN_ANY_GROUP)) {
- mcg = new ConfigGroup(cpd, ConfigGroup.NOT_IN_ANY_GROUP);
- }
- else {
- mcg = new ConfigGroup(cpd, cg);
+ mcg = new ConfigGroup(cpd, ConfigGroup.COMMON);
+ } else if (names.equals(NOT_IN_ANY_GROUP)) {
+ mcg = new ConfigGroup(cpd, ConfigGroup.NOT_IN_ANY_GROUP);
+ } else {
+ mcg = new ConfigGroup(cpd, cg);
}
groupItem.setData(mcg);
String[] nameArray = groupNamesToArray(names);
@@ -491,15 +511,17 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Contains group.
*
- * @param groupName the group name
- * @param settingsItems the settings items
+ * @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]))) {
return true;
- }
+ }
}
return false;
}
@@ -507,16 +529,16 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* 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
+ * @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
*/
protected void addNewConfigurationParameterToGUI(ConfigurationParameter newCP, TreeItem group) {
- if (null == group)
- {
- throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
+ if (null == group) {
+ throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
}
// is part of group but could be NOT_IN_ANY_GROUP
@@ -548,8 +570,10 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Fill overrides.
*
- * @param parent the parent
- * @param modelCP the model CP
+ * @param parent
+ * the parent
+ * @param modelCP
+ * the model CP
*/
// here just make above fn compile OK
protected void fillOverrides(TreeItem parent, ConfigurationParameter modelCP) {
@@ -558,7 +582,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Checks if is override.
*
- * @param item the item
+ * @param item
+ * the item
* @return true, if is override
*/
protected boolean isOverride(TreeItem item) {
@@ -568,19 +593,21 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Checks if is parameter.
*
- * @param item the item
+ * @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));
+ return (!isGroup(item) && !s.startsWith(DELEGATE_HEADER) && !s.startsWith(FLOWCTLR_HEADER)
+ && !item.getText().startsWith(OVERRIDE_HEADER));
}
/**
* Checks if is group.
*
- * @param item the item
+ * @param item
+ * the item
* @return true, if is group
*/
// Note: rest of code considers NOT_IN_ANY_GROUP to be a kind of group
@@ -593,7 +620,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Checks if is not in any group.
*
- * @param item the item
+ * @param item
+ * the item
* @return true, if is not in any group
*/
protected boolean isNOT_IN_ANY_GROUP(TreeItem item) {
@@ -603,7 +631,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Checks if is common group.
*
- * @param item the item
+ * @param item
+ * the item
* @return true, if is common group
*/
protected boolean isCommonGroup(TreeItem item) {
@@ -613,7 +642,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Checks if is delegate.
*
- * @param item the item
+ * @param item
+ * the item
* @return true, if is delegate
*/
protected boolean isDelegate(TreeItem item) {
@@ -659,7 +689,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Gets the name.
*
- * @param item the item
+ * @param item
+ * the item
* @return the name
*/
protected String getName(TreeItem item) {
@@ -669,23 +700,24 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Gets the name.
*
- * @param s the s
+ * @param s
+ * the s
* @return the name
*/
protected String getName(String s) {
if (s.startsWith(NOT_IN_ANY_GROUP_HEADER)) {
- return NOT_IN_ANY_GROUP;
+ return NOT_IN_ANY_GROUP;
}
if (s.startsWith(COMMON_GROUP_HEADER)) {
- return COMMON_GROUP;
+ return COMMON_GROUP;
}
if (s.startsWith(GROUP_HEADER)) {
- return s.substring(GROUP_HEADER.length());
+ return s.substring(GROUP_HEADER.length());
}
if (s.startsWith(OVERRIDE_HEADER)) {
- return s.substring(OVERRIDE_HEADER.length());
+ return s.substring(OVERRIDE_HEADER.length());
}
// parameter
return s.substring(s.indexOf(nameHeader) + nameHeader.length());
@@ -694,8 +726,10 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Gets the item index.
*
- * @param parent the parent
- * @param child the child
+ * @param parent
+ * the parent
+ * @param child
+ * the child
* @return the item index
*/
protected int getItemIndex(TreeItem parent, TreeItem child) {
@@ -705,8 +739,10 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Gets the item index.
*
- * @param parent the parent
- * @param child the child
+ * @param parent
+ * the parent
+ * @param child
+ * the child
* @return the item index
*/
protected int getItemIndex(Tree parent, TreeItem child) {
@@ -717,17 +753,19 @@ public abstract class AbstractSectionParm extends AbstractSection {
* 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 sourceItemName the source item name
+ * @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) {
- return null;
+ return null;
}
if (null != containingGroup && isNOT_IN_ANY_GROUP(containingGroup)) {
- return new TreeItem[] { findMatchingParm(settingsTree.getItems()[0], sourceItemName) };
+ return new TreeItem[] { findMatchingParm(settingsTree.getItems()[0], sourceItemName) };
}
TreeItem[] groups = getSettingsGroups((null == containingGroup) ? tree.getItems()[1] // use
@@ -752,8 +790,10 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Find matching parm.
*
- * @param group the group
- * @param name the name
+ * @param group
+ * the group
+ * @param name
+ * the name
* @return the tree item
*/
private TreeItem findMatchingParm(TreeItem group, String name) {
@@ -761,7 +801,7 @@ public abstract class AbstractSectionParm extends AbstractSection {
for (int i = 0; i < items.length; i++) {
if (name.equals(getName(items[i]))) {
return items[i];
- }
+ }
}
throw new InternalErrorCDE("invalid state");
}
@@ -769,16 +809,17 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* get set of settings group from settingsTree that correspond to parmsection group.
*
- * @param group the group
+ * @param group
+ * the group
* @return set of settings group from settingsTree that correspond to parm-section group
*/
protected TreeItem[] getSettingsGroups(TreeItem group) {
if (null == settingsTree) {
- return null;
+ return null;
}
if (isNOT_IN_ANY_GROUP(group)) {
- return new TreeItem[] { settingsTree.getItems()[0] };
+ return new TreeItem[] { settingsTree.getItems()[0] };
}
AbstractList results = new ArrayList();
@@ -797,7 +838,7 @@ public abstract class AbstractSectionParm extends AbstractSection {
String name = getName(items[itemIndex].getText());
for (int i = 0; i < groupNamesArray.length; i++) {
if (name.equals(groupNamesArray[i])) {
- results.add(items[itemIndex]);
+ results.add(items[itemIndex]);
}
}
}
@@ -807,7 +848,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* find settings tree item for group name.
*
- * @param name the name
+ * @param name
+ * the name
* @return settings tree item for group name
*/
protected TreeItem getSettingsGroupTreeItemByName(String name) {
@@ -815,7 +857,7 @@ public abstract class AbstractSectionParm extends AbstractSection {
for (int i = 0; i < items.length; i++) {
if (name.equals(getName(items[i].getText()))) {
return items[i];
- }
+ }
}
throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
}
@@ -823,13 +865,13 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Gets the corresponding model parm.
*
- * @param item the item
+ * @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$
+ if (!isParameter(item)) {
+ throw new InternalErrorCDE("invalid argument"); //$NON-NLS-1$
}
return (ConfigurationParameter) item.getData();
}
@@ -837,13 +879,13 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Gets the corresponding model group.
*
- * @param item the item
+ * @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$
+ if (!isGroup(item)) {
+ throw new InternalErrorCDE("invalid argument"); //$NON-NLS-1$
}
return (ConfigGroup) item.getData();
}
@@ -858,8 +900,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
}
// ***********************************************************************************************
- // Methods affecting the parameter settings.
- // These run whether or not the settings page has been instantiated.
+ // 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.
// ***********************************************************************************************
@@ -871,13 +913,14 @@ public abstract class AbstractSectionParm extends AbstractSection {
* 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 the remove from GUI
+ * @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))
- {
- throw new InternalErrorCDE("invalid argument"); //$NON-NLS-1$
+ if (!isParameter(parmItem)) {
+ throw new InternalErrorCDE("invalid argument"); //$NON-NLS-1$
}
ConfigurationParameterSettings modelSettings = getModelSettings();
@@ -910,9 +953,12 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Update parm in settings GUI.
*
- * @param existingCP the existing CP
- * @param existingTreeItem the existing tree item
- * @param prevName the prev name
+ * @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) {
@@ -937,7 +983,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Gets the all group names.
*
- * @param aCpd the a cpd
+ * @param aCpd
+ * the a cpd
* @return all named groups, excludes <Common> and <Not in any group>
*/
protected String[] getAllGroupNames(ConfigurationParameterDeclarations aCpd) {
@@ -993,8 +1040,10 @@ public abstract class AbstractSectionParm extends AbstractSection {
* 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 the group names
- * @param cps the cps
+ * @param groupNames
+ * the group names
+ * @param cps
+ * the cps
*/
public void removeIncludedParmSettingsFromMultipleGroups(String[] groupNames,
ConfigurationParameter[] cps) {
@@ -1006,17 +1055,18 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* 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
+ * @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,
ConfigurationParameter[] cps) {
ConfigurationParameterSettings modelSettings = getModelSettings();
// modelSettings.setParameterValue()
- if (groupName.equals(COMMON_GROUP))
- {
- throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
+ if (groupName.equals(COMMON_GROUP)) {
+ throw new InternalErrorCDE("invalid state"); //$NON-NLS-1$
}
if (groupName.equals(NOT_IN_ANY_GROUP)) {
@@ -1025,14 +1075,15 @@ public abstract class AbstractSectionParm extends AbstractSection {
} else {
for (int i = 0; i < cps.length; i++) {
modelSettings.setParameterValue(groupName, cps[i].getName(), null);
- }
+ }
}
if (null != settings) {
TreeItem settingGroup = getSettingsGroupTreeItemByName(groupName);
if (groupName.equals(COMMON_GROUP) || groupName.equals(NOT_IN_ANY_GROUP)) {
disposeAllChildItems(settingGroup);
} else {
- if (getConfigurationParameterDeclarations().getConfigurationGroupDeclarations(groupName).length == 1) {
+ if (getConfigurationParameterDeclarations()
+ .getConfigurationGroupDeclarations(groupName).length == 1) {
settingGroup.dispose();
} else {
@@ -1048,7 +1099,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Dispose all child items.
*
- * @param parent the parent
+ * @param parent
+ * the parent
*/
public void disposeAllChildItems(TreeItem parent) {
TreeItem[] items = parent.getItems();
@@ -1060,7 +1112,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
/**
* Show description as tool tip.
*
- * @param event the event
+ * @param event
+ * the event
*/
protected void showDescriptionAsToolTip(Event event) {
TreeItem item = tree.getItem(new Point(event.x, event.y));
@@ -1078,9 +1131,8 @@ public abstract class AbstractSectionParm extends AbstractSection {
}
if (text != null) {
setToolTipText(tree, text);
- }
- else {
- tree.setToolTipText(""); //$NON-NLS-1$
+ } else {
+ tree.setToolTipText(""); //$NON-NLS-1$
}
}
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregatePage.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregatePage.java
index 52502bf..a34a1fb 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregatePage.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregatePage.java
@@ -23,7 +23,6 @@ import org.apache.uima.taeconfigurator.editors.Form2Panel;
import org.apache.uima.taeconfigurator.editors.MultiPageEditor;
import org.eclipse.ui.forms.IManagedForm;
-
/**
* The Class AggregatePage.
*/
@@ -38,16 +37,18 @@ public class AggregatePage extends HeaderPageWithSash {
/**
* Instantiates a new aggregate page.
*
- * @param aEditor the a editor
+ * @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
+ * @param managedForm
+ * the managed form
*/
@Override
protected void createFormContent(IManagedForm managedForm) {
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregateSection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregateSection.java
index ba58109..627efc3 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregateSection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/AggregateSection.java
@@ -55,7 +55,6 @@ import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.ui.forms.IManagedForm;
-
/**
* The Class AggregateSection.
*/
@@ -97,8 +96,10 @@ public class AggregateSection extends AbstractSection {
/**
* 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
+ * @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",
@@ -131,12 +132,13 @@ public class AggregateSection extends AbstractSection {
// This little code fragment is an attempt to get the right sizing for the buttons
// Was wrong on Mac platforms
- // Word below is the longer of the two words in the button container
+ // Word below is the longer of the two words in the button container
Button tempForSize = toolkit.createButton(tableContainer, "Remove", SWT.PUSH);
Point p = tempForSize.computeSize(SWT.DEFAULT, SWT.DEFAULT);
tempForSize.dispose();
-
- Composite bottomButtonContainer = newButtonContainer(tableContainer, HORIZONTAL_BUTTONS, 3* p.x);
+
+ Composite bottomButtonContainer = newButtonContainer(tableContainer, HORIZONTAL_BUTTONS,
+ 3 * p.x);
addButton = newPushButton(bottomButtonContainer, S_ADD,
"Click here to add a locally defined AE or CAS Consumer delegate", ENABLED);
@@ -252,14 +254,13 @@ public class AggregateSection extends AbstractSection {
boolean bEnableButtons = (filesTable.getSelectionCount() > 0);
removeButton.setEnabled(bEnableButtons);
addToFlowButton.setEnabled(bEnableButtons);
- } else if (event.type == SWT.MouseDown &&
- (event.button == 3 ||
- // this is for Macintosh - they just have one button
- (event.button == 1 && (0 != (event.stateMask & SWT.CTRL))))) {
+ } else if (event.type == SWT.MouseDown && (event.button == 3 ||
+ // this is for Macintosh - they just have one button
+ (event.button == 1 && (0 != (event.stateMask & SWT.CTRL))))) {
handleTableContextMenuRequest(event);
} else if (event.type == SWT.MouseHover && !bDisableToolTipHelp) {
handleTableHoverHelp(event);
- }
+ }
// Don't need this. Next mouse hover kills tool tip anyway
// else if (event.type == SWT.MouseMove) {
// filesTable.setToolTipText("");
@@ -294,10 +295,14 @@ public class AggregateSection extends AbstractSection {
/**
* 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
+ * @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) {
@@ -356,7 +361,7 @@ public class AggregateSection extends AbstractSection {
FlowNodes flow = new FlowNodes(getAnalysisEngineMetaData().getFlowConstraints());
String[] savedFlowNodes = flow.getFlow();
- if (null == savedFlowNodes)
+ if (null == savedFlowNodes)
savedFlowNodes = stringArray0;
// item may be in the flow 0, 1 or more times
@@ -423,12 +428,13 @@ public class AggregateSection extends AbstractSection {
/**
* Adds the node to flow.
*
- * @param node the node
+ * @param node
+ * the node
*/
private void addNodeToFlow(String node) {
FlowSection fs = editor.getAggregatePage().getFlowSection();
fs.addNode(node);
-// fs.refresh(); // the fs.addNode does a refresh
+ // fs.refresh(); // the fs.addNode does a refresh
}
/**
@@ -457,17 +463,14 @@ public class AggregateSection extends AbstractSection {
" <protocol>{2}</protocol>\n" + // SOAP or Vinci
" <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"
- + " <parameters>\n"
- + " <parameter name=\"brokerURL\" value=\"{0}\"/>\n"
- + " <parameter name=\"endpoint\" value=\"{1}\"/>\n"
- + "{2}"
- + " </parameters>\n"
- + "</customResourceSpecifier>";
+ 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"
+ + " <parameters>\n" + " <parameter name=\"brokerURL\" value=\"{0}\"/>\n"
+ + " <parameter name=\"endpoint\" value=\"{1}\"/>\n" + "{2}" + " </parameters>\n"
+ + "</customResourceSpecifier>";
/**
* Handle add remote.
@@ -480,10 +483,8 @@ public class AggregateSection extends AbstractSection {
return;
String sServiceType = dialog.getSelectedServiceTypeName();
- if (sServiceType != null &&
- !sServiceType.equals("UIMA-AS JMS") &&
- !sServiceType.equals("SOAP") &&
- !sServiceType.equals("Vinci")) {
+ if (sServiceType != null && !sServiceType.equals("UIMA-AS JMS") && !sServiceType.equals("SOAP")
+ && !sServiceType.equals("Vinci")) {
return;
}
String sURI = dialog.getSelectedUri();
@@ -501,20 +502,19 @@ public class AggregateSection extends AbstractSection {
String vnsHostPort = "";
if (dialog.vnsHost.length() > 0) {
vnsHostPort = MessageFormat.format(" <parameter name=\"VNS_HOST\" value=\"{0}\"/>\n",
- new Object[] { dialog.vnsHost });
+ new Object[] { dialog.vnsHost });
}
if (dialog.vnsPort.length() > 0) {
vnsHostPort += MessageFormat.format(" <parameter name=\"VNS_PORT\" value=\"{0}\"/>\n",
new Object[] { dialog.vnsPort });
}
-
+
if (vnsHostPort.length() > 0)
vnsHostPort = "\n <parameters>" + vnsHostPort + " </parameters>";
-
-
- printWriter.println(MessageFormat.format(REMOTE_TEMPLATE, new Object[] { dialog.aeOrCc, sURI,
- sServiceType, dialog.timeout, vnsHostPort }));
- } else {
+
+ printWriter.println(MessageFormat.format(REMOTE_TEMPLATE,
+ new Object[] { dialog.aeOrCc, sURI, sServiceType, dialog.timeout, vnsHostPort }));
+ } else {
// is UIMA-AS JMS
StringBuilder sb = new StringBuilder();
addParam(sb, "timeout", dialog.timeout);
@@ -522,11 +522,9 @@ public class AggregateSection extends AbstractSection {
addParam(sb, "cpctimeout", dialog.cpcTimeout);
addParam(sb, "binary_serialization", dialog.binary_serialization);
addParam(sb, "ignore_process_errors", dialog.ignore_process_errors);
- printWriter.println(MessageFormat.format(REMOTE_JMS_TEMPLATE, new Object[] {
- sURI, // brokerUrl
+ printWriter.println(MessageFormat.format(REMOTE_JMS_TEMPLATE, new Object[] { sURI, // brokerUrl
dialog.endpoint, // endpoint
- sb.toString()
- }));
+ sb.toString() }));
}
printWriter.close();
@@ -540,18 +538,22 @@ public class AggregateSection extends AbstractSection {
}
}
}
-
+
/**
* Adds the param.
*
- * @param sb the sb
- * @param name the name
- * @param value the value
+ * @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");
+ sb = sb.append(" <parameter name=\"").append(name).append("\" value=\"").append(value)
+ .append("\"/>\n");
}
return sb;
}
@@ -564,8 +566,7 @@ public class AggregateSection extends AbstractSection {
* Handle find analysis engine.
*/
private void handleFindAnalysisEngine() {
- FindComponentDialog dialog1 = new FindComponentDialog(
- this,
+ FindComponentDialog dialog1 = new FindComponentDialog(this,
"Find an Analysis Engine (AE), CAS Consumer, or Remote Service Descriptor",
"Specify a name pattern and/or additional constraints, and then push the Search button",
delegateComponentStringHeadersLC);
@@ -605,7 +606,7 @@ public class AggregateSection extends AbstractSection {
shortName = fileName.substring(nLastSlashLoc + 1);
}
produceKeyAddDelegate(shortName, editor.getFullPathFromDescriptorRelativePath(fileName),
- // dialog2.getAutoAddToFlow(),
+ // dialog2.getAutoAddToFlow(),
true, dialog2.isImportByName);
}
finishAggregateChangeAction();
@@ -614,7 +615,8 @@ public class AggregateSection extends AbstractSection {
/**
* Handle table context menu request.
*
- * @param event the event
+ * @param event
+ * the event
*/
private void handleTableContextMenuRequest(Event event) {
TableItem item = filesTable.getItem(new Point(event.x, event.y));
@@ -633,7 +635,8 @@ public class AggregateSection extends AbstractSection {
/**
* Handle table hover help.
*
- * @param event the event
+ * @param event
+ * the event
*/
private void handleTableHoverHelp(Event event) {
TableItem item = filesTable.getItem(new Point(event.x, event.y));
@@ -641,8 +644,8 @@ public class AggregateSection extends AbstractSection {
if (null != item) {
Map dels = editor.getResolvedDelegates();
if (null != dels) {
- sDesc = getDescriptionForDescriptor(item.getText(0), (ResourceSpecifier) dels.get(item
- .getText(1)));
+ sDesc = getDescriptionForDescriptor(item.getText(0),
+ (ResourceSpecifier) dels.get(item.getText(1)));
}
}
filesTable.setToolTipText(sDesc);
@@ -651,10 +654,14 @@ public class AggregateSection extends AbstractSection {
/**
* 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
+ * @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,
@@ -679,16 +686,10 @@ public class AggregateSection extends AbstractSection {
&& !(inputDescription instanceof CasConsumerDescription)
&& !(inputDescription instanceof URISpecifier)
&& !(inputDescription instanceof PearSpecifier)
- && !(isJmsDescriptor(inputDescription))
- ) {
- Utility
- .popMessage(
- "Invalid kind of descriptor",
- MessageFormat
- .format(
- "Operation cancelled: The descriptor ''{0}'' being added is not an Analysis Engine or a CAS Consumer or a Remote Service.",
- new Object[] { maybeShortenFileName(fileName) }),
- MessageDialog.ERROR);
+ && !(isJmsDescriptor(inputDescription))) {
+ Utility.popMessage("Invalid kind of descriptor", MessageFormat.format(
+ "Operation cancelled: The descriptor ''{0}'' being added is not an Analysis Engine or a CAS Consumer or a Remote Service.",
+ new Object[] { maybeShortenFileName(fileName) }), MessageDialog.ERROR);
return false;
}
@@ -706,11 +707,12 @@ public class AggregateSection extends AbstractSection {
finishAggregateChangeAction();
return true;
}
-
+
/**
* Checks if is new key.
*
- * @param keyName the key name
+ * @param keyName
+ * the key name
* @return true, if is new key
*/
private boolean isNewKey(String keyName) {
@@ -725,7 +727,8 @@ public class AggregateSection extends AbstractSection {
/**
* Adds the parameters for delegate.
*
- * @param tae the tae
+ * @param tae
+ * the tae
*/
public void addParametersForDelegate(AnalysisEngineDescription tae) {
ConfigurationParameter[] candidateNewParams = tae.getAnalysisEngineMetaData()
@@ -747,8 +750,8 @@ public class AggregateSection extends AbstractSection {
if (oldParams == null || oldParams.length == 0) {
getAnalysisEngineMetaData().getConfigurationParameterDeclarations()
.setConfigurationParameters(candidateNewParams);
- getAnalysisEngineMetaData().getConfigurationParameterSettings().setParameterSettings(
- candidateSettings);
+ getAnalysisEngineMetaData().getConfigurationParameterSettings()
+ .setParameterSettings(candidateSettings);
} else {
// first do parameters
Vector newParams = new Vector();
@@ -800,12 +803,14 @@ public class AggregateSection extends AbstractSection {
for (int i = 0; i < newSettings.size(); i++) {
newPlusOldSettings[oldSettings.length + i] = (NameValuePair) newSettings.elementAt(i);
}
- getAnalysisEngineMetaData().getConfigurationParameterSettings().setParameterSettings(
- newPlusOldSettings);
+ getAnalysisEngineMetaData().getConfigurationParameterSettings()
+ .setParameterSettings(newPlusOldSettings);
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
*/
@Override
@@ -823,8 +828,10 @@ public class AggregateSection extends AbstractSection {
/**
* adds a tableItem to the table.
*
- * @param o the o
- * @param keyName the key name
+ * @param o
+ * the o
+ * @param keyName
+ * the key name
*/
private void addFile(Object o, String keyName) {
Import impItem = (Import) o;
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilityPage.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilityPage.java
index 0ce4e8c..ffdcb39 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilityPage.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilityPage.java
@@ -24,7 +24,6 @@ import org.apache.uima.taeconfigurator.editors.MultiPageEditor;
import org.eclipse.swt.SWT;
import org.eclipse.ui.forms.IManagedForm;
-
/**
* The Class CapabilityPage.
*/
@@ -36,7 +35,8 @@ public class CapabilityPage extends HeaderPageWithSash {
/**
* Instantiates a new capability page.
*
- * @param aEditor the a editor
+ * @param aEditor
+ * the a editor
*/
public CapabilityPage(MultiPageEditor aEditor) {
super(aEditor, "Capabilities");
@@ -45,7 +45,8 @@ public class CapabilityPage extends HeaderPageWithSash {
/**
* Called by the framework to fill in the contents.
*
- * @param managedForm the managed form
+ * @param managedForm
+ * the managed form
*/
@Override
protected void createFormContent(IManagedForm managedForm) {
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilitySection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilitySection.java
index 40ff2b7..ec32a94 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilitySection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/CapabilitySection.java
@@ -49,7 +49,6 @@ import org.eclipse.swt.widgets.TreeColumn;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.ui.forms.IManagedForm;
-
/**
* The Class CapabilitySection.
*/
@@ -160,19 +159,22 @@ public class CapabilitySection extends AbstractSection {
/**
* Instantiates a new capability section.
*
- * @param aEditor the a editor
- * @param parent the parent
+ * @param aEditor
+ * the a editor
+ * @param parent
+ * the parent
*/
public CapabilitySection(MultiPageEditor aEditor, Composite parent) {
- super(
- aEditor,
- parent,
- "Component Capabilities",
+ super(aEditor, parent, "Component Capabilities",
"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)
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.taeconfigurator.editors.ui.AbstractSection#initialize(org.eclipse.ui.forms.
+ * IManagedForm)
*/
@Override
public void initialize(IManagedForm form) {
@@ -183,7 +185,7 @@ public class CapabilitySection extends AbstractSection {
toolkit.paintBordersFor(sectionClient);
tt = newTree(sectionClient, SWT.V_SCROLL | SWT.SINGLE | SWT.FULL_SELECTION);
-// Table table = tt.getTable();
+ // Table table = tt.getTable();
// work around for bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=65865
new TreeColumn(tt, SWT.NONE).setText(" ");
@@ -197,9 +199,7 @@ public class CapabilitySection extends AbstractSection {
tt.addListener(SWT.MouseHover, this); // to show description
final Composite buttonContainer = newButtonContainer(sectionClient);
- addCapabilityButton = newPushButton(
- buttonContainer,
- "Add Capability Set",
+ addCapabilityButton = newPushButton(buttonContainer, "Add Capability Set",
"Analysis Engines can have one or more sets of capabilities; each one describes a set of outputs that are produced, given a particular set of inputs. Click here to add a capability set.");
addLangButton = newPushButton(buttonContainer, "Add Language",
"Click here to add a Language Capability to the selected set.");
@@ -233,7 +233,7 @@ public class CapabilitySection extends AbstractSection {
TreeItem item = new TreeItem(tt, SWT.NONE);
item.setText(TITLE_COL, CAPABILITY_SET);
item.setData(cs[i]);
- tt.setSelection( item ); // set default selection
+ tt.setSelection(item); // set default selection
fillCapability(item, cs[i]);
// if (0 == i) {
item.setExpanded(true);
@@ -254,7 +254,7 @@ public class CapabilitySection extends AbstractSection {
* value of hash table keyed on type name.
*/
private static class TypeCapability {
-
+
/** The is input type. */
boolean isInputType; // true if mentioned in <type>
@@ -269,7 +269,7 @@ public class CapabilitySection extends AbstractSection {
* The Class FeatureCapability.
*/
private static class FeatureCapability {
-
+
/** The is input feature. */
boolean isInputFeature = false;
@@ -283,7 +283,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Creates the language header gui.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the table tree item
*/
private TreeItem createLanguageHeaderGui(TreeItem parent) {
@@ -296,7 +297,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Creates the sofa header gui.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the table tree item
*/
private TreeItem createSofaHeaderGui(TreeItem parent) {
@@ -309,8 +311,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Fill capability.
*
- * @param parent the parent
- * @param c the c
+ * @param parent
+ * the parent
+ * @param c
+ * the c
*/
private void fillCapability(TreeItem parent, Capability c) {
// first output language capabilities
@@ -420,8 +424,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Sets the gui type name.
*
- * @param item the item
- * @param typeName the type name
+ * @param item
+ * the item
+ * @param typeName
+ * the type name
*/
private void setGuiTypeName(TreeItem item, String typeName) {
item.setText(TITLE_COL, TYPE_TITLE);
@@ -432,9 +438,12 @@ public class CapabilitySection extends AbstractSection {
/**
* Sets the gui sofa name.
*
- * @param item the item
- * @param sofaName the sofa name
- * @param isInput the is input
+ * @param item
+ * the item
+ * @param sofaName
+ * the sofa name
+ * @param isInput
+ * the is input
*/
private void setGuiSofaName(TreeItem item, String sofaName, boolean isInput) {
item.setData(SOFA_TITLE);
@@ -451,7 +460,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the type capability.
*
- * @param typeName the type name
+ * @param typeName
+ * the type name
* @return the type capability
*/
private TypeCapability getTypeCapability(String typeName) {
@@ -465,8 +475,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the feature capability.
*
- * @param tc the tc
- * @param featureShortName the feature short name
+ * @param tc
+ * the tc
+ * @param featureShortName
+ * the feature short name
* @return the feature capability
*/
private FeatureCapability getFeatureCapability(TypeCapability tc, String featureShortName) {
@@ -480,7 +492,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the type name from full feature name.
*
- * @param name the name
+ * @param name
+ * the name
* @return the type name from full feature name
*/
public String getTypeNameFromFullFeatureName(String name) {
@@ -490,7 +503,9 @@ public class CapabilitySection extends AbstractSection {
/*
* (non-Javadoc)
*
- * @see org.apache.uima.taeconfigurator.editors.ui.AbstractTableSection#handleEvent(org.eclipse.swt.widgets.Event)
+ * @see
+ * org.apache.uima.taeconfigurator.editors.ui.AbstractTableSection#handleEvent(org.eclipse.swt.
+ * widgets.Event)
*/
@Override
public void handleEvent(Event event) {
@@ -539,7 +554,7 @@ public class CapabilitySection extends AbstractSection {
createSofaHeaderGui(item);
item.setExpanded(true);
- tt.setSelection( item );
+ tt.setSelection(item);
if (tt.getItemCount() == 1)
tt.getColumn(TITLE_COL).pack();
finishAction();
@@ -548,9 +563,12 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the or create all feat item.
*
- * @param editItem the edit item
- * @param column the column
- * @param inOrOut the in or out
+ * @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(TreeItem editItem, int column, String inOrOut) {
@@ -566,7 +584,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the all feat item.
*
- * @param editItem the edit item
+ * @param editItem
+ * the edit item
* @return the all feat item
*/
private TreeItem getAllFeatItem(TreeItem editItem) {
@@ -582,8 +601,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Removes the all feat item gui.
*
- * @param editItem the edit item
- * @param column the column
+ * @param editItem
+ * the edit item
+ * @param column
+ * the column
*/
private void removeAllFeatItemGui(TreeItem editItem, int column) {
TreeItem allFeatItem = getAllFeatItem(editItem);
@@ -599,8 +620,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Handle edit.
*
- * @param editItem the edit item
- * @param itemKind the item kind
+ * @param editItem
+ * the edit item
+ * @param itemKind
+ * the item kind
*/
private void handleEdit(TreeItem editItem, int itemKind) {
Capability c = getCapability(editItem);
@@ -622,23 +645,21 @@ public class CapabilitySection extends AbstractSection {
// change name in all mappings
// if switch from input to output, delete from one array, add to other,
// mappings: no change (maybe the user switches the other items too).
- if (Window.CANCEL == Utility
- .popOkCancel(
- "Confirm Change to all Capability Sets",
- "This edit operation will change the Sofa in all Capability Sets in which it is defined. Please confirm.",
- MessageDialog.WARNING))
+ if (Window.CANCEL == Utility.popOkCancel("Confirm Change to all Capability Sets",
+ "This edit operation will change the Sofa in all Capability Sets in which it is defined. Please confirm.",
+ MessageDialog.WARNING))
return;
final Capability[] cSets = getCapabilities();
for (int i = 0; i < cSets.length; i++) {
boolean wasRemoved;
String[] prevSofas;
if (existingIsInput) {
- cSets[i].setInputSofas((String[]) Utility.removeElementsFromArray(prevSofas = cSets[i]
- .getInputSofas(), existingSofaName, String.class));
+ cSets[i].setInputSofas((String[]) Utility.removeElementsFromArray(
+ prevSofas = cSets[i].getInputSofas(), existingSofaName, String.class));
wasRemoved = prevSofas != cSets[i].getInputSofas();
} else {
- cSets[i].setOutputSofas((String[]) Utility.removeElementsFromArray(prevSofas = cSets[i]
- .getOutputSofas(), existingSofaName, String.class));
+ cSets[i].setOutputSofas((String[]) Utility.removeElementsFromArray(
+ prevSofas = cSets[i].getOutputSofas(), existingSofaName, String.class));
wasRemoved = prevSofas != cSets[i].getOutputSofas();
}
if (wasRemoved) {
@@ -685,7 +706,8 @@ public class CapabilitySection extends AbstractSection {
removeAllFeatItemGui(editItem, INPUT_COL);
}
- TypeOrFeature typeOutput = getTypeOrFeature(c.getOutputs(), getFullyQualifiedName(editItem));
+ TypeOrFeature typeOutput = getTypeOrFeature(c.getOutputs(),
+ getFullyQualifiedName(editItem));
if (dialog.outputs[0]) {
if (null == typeOutput) {
@@ -708,9 +730,7 @@ public class CapabilitySection extends AbstractSection {
break;
}
case LANG_ITEM: {
- CommonInputDialog dialog = new CommonInputDialog(
- this,
- "Edit Language",
+ CommonInputDialog dialog = new CommonInputDialog(this, "Edit Language",
"Enter a two letter ISO-639 language code, followed optionally by a two-letter ISO-3166 country code (Examples: fr or fr-CA)",
CommonInputDialog.LANGUAGE, editItem.getText(NAME_COL));
if (dialogForLanguage(c, dialog) == Window.CANCEL)
@@ -744,8 +764,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Any capability set declares sofa.
*
- * @param name the name
- * @param isInput the is input
+ * @param name
+ * the name
+ * @param isInput
+ * the is input
* @return true, if successful
*/
private boolean anyCapabilitySetDeclaresSofa(String name, boolean isInput) {
@@ -763,8 +785,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Handle remove.
*
- * @param removeItem the remove item
- * @param itemKind the item kind
+ * @param removeItem
+ * the remove item
+ * @param itemKind
+ * the item kind
*/
private void handleRemove(TreeItem removeItem, int itemKind) {
int selectionIndex = tt.indexOf(tt.getSelection()[0]);
@@ -782,17 +806,16 @@ public class CapabilitySection extends AbstractSection {
break;
}
case LANG_ITEM: {
- c.setLanguagesSupported(stringArrayRemove(c.getLanguagesSupported(), removeItem
- .getText(NAME_COL)));
+ c.setLanguagesSupported(
+ stringArrayRemove(c.getLanguagesSupported(), removeItem.getText(NAME_COL)));
removeItem.dispose();
break;
}
case SOFA_ITEM: {
- if (Window.CANCEL == Utility
- .popOkCancel(
- "Confirm Removal of Sofa",
- "This action will remove this Sofa as a capability, and delete its mappings if no other capability set declares this Sofa."
- + " Please confirm.", MessageDialog.WARNING)) {
+ if (Window.CANCEL == Utility.popOkCancel("Confirm Removal of Sofa",
+ "This action will remove this Sofa as a capability, and delete its mappings if no other capability set declares this Sofa."
+ + " Please confirm.",
+ MessageDialog.WARNING)) {
maybeSetSelection(tt, selectionIndex + 1);
return;
}
@@ -817,9 +840,8 @@ public class CapabilitySection extends AbstractSection {
return 1;
}
};
- editor.getAeDescription().setSofaMappings(
- (SofaMapping[]) Utility.removeElementsFromArray(getSofaMappings(), sofaName,
- SofaMapping.class, comparator));
+ editor.getAeDescription().setSofaMappings((SofaMapping[]) Utility.removeElementsFromArray(
+ getSofaMappings(), sofaName, SofaMapping.class, comparator));
sofaMapSection.markStale();
}
@@ -861,7 +883,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Removes the capability set.
*
- * @param c the c
+ * @param c
+ * the c
*/
private void removeCapabilitySet(Capability c) {
Capability[] cs = getAnalysisEngineMetaData().getCapabilities();
@@ -876,7 +899,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Checks if is input.
*
- * @param item the item
+ * @param item
+ * the item
* @return true, if is input
*/
private boolean isInput(TreeItem item) {
@@ -886,7 +910,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Checks if is output.
*
- * @param item the item
+ * @param item
+ * the item
* @return true, if is output
*/
private boolean isOutput(TreeItem item) {
@@ -896,8 +921,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Checks if is input.
*
- * @param fullFeatureName the full feature name
- * @param c the c
+ * @param fullFeatureName
+ * the full feature name
+ * @param c
+ * the c
* @return true, if is input
*/
public static boolean isInput(String fullFeatureName, Capability c) {
@@ -907,8 +934,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Checks if is output.
*
- * @param fullFeatureName the full feature name
- * @param c the c
+ * @param fullFeatureName
+ * the full feature name
+ * @param c
+ * the c
* @return true, if is output
*/
public static boolean isOutput(String fullFeatureName, Capability c) {
@@ -918,20 +947,22 @@ public class CapabilitySection extends AbstractSection {
/**
* Removes the feature.
*
- * @param c the c
- * @param removeItem the remove item
+ * @param c
+ * the c
+ * @param removeItem
+ * the remove item
*/
private void removeFeature(Capability c, TreeItem removeItem) {
String shortFeatureName = removeItem.getText(NAME_COL);
if (shortFeatureName.equals(ALL_FEATURES)) {
if (isInput(removeItem)) {
- TypeOrFeature tfItem = getTypeOrFeature(c.getInputs(), getFullyQualifiedName(removeItem
- .getParentItem()));
+ TypeOrFeature tfItem = getTypeOrFeature(c.getInputs(),
+ getFullyQualifiedName(removeItem.getParentItem()));
tfItem.setAllAnnotatorFeatures(false);
}
if (isOutput(removeItem) /* || isUpdate(removeItem) */) {
- TypeOrFeature tfItem = getTypeOrFeature(c.getOutputs(), getFullyQualifiedName(removeItem
- .getParentItem()));
+ TypeOrFeature tfItem = getTypeOrFeature(c.getOutputs(),
+ getFullyQualifiedName(removeItem.getParentItem()));
tfItem.setAllAnnotatorFeatures(false);
}
} else {
@@ -948,7 +979,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the capability from table tree item.
*
- * @param item the item
+ * @param item
+ * the item
* @return the capability from table tree item
*/
public Capability getCapabilityFromTreeItem(TreeItem item) {
@@ -958,8 +990,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Handle add lang.
*
- * @param selItem the sel item
- * @param itemKind the item kind
+ * @param selItem
+ * the sel item
+ * @param itemKind
+ * the item kind
*/
private void handleAddLang(TreeItem selItem, int itemKind) {
if (itemKind == CS)
@@ -971,9 +1005,7 @@ public class CapabilitySection extends AbstractSection {
else if (itemKind == FEAT || itemKind == SOFA_ITEM)
selItem = selItem.getParentItem().getParentItem().getItems()[0];
Capability c = getCapabilityFromTreeItem(selItem.getParentItem());
- CommonInputDialog dialog = new CommonInputDialog(
- this,
- "Add Language",
+ CommonInputDialog dialog = new CommonInputDialog(this, "Add Language",
"Enter a two letter ISO-639 language code, followed optionally by a two-letter ISO-3166 country code (Examples: fr or fr-CA)",
CommonInputDialog.LANGUAGE);
if (dialogForLanguage(c, dialog) == Window.CANCEL)
@@ -993,8 +1025,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Handle add type.
*
- * @param selItem the sel item
- * @param itemKind the item kind
+ * @param selItem
+ * the sel item
+ * @param itemKind
+ * the item kind
*/
private void handleAddType(TreeItem selItem, int itemKind) {
if (itemKind == LANG || itemKind == TYPE || itemKind == SOFA)
@@ -1035,8 +1069,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Handle add sofa.
*
- * @param selItem the sel item
- * @param itemKind the item kind
+ * @param selItem
+ * the sel item
+ * @param itemKind
+ * the item kind
*/
private void handleAddSofa(TreeItem selItem, int itemKind) {
if (itemKind == CS)
@@ -1069,8 +1105,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Handle add edit feature.
*
- * @param selItem the sel item
- * @param itemKind the item kind
+ * @param selItem
+ * the sel item
+ * @param itemKind
+ * the item kind
*/
private void handleAddEditFeature(TreeItem selItem, int itemKind) {
if (itemKind == FEAT)
@@ -1092,10 +1130,14 @@ public class CapabilitySection extends AbstractSection {
/**
* Adds the or edit feature.
*
- * @param dialog the dialog
- * @param typeName the type name
- * @param parentItem the parent item
- * @param c the c
+ * @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
@@ -1113,12 +1155,10 @@ public class CapabilitySection extends AbstractSection {
//
// For the "all features" case, we can't set an output state for all features on an input type.
if (dialog.allFeaturesOutput && (null == getTypeOrFeature(c.getOutputs(), typeName))) {
- Utility
- .popMessage(
- "Unable to set AllFeatures",
- "Skipping setting of <All Features> for output, because you must have the type specified itself"
- + " as an output in order to set the <All Features>. You can individually set all the features, instead.",
- MessageDialog.WARNING);
+ Utility.popMessage("Unable to set AllFeatures",
+ "Skipping setting of <All Features> for output, because you must have the type specified itself"
+ + " as an output in order to set the <All Features>. You can individually set all the features, instead.",
+ MessageDialog.WARNING);
dialog.allFeaturesOutput = false;
} else
c.setOutputs(setAllFeatures(c.getOutputs(), typeName, dialog.allFeaturesOutput));
@@ -1155,7 +1195,7 @@ public class CapabilitySection extends AbstractSection {
}
parentItem.setExpanded(true);
tt.getColumn(NAME_COL).pack();
- tt.setSelection( parentItem );
+ tt.setSelection(parentItem);
c.setInputs(replaceFeaturesKeepingTypes(c.getInputs(), typeName, inputsL));
c.setOutputs(replaceFeaturesKeepingTypes(c.getOutputs(), typeName, outputsL));
@@ -1166,7 +1206,8 @@ public class CapabilitySection extends AbstractSection {
/**
* New feature.
*
- * @param name the name
+ * @param name
+ * the name
* @return the type or feature
*/
private TypeOrFeature newFeature(String name) {
@@ -1179,7 +1220,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the fully qualified name.
*
- * @param item the item
+ * @param item
+ * the item
* @return the fully qualified name
*/
public String getFullyQualifiedName(TreeItem item) {
@@ -1191,8 +1233,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the fully qualified name.
*
- * @param namespace the namespace
- * @param name the name
+ * @param namespace
+ * the namespace
+ * @param name
+ * the name
* @return the fully qualified name
*/
// used by dialog table -has different columns
@@ -1205,10 +1249,12 @@ public class CapabilitySection extends AbstractSection {
* 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 the items
- * @param typeName the type name
- * @param features -
- * associated with the type
+ * @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,
@@ -1230,9 +1276,12 @@ public class CapabilitySection extends AbstractSection {
/**
* Sets the all features.
*
- * @param items Existing array of TypeOrFeature items (input or output)
- * @param typeName the type name
- * @param isAllFeatures AllFeatures value
+ * @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,
@@ -1272,7 +1321,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the item kind.
*
- * @param item the item
+ * @param item
+ * the item
* @return the item kind
*/
private int getItemKind(TreeItem item) {
@@ -1296,7 +1346,9 @@ public class CapabilitySection extends AbstractSection {
throw new InternalErrorCDE("invalid state");
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
*/
@Override
@@ -1318,8 +1370,10 @@ public class CapabilitySection extends AbstractSection {
/**
* Dialog for language.
*
- * @param c the c
- * @param dialog the dialog
+ * @param c
+ * the c
+ * @param dialog
+ * the dialog
* @return the int
*/
private int dialogForLanguage(Capability c, CommonInputDialog dialog) {
@@ -1331,11 +1385,10 @@ public class CapabilitySection extends AbstractSection {
boolean alreadySpecified = false;
for (int i = 0; i < languages.length; i++) {
if (languages[i].equals(dialog.getValue())) {
- Utility
- .popMessage(
- "Language spec already defined",
- "The language specification you entered is already specified.\nPlease enter a different specification, or Cancel this operation."
- + "\n\nLanguage: " + dialog.getValue(), MessageDialog.ERROR);
+ Utility.popMessage("Language spec already defined",
+ "The language specification you entered is already specified.\nPlease enter a different specification, or Cancel this operation."
+ + "\n\nLanguage: " + dialog.getValue(),
+ MessageDialog.ERROR);
alreadySpecified = true;
break;
}
@@ -1349,7 +1402,8 @@ public class CapabilitySection extends AbstractSection {
/**
* Gets the capability.
*
- * @param item the item
+ * @param item
+ * the item
* @return the capability
*/
private Capability getCapability(TreeItem item) {
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ExtnlResBindSection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ExtnlResBindSection.java
index 9b86639..3c669bb 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ExtnlResBindSection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ExtnlResBindSection.java
@@ -43,12 +43,11 @@ import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.ui.forms.IManagedForm;
-
/**
* The Class ExtnlResBindSection.
*/
public class ExtnlResBindSection extends AbstractSection {
-
+
/** The Constant boundHeader. */
private final static String boundHeader = "Bound to: ";
@@ -82,19 +81,22 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Instantiates a new extnl res bind section.
*
- * @param aEditor the a editor
- * @param parent the parent
+ * @param aEditor
+ * the a editor
+ * @param parent
+ * the parent
*/
public ExtnlResBindSection(MultiPageEditor aEditor, Composite parent) {
- super(
- aEditor,
- parent,
- "Resources Needs, Definitions and Bindings",
+ super(aEditor, parent, "Resources Needs, Definitions and Bindings",
"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)
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.taeconfigurator.editors.ui.AbstractSection#initialize(org.eclipse.ui.forms.
+ * IManagedForm)
*/
@Override
public void initialize(IManagedForm form) {
@@ -128,7 +130,9 @@ public class ExtnlResBindSection extends AbstractSection {
tree.addListener(SWT.MouseDoubleClick, this);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.ui.forms.AbstractFormPart#refresh()
*/
@Override
@@ -151,8 +155,10 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Adds the external resource description to GUI.
*
- * @param xrd the xrd
- * @param bindings the bindings
+ * @param xrd
+ * the xrd
+ * @param bindings
+ * the bindings
*/
private void addExternalResourceDescriptionToGUI(ExternalResourceDescription xrd,
ExternalResourceBinding[] bindings) {
@@ -165,8 +171,10 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Fill xrd item.
*
- * @param item the item
- * @param xrd the xrd
+ * @param item
+ * the item
+ * @param xrd
+ * the xrd
*/
private void fillXrdItem(TreeItem item, ExternalResourceDescription xrd) {
StringBuffer text = new StringBuffer();
@@ -193,9 +201,12 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Fill bindings.
*
- * @param parent the parent
- * @param xrd the xrd
- * @param bindings the bindings
+ * @param parent
+ * the parent
+ * @param xrd
+ * the xrd
+ * @param bindings
+ * the bindings
*/
private void fillBindings(TreeItem parent, ExternalResourceDescription xrd,
ExternalResourceBinding[] bindings) {
@@ -211,9 +222,12 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Adds the binding to GUI.
*
- * @param parent the parent
- * @param key the key
- * @param xrb the xrb
+ * @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);
@@ -252,7 +266,8 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Gets the XR description from tree item.
*
- * @param item the item
+ * @param item
+ * the item
* @return the XR description from tree item
*/
public ExternalResourceDescription getXRDescriptionFromTreeItem(TreeItem item) {
@@ -272,9 +287,9 @@ public class ExtnlResBindSection extends AbstractSection {
ExternalResourceDescription xrd = getXRDescriptionFromTreeItem(item);
ResourceSpecifier rs = xrd.getResourceSpecifier();
if (!((rs instanceof FileResourceSpecifier) || (rs instanceof FileLanguageResourceSpecifier))) {
- Utility.popMessage("Can''t edit custom resource", "This resource is a '"
- + rs.getClass().getName()
- + "', and any edits have to be done directly in the XML in the Source view.",
+ Utility.popMessage("Can''t edit custom resource",
+ "This resource is a '" + rs.getClass().getName()
+ + "', and any edits have to be done directly in the XML in the Source view.",
MessageDialog.INFORMATION);
return;
}
@@ -303,18 +318,20 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Alter existing XRD.
*
- * @param dialog the dialog
- * @param xrd the xrd
- * @param item the item
+ * @param dialog
+ * the dialog
+ * @param xrd
+ * the xrd
+ * @param item
+ * the item
*/
private void alterExistingXRD(AddExternalResourceDialog dialog, ExternalResourceDescription xrd,
TreeItem item) {
valueChanged = false;
xrd.setName(setValueChanged(dialog.xrName, xrd.getName()));
xrd.setDescription(setValueChanged(dialog.xrDescription, xrd.getDescription()));
- xrd
- .setImplementationName(setValueChanged(dialog.xrImplementation, xrd
- .getImplementationName()));
+ xrd.setImplementationName(
+ setValueChanged(dialog.xrImplementation, xrd.getImplementationName()));
ResourceSpecifier rs = xrd.getResourceSpecifier();
if (null == dialog.xrUrlSuffix || "".equals(dialog.xrUrlSuffix)) {
@@ -377,10 +394,9 @@ public class ExtnlResBindSection extends AbstractSection {
return;
TreeItem item = tree.getSelection()[0];
if (null == item.getParentItem()) { // case of removing a resource
- if (Window.CANCEL == Utility
- .popOkCancel("Removing Resource",
- "Removing an External Resource and all its bindings. Resource name:"
- + item.getText(), MessageDialog.WARNING))
+ if (Window.CANCEL == Utility.popOkCancel("Removing Resource",
+ "Removing an External Resource and all its bindings. Resource name:" + item.getText(),
+ MessageDialog.WARNING))
return;
removeAllBindings(item);
removeResource(item);
@@ -392,7 +408,8 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Gets the XR binding from tree item.
*
- * @param item the item
+ * @param item
+ * the item
* @return the XR binding from tree item
*/
public ExternalResourceBinding getXRBindingFromTreeItem(TreeItem item) {
@@ -402,7 +419,8 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Removes the binding.
*
- * @param item the item
+ * @param item
+ * the item
*/
private void removeBinding(TreeItem item) {
ExternalResourceBinding xrb = getXRBindingFromTreeItem(item);
@@ -415,7 +433,8 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Removes the bound flag in dependency section.
*
- * @param xrb the xrb
+ * @param xrb
+ * the xrb
*/
private void removeBoundFlagInDependencySection(ExternalResourceBinding xrb) {
String key = xrb.getKey();
@@ -429,7 +448,8 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Removes the all bindings.
*
- * @param item the item
+ * @param item
+ * the item
*/
private void removeAllBindings(TreeItem item) {
TreeItem[] items = item.getItems();
@@ -441,7 +461,8 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Removes the resource.
*
- * @param item the item
+ * @param item
+ * the item
*/
private void removeResource(TreeItem item) {
ExternalResourceDescription xrd = getXRDescriptionFromTreeItem(item);
@@ -450,7 +471,9 @@ public class ExtnlResBindSection extends AbstractSection {
setFileDirty();
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
*/
@Override
@@ -469,7 +492,8 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Checks if is bound spec.
*
- * @param item the item
+ * @param item
+ * the item
* @return true, if is bound spec
*/
private boolean isBoundSpec(TreeItem item) {
@@ -479,7 +503,8 @@ public class ExtnlResBindSection extends AbstractSection {
/**
* Resource name already defined.
*
- * @param name the name
+ * @param name
+ * the name
* @return true, if successful
*/
public boolean resourceNameAlreadyDefined(String name) {
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FileAndShortName.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FileAndShortName.java
index fabafb7..153198f 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FileAndShortName.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FileAndShortName.java
@@ -22,12 +22,11 @@ package org.apache.uima.taeconfigurator.editors.ui;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.IPath;
-
/**
* The Class FileAndShortName.
*/
public class FileAndShortName {
-
+
/** The file name. */
public String fileName;
@@ -37,7 +36,8 @@ public class FileAndShortName {
/**
* Instantiates a new file and short name.
*
- * @param o the o
+ * @param o
+ * the o
*/
public FileAndShortName(Object o) {
@@ -46,10 +46,10 @@ public class FileAndShortName {
fileName = file.getLocation().toString();
shortName = file.getName();
} else if (o instanceof String) {
- fileName = (String)o;
- int lastSlash = fileName.lastIndexOf('/');
- shortName = (lastSlash >= 0) ? fileName.substring(lastSlash + 1) : fileName;
- } else {
+ fileName = (String) o;
+ int lastSlash = fileName.lastIndexOf('/');
+ shortName = (lastSlash >= 0) ? fileName.substring(lastSlash + 1) : fileName;
+ } else {
IPath path = (IPath) o;
fileName = path.toString();
shortName = path.toFile().getName();
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FlowSection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FlowSection.java
index d64bd99..77967a7 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FlowSection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/FlowSection.java
@@ -53,7 +53,6 @@ import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.ui.forms.IManagedForm;
-
/**
* The Class FlowSection.
*/
@@ -108,8 +107,10 @@ public class FlowSection extends AbstractSection {
/**
* creates a section only for aggregate specifiers to define the flow of their delegates.
*
- * @param aEditor the referenced multipage editor
- * @param parent the parent
+ * @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$
@@ -136,9 +137,9 @@ public class FlowSection extends AbstractSection {
((GridData) sectionClient.getLayoutData()).grabExcessHorizontalSpace = false;
flowChoiceLabel = newLabelWithTip(sectionClient, Messages.getString("FlowSection.FlowKind"), //$NON-NLS-1$
- Messages.getString("FlowSection.FlowKindTip")); //$NON-NLS-1$
- flowControllerChoice = newCComboWithTip(sectionClient, Messages
- .getString("FlowSection.FlowKindTip")); //$NON-NLS-1$
+ Messages.getString("FlowSection.FlowKindTip")); //$NON-NLS-1$
+ flowControllerChoice = newCComboWithTip(sectionClient,
+ Messages.getString("FlowSection.FlowKindTip")); //$NON-NLS-1$
flowControllerChoice.add(FIXED_FLOW);
flowControllerChoice.add(CAPABILITY_LANGUAGE_FLOW);
@@ -184,10 +185,10 @@ public class FlowSection extends AbstractSection {
// Buttons
final Composite buttonContainer = newButtonContainer(flowComposite, VERTICAL_BUTTONS, 70);
- upButton = newPushButton(buttonContainer, S_UP,
- Messages.getString("FlowSection.upTip"), !ENABLED); //$NON-NLS-1$
- downButton = newPushButton(buttonContainer, S_DOWN,
- Messages.getString("FlowSection.downTip"), !ENABLED); //$NON-NLS-1$
+ upButton = newPushButton(buttonContainer, S_UP, Messages.getString("FlowSection.upTip"), //$NON-NLS-1$
+ !ENABLED);
+ downButton = newPushButton(buttonContainer, S_DOWN, Messages.getString("FlowSection.downTip"), //$NON-NLS-1$
+ !ENABLED);
enableBorders(sectionClient);
toolkit.paintBordersFor(sectionClient);
}
@@ -216,12 +217,11 @@ public class FlowSection extends AbstractSection {
String[] nodes = nodesModel.getFlow();
if (null == nodes) {
nodesModel.setFlow(nodes = stringArray0);
- }
+ }
// 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)
- );
+ item.setImage(TAEConfiguratorPlugin.getImage(TAEConfiguratorPlugin.IMAGE_ANNOTATOR));
item.setText(0, nodes[i]);
}
packTable(flowList);
@@ -231,15 +231,16 @@ public class FlowSection extends AbstractSection {
FixedFlow ff;
if (null == flowConstraints) {
// force fixed flow if nothing is specified
- getAnalysisEngineMetaData().setFlowConstraints(
- flowConstraints = ff = new FixedFlow_impl());
+ getAnalysisEngineMetaData()
+ .setFlowConstraints(flowConstraints = ff = new FixedFlow_impl());
ff.setFixedFlow(stringArray0);
}
String modelFlowType = flowConstraints.getFlowConstraintsType();
- flowControllerChoice.setText(modelFlowType
- .equals(CapabilityLanguageFlow.FLOW_CONSTRAINTS_TYPE) ? CAPABILITY_LANGUAGE_FLOW
- : FIXED_FLOW);
+ flowControllerChoice
+ .setText(modelFlowType.equals(CapabilityLanguageFlow.FLOW_CONSTRAINTS_TYPE)
+ ? CAPABILITY_LANGUAGE_FLOW
+ : FIXED_FLOW);
enableFlowControllerGUI(false);
} else {
@@ -253,19 +254,18 @@ public class FlowSection extends AbstractSection {
/**
* Refresh fcd.
*
- * @param fcd the fcd
+ * @param fcd
+ * the fcd
*/
private void refreshFcd(FlowControllerDeclaration fcd) {
enableFlowControllerGUI(true);
String keyName;
if (null == fcd.getKey() || "".equals(fcd.getKey())) {
keyName = "Warning: no key name is specified";
- flowControllerKeyGUI.setToolTipText(
- "Use Source tab below to specify a key name " +
- "in the <flowController> element, or the imported <flowController>");
- }
- else {
- keyName = fcd.getKey();
+ flowControllerKeyGUI.setToolTipText("Use Source tab below to specify a key name "
+ + "in the <flowController> element, or the imported <flowController>");
+ } else {
+ keyName = fcd.getKey();
}
flowControllerKeyGUI.setText(keyName);
Import fcdImport = fcd.getImport();
@@ -274,10 +274,10 @@ public class FlowSection extends AbstractSection {
fileName = fcdImport.getLocation();
if (null == fileName || (0 == fileName.length())) {
fileName = fcdImport.getName();
+ }
}
- }
- flowControllerGUI.setText(null == fileName ?
- "Warning: no <import> in <flowController>" : fileName);
+ flowControllerGUI
+ .setText(null == fileName ? "Warning: no <import> in <flowController>" : fileName);
flowControllerChoice.setText(USER_DEFINED_FLOW);
// must follow label updates
// because this method also does the redraw
@@ -288,7 +288,8 @@ public class FlowSection extends AbstractSection {
/**
* Enable flow controller GUI.
*
- * @param enableState the enable state
+ * @param enableState
+ * the enable state
*/
private void enableFlowControllerGUI(boolean enableState) {
flowControllerLabel.setEnabled(enableState);
@@ -324,32 +325,29 @@ public class FlowSection extends AbstractSection {
String flowTypeGUI = flowControllerChoice.getText();
if (null == flowTypeGUI || flowTypeGUI.equals(S_)) {
return;
- }
+ }
String prevFlowTypeGUI;
FlowControllerDeclaration fcd = getFlowControllerDeclaration();
FlowConstraints modelFlow = getModelFlow();
if (null != fcd) {
prevFlowTypeGUI = USER_DEFINED_FLOW;
- }
- else {
+ } else {
if (null == modelFlow) {
- prevFlowTypeGUI = "";
- }
- else {
+ prevFlowTypeGUI = "";
+ } else {
String prevFlowType = modelFlow.getFlowConstraintsType();
if (CapabilityLanguageFlow.FLOW_CONSTRAINTS_TYPE.equals(prevFlowType)) {
prevFlowTypeGUI = CAPABILITY_LANGUAGE_FLOW;
- }
- else {
+ } else {
prevFlowTypeGUI = FIXED_FLOW;
- }
+ }
}
}
if (prevFlowTypeGUI.equals(flowTypeGUI)) {
return;
- }
+ }
CapabilityLanguageFlow clf = null;
FixedFlow ff = null;
@@ -382,10 +380,9 @@ public class FlowSection extends AbstractSection {
String[] nodes = new FlowNodes(getModelFlow()).getFlow();
// update both model and gui: swap nodes
int selection = flowList.getSelectionIndex();
- if (selection == 0)
- {
+ if (selection == 0) {
return; // can't move up 0
- }
+ }
String temp = nodes[selection - 1];
nodes[selection - 1] = nodes[selection];
nodes[selection] = temp;
@@ -396,10 +393,9 @@ public class FlowSection extends AbstractSection {
String[] nodes = new FlowNodes(getModelFlow()).getFlow();
// update both model and gui: swap nodes
int selection = flowList.getSelectionIndex();
- if (selection == flowList.getItemCount() - 1)
- {
+ if (selection == flowList.getItemCount() - 1) {
return; // can't move down at end of list
- }
+ }
String temp = nodes[selection + 1];
nodes[selection + 1] = nodes[selection];
nodes[selection] = temp;
@@ -435,7 +431,8 @@ public class FlowSection extends AbstractSection {
/**
* Handle hover help.
*
- * @param event the event
+ * @param event
+ * the event
*/
private void handleHoverHelp(Event event) {
String sDesc = "";
@@ -450,7 +447,8 @@ public class FlowSection extends AbstractSection {
/**
* Handle context menu request.
*
- * @param event the event
+ * @param event
+ * the event
*/
private void handleContextMenuRequest(Event event) {
Import imp = getFlowControllerDeclaration().getImport();
@@ -496,14 +494,15 @@ public class FlowSection extends AbstractSection {
/**
* Adds a node to the flowList.
*
- * @param node the key of the delegate
+ * @param node
+ * the key of the delegate
*/
public void addNode(String node) {
FlowConstraints flowConstraints = getModelFlow();
if (null == flowConstraints) {
// no constraints declared
// set up Fix Flow style of constraints
- // This can happen if the style is user-defined flow
+ // This can happen if the style is user-defined flow
flowConstraints = UIMAFramework.getResourceSpecifierFactory().createFixedFlow();
getAnalysisEngineMetaData().setFlowConstraints(flowConstraints);
}
@@ -563,13 +562,14 @@ public class FlowSection extends AbstractSection {
/**
* Proofs if a node is contained in the list of nodes.
*
- * @param node the node
+ * @param node
+ * the node
* @return whether the node is in the list or not
*/
public boolean containsNode(String node) {
String[] nodes = new FlowNodes(getModelFlow()).getFlow();
if (null == nodes) {
- return false;
+ return false;
}
for (int i = 0; i < nodes.length; i++) {
@@ -620,7 +620,8 @@ public class FlowSection extends AbstractSection {
}
/** The Constant flowControllerHeadersLC. */
- private static final String[] flowControllerHeadersLC = new String[] { "<flowcontrollerdescription" }; // don't
+ private static final String[] flowControllerHeadersLC = new String[] {
+ "<flowcontrollerdescription" }; // don't
// end
// in a
@@ -639,7 +640,7 @@ public class FlowSection extends AbstractSection {
"Specify a name pattern and/or other constraints, and then push the Search button",
flowControllerHeadersLC);
if (Window.CANCEL == dialog1.open()) {
- return;
+ return;
}
List matchingDelegateComponentDescriptors = dialog1.getMatchingDelegateComponentDescriptors();
@@ -654,7 +655,7 @@ public class FlowSection extends AbstractSection {
PickTaeForTypesDialog dialog2 = new PickTaeForTypesDialog(this, editor.getFile().getName(),
matchingDelegateComponentDescriptors, matchingDelegateComponentDescriptions);
if (Window.CANCEL == dialog2.open()) {
- return;
+ return;
}
String[] selectedDelegateComponentDescriptors = dialog2
@@ -673,17 +674,20 @@ public class FlowSection extends AbstractSection {
} else {
shortName = fileName.substring(nLastSlashLoc + 1);
}
- produceKeyAddFlowController(shortName,
- editor.getFullPathFromDescriptorRelativePath(fileName), dialog2.isImportByName);
+ produceKeyAddFlowController(shortName, editor.getFullPathFromDescriptorRelativePath(fileName),
+ dialog2.isImportByName);
}
}
/**
* Produce key add flow controller.
*
- * @param shortName the short name
- * @param fullPathFileName the full path file name
- * @param isImportByName the is import by name
+ * @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) {
@@ -736,11 +740,11 @@ public class FlowSection extends AbstractSection {
*/
private void handleSpecifyFlowController() {
MultiResourceSelectionDialog dialog = new MultiResourceSelectionDialog(getSection().getShell(),
- editor.getFile().getProject().getParent(), "Flow Controller Selection", editor
- .getFile().getLocation(), editor);
+ editor.getFile().getProject().getParent(), "Flow Controller Selection",
+ editor.getFile().getLocation(), editor);
dialog.setTitle("Flow Controller Selection");
dialog.setMessage("Select a Flow Controller descriptor from the workspace:");
- if (Window.CANCEL == dialog.open()) {
+ if (Window.CANCEL == dialog.open()) {
return;
}
Object[] files = dialog.getResult();
@@ -754,7 +758,8 @@ public class FlowSection extends AbstractSection {
/**
* Check for one selection.
*
- * @param numberSelected the number selected
+ * @param numberSelected
+ * the number selected
* @return true, if successful
*/
private boolean checkForOneSelection(int numberSelected) {
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/GeneralSection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/GeneralSection.java
index 7302f69..3aab457 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/GeneralSection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/GeneralSection.java
@@ -40,13 +40,14 @@ import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Event;
import org.eclipse.ui.forms.IManagedForm;
-
/**
* The Class GeneralSection.
*/
public class GeneralSection extends AbstractSection {
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
*/
@Override
@@ -68,8 +69,10 @@ public class GeneralSection extends AbstractSection {
/**
* 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
+ * @param aEditor
+ * the referenced multipage editor
+ * @param parent
+ * the parent
*/
public GeneralSection(MultiPageEditor aEditor, Composite parent) {
super(aEditor, parent, "Implementation Details", null);
@@ -88,16 +91,16 @@ public class GeneralSection extends AbstractSection {
((GridData) sectionClient.getLayoutData()).grabExcessVerticalSpace = false;
// FrameworkImplementation choose, 2 radio buttons
if (isAeDescriptor() || isCasConsumerDescriptor()) {
- toolkit.createLabel(sectionClient, "Implementation Language").setToolTipText(
- "Choose the implementation language here.");
+ toolkit.createLabel(sectionClient, "Implementation Language")
+ .setToolTipText("Choose the implementation language here.");
Composite buttons = new2ColumnComposite(sectionClient);
cppButton = newRadioButton(buttons, "C/C++", "C/C++", NOT_SELECTED);
javaButton = newRadioButton(buttons, "Java", "Java", SELECTED);
// DescriptorType choose, 2 radio buttons
- toolkit.createLabel(sectionClient, "Engine Type").setToolTipText(
- "Choose the type of the engine here.");
+ toolkit.createLabel(sectionClient, "Engine Type")
+ .setToolTipText("Choose the type of the engine here.");
buttons = new2ColumnComposite(sectionClient);
@@ -169,7 +172,8 @@ public class GeneralSection extends AbstractSection {
if (Window.CANCEL == Utility.popOkCancel("Switching from Primitive AE",
"This action will clear the capabilities, reset the delegates, "
+ "reset the parameters, reset any resource information "
- + "and reset the type system. Are you sure?", MessageDialog.WARNING)) {
+ + "and reset the type system. Are you sure?",
+ MessageDialog.WARNING)) {
primitiveButton.setSelection(true);
aggregateButton.setSelection(false);
return;
@@ -210,13 +214,13 @@ public class GeneralSection extends AbstractSection {
if (event.widget == javaButton || event.widget == cppButton) {
valueChanged = false;
if (cppButton.getSelection()) {
- editor.getAeDescription().setFrameworkImplementation(
- setValueChanged(Constants.CPP_FRAMEWORK_NAME, editor.getAeDescription()
- .getFrameworkImplementation()));
+ editor.getAeDescription()
+ .setFrameworkImplementation(setValueChanged(Constants.CPP_FRAMEWORK_NAME,
+ editor.getAeDescription().getFrameworkImplementation()));
} else {
- editor.getAeDescription().setFrameworkImplementation(
- setValueChanged(Constants.JAVA_FRAMEWORK_NAME, editor.getAeDescription()
- .getFrameworkImplementation()));
+ editor.getAeDescription()
+ .setFrameworkImplementation(setValueChanged(Constants.JAVA_FRAMEWORK_NAME,
+ editor.getAeDescription().getFrameworkImplementation()));
}
if (!valueChanged)
return;
@@ -250,11 +254,11 @@ public class GeneralSection extends AbstractSection {
addCapabilitySet();
// reset parameters
// reset the parameters not declared in a group
- getConfigurationParameterDeclarations().setConfigurationParameters(
- new ConfigurationParameter[0]);
+ getConfigurationParameterDeclarations()
+ .setConfigurationParameters(new ConfigurationParameter[0]);
// reset groups
- getConfigurationParameterDeclarations().setConfigurationGroups(
- AbstractSection.configurationGroupArray0);
+ getConfigurationParameterDeclarations()
+ .setConfigurationGroups(AbstractSection.configurationGroupArray0);
// reset common parameters
getConfigurationParameterDeclarations().setCommonParameters(new ConfigurationParameter[0]);
// reset default group name
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/HeaderPage.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/HeaderPage.java
index 2939913..b402387 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/HeaderPage.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/HeaderPage.java
@@ -40,7 +40,6 @@ import org.eclipse.ui.forms.editor.FormPage;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.ScrolledForm;
-
/**
* Common part of most pages.
*/
@@ -82,9 +81,12 @@ public abstract class HeaderPage extends FormPage {
/**
* Instantiates a new header page.
*
- * @param formEditor the form editor
- * @param id the id
- * @param keyPageTitle the key page title
+ * @param formEditor
+ * the form editor
+ * @param id
+ * the id
+ * @param keyPageTitle
+ * the key page title
*/
public HeaderPage(MultiPageEditor formEditor, String id, String keyPageTitle) {
super(formEditor, id, keyPageTitle);
@@ -95,8 +97,10 @@ public abstract class HeaderPage extends FormPage {
/**
* Instantiates a new header page.
*
- * @param formEditor the form editor
- * @param pageTitle the page title
+ * @param formEditor
+ * the form editor
+ * @param pageTitle
+ * the page title
*/
public HeaderPage(MultiPageEditor formEditor, String pageTitle) {
this(formEditor, "UID_" + pageTitle, pageTitle);
@@ -105,11 +109,12 @@ public abstract class HeaderPage extends FormPage {
/**
* Maybe initialize.
*
- * @param managedForm the managed form
+ * @param managedForm
+ * the managed form
*/
protected void maybeInitialize(IManagedForm managedForm) {
-// if (TAEConfiguratorPlugin.is30version)
-// ((ManagedForm) managedForm).initialize();
+ // if (TAEConfiguratorPlugin.is30version)
+ // ((ManagedForm) managedForm).initialize();
}
/*
@@ -119,7 +124,8 @@ public abstract class HeaderPage extends FormPage {
/**
* New composite.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
public Composite newComposite(Composite parent) {
@@ -129,7 +135,8 @@ public abstract class HeaderPage extends FormPage {
/**
* New centered 2 span composite.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
// this composite spans col 1 & 2, out of a 4 column (0, 1, 2, 3) grid layout
@@ -143,8 +150,10 @@ public abstract class HeaderPage extends FormPage {
/**
* Newn column section.
*
- * @param parent the parent
- * @param cols the cols
+ * @param parent
+ * the parent
+ * @param cols
+ * the cols
* @return the composite
*/
public Composite newnColumnSection(Composite parent, int cols) {
@@ -161,7 +170,8 @@ public abstract class HeaderPage extends FormPage {
/**
* Setup 1 column layout.
*
- * @param managedForm the managed form
+ * @param managedForm
+ * the managed form
* @return the composite
*/
public Composite setup1ColumnLayout(IManagedForm managedForm) {
@@ -174,7 +184,7 @@ public abstract class HeaderPage extends FormPage {
Control c = form.getParent();
while (!(c instanceof ScrolledComposite)) {
- c = c.getParent();
+ c = c.getParent();
}
((GridData) xtra.getLayoutData()).widthHint = c.getSize().x;
return xtra;
@@ -183,8 +193,10 @@ public abstract class HeaderPage extends FormPage {
/**
* Setup 2 column grid.
*
- * @param managedForm the managed form
- * @param equalWidth the equal width
+ * @param managedForm
+ * the managed form
+ * @param equalWidth
+ * the equal width
* @return the composite
*/
// this method creates no new composites.
@@ -200,9 +212,12 @@ public abstract class HeaderPage extends FormPage {
/**
* Setup 2 column layout.
*
- * @param managedForm the managed form
- * @param w1 the w 1
- * @param w2 the w 2
+ * @param managedForm
+ * the managed form
+ * @param w1
+ * the w 1
+ * @param w2
+ * the w 2
* @return the form 2 panel
*/
public Form2Panel setup2ColumnLayout(IManagedForm managedForm, int w1, int w2) {
@@ -214,7 +229,7 @@ public abstract class HeaderPage extends FormPage {
xtra.setLayoutData(new GridData(GridData.FILL_BOTH));
Control c = xtra.getParent();
while (!(c instanceof ScrolledComposite)) {
- c = c.getParent();
+ c = c.getParent();
}
((GridData) xtra.getLayoutData()).widthHint = c.getSize().x;
((GridData) xtra.getLayoutData()).heightHint = c.getSize().y;
@@ -258,25 +273,28 @@ public abstract class HeaderPage extends FormPage {
/**
* Sash impl.
*
- * @param managedForm the managed form
- * @param equalWidth the equal width
+ * @param managedForm
+ * the managed form
+ * @param equalWidth
+ * the equal width
* @return the form 2 panel
*/
public Form2Panel setup2ColumnLayout(IManagedForm managedForm, boolean equalWidth) {
if (equalWidth) {
- return setup2ColumnLayout(managedForm, 50, 50);
- }
- else {
- // a hack - based on first column more likely being wider
- return setup2ColumnLayout(managedForm, 60, 40);
+ return setup2ColumnLayout(managedForm, 50, 50);
+ } else {
+ // a hack - based on first column more likely being wider
+ return setup2ColumnLayout(managedForm, 60, 40);
}
}
/**
* Setup 2 column layout not sash.
*
- * @param managedForm the managed form
- * @param equalWidth the equal width
+ * @param managedForm
+ * the managed form
+ * @param equalWidth
+ * the equal width
* @return the form 2 panel
*/
public Form2Panel setup2ColumnLayoutNotSash(IManagedForm managedForm, boolean equalWidth) {
@@ -304,7 +322,8 @@ public abstract class HeaderPage extends FormPage {
float col1CurrentWidth = leftPanel.getSize().x;
float col2CurrentWidth = rightPanel.getSize().x;
final int minLeftPanelWidth = 250; // in pels
- final int minRightPanelWidth = (int) (col2CurrentWidth * minLeftPanelWidth / col1CurrentWidth);
+ final int minRightPanelWidth = (int) (col2CurrentWidth * minLeftPanelWidth
+ / col1CurrentWidth);
((GridData) leftPanel.getLayoutData()).widthHint = minLeftPanelWidth;
((GridData) rightPanel.getLayoutData()).widthHint = minRightPanelWidth;
sform.removeListener(SWT.Resize, this); // only do this one time
@@ -316,8 +335,10 @@ public abstract class HeaderPage extends FormPage {
/**
* Setup 2 column layout on 4 grid.
*
- * @param managedForm the managed form
- * @param equalWidth the equal width
+ * @param managedForm
+ * the managed form
+ * @param equalWidth
+ * the equal width
* @return the form 2 panel
*/
public Form2Panel setup2ColumnLayoutOn4Grid(IManagedForm managedForm, boolean equalWidth) {
@@ -331,7 +352,8 @@ public abstract class HeaderPage extends FormPage {
/**
* Spacer.
*
- * @param container the container
+ * @param container
+ * the container
*/
protected void spacer(Composite container) {
toolkit.createLabel(container, " ");
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/HeaderPageWithSash.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/HeaderPageWithSash.java
index 4e8c23c..a6d08ea 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/HeaderPageWithSash.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/HeaderPageWithSash.java
@@ -40,9 +40,12 @@ public class HeaderPageWithSash extends HeaderPage {
/**
* Instantiates a new header page with sash.
*
- * @param formEditor the form editor
- * @param id the id
- * @param keyPageTitle the key page title
+ * @param formEditor
+ * the form editor
+ * @param id
+ * the id
+ * @param keyPageTitle
+ * the key page title
*/
public HeaderPageWithSash(MultiPageEditor formEditor, String id, String keyPageTitle) {
super(formEditor, id, keyPageTitle);
@@ -51,8 +54,10 @@ public class HeaderPageWithSash extends HeaderPage {
/**
* Instantiates a new header page with sash.
*
- * @param formEditor the form editor
- * @param pageTitle the page title
+ * @param formEditor
+ * the form editor
+ * @param pageTitle
+ * the page title
*/
public HeaderPageWithSash(MultiPageEditor formEditor, String pageTitle) {
super(formEditor, pageTitle);
@@ -61,7 +66,8 @@ public class HeaderPageWithSash extends HeaderPage {
/**
* Creates the tool bar actions.
*
- * @param managedForm the managed form
+ * @param managedForm
+ * the managed form
*/
protected void createToolBarActions(IManagedForm managedForm) {
final ScrolledForm form = managedForm.getForm();
@@ -76,10 +82,10 @@ public class HeaderPageWithSash extends HeaderPage {
haction.setChecked(true);
haction.setToolTipText("Horizontal Orientation");
TAEConfiguratorPlugin instance = TAEConfiguratorPlugin.getDefault();
- haction.setImageDescriptor(instance
- .getImageDescriptor(TAEConfiguratorPlugin.IMAGE_TH_HORIZONTAL));
- haction.setDisabledImageDescriptor(instance
- .getImageDescriptor(TAEConfiguratorPlugin.IMAGE_TH_HORIZONTAL));
+ haction.setImageDescriptor(
+ instance.getImageDescriptor(TAEConfiguratorPlugin.IMAGE_TH_HORIZONTAL));
+ haction.setDisabledImageDescriptor(
+ instance.getImageDescriptor(TAEConfiguratorPlugin.IMAGE_TH_HORIZONTAL));
vaction = new Action("ver", IAction.AS_RADIO_BUTTON) { //$NON-NLS-1$
@Override
@@ -90,10 +96,10 @@ public class HeaderPageWithSash extends HeaderPage {
};
vaction.setChecked(false);
vaction.setToolTipText("Vertical Orientation");
- vaction.setImageDescriptor(instance
- .getImageDescriptor(TAEConfiguratorPlugin.IMAGE_TH_VERTICAL));
- vaction.setDisabledImageDescriptor(instance
- .getImageDescriptor(TAEConfiguratorPlugin.IMAGE_TH_VERTICAL));
+ vaction.setImageDescriptor(
+ instance.getImageDescriptor(TAEConfiguratorPlugin.IMAGE_TH_VERTICAL));
+ vaction.setDisabledImageDescriptor(
+ instance.getImageDescriptor(TAEConfiguratorPlugin.IMAGE_TH_VERTICAL));
form.getToolBarManager().add(haction);
form.getToolBarManager().add(vaction);
form.updateToolBar();
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ImportResBindSection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ImportResBindSection.java
index 1296d05..5250024 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ImportResBindSection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ImportResBindSection.java
@@ -27,7 +27,6 @@ import org.apache.uima.util.InvalidXMLException;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.swt.widgets.Composite;
-
/**
* The Class ImportResBindSection.
*/
@@ -36,8 +35,10 @@ public class ImportResBindSection extends ImportSection {
/**
* Instantiates a new import res bind section.
*
- * @param editor the editor
- * @param parent the parent
+ * @param editor
+ * the editor
+ * @param parent
+ * the parent
*/
public ImportResBindSection(MultiPageEditor editor, Composite parent) {
super(editor, parent, "Imports for External Resources and Bindings",
@@ -46,7 +47,9 @@ public class ImportResBindSection extends ImportSection {
// **************************************
// * Code to support type import section
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#isAppropriate()
*/
// **************************************
@@ -58,7 +61,8 @@ public class ImportResBindSection extends ImportSection {
/**
* used when hovering.
*
- * @param source the source
+ * @param source
+ * the source
* @return the description from import
*/
@Override
@@ -66,7 +70,9 @@ public class ImportResBindSection extends ImportSection {
return ""; // imports for resource bindings don't have descriptions
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#getModelImportArray()
*/
@Override
@@ -74,15 +80,21 @@ public class ImportResBindSection extends ImportSection {
return getResourceManagerConfiguration().getImports();
}
- /* (non-Javadoc)
- * @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#setModelImportArray(org.apache.uima.resource.metadata.Import[])
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.taeconfigurator.editors.ui.ImportSection#setModelImportArray(org.apache.uima.
+ * resource.metadata.Import[])
*/
@Override
protected void setModelImportArray(Import[] imports) {
getResourceManagerConfiguration().setImports(imports);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#clearModelBaseValue()
*/
@Override
@@ -91,8 +103,11 @@ public class ImportResBindSection extends ImportSection {
getResourceManagerConfiguration().setExternalResources(externalResourceDescription0);
}
- /* (non-Javadoc)
- * @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#isValidImport(java.lang.String, java.lang.String)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#isValidImport(java.lang.String,
+ * java.lang.String)
*/
// indexes are checked and merged when the CAS is built
@Override
@@ -118,7 +133,8 @@ public class ImportResBindSection extends ImportSection {
/**
* Revert.
*
- * @param rmc the rmc
+ * @param rmc
+ * the rmc
*/
private void revert(ResourceManagerConfiguration rmc) {
getResourceManagerConfiguration()
@@ -127,7 +143,9 @@ public class ImportResBindSection extends ImportSection {
editor.setResolvedExternalResourcesAndBindings(rmc);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#finishImportChangeAction()
*/
@Override
@@ -135,7 +153,9 @@ public class ImportResBindSection extends ImportSection {
editor.getResourcesPage().getResourceDependencySection().refresh(); // to change Binding flag
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#enable()
*/
@Override
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ImportSection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ImportSection.java
index 54831ba..afd918a 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ImportSection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/ImportSection.java
@@ -47,7 +47,6 @@ import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.eclipse.ui.forms.IManagedForm;
-
/**
* Imports - used by aggregates types type priorities indexes external resource specifications.
*/
@@ -63,15 +62,18 @@ public abstract class ImportSection extends AbstractSection {
/**
* Sets the model import array.
*
- * @param newImports the new model import array
+ * @param newImports
+ * the new model import array
*/
protected abstract void setModelImportArray(Import[] newImports);
/**
* Checks if is valid import.
*
- * @param title the title
- * @param message the message
+ * @param title
+ * the title
+ * @param message
+ * the message
* @return true, if is valid import
*/
protected abstract boolean isValidImport(String title, String message);
@@ -84,13 +86,16 @@ public abstract class ImportSection extends AbstractSection {
/**
* Gets the description from import.
*
- * @param source the source
+ * @param source
+ * the source
* @return the description from import
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
- protected abstract String getDescriptionFromImport(String source) throws InvalidXMLException,
- IOException;
+ protected abstract String getDescriptionFromImport(String source)
+ throws InvalidXMLException, IOException;
/**
* Checks if is appropriate.
@@ -140,17 +145,26 @@ public abstract class ImportSection extends AbstractSection {
/**
* Instantiates a new import section.
*
- * @param aEditor the a editor
- * @param parent the parent
- * @param title the title
- * @param description the description
+ * @param aEditor
+ * the a editor
+ * @param parent
+ * the parent
+ * @param title
+ * the title
+ * @param description
+ * the description
*/
- public ImportSection(MultiPageEditor aEditor, Composite parent, String title, String description) {
+ public ImportSection(MultiPageEditor aEditor, Composite parent, String title,
+ String description) {
super(aEditor, parent, title, description);
}
- /* (non-Javadoc)
- * @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#initialize(org.eclipse.ui.forms.IManagedForm)
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.taeconfigurator.editors.ui.AbstractSection#initialize(org.eclipse.ui.forms.
+ * IManagedForm)
*/
@Override
public void initialize(IManagedForm form) {
@@ -185,7 +199,9 @@ public abstract class ImportSection extends AbstractSection {
toolkit.paintBordersFor(sectionClient);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.ui.forms.AbstractFormPart#refresh()
*/
@Override
@@ -219,7 +235,9 @@ public abstract class ImportSection extends AbstractSection {
/*
* (non-Javadoc)
*
- * @see org.apache.uima.taeconfigurator.editors.ui.AbstractTableSection#handleEvent(org.eclipse.swt.widgets.Event)
+ * @see
+ * org.apache.uima.taeconfigurator.editors.ui.AbstractTableSection#handleEvent(org.eclipse.swt.
+ * widgets.Event)
*/
@Override
public void handleEvent(Event event) {
@@ -271,9 +289,7 @@ public abstract class ImportSection extends AbstractSection {
* Handle set data path.
*/
private void handleSetDataPath() {
- CommonInputDialog dialog = new CommonInputDialog(
- this,
- "Set DataPath",
+ CommonInputDialog dialog = new CommonInputDialog(this, "Set DataPath",
"The DataPath is a series of locations which will be used when looking up imports and external resources.\nEnter a series of absolute path names, separated by the character used to separate classpath names on this platform.",
CommonInputDialog.ALLOK, CDEpropertyPage.getDataPath(editor.getProject()));
if (dialog.open() == Window.CANCEL)
@@ -286,9 +302,10 @@ public abstract class ImportSection extends AbstractSection {
*/
private void handleAdd() {
Shell shell = getSection().getShell();
- MultiResourceSelectionDialog dialog = new MultiResourceSelectionDialog(shell, editor.getFile()
- .getProject().getParent(), "Select one or more descriptor files to import:", editor
- .getFile().getLocation(), editor);
+ MultiResourceSelectionDialog dialog = new MultiResourceSelectionDialog(shell,
+ editor.getFile().getProject().getParent(),
+ "Select one or more descriptor files to import:", editor.getFile().getLocation(),
+ editor);
dialog.setTitle("Import File(s) Selection");
if (dialog.open() == Window.CANCEL)
return;
@@ -312,9 +329,10 @@ public abstract class ImportSection extends AbstractSection {
* Called with either byLocation non-null or byName non-null Adds multiple (by location) or one
* (by name).
*
- * @param locations objects returned from dialog
- * @param isByName true
- * if imports should be done by name
+ * @param locations
+ * objects returned from dialog
+ * @param isByName
+ * true if imports should be done by name
* @return false if any import caused an error, true of all OK
*/
public boolean addImports(Object[] locations, boolean isByName) {
@@ -338,8 +356,7 @@ public abstract class ImportSection extends AbstractSection {
setModelImportArray(newImports);
- if (!isValidImport(
- "Error Adding Import(s)",
+ if (!isValidImport("Error Adding Import(s)",
"An error was caused by adding Import(s); operation cancelled. Please correct the error and retry.")) {
setModelImportArray(currentImports);
return false;
@@ -350,20 +367,17 @@ public abstract class ImportSection extends AbstractSection {
/**
* Already imported.
*
- * @param imp the imp
+ * @param imp
+ * the imp
* @return true, if successful
*/
private boolean alreadyImported(Import imp) {
String currentFileBeingEdited = editor.getFile().getLocation().toString();
currentFileBeingEdited = editor.getDescriptorRelativePath(currentFileBeingEdited);
if (currentFileBeingEdited.equals(imp.getLocation())) {
- Utility
- .popMessage(
- "Error - importing self",
- MessageFormat
- .format(
- "The import {0} is the same as the current file being edited. A file can''t be imported into itself.",
- new Object[] { imp.getLocation() }), MessageDialog.ERROR);
+ Utility.popMessage("Error - importing self", MessageFormat.format(
+ "The import {0} is the same as the current file being edited. A file can''t be imported into itself.",
+ new Object[] { imp.getLocation() }), MessageDialog.ERROR);
return true;
}
@@ -372,16 +386,19 @@ public abstract class ImportSection extends AbstractSection {
return false;
for (int i = 0; i < currentImports.length; i++) {
if (currentImports[i].equals(imp)) {
- Utility.popMessage("Error - duplicate import", MessageFormat.format(
- "The import {0} is already present", new Object[] { null != imp.getName() ? imp
- .getName() : imp.getLocation() }), MessageDialog.ERROR);
+ Utility.popMessage("Error - duplicate import",
+ MessageFormat.format("The import {0} is already present",
+ new Object[] { null != imp.getName() ? imp.getName() : imp.getLocation() }),
+ MessageDialog.ERROR);
return true;
}
}
return false;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.AbstractSection#enable()
*/
@Override
@@ -396,7 +413,8 @@ public abstract class ImportSection extends AbstractSection {
/**
* Handle table context menu request.
*
- * @param event the event
+ * @param event
+ * the event
*/
private void handleTableContextMenuRequest(Event event) {
TableItem item = importTable.getItem(new Point(event.x, event.y));
@@ -409,7 +427,8 @@ public abstract class ImportSection extends AbstractSection {
/**
* Handle table hover help.
*
- * @param event the event
+ * @param event
+ * the event
*/
private void handleTableHoverHelp(Event event) {
TableItem item = importTable.getItem(new Point(event.x, event.y));
@@ -464,8 +483,10 @@ public abstract class ImportSection extends AbstractSection {
/**
* Export importable part.
*
- * @param xmlStartElement first element exported
- * @param partTemplate the part template
+ * @param xmlStartElement
+ * first element exported
+ * @param partTemplate
+ * the part template
*/
protected void exportImportablePart(String xmlStartElement, String partTemplate) {
String xmlEndElement = xmlStartElement.replaceFirst("<", "</");
@@ -480,15 +501,15 @@ public abstract class ImportSection extends AbstractSection {
if (start < 0 || end < 0)
throw new InternalErrorCDE("invalid state");
start += xmlStartElement.length();
- printWriter.println(MessageFormat.format(partTemplate, new Object[] { dialog.baseFileName,
- wholeModel.substring(start, end) + "\n" }));
+ printWriter.println(MessageFormat.format(partTemplate,
+ new Object[] { dialog.baseFileName, wholeModel.substring(start, end) + "\n" }));
printWriter.close();
clearModelBaseValue();
setFileDirty(); // do as soon as file changes, in case later error aborts processing
Import imp = createImport(dialog.genFilePath, dialog.isImportByName);
- setModelImportArray((Import[]) Utility.addElementToArray(getModelImportArray(), imp,
- Import.class));
+ setModelImportArray(
+ (Import[]) Utility.addElementToArray(getModelImportArray(), imp, Import.class));
isValidImport("Error Exporting a part and Importing it",
"An unexpected error was caused by the export operation");
refresh();
@@ -498,8 +519,8 @@ public abstract class ImportSection extends AbstractSection {
IFile ifile = (IFile) file;
ifile.refreshLocal(1, null);
((IFile) file).setPersistentProperty(
- new QualifiedName(PLUGIN_ID, IMPORTABLE_PART_CONTEXT), editor.getFile()
- .getLocation().toString());
+ new QualifiedName(PLUGIN_ID, IMPORTABLE_PART_CONTEXT),
+ editor.getFile().getLocation().toString());
} catch (CoreException e) {
throw new InternalErrorCDE("unexpected exception", e);
}
diff --git a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/IndexImportSection.java b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/IndexImportSection.java
index 82047fb..55f42a9 100644
--- a/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/IndexImportSection.java
+++ b/uimaj-ep-configurator/src/main/java/org/apache/uima/taeconfigurator/editors/ui/IndexImportSection.java
@@ -32,7 +32,6 @@ import org.apache.uima.util.InvalidXMLException;
import org.apache.uima.util.XMLInputSource;
import org.eclipse.swt.widgets.Composite;
-
/**
* The Class IndexImportSection.
*/
@@ -41,8 +40,10 @@ public class IndexImportSection extends ImportSection {
/**
* Instantiates a new index import section.
*
- * @param editor the editor
- * @param parent the parent
+ * @param editor
+ * the editor
+ * @param parent
+ * the parent
*/
public IndexImportSection(MultiPageEditor editor, Composite parent) {
super(editor, parent, "Index Imports",
@@ -52,7 +53,9 @@ public class IndexImportSection extends ImportSection {
// **************************************
// * Code to support type import section
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#isAppropriate()
*/
// **************************************
@@ -64,19 +67,24 @@ public class IndexImportSection extends ImportSection {
/**
* used when hovering.
*
- * @param source the source
+ * @param source
+ * the source
* @return the description from import
- * @throws InvalidXMLException the invalid XML exception
- * @throws IOException Signals that an I/O exception has occurred.
+ * @throws InvalidXMLException
+ * the invalid XML exception
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
@Override
protected String getDescriptionFromImport(String source) throws InvalidXMLException, IOException {
- FsIndexCollection parsedImportItem = UIMAFramework.getXMLParser().parseFsIndexCollection(
- new XMLInputSource(source));
+ FsIndexCollection parsedImportItem = UIMAFramework.getXMLParser()
+ .parseFsIndexCollection(new XMLInputSource(source));
return parsedImportItem.getDescription();
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#getModelImportArray()
*/
@Override
@@ -84,8 +92,12 @@ public class IndexImportSection extends ImportSection {
return getFsIndexCollection().getImports();
}
- /* (non-Javadoc)
- * @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#setModelImportArray(org.apache.uima.resource.metadata.Import[])
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.taeconfigurator.editors.ui.ImportSection#setModelImportArray(org.apache.uima.
+ * resource.metadata.Import[])
*/
@Override
protected void setModelImportArray(Import[] imports) {
@@ -94,7 +106,9 @@ public class IndexImportSection extends ImportSection {
getFsIndexCollection().setImports(imports);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.taeconfigurator.editors.ui.ImportSection#clearModelBaseValue()
*/
@Override
@@ -102,8 +116,11 @@ public class IndexImportSection extends ImportSection {
getAnalysisEngineMetaData().setFsIndexes(fsIndexDescription0);
... 12416 lines suppressed ...
[uima-uimaj] 07/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit c4cce1e29f56da718a13c1d839791715260b0403
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:10:58 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../uima/jcas/jcasgenp/EP_LogThrowErrorImpl.java | 2 +-
.../org/apache/uima/jcas/jcasgenp/JgPlugin.java | 4 +--
.../apache/uima/jcas/jcasgenp/JgPluginRunner.java | 4 ++-
.../org/apache/uima/jcas/jcasgenp/MergerImpl.java | 10 +++++---
.../uima/jcas/jcasgenp/ProgressMonitorImpl.java | 30 +++++++++++++++-------
5 files changed, 34 insertions(+), 16 deletions(-)
diff --git a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/EP_LogThrowErrorImpl.java b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/EP_LogThrowErrorImpl.java
index 048ba55..626f5fc 100644
--- a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/EP_LogThrowErrorImpl.java
+++ b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/EP_LogThrowErrorImpl.java
@@ -41,7 +41,7 @@ public class EP_LogThrowErrorImpl implements IError {
*/
@Override
public void newError(int severity, String message, Exception exception) {
- String pluginId = JgPlugin.getUniqueIdentifier();
+ String pluginId = JgPlugin.getUniqueIdentifier();
ILog log = JgPlugin.getDefault().getLog();
log.log(new Status(logLevels[severity], pluginId, IStatus.OK, message, exception));
if (IError.WARN < severity)
diff --git a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/JgPlugin.java b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/JgPlugin.java
index 49d2f87..6bd6025 100644
--- a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/JgPlugin.java
+++ b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/JgPlugin.java
@@ -28,7 +28,7 @@ import org.eclipse.core.runtime.Plugin;
* The main plugin class to be used in the desktop.
*/
public class JgPlugin extends Plugin {
-
+
/** The plugin. */
// The shared instance.
private static JgPlugin plugin;
@@ -39,7 +39,7 @@ public class JgPlugin extends Plugin {
/**
* The constructor.
*/
-// @edu.umd.cs.findbugs.annotations.SuppressWarnings("ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD")
+ // @edu.umd.cs.findbugs.annotations.SuppressWarnings("ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD")
public JgPlugin() {
plugin = this;
}
diff --git a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/JgPluginRunner.java b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/JgPluginRunner.java
index 65206bc..ee676af 100644
--- a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/JgPluginRunner.java
+++ b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/JgPluginRunner.java
@@ -41,7 +41,9 @@ public class JgPluginRunner implements IPlatformRunnable {
public JgPluginRunner() {
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.core.runtime.IPlatformRunnable#run(java.lang.Object)
*/
@Override
diff --git a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/MergerImpl.java b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/MergerImpl.java
index fc79a47..3916c2d 100644
--- a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/MergerImpl.java
+++ b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/MergerImpl.java
@@ -35,15 +35,19 @@ import org.eclipse.jdt.core.jdom.IDOMCompilationUnit;
* The Class MergerImpl.
*/
public class MergerImpl implements org.apache.uima.tools.jcasgen.IMerge {
-
+
/** The Constant jControlModel. */
static final String jControlModel = "jMergeCtl.xml";
/** The j control model instance. */
static JControlModel jControlModelInstance = null;
- /* (non-Javadoc)
- * @see org.apache.uima.tools.jcasgen.IMerge#doMerge(org.apache.uima.tools.jcasgen.Jg, org.apache.uima.tools.jcasgen.IProgressMonitor, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.io.File)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.tools.jcasgen.IMerge#doMerge(org.apache.uima.tools.jcasgen.Jg,
+ * org.apache.uima.tools.jcasgen.IProgressMonitor, java.lang.String, java.lang.String,
+ * java.lang.String, java.lang.String, java.io.File)
*/
@Override
public void doMerge(Jg jg, IProgressMonitor progressMonitor, String sourceContents,
diff --git a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/ProgressMonitorImpl.java b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/ProgressMonitorImpl.java
index ba33a29..9f20499 100644
--- a/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/ProgressMonitorImpl.java
+++ b/uimaj-ep-jcasgen/src/main/java/org/apache/uima/jcas/jcasgenp/ProgressMonitorImpl.java
@@ -26,20 +26,23 @@ import org.eclipse.core.runtime.IProgressMonitor;
* The Class ProgressMonitorImpl.
*/
public class ProgressMonitorImpl implements org.apache.uima.tools.jcasgen.IProgressMonitor {
-
+
/** The fwd. */
private IProgressMonitor fwd;
/**
* Instantiates a new progress monitor impl.
*
- * @param pm the pm
+ * @param pm
+ * the pm
*/
ProgressMonitorImpl(IProgressMonitor pm) {
fwd = pm;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.jcasgen.IProgressMonitor#done()
*/
@Override
@@ -47,7 +50,9 @@ public class ProgressMonitorImpl implements org.apache.uima.tools.jcasgen.IProgr
fwd.done();
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.jcasgen.IProgressMonitor#beginTask(java.lang.String, int)
*/
@Override
@@ -55,7 +60,9 @@ public class ProgressMonitorImpl implements org.apache.uima.tools.jcasgen.IProgr
fwd.beginTask(name, totalWorked);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.jcasgen.IProgressMonitor#subTask(java.lang.String)
*/
@Override
@@ -63,7 +70,9 @@ public class ProgressMonitorImpl implements org.apache.uima.tools.jcasgen.IProgr
fwd.subTask(name);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.tools.jcasgen.IProgressMonitor#worked(int)
*/
@Override
@@ -74,7 +83,8 @@ public class ProgressMonitorImpl implements org.apache.uima.tools.jcasgen.IProgr
/**
* Internal worked.
*
- * @param work the work
+ * @param work
+ * the work
*/
/*
* (non-Javadoc)
@@ -101,7 +111,8 @@ public class ProgressMonitorImpl implements org.apache.uima.tools.jcasgen.IProgr
/**
* Sets the canceled.
*
- * @param value the new canceled
+ * @param value
+ * the new canceled
*/
/*
* (non-Javadoc)
@@ -114,7 +125,8 @@ public class ProgressMonitorImpl implements org.apache.uima.tools.jcasgen.IProgr
/**
* Sets the task name.
*
- * @param name the new task name
+ * @param name
+ * the new task name
*/
/*
* (non-Javadoc)
[uima-uimaj] 13/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit 695bccdd1bb5ce2455a0038a023981585a75e791
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:20:24 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../org/apache/uima/caseditor/CasEditorPlugin.java | 46 +-
.../java/org/apache/uima/caseditor/Images.java | 5 +-
.../org/apache/uima/caseditor/core/TaeError.java | 10 +-
.../uima/caseditor/core/model/DefaultColors.java | 97 ++-
.../caseditor/core/model/dotcorpus/DotCorpus.java | 45 +-
.../core/model/dotcorpus/DotCorpusSerializer.java | 65 +-
.../editor/AbstractAnnotationDocumentListener.java | 22 +-
.../uima/caseditor/editor/AbstractDocument.java | 72 +-
.../caseditor/editor/AbstractDocumentListener.java | 17 +-
.../uima/caseditor/editor/AnnotationDocument.java | 45 +-
.../uima/caseditor/editor/AnnotationEditor.java | 768 +++++++++++----------
.../editor/AnnotationEditorActionContributor.java | 7 +-
.../AnnotationEditorPreferenceConstants.java | 10 +-
.../AnnotationEditorPreferenceInitializer.java | 3 +-
.../editor/AnnotationEditorPreferencePage.java | 31 +-
.../editor/AnnotationEditorSelection.java | 14 +-
.../caseditor/editor/AnnotationEditorView.java | 13 +-
.../editor/AnnotationInformationProvider.java | 24 +-
.../editor/AnnotationSelectionListener.java | 6 +-
.../uima/caseditor/editor/AnnotationStyle.java | 163 +++--
.../editor/AnnotationStyleChangeListener.java | 11 +-
.../apache/uima/caseditor/editor/ArrayValue.java | 15 +-
.../uima/caseditor/editor/CasDocumentProvider.java | 78 ++-
.../editor/CasDocumentProviderFactory.java | 34 +-
.../uima/caseditor/editor/CasEditorError.java | 11 +-
.../uima/caseditor/editor/CasEditorView.java | 122 ++--
.../uima/caseditor/editor/CasEditorViewPage.java | 80 ++-
.../uima/caseditor/editor/ChangeModeAction.java | 10 +-
.../caseditor/editor/CustomInformationControl.java | 15 +-
.../uima/caseditor/editor/DocumentUimaImpl.java | 90 ++-
.../editor/FeatureStructureSelection.java | 12 +-
.../editor/FeatureStructureSelectionIterator.java | 7 +-
.../editor/FeatureStructureSelectionProvider.java | 19 +-
.../apache/uima/caseditor/editor/FeatureValue.java | 18 +-
.../uima/caseditor/editor/FindAnnotateAction.java | 12 +-
.../uima/caseditor/editor/FindAnnotateDialog.java | 195 +++---
.../editor/IAnnotationEditorModifyListener.java | 19 +-
.../caseditor/editor/IAnnotationStyleListener.java | 18 +-
.../apache/uima/caseditor/editor/ICasDocument.java | 25 +-
.../caseditor/editor/ICasDocumentListener.java | 14 +-
.../apache/uima/caseditor/editor/ICasEditor.java | 27 +-
.../caseditor/editor/ICasEditorInputListener.java | 37 +-
.../ICustomInformationControlContentHandler.java | 9 +-
.../caseditor/editor/IEditorSelectionListener.java | 13 +-
.../caseditor/editor/ModelFeatureStructure.java | 42 +-
.../caseditor/editor/QuickTypeSelectionDialog.java | 37 +-
.../apache/uima/caseditor/editor/SubPageSite.java | 23 +-
.../caseditor/editor/TextDocumentProvider.java | 52 +-
.../action/DeleteFeatureStructureAction.java | 14 +-
.../action/LowerLeftAnnotationSideAction.java | 17 +-
.../action/LowerRightAnnotationSideAction.java | 23 +-
.../editor/action/MergeAnnotationAction.java | 15 +-
.../action/WideLeftAnnotationSideAction.java | 22 +-
.../action/WideRightAnnotationSideAction.java | 21 +-
.../annotation/BackgroundDrawingStrategy.java | 114 +--
.../editor/annotation/BoxDrawingStrategy.java | 36 +-
.../editor/annotation/BracketDrawingStrategy.java | 33 +-
.../caseditor/editor/annotation/DrawingStyle.java | 22 +-
.../editor/annotation/EclipseAnnotationPeer.java | 17 +-
.../editor/annotation/TagDrawingStrategy.java | 117 ++--
.../annotation/TextColorDrawingStrategy.java | 4 +-
.../editor/annotation/TokenDrawingStrategy.java | 20 +-
.../annotation/UnderlineDrawingStrategy.java | 19 +-
.../editor/context/AnnotationEditingControl.java | 7 +-
.../context/AnnotationEditingControlCreator.java | 9 +-
.../editor/contextmenu/IModeMenuListener.java | 27 +-
.../contextmenu/IShowAnnotationsListener.java | 30 +-
.../caseditor/editor/contextmenu/ModeMenu.java | 35 +-
.../editor/contextmenu/ShowAnnotationsMenu.java | 318 ++++-----
.../caseditor/editor/contextmenu/TypeMenu.java | 153 ++--
.../editview/CreateFeatureStructureDialog.java | 23 +-
.../uima/caseditor/editor/editview/EditView.java | 5 +-
.../caseditor/editor/editview/EditViewPage.java | 258 +++----
.../editview/FeatureColumnLabelProvider.java | 7 +-
.../editview/FeatureStructureContentProvider.java | 28 +-
.../editor/editview/ValueColumnLabelProvider.java | 20 +-
.../validator/ByteCellEditorValidator.java | 7 +-
.../validator/CellEditorValidatorFacotory.java | 6 +-
.../validator/FloatCellEditorValidator.java | 6 +-
.../validator/IntegerCellEditorValidator.java | 6 +-
.../validator/LongCellEditorValidator.java | 7 +-
.../validator/ShortCellEditorValidator.java | 5 +-
.../editor/fsview/FeatureStructureBrowserView.java | 5 +-
.../fsview/FeatureStructureBrowserViewPage.java | 69 +-
.../fsview/FeatureStructureLabelProvider.java | 13 +-
.../caseditor/editor/fsview/ITypePaneListener.java | 6 +-
.../uima/caseditor/editor/fsview/TypeCombo.java | 61 +-
.../editor/outline/AnnotationOutline.java | 167 ++---
.../editor/outline/AnnotationTreeNode.java | 32 +-
.../editor/outline/AnnotationTreeNodeList.java | 25 +-
.../editor/outline/AnnotationTypeTreeNode.java | 40 +-
.../outline/ModeSensitiveContentProvider.java | 54 +-
.../editor/outline/OutlineContentProviderBase.java | 163 ++---
.../editor/outline/OutlineLabelProvider.java | 12 +-
.../caseditor/editor/outline/OutlinePageBook.java | 16 +-
.../caseditor/editor/outline/OutlineStyles.java | 11 +-
.../editor/outline/OutlineTableSorter.java | 19 +-
.../editor/outline/SwitchStyleAction.java | 62 +-
.../editor/outline/TypeGroupedContentProvider.java | 274 ++++----
.../editor/styleview/AnnotationStyleView.java | 3 +-
.../editor/styleview/AnnotationStyleViewPage.java | 198 +++---
.../editor/styleview/AnnotationTypeNode.java | 32 +-
.../editor/util/AnnotationComparator.java | 11 +-
.../caseditor/editor/util/AnnotationSelection.java | 16 +-
.../editor/util/ContainingConstraint.java | 20 +-
.../editor/util/FeatureStructureTransfer.java | 54 +-
.../uima/caseditor/editor/util/IDGenerator.java | 11 +-
.../uima/caseditor/editor/util/ObjectTransfer.java | 14 +-
.../uima/caseditor/editor/util/Primitives.java | 103 ++-
.../apache/uima/caseditor/editor/util/Span.java | 27 +-
.../editor/util/StrictTypeConstraint.java | 9 +-
.../uima/caseditor/editor/util/UimaUtil.java | 6 +-
.../ui/property/AnnotationPropertyPage.java | 252 +++----
.../ui/property/EditorAnnotationPropertyPage.java | 10 +-
.../core/model/dotcorpus/AnnotationStyleTest.java | 28 +-
.../model/dotcorpus/DotCorpusSerializerTest.java | 7 +-
.../apache/uima/caseditor/core/util/SpanTest.java | 48 +-
.../uima/caseditor/editor/AnnotationStyleTest.java | 24 +-
.../uima/caseditor/editor/util/SpanTest.java | 52 +-
119 files changed, 3034 insertions(+), 2879 deletions(-)
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/CasEditorPlugin.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/CasEditorPlugin.java
index 3192632..4151f14 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/CasEditorPlugin.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/CasEditorPlugin.java
@@ -28,12 +28,11 @@ import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.osgi.framework.BundleContext;
-
/**
* TODO: add javadoc here.
*/
public class CasEditorPlugin extends AbstractUIPlugin {
-
+
/** The Constant ID. */
public static final String ID = "org.apache.uima.caseditor";
@@ -50,10 +49,9 @@ public class CasEditorPlugin extends AbstractUIPlugin {
*/
private ResourceBundle mResourceBundle;
-
/** The show migration dialog. */
private boolean showMigrationDialog = false;
-
+
/**
* The constructor.
*/
@@ -64,8 +62,10 @@ public class CasEditorPlugin extends AbstractUIPlugin {
/**
* This method is called upon plug-in activation.
*
- * @param context the context
- * @throws Exception -
+ * @param context
+ * the context
+ * @throws Exception
+ * -
*/
@Override
public void start(BundleContext context) throws Exception {
@@ -75,8 +75,10 @@ public class CasEditorPlugin extends AbstractUIPlugin {
/**
* This method is called when the plug-in is stopped.
*
- * @param context the context
- * @throws Exception -
+ * @param context
+ * the context
+ * @throws Exception
+ * -
*/
@Override
public void stop(BundleContext context) throws Exception {
@@ -98,7 +100,8 @@ public class CasEditorPlugin extends AbstractUIPlugin {
/**
* Returns the string from the plugin's resource bundle, or 'key' if not found.
*
- * @param key the key
+ * @param key
+ * the key
* @return resource string
*/
public static String getResourceString(String key) {
@@ -131,17 +134,20 @@ public class CasEditorPlugin extends AbstractUIPlugin {
/**
* Log the throwable.
*
- * @param t the t
+ * @param t
+ * the t
*/
public static void log(Throwable t) {
getDefault().getLog().log(new Status(IStatus.ERROR, ID, IStatus.OK, t.getMessage(), t));
}
-
+
/**
* Log.
*
- * @param message the message
- * @param t the t
+ * @param message
+ * the message
+ * @param t
+ * the t
*/
public static void log(String message, Throwable t) {
getDefault().getLog().log(new Status(IStatus.ERROR, ID, IStatus.OK, message, t));
@@ -150,7 +156,8 @@ public class CasEditorPlugin extends AbstractUIPlugin {
/**
* Log error.
*
- * @param message the message
+ * @param message
+ * the message
*/
public static void logError(String message) {
getDefault().getLog().log(new Status(IStatus.ERROR, ID, message));
@@ -159,20 +166,21 @@ public class CasEditorPlugin extends AbstractUIPlugin {
/**
* Retrieves an image.
*
- * @param image the image
+ * @param image
+ * the image
* @return the requested image if not available null
*/
public static ImageDescriptor getTaeImageDescriptor(Images image) {
return imageDescriptorFromPlugin(ID, ICONS_PATH + image.getPath());
}
-
+
/**
* Sets the show migration dialog.
*/
public void setShowMigrationDialog() {
showMigrationDialog = true;
}
-
+
/**
* Gets the and clear show migration dialog flag.
*
@@ -183,8 +191,8 @@ public class CasEditorPlugin extends AbstractUIPlugin {
showMigrationDialog = false;
return true;
}
-
+
return false;
}
-
+
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/Images.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/Images.java
index e1c3767..3bc24a5 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/Images.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/Images.java
@@ -24,12 +24,11 @@ import org.eclipse.jface.resource.ImageDescriptor;
/**
* All images in the Cas Editor are referenced here.
*
- * Call {@link CasEditorPlugin#getTaeImageDescriptor(Images)} to retrieve
- * an actual {@link ImageDescriptor}.
+ * Call {@link CasEditorPlugin#getTaeImageDescriptor(Images)} to retrieve an actual
+ * {@link ImageDescriptor}.
*/
public enum Images {
-
/**
* The source folder image.
*/
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/TaeError.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/TaeError.java
index 609766d..bb11bbb 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/TaeError.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/TaeError.java
@@ -19,7 +19,6 @@
package org.apache.uima.caseditor.core;
-
/**
* A general {@link RuntimeException} which is thrown if something unexpected happens.
*/
@@ -31,7 +30,8 @@ public class TaeError extends RuntimeException {
/**
* Initializes the current instance.
*
- * @param message the message
+ * @param message
+ * the message
*/
public TaeError(String message) {
super(message);
@@ -40,8 +40,10 @@ public class TaeError extends RuntimeException {
/**
* Initializes the current instance.
*
- * @param message the message
- * @param cause the cause
+ * @param message
+ * the message
+ * @param cause
+ * the cause
*/
public TaeError(String message, Throwable cause) {
super(message, cause);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/DefaultColors.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/DefaultColors.java
index 1eb7ba3..7b585d6 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/DefaultColors.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/DefaultColors.java
@@ -32,10 +32,8 @@ import org.apache.uima.cas.Type;
import org.apache.uima.cas.TypeSystem;
import org.apache.uima.caseditor.editor.AnnotationStyle;
-
/**
- * Utility to assign default colors to the annotation types in the
- * TypeSystem.
+ * Utility to assign default colors to the annotation types in the TypeSystem.
*/
public class DefaultColors {
@@ -43,81 +41,74 @@ public class DefaultColors {
/** The Constant BRIGHT. */
// (use high brightness for best contrast against black text)
private static final float BRIGHT = 0.95f;
-
+
/** The Constant COLORS. */
public static final Color[] COLORS = new Color[] {
- // low saturation colors are best, so put them first
- Color.getHSBColor(55f / 360, 0.25f, BRIGHT), // butter yellow?
- Color.getHSBColor(0f / 360, 0.25f, BRIGHT), // pink?
- Color.getHSBColor(210f / 360, 0.25f, BRIGHT), // baby blue?
- Color.getHSBColor(120f / 360, 0.25f, BRIGHT), // mint green?
- Color.getHSBColor(290f / 360, 0.25f, BRIGHT), // lavender?
- Color.getHSBColor(30f / 360, 0.25f, BRIGHT), // tangerine?
- Color.getHSBColor(80f / 360, 0.25f, BRIGHT), // celery green?
- Color.getHSBColor(330f / 360, 0.25f, BRIGHT), // light coral?
- Color.getHSBColor(160f / 360, 0.25f, BRIGHT), // aqua?
- Color.getHSBColor(250f / 360, 0.25f, BRIGHT), // light violet?
-
- // higher saturation colors
- Color.getHSBColor(55f / 360, 0.5f, BRIGHT),
- Color.getHSBColor(0f / 360, 0.5f, BRIGHT),
- Color.getHSBColor(210f / 360, 0.5f, BRIGHT),
- Color.getHSBColor(120f / 360, 0.5f, BRIGHT),
- Color.getHSBColor(290f / 360, 0.5f, BRIGHT),
- Color.getHSBColor(30f / 360, 0.5f, BRIGHT),
- Color.getHSBColor(80f / 360, 0.5f, BRIGHT),
- Color.getHSBColor(330f / 360, 0.5f, BRIGHT),
- Color.getHSBColor(160f / 360, 0.5f, BRIGHT),
- Color.getHSBColor(250f / 360, 0.5f, BRIGHT),
-
- // even higher saturation colors
- Color.getHSBColor(55f / 360, 0.75f, BRIGHT),
- Color.getHSBColor(0f / 360, 0.75f, BRIGHT),
- Color.getHSBColor(210f / 360, 0.75f, BRIGHT),
- Color.getHSBColor(120f / 360, 0.75f, BRIGHT),
- Color.getHSBColor(290f / 360, 0.75f, BRIGHT),
- Color.getHSBColor(30f / 360, 0.75f, BRIGHT),
- Color.getHSBColor(80f / 360, 0.75f, BRIGHT),
- Color.getHSBColor(330f / 360, 0.75f, BRIGHT),
- Color.getHSBColor(160f / 360, 0.75f, BRIGHT),
- Color.getHSBColor(250f / 360, 0.75f, BRIGHT) };
-
+ // low saturation colors are best, so put them first
+ Color.getHSBColor(55f / 360, 0.25f, BRIGHT), // butter yellow?
+ Color.getHSBColor(0f / 360, 0.25f, BRIGHT), // pink?
+ Color.getHSBColor(210f / 360, 0.25f, BRIGHT), // baby blue?
+ Color.getHSBColor(120f / 360, 0.25f, BRIGHT), // mint green?
+ Color.getHSBColor(290f / 360, 0.25f, BRIGHT), // lavender?
+ Color.getHSBColor(30f / 360, 0.25f, BRIGHT), // tangerine?
+ Color.getHSBColor(80f / 360, 0.25f, BRIGHT), // celery green?
+ Color.getHSBColor(330f / 360, 0.25f, BRIGHT), // light coral?
+ Color.getHSBColor(160f / 360, 0.25f, BRIGHT), // aqua?
+ Color.getHSBColor(250f / 360, 0.25f, BRIGHT), // light violet?
+
+ // higher saturation colors
+ Color.getHSBColor(55f / 360, 0.5f, BRIGHT), Color.getHSBColor(0f / 360, 0.5f, BRIGHT),
+ Color.getHSBColor(210f / 360, 0.5f, BRIGHT), Color.getHSBColor(120f / 360, 0.5f, BRIGHT),
+ Color.getHSBColor(290f / 360, 0.5f, BRIGHT), Color.getHSBColor(30f / 360, 0.5f, BRIGHT),
+ Color.getHSBColor(80f / 360, 0.5f, BRIGHT), Color.getHSBColor(330f / 360, 0.5f, BRIGHT),
+ Color.getHSBColor(160f / 360, 0.5f, BRIGHT), Color.getHSBColor(250f / 360, 0.5f, BRIGHT),
+
+ // even higher saturation colors
+ Color.getHSBColor(55f / 360, 0.75f, BRIGHT), Color.getHSBColor(0f / 360, 0.75f, BRIGHT),
+ Color.getHSBColor(210f / 360, 0.75f, BRIGHT), Color.getHSBColor(120f / 360, 0.75f, BRIGHT),
+ Color.getHSBColor(290f / 360, 0.75f, BRIGHT), Color.getHSBColor(30f / 360, 0.75f, BRIGHT),
+ Color.getHSBColor(80f / 360, 0.75f, BRIGHT), Color.getHSBColor(330f / 360, 0.75f, BRIGHT),
+ Color.getHSBColor(160f / 360, 0.75f, BRIGHT), Color.getHSBColor(250f / 360, 0.75f, BRIGHT) };
+
/**
- * Assigns color to the annotation types in the provided <code>TypeSystem</code>.
- * If a user provides an already existing mapping these will not be changed
- * and taken into account when mapping the not assigned types.
+ * Assigns color to the annotation types in the provided <code>TypeSystem</code>. If a user
+ * provides an already existing mapping these will not be changed and taken into account when
+ * mapping the not assigned types.
*
- * @param ts the <code>TypeSystem</code>
- * @param styles already existing styles which map an annotation to a color
+ * @param ts
+ * the <code>TypeSystem</code>
+ * @param styles
+ * already existing styles which map an annotation to a color
* @return the collection
*/
- public static Collection<AnnotationStyle> assignColors(TypeSystem ts, Collection<AnnotationStyle> styles) {
-
+ public static Collection<AnnotationStyle> assignColors(TypeSystem ts,
+ Collection<AnnotationStyle> styles) {
+
Map<String, Color> typeNameToColorMap = new HashMap<>();
-
+
for (AnnotationStyle style : styles) {
typeNameToColorMap.put(style.getAnnotation(), style.getColor());
}
-
+
for (Type type : ts.getProperlySubsumedTypes(ts.getType(CAS.TYPE_NAME_ANNOTATION))) {
if (!typeNameToColorMap.containsKey(type.getName())) {
Color c = COLORS[typeNameToColorMap.size() % COLORS.length];
typeNameToColorMap.put(type.getName(), c);
}
}
-
+
Set<AnnotationStyle> newStyles = new HashSet<>();
-
+
for (AnnotationStyle style : styles) {
typeNameToColorMap.remove(style.getAnnotation());
newStyles.add(style);
}
-
+
for (Map.Entry<String, Color> entry : typeNameToColorMap.entrySet()) {
newStyles.add(new AnnotationStyle(entry.getKey(), AnnotationStyle.Style.BACKGROUND,
entry.getValue(), 0));
}
-
+
return Collections.unmodifiableSet(newStyles);
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/dotcorpus/DotCorpus.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/dotcorpus/DotCorpus.java
index 374419e..0750167 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/dotcorpus/DotCorpus.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/dotcorpus/DotCorpus.java
@@ -28,13 +28,12 @@ import java.util.Set;
import org.apache.uima.cas.Type;
import org.apache.uima.caseditor.editor.AnnotationStyle;
-
/**
* This class contains all project specific configuration parameters. Note: Use DotCorpusSerialzer
* to read or write an instance of this class to or from a byte stream.
*/
public class DotCorpus {
-
+
/** The default value for editor line length hint. */
public static final int EDITOR_LINE_LENGTH_HINT_DEFAULT = 80;
@@ -61,7 +60,7 @@ public class DotCorpus {
* Contains names of types which are visible/shown.
*/
private Set<String> shownTypes = new HashSet<>();
-
+
/**
* Retrieves type system name parameter.
*
@@ -107,7 +106,8 @@ public class DotCorpus {
/**
* Removes the cas processor folder.
*
- * @param folder the folder
+ * @param folder
+ * the folder
*/
@Deprecated
public void removeCasProcessorFolder(String folder) {
@@ -117,7 +117,8 @@ public class DotCorpus {
/**
* Adds a corpus folder.
*
- * @param name the name
+ * @param name
+ * the name
*/
@Deprecated
public void addCorpusFolder(String name) {
@@ -127,7 +128,8 @@ public class DotCorpus {
/**
* Removes the given corpus folder.
*
- * @param name the name
+ * @param name
+ * the name
*/
@Deprecated
public void removeCorpusFolder(String name) {
@@ -159,7 +161,8 @@ public class DotCorpus {
/**
* Sets the editor line length hint parameter.
*
- * @param lineLengthHint the new editor line length
+ * @param lineLengthHint
+ * the new editor line length
* @deprecated setting was moved to preference store
*/
@Deprecated
@@ -175,7 +178,7 @@ public class DotCorpus {
public Collection<AnnotationStyle> getAnnotationStyles() {
return Collections.unmodifiableCollection(mStyleMap.values());
}
-
+
/**
* Gets the shown types.
*
@@ -184,29 +187,32 @@ public class DotCorpus {
public Collection<String> getShownTypes() {
return Collections.unmodifiableCollection(shownTypes);
}
-
+
/**
* Sets the shown type.
*
- * @param type the new shown type
+ * @param type
+ * the new shown type
*/
public void setShownType(String type) {
shownTypes.add(type);
}
-
+
/**
* Removes the shown type.
*
- * @param type the type
+ * @param type
+ * the type
*/
public void removeShownType(String type) {
shownTypes.remove(type);
}
-
+
/**
* Adds an AnnotationStyle. TODO: move style stuff to nlp project
*
- * @param style the new style
+ * @param style
+ * the new style
*/
public void setStyle(AnnotationStyle style) {
@@ -224,7 +230,8 @@ public class DotCorpus {
/**
* Removes an AnnotationStyle for the given name, does nothing if not existent.
*
- * @param name the name
+ * @param name
+ * the name
*/
public void removeStyle(String name) {
mStyleMap.remove(name);
@@ -233,7 +240,8 @@ public class DotCorpus {
/**
* Retrieves the AnnotationStyle for the given type or null if not available.
*
- * @param type the type
+ * @param type
+ * the type
* @return the requested style or null if none
*/
public AnnotationStyle getAnnotation(Type type) {
@@ -256,11 +264,12 @@ public class DotCorpus {
public int hashCode() {
return 0;
}
-
+
/**
* Checks if the given object is equal to the current instance.
*
- * @param obj the obj
+ * @param obj
+ * the obj
* @return true, if successful
*/
@Override
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/dotcorpus/DotCorpusSerializer.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/dotcorpus/DotCorpusSerializer.java
index b74357d..b841cb3 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/dotcorpus/DotCorpusSerializer.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/dotcorpus/DotCorpusSerializer.java
@@ -42,7 +42,6 @@ import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
-
/**
* This class is responsible to read and write {@link DotCorpus} objects from or to a byte stream.
*/
@@ -71,7 +70,7 @@ public class DotCorpusSerializer {
/** The Constant STYLE_LAYER_ATTRIBUTE. */
private static final String STYLE_LAYER_ATTRIBUTE = "layer";
-
+
/** The Constant STYLE_CONFIG_ATTRIBUTE. */
private static final String STYLE_CONFIG_ATTRIBUTE = "config";
@@ -95,20 +94,21 @@ public class DotCorpusSerializer {
/** The Constant SHOWN_ELEMENT. */
private static final String SHOWN_ELEMENT = "shown";
-
+
/** The Constant SHOWN_TYPE_ATTRIBUTE. */
private static final String SHOWN_TYPE_ATTRIBUTE = "type";
-
+
/** The Constant SHOWN_IS_VISISBLE_ATTRIBUTE. */
private static final String SHOWN_IS_VISISBLE_ATTRIBUTE = "visible";
-
-
+
/**
* Creates a {@link DotCorpus} object from a given {@link InputStream}.
*
- * @param dotCorpusStream the dot corpus stream
+ * @param dotCorpusStream
+ * the dot corpus stream
* @return the {@link DotCorpus} instance.
- * @throws CoreException -
+ * @throws CoreException
+ * -
*/
public static DotCorpus parseDotCorpus(InputStream dotCorpusStream) throws CoreException {
DocumentBuilderFactory documentBuilderFactory = XMLUtils.createDocumentBuilderFactory();
@@ -161,7 +161,7 @@ public class DotCorpusSerializer {
// TODO: This code will emit NumberFormatExceptions if the values
// are incorrect, they should be caught, logged and replaced with default
// values
-
+
if (TYPESYSTEM_ELEMENT.equals(corporaChildElement.getNodeName())) {
dotCorpus.setTypeSystemFilename(corporaChildElement.getAttribute(TYPESYTEM_FILE_ATTRIBUTE));
} else if (CORPUS_ELEMENT.equals(corporaChildElement.getNodeName())) {
@@ -179,12 +179,12 @@ public class DotCorpusSerializer {
Color color = new Color(colorInteger);
String drawingLayerString = corporaChildElement.getAttribute(STYLE_LAYER_ATTRIBUTE);
-
+
String drawingConfigString = corporaChildElement.getAttribute(STYLE_CONFIG_ATTRIBUTE);
-
+
if (drawingConfigString.length() == 0)
drawingConfigString = null;
-
+
int drawingLayer;
try {
@@ -193,13 +193,14 @@ public class DotCorpusSerializer {
drawingLayer = 0;
}
- AnnotationStyle style = new AnnotationStyle(type, AnnotationStyle.Style
- .valueOf(styleString), color, drawingLayer, drawingConfigString);
+ AnnotationStyle style = new AnnotationStyle(type,
+ AnnotationStyle.Style.valueOf(styleString), color, drawingLayer,
+ drawingConfigString);
dotCorpus.setStyle(style);
} else if (CAS_PROCESSOR_ELEMENT.equals(corporaChildElement.getNodeName())) {
- dotCorpus.addCasProcessorFolder(corporaChildElement
- .getAttribute(CAS_PROCESSOR_FOLDER_ATTRIBUTE));
+ dotCorpus.addCasProcessorFolder(
+ corporaChildElement.getAttribute(CAS_PROCESSOR_FOLDER_ATTRIBUTE));
} else if (EDITOR_ELEMENT.equals(corporaChildElement.getNodeName())) {
String lineLengthHintString = corporaChildElement
.getAttribute(EDITOR_LINE_LENGTH_ATTRIBUTE);
@@ -209,16 +210,15 @@ public class DotCorpusSerializer {
dotCorpus.setEditorLineLength(lineLengthHint);
} else if (SHOWN_ELEMENT.equals(corporaChildElement.getNodeName())) {
String type = corporaChildElement.getAttribute(SHOWN_TYPE_ATTRIBUTE);
-
+
String isVisisbleString = corporaChildElement.getAttribute(SHOWN_IS_VISISBLE_ATTRIBUTE);
-
+
boolean isVisible = Boolean.parseBoolean(isVisisbleString);
-
+
if (isVisible) {
- dotCorpus.setShownType(type);
+ dotCorpus.setShownType(type);
}
- }
- else {
+ } else {
String message = "Unexpected element: " + corporaChildElement.getNodeName();
IStatus s = new Status(IStatus.ERROR, CasEditorPlugin.ID, IStatus.OK, message, null);
@@ -237,7 +237,8 @@ public class DotCorpusSerializer {
* the {@link DotCorpus} object to serialize.
* @param out
* - the stream to write the current <code>DotCorpus</code> instance.
- * @throws CoreException -
+ * @throws CoreException
+ * -
*/
public static void serialize(DotCorpus dotCorpus, OutputStream out) throws CoreException {
@@ -264,11 +265,11 @@ public class DotCorpusSerializer {
Color color = style.getColor();
int colorInt = new Color(color.getRed(), color.getGreen(), color.getBlue()).getRGB();
styleAttributes.addAttribute("", "", STYLE_COLOR_ATTRIBUTE, "", Integer.toString(colorInt));
- styleAttributes.addAttribute("", "", STYLE_LAYER_ATTRIBUTE, "", Integer.toString(style
- .getLayer()));
+ styleAttributes.addAttribute("", "", STYLE_LAYER_ATTRIBUTE, "",
+ Integer.toString(style.getLayer()));
if (style.getConfiguration() != null) {
- styleAttributes.addAttribute("", "", STYLE_CONFIG_ATTRIBUTE, "", style
- .getConfiguration());
+ styleAttributes.addAttribute("", "", STYLE_CONFIG_ATTRIBUTE, "",
+ style.getConfiguration());
}
xmlSerHandler.startElement("", STYLE_ELEMENT, STYLE_ELEMENT, styleAttributes);
@@ -276,19 +277,19 @@ public class DotCorpusSerializer {
}
for (String type : dotCorpus.getShownTypes()) {
-
+
AttributesImpl shownAttributes = new AttributesImpl();
shownAttributes.addAttribute("", "", SHOWN_TYPE_ATTRIBUTE, "", type);
shownAttributes.addAttribute("", "", SHOWN_IS_VISISBLE_ATTRIBUTE, "", "true");
-
+
xmlSerHandler.startElement("", SHOWN_ELEMENT, SHOWN_ELEMENT, shownAttributes);
xmlSerHandler.endElement("", SHOWN_ELEMENT, SHOWN_ELEMENT);
}
-
+
if (dotCorpus.getTypeSystemFileName() != null) {
AttributesImpl typeSystemFileAttributes = new AttributesImpl();
- typeSystemFileAttributes.addAttribute("", "", TYPESYTEM_FILE_ATTRIBUTE, "", dotCorpus
- .getTypeSystemFileName());
+ typeSystemFileAttributes.addAttribute("", "", TYPESYTEM_FILE_ATTRIBUTE, "",
+ dotCorpus.getTypeSystemFileName());
xmlSerHandler.startElement("", TYPESYSTEM_ELEMENT, TYPESYSTEM_ELEMENT,
typeSystemFileAttributes);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractAnnotationDocumentListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractAnnotationDocumentListener.java
index 9d2e8ac..204db2d 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractAnnotationDocumentListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractAnnotationDocumentListener.java
@@ -25,7 +25,6 @@ import java.util.Collection;
import org.apache.uima.cas.FeatureStructure;
import org.apache.uima.cas.text.AnnotationFS;
-
/**
* This listener listens only for {@link AnnotationFS} change events. All other change events for
* {@link FeatureStructure}s are filtered.
@@ -35,7 +34,8 @@ public abstract class AbstractAnnotationDocumentListener extends AbstractDocumen
/**
* Filter annotations.
*
- * @param structures the structures
+ * @param structures
+ * the structures
* @return the collection
*/
private Collection<AnnotationFS> filterAnnotations(Collection<FeatureStructure> structures) {
@@ -53,7 +53,8 @@ public abstract class AbstractAnnotationDocumentListener extends AbstractDocumen
/**
* Add notification.
*
- * @param structures the structures
+ * @param structures
+ * the structures
*/
@Override
public void added(Collection<FeatureStructure> structures) {
@@ -67,7 +68,8 @@ public abstract class AbstractAnnotationDocumentListener extends AbstractDocumen
/**
* Remove notification.
*
- * @param structures the structures
+ * @param structures
+ * the structures
*/
@Override
public void removed(Collection<FeatureStructure> structures) {
@@ -81,7 +83,8 @@ public abstract class AbstractAnnotationDocumentListener extends AbstractDocumen
/**
* Update notification.
*
- * @param structures the structures
+ * @param structures
+ * the structures
*/
@Override
public void updated(Collection<FeatureStructure> structures) {
@@ -95,21 +98,24 @@ public abstract class AbstractAnnotationDocumentListener extends AbstractDocumen
/**
* Added annotation.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
protected abstract void addedAnnotation(Collection<AnnotationFS> annotations);
/**
* Removed annotation.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
protected abstract void removedAnnotation(Collection<AnnotationFS> annotations);
/**
* Updated annotation.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
protected abstract void updatedAnnotation(Collection<AnnotationFS> annotations);
}
\ No newline at end of file
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractDocument.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractDocument.java
index 2771690..9cdb812 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractDocument.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractDocument.java
@@ -27,7 +27,6 @@ import org.eclipse.core.runtime.ListenerList;
import org.eclipse.core.runtime.SafeRunner;
import org.eclipse.jface.util.SafeRunnable;
-
/**
* Abstract base class for document implementations.
*/
@@ -40,7 +39,8 @@ public abstract class AbstractDocument implements ICasDocument {
/**
* Registers a change listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
@Override
public void addChangeListener(final ICasDocumentListener listener) {
@@ -50,7 +50,8 @@ public abstract class AbstractDocument implements ICasDocument {
/**
* Unregisters a change listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
@Override
public void removeChangeListener(ICasDocumentListener listener) {
@@ -60,13 +61,14 @@ public abstract class AbstractDocument implements ICasDocument {
/**
* Sends an added message to registered listeners.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
protected void fireAddedFeatureStructure(final FeatureStructure annotation) {
-
+
for (Object listener : mListener.getListeners()) {
final ICasDocumentListener documentListener = (ICasDocumentListener) listener;
-
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
@@ -79,13 +81,15 @@ public abstract class AbstractDocument implements ICasDocument {
/**
* Sends an added message to registered listeners.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
- protected void fireAddedFeatureStructure(final Collection<? extends FeatureStructure> annotations) {
+ protected void fireAddedFeatureStructure(
+ final Collection<? extends FeatureStructure> annotations) {
for (Object listener : mListener.getListeners()) {
-
+
final ICasDocumentListener documentListener = (ICasDocumentListener) listener;
-
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
@@ -98,13 +102,14 @@ public abstract class AbstractDocument implements ICasDocument {
/**
* Sends a removed message to registered listeners.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
protected void fireRemovedFeatureStructure(final FeatureStructure annotation) {
for (Object listener : mListener.getListeners()) {
-
+
final ICasDocumentListener documentListener = (ICasDocumentListener) listener;
-
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
@@ -117,13 +122,15 @@ public abstract class AbstractDocument implements ICasDocument {
/**
* Sends a removed message to registered listeners.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
- protected void fireRemovedFeatureStructure(final Collection<? extends FeatureStructure> annotations) {
+ protected void fireRemovedFeatureStructure(
+ final Collection<? extends FeatureStructure> annotations) {
for (Object listener : mListener.getListeners()) {
-
+
final ICasDocumentListener documentListener = (ICasDocumentListener) listener;
-
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
@@ -136,13 +143,14 @@ public abstract class AbstractDocument implements ICasDocument {
/**
* Sends an updated message to registered listeners.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
protected void fireUpdatedFeatureStructure(final FeatureStructure annotation) {
for (Object listener : mListener.getListeners()) {
-
+
final ICasDocumentListener documentListener = (ICasDocumentListener) listener;
-
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
@@ -155,13 +163,15 @@ public abstract class AbstractDocument implements ICasDocument {
/**
* Sends an updated message to registered listeners.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
- protected void fireUpdatedFeatureStructure(final Collection<? extends FeatureStructure> annotations) {
+ protected void fireUpdatedFeatureStructure(
+ final Collection<? extends FeatureStructure> annotations) {
for (Object listener : mListener.getListeners()) {
-
+
final ICasDocumentListener documentListener = (ICasDocumentListener) listener;
-
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
@@ -176,9 +186,9 @@ public abstract class AbstractDocument implements ICasDocument {
*/
protected void fireChanged() {
for (Object listener : mListener.getListeners()) {
-
+
final ICasDocumentListener documentListener = (ICasDocumentListener) listener;
-
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
@@ -191,14 +201,16 @@ public abstract class AbstractDocument implements ICasDocument {
/**
* Fire view changed.
*
- * @param oldViewName the old view name
- * @param newViewName the new view name
+ * @param oldViewName
+ * the old view name
+ * @param newViewName
+ * the new view name
*/
protected void fireViewChanged(final String oldViewName, final String newViewName) {
for (Object listener : mListener.getListeners()) {
-
+
final ICasDocumentListener documentListener = (ICasDocumentListener) listener;
-
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractDocumentListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractDocumentListener.java
index 6e2fc25..3d09d0e 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractDocumentListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AbstractDocumentListener.java
@@ -29,11 +29,12 @@ public abstract class AbstractDocumentListener implements ICasDocumentListener {
@Override
public void added(Collection<FeatureStructure> newFeatureStructure) {
}
-
+
/**
* Forwards the call.
*
- * @param newAnnotation the new annotation
+ * @param newAnnotation
+ * the new annotation
*/
@Override
public void added(FeatureStructure newAnnotation) {
@@ -43,11 +44,12 @@ public abstract class AbstractDocumentListener implements ICasDocumentListener {
@Override
public void removed(Collection<FeatureStructure> deletedFeatureStructure) {
}
-
+
/**
* Forwards the call.
*
- * @param deletedAnnotation the deleted annotation
+ * @param deletedAnnotation
+ * the deleted annotation
*/
@Override
public void removed(FeatureStructure deletedAnnotation) {
@@ -57,11 +59,12 @@ public abstract class AbstractDocumentListener implements ICasDocumentListener {
@Override
public void updated(Collection<FeatureStructure> featureStructure) {
}
-
+
/**
* Forwards the call.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
@Override
public void updated(FeatureStructure annotation) {
@@ -71,7 +74,7 @@ public abstract class AbstractDocumentListener implements ICasDocumentListener {
@Override
public void changed() {
}
-
+
@Override
public void viewChanged(String oldViewName, String newViewName) {
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationDocument.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationDocument.java
index e84021b..577c958 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationDocument.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationDocument.java
@@ -30,7 +30,6 @@ import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.DocumentEvent;
-
/**
* The <code>AnnotationDocument</code> adapts the annotation document to the eclipse Document
* (needed for the editor).
@@ -59,7 +58,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Transform text.
*
- * @param text the text
+ * @param text
+ * the text
* @return the string
*/
private String transformText(String text) {
@@ -100,7 +100,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Sets the document.
*
- * @param element the new document
+ * @param element
+ * the new document
*/
public void setDocument(ICasDocument element) {
mDocument = element;
@@ -120,7 +121,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
@Override
public void addFeatureStructure(FeatureStructure annotation) {
@@ -132,7 +134,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
@Override
public void addFeatureStructures(Collection<? extends FeatureStructure> annotations) {
@@ -144,7 +147,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
@Override
public void removeFeatureStructure(FeatureStructure annotation) {
@@ -156,7 +160,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param annotationsToRemove the annotations to remove
+ * @param annotationsToRemove
+ * the annotations to remove
*/
@Override
public void removeFeatureStructures(Collection<? extends FeatureStructure> annotationsToRemove) {
@@ -168,7 +173,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
@Override
public void update(FeatureStructure annotation) {
@@ -180,7 +186,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
@Override
public void updateFeatureStructure(Collection<? extends FeatureStructure> annotations) {
@@ -202,7 +209,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param type the type
+ * @param type
+ * the type
* @return the annotations
*/
@Override
@@ -213,7 +221,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
@Override
public void addChangeListener(ICasDocumentListener listener) {
@@ -223,7 +232,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
@Override
public void removeChangeListener(ICasDocumentListener listener) {
@@ -234,8 +244,10 @@ class AnnotationDocument extends Document implements ICasDocument {
* Wrap words at next space after lineLengthHint chars in a line. If the line is shorter than
* lineLengthHint nothing happens. The space char is replaced with an line feed char.
*
- * @param textString the text string
- * @param lineLengthHint the line length hint
+ * @param textString
+ * the text string
+ * @param lineLengthHint
+ * the line length hint
* @return input text with line breaks
*/
private String wrapWords(String textString, int lineLengthHint) {
@@ -274,7 +286,8 @@ class AnnotationDocument extends Document implements ICasDocument {
/**
* Call is forwarded to the set document.
*
- * @param type the type
+ * @param type
+ * the type
* @return the type
*/
@Override
@@ -304,7 +317,7 @@ class AnnotationDocument extends Document implements ICasDocument {
@Override
public String getTypeSystemText() {
- if(mDocument != null) {
+ if (mDocument != null) {
return mDocument.getTypeSystemText();
}
return null;
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditor.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditor.java
index 4d911d9..6f8e20a 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditor.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditor.java
@@ -143,40 +143,41 @@ import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds;
import org.eclipse.ui.texteditor.StatusTextEditor;
import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
-
/**
* An editor to annotate text.
*/
-public final class AnnotationEditor extends StatusTextEditor implements ICasEditor, ISelectionListener {
-
+public final class AnnotationEditor extends StatusTextEditor
+ implements ICasEditor, ISelectionListener {
+
/**
* The Class AbstractAnnotateAction.
*/
private abstract class AbstractAnnotateAction extends Action
- implements ISelectionChangedListener {
+ implements ISelectionChangedListener {
@Override
public void selectionChanged(SelectionChangedEvent event) {
- setEnabled(AnnotationEditor.this.getSelection().y -
- AnnotationEditor.this.getSelection().x > 0);
+ setEnabled(
+ AnnotationEditor.this.getSelection().y - AnnotationEditor.this.getSelection().x > 0);
}
}
-
+
/**
* This action annotates the selected text with a defined tag.
*/
private class QuickAnnotateAction extends AbstractAnnotateAction {
-
+
/** The Constant ID. */
private static final String ID = "QuickAnnotate";
-
+
/** The m text widget. */
private StyledText mTextWidget;
/**
* Initializes a new instance.
*
- * @param textWidget the text widget
+ * @param textWidget
+ * the text widget
*/
QuickAnnotateAction(StyledText textWidget) {
mTextWidget = textWidget;
@@ -193,7 +194,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
// get old annotations of current type for this area
// if there is something ... the delete them and add
Collection<AnnotationFS> oldAnnotations = getAnnotation(getDocument().getCAS(),
- getAnnotationMode(), new Span(selection.x, selection.y));
+ getAnnotationMode(), new Span(selection.x, selection.y));
if (!oldAnnotations.isEmpty()) {
getDocument().removeFeatureStructures(oldAnnotations);
@@ -228,15 +229,14 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/** The Constant ID. */
private static final String ID = "Annotate";
-
+
@Override
public void run() {
if (isSomethingSelected()) {
- QuickTypeSelectionDialog typeDialog =
- new QuickTypeSelectionDialog(Display.getCurrent().getActiveShell(),
- AnnotationEditor.this);
+ QuickTypeSelectionDialog typeDialog = new QuickTypeSelectionDialog(
+ Display.getCurrent().getActiveShell(), AnnotationEditor.this);
typeDialog.open();
}
@@ -247,7 +247,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
* Shows the annotation editing context for the active annotation.
*/
private class ShowAnnotationContextEditAction extends Action {
-
+
/** The m presenter. */
private InformationPresenter mPresenter;
@@ -299,30 +299,33 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
* document with the annotations in eclipse.
*/
private class DocumentListener extends AbstractAnnotationDocumentListener {
-
+
/**
* Adds a collection of annotations.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
@Override
public void addedAnnotation(Collection<AnnotationFS> annotations) {
- IAnnotationModelExtension annotationModel = (IAnnotationModelExtension) getDocumentProvider().getAnnotationModel(getEditorInput());
-
+ IAnnotationModelExtension annotationModel = (IAnnotationModelExtension) getDocumentProvider()
+ .getAnnotationModel(getEditorInput());
+
Map<Annotation, Position> addAnnotationMap = new HashMap<>();
-
+
for (AnnotationFS annotation : annotations) {
- addAnnotationMap.put(new EclipseAnnotationPeer(annotation), new Position(annotation.getBegin(),
- annotation.getEnd() - annotation.getBegin()));
+ addAnnotationMap.put(new EclipseAnnotationPeer(annotation),
+ new Position(annotation.getBegin(), annotation.getEnd() - annotation.getBegin()));
}
-
+
annotationModel.replaceAnnotations(null, addAnnotationMap);
}
/**
* Removes a collection of annotations.
*
- * @param deletedAnnotations the deleted annotations
+ * @param deletedAnnotations
+ * the deleted annotations
*/
@Override
public void removedAnnotation(Collection<AnnotationFS> deletedAnnotations) {
@@ -335,35 +338,38 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
highlight(0, 0); // TODO: only if removed annotation was selected
- IAnnotationModelExtension annotationModel = (IAnnotationModelExtension) getDocumentProvider().getAnnotationModel(getEditorInput());
-
+ IAnnotationModelExtension annotationModel = (IAnnotationModelExtension) getDocumentProvider()
+ .getAnnotationModel(getEditorInput());
+
Annotation removeAnnotations[] = new Annotation[deletedAnnotations.size()];
int removeAnnotationsIndex = 0;
for (AnnotationFS annotation : deletedAnnotations) {
removeAnnotations[removeAnnotationsIndex++] = new EclipseAnnotationPeer(annotation);
}
-
+
annotationModel.replaceAnnotations(removeAnnotations, null);
}
/**
* Updated annotation.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
@Override
public void updatedAnnotation(Collection<AnnotationFS> annotations) {
-
- IAnnotationModelExtension annotationModel = (IAnnotationModelExtension) getDocumentProvider().getAnnotationModel(getEditorInput());
-
+
+ IAnnotationModelExtension annotationModel = (IAnnotationModelExtension) getDocumentProvider()
+ .getAnnotationModel(getEditorInput());
+
for (AnnotationFS annotation : annotations) {
- annotationModel.modifyAnnotationPosition(new EclipseAnnotationPeer(annotation),
+ annotationModel.modifyAnnotationPosition(new EclipseAnnotationPeer(annotation),
new Position(annotation.getBegin(), annotation.getEnd() - annotation.getBegin()));
}
-
- selectionChanged(getSite().getPage().getActivePart(), mFeatureStructureSelectionProvider.getSelection());
- }
+ selectionChanged(getSite().getPage().getActivePart(),
+ mFeatureStructureSelectionProvider.getSelection());
+ }
@Override
public void changed() {
@@ -374,7 +380,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
@Override
public void viewChanged(String oldViewName, String newViewName) {
- // TODO: Currently do nothing ...
+ // TODO: Currently do nothing ...
}
}
@@ -382,7 +388,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
* Sometimes the wrong annotation is selected ... ????
*/
private class FeatureStructureDragListener implements DragSourceListener {
-
+
/** The m is active. */
private boolean mIsActive;
@@ -392,7 +398,8 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/**
* Instantiates a new feature structure drag listener.
*
- * @param textWidget the text widget
+ * @param textWidget
+ * the text widget
*/
FeatureStructureDragListener(final StyledText textWidget) {
textWidget.addKeyListener(new KeyListener() {
@@ -426,8 +433,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
// Workaround: It is possible check that is text under the cursor ?
try {
offset = textWidget.getOffsetAtLocation(new Point(e.x, e.y));
- }
- catch (IllegalArgumentException e2) {
+ } catch (IllegalArgumentException e2) {
return;
}
@@ -436,8 +442,8 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
mCandidate = view.get(offset);
if (mCandidate != null) {
- textWidget.setSelectionRange(mCandidate.getBegin(), mCandidate.getEnd()
- - mCandidate.getBegin());
+ textWidget.setSelectionRange(mCandidate.getBegin(),
+ mCandidate.getEnd() - mCandidate.getBegin());
}
}
}
@@ -494,12 +500,10 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
// ask document provider for this
// getAnnotation must be added to cas document provider
- AnnotationStyle style = getAnnotationStyle(
- eclipseAnnotation.getAnnotationFS().getType());
+ AnnotationStyle style = getAnnotationStyle(eclipseAnnotation.getAnnotationFS().getType());
return style.getLayer();
- }
- else {
+ } else {
return 0;
}
}
@@ -522,11 +526,12 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
}
/**
- * This implementation imitates the behavior without the
- * {@link IAnnotationAccessExtension}.
+ * This implementation imitates the behavior without the {@link IAnnotationAccessExtension}.
*
- * @param annotationType the annotation type
- * @param potentialSupertype the potential supertype
+ * @param annotationType
+ * the annotation type
+ * @param potentialSupertype
+ * the potential supertype
* @return true, if is subtype
*/
@Override
@@ -534,8 +539,8 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
Type type = getDocument().getCAS().getTypeSystem().getType((String) annotationType);
- return mShowAnnotationsMenu.getSelectedTypes().contains(type) ||
- getAnnotationMode().equals(type);
+ return mShowAnnotationsMenu.getSelectedTypes().contains(type)
+ || getAnnotationMode().equals(type);
}
@Override
@@ -549,61 +554,62 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
*/
// TODO: Move to external class
static class CasViewMenu extends ContributionItem {
-
+
/** The cas editor. */
private AnnotationEditor casEditor;
-
+
/**
* Instantiates a new cas view menu.
*
- * @param casEditor the cas editor
+ * @param casEditor
+ * the cas editor
*/
public CasViewMenu(AnnotationEditor casEditor) {
this.casEditor = casEditor;
- }
+ }
@Override
public void fill(Menu parentMenu, int index) {
-
+
CAS cas = casEditor.getDocument().getCAS();
-
- for (Iterator<CAS> it = cas.getViewIterator(); it.hasNext(); ) {
-
+
+ for (Iterator<CAS> it = cas.getViewIterator(); it.hasNext();) {
+
CAS casView = it.next();
final String viewName = casView.getViewName();
-
+
final MenuItem actionItem = new MenuItem(parentMenu, SWT.CHECK);
actionItem.setText(viewName);
-
+
// TODO: Disable non-text views, check mime-type
try {
actionItem.setEnabled(cas.getDocumentText() != null);
} catch (Throwable t) {
// TODO: Not nice, discuss better solution on ml
- actionItem.setEnabled(false);
+ actionItem.setEnabled(false);
}
-
+
// TODO: Add support for non text views, editor has
- // to display some error message
-
+ // to display some error message
+
if (cas.getViewName().equals(viewName))
- actionItem.setSelection(true);
-
+ actionItem.setSelection(true);
+
// TODO: move this to an action
actionItem.addListener(SWT.Selection, new Listener() {
@Override
public void handleEvent(Event e) {
// Trigger only if view is really changed
// TODO: Move this check to the document itself ...
- if(!casEditor.getDocument().getCAS().getViewName().equals(viewName)) {
- casEditor.showView(viewName);
+ if (!casEditor.getDocument().getCAS().getViewName().equals(viewName)) {
+ casEditor.showView(viewName);
}
}
});
}
}
}
-
+
/** The m annotation mode. */
private Type mAnnotationMode;
@@ -617,7 +623,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/** The m editor input listener. */
private ListenerList mEditorInputListener = new ListenerList();
-
+
/** TODO: Do we really need this position variable ?. */
private int mCursorPosition;
@@ -641,13 +647,13 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/** The m annotation style listener. */
private AnnotationStyleChangeListener mAnnotationStyleListener;
-
+
/** The shown annotation types. */
private Collection<Type> shownAnnotationTypes = new HashSet<>();
-
+
/** The preference store change listener. */
private IPropertyChangeListener preferenceStoreChangeListener;
-
+
/** The cas document provider. */
private CasDocumentProvider casDocumentProvider;
@@ -659,19 +665,18 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
@Override
public void init(IEditorSite site, IEditorInput input) throws PartInitException {
- casDocumentProvider =
- CasDocumentProviderFactory.instance().getDocumentProvider(input);
-
+ casDocumentProvider = CasDocumentProviderFactory.instance().getDocumentProvider(input);
+
setDocumentProvider(new TextDocumentProvider(casDocumentProvider));
super.init(site, input);
}
-
+
@Override
public CasDocumentProvider getCasDocumentProvider() {
return casDocumentProvider;
}
-
+
/**
* Retrieves the tooltip of the title.
*
@@ -683,7 +688,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
return super.getTitleToolTip();
}
ICasDocument document = getDocument();
- if(document == null) {
+ if (document == null) {
return super.getTitleToolTip();
}
String typeSystemText = document.getTypeSystemText();
@@ -694,23 +699,23 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
return toolTipText;
}
}
-
+
/**
* Retrieves annotation editor adapters.
*
- * @param adapter the adapter
+ * @param adapter
+ * the adapter
* @return an adapter or null
*/
@Override
- public Object getAdapter(@SuppressWarnings("rawtypes") Class adapter) {
+ public Object getAdapter(@SuppressWarnings("rawtypes")
+ Class adapter) {
if (IContentOutlinePage.class.equals(adapter) && getDocument() != null) {
return mOutlinePage;
- }
- else if (CAS.class.equals(adapter) && getDocument() != null) {
+ } else if (CAS.class.equals(adapter) && getDocument() != null) {
return getDocument().getCAS();
- }
- else {
+ } else {
return super.getAdapter(adapter);
}
@@ -726,29 +731,31 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
mPainter = new AnnotationPainter(sourceViewer, new AnnotationAccess());
sourceViewer.addPainter(mPainter);
-
+
return sourceViewer;
}
/**
* Sets the text size.
*
- * @param newSize the new text size
+ * @param newSize
+ * the new text size
*/
private void setTextSize(int newSize) {
Font font = getSourceViewer().getTextWidget().getFont();
-
+
if (font.getFontData().length > 0) {
FontData fd = font.getFontData()[0];
- getSourceViewer().getTextWidget().setFont(new Font(font.getDevice(),
- fd.getName(), newSize, fd.getStyle()));
+ getSourceViewer().getTextWidget()
+ .setFont(new Font(font.getDevice(), fd.getName(), newSize, fd.getStyle()));
}
}
-
+
/**
* Configures the editor.
*
- * @param parent the parent
+ * @param parent
+ * the parent
*/
@Override
public void createPartControl(Composite parent) {
@@ -766,9 +773,9 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
// that
//
// Until this can be used we improvise by registering a couple of listeners which
- // compute a caret offset change based on events which could change it,
+ // compute a caret offset change based on events which could change it,
// that are key and mouse listeners.
-
+
getSourceViewer().getTextWidget().addKeyListener(new KeyListener() {
@Override
public void keyPressed(KeyEvent e) {
@@ -806,32 +813,34 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
@Override
public void mouseUp(MouseEvent e) {
int newCaretOffset = getSourceViewer().getTextWidget().getCaretOffset();
-
+
if (newCaretOffset != mCursorPosition) {
mCursorPosition = newCaretOffset;
refreshSelection();
- }
+ }
}
});
-
// UIMA-2242:
// When a single character is selected with a double click the selection
// changes but the caret does not.
// A press on enter now fails to create an annotation.
-
+
// UIMA-2247:
// Changed again to ensure that also selection from the find dialog
// can be detected
- getSourceViewer().getSelectionProvider().addSelectionChangedListener(new ISelectionChangedListener() {
- @Override
- public void selectionChanged(SelectionChangedEvent event) {
- mFeatureStructureSelectionProvider.setSelection(new AnnotationEditorSelection((ITextSelection) event.getSelection(),
- new StructuredSelection(ModelFeatureStructure.create(getDocument(), getSelectedAnnotations()))));
- }
- });
-
+ getSourceViewer().getSelectionProvider()
+ .addSelectionChangedListener(new ISelectionChangedListener() {
+ @Override
+ public void selectionChanged(SelectionChangedEvent event) {
+ mFeatureStructureSelectionProvider.setSelection(
+ new AnnotationEditorSelection((ITextSelection) event.getSelection(),
+ new StructuredSelection(ModelFeatureStructure.create(getDocument(),
+ getSelectedAnnotations()))));
+ }
+ });
+
DragSource dragSource = new DragSource(getSourceViewer().getTextWidget(), DND.DROP_COPY);
Transfer[] types = new Transfer[] { FeatureStructureTransfer.getInstance() };
@@ -844,38 +853,39 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
getSourceViewer().setEditable(false);
getSite().setSelectionProvider(mFeatureStructureSelectionProvider);
-
-
+
// Retrieve font size from preference store, default is 15
IPreferenceStore prefStore = CasEditorPlugin.getDefault().getPreferenceStore();
- int textSize = prefStore.getInt(AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_TEXT_SIZE);
-
+ int textSize = prefStore
+ .getInt(AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_TEXT_SIZE);
+
if (textSize > 0) {
setTextSize(textSize);
}
-
+
preferenceStoreChangeListener = (new IPropertyChangeListener() {
-
+
@Override
public void propertyChange(PropertyChangeEvent event) {
- if (AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_TEXT_SIZE.equals(event.getProperty())) {
+ if (AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_TEXT_SIZE
+ .equals(event.getProperty())) {
Integer textSize = (Integer) event.getNewValue();
-
+
if (textSize != null && textSize > 0) {
setTextSize(textSize);
}
}
}
});
-
+
prefStore.addPropertyChangeListener(preferenceStoreChangeListener);
-
+
// Note: In case the CAS could not be created the editor will be initialized with
- // a null document (getDocument() == null). Depending on the error it might be
+ // a null document (getDocument() == null). Depending on the error it might be
// possible to recover and the editor input will be set again. The createPartControl
// method might be called with a document or without one, both cases must be supported.
-
- // Perform the document dependent initialization
+
+ // Perform the document dependent initialization
initiallySynchronizeUI();
}
@@ -909,62 +919,62 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
protected void doSetInput(final IEditorInput input) throws CoreException {
final IEditorInput oldInput = getEditorInput();
final ICasDocument oldDocument = getDocument();
-
+
// Unregister the editor listeners on the old input
// TODO: Should we make methods to encapsulate the register/unregister code?
if (oldDocument != null) {
oldDocument.removeChangeListener(mAnnotationSynchronizer);
mAnnotationSynchronizer = null;
-
- getCasDocumentProvider().getTypeSystemPreferenceStore(getEditorInput()).
- removePropertyChangeListener(mAnnotationStyleListener);
+
+ getCasDocumentProvider().getTypeSystemPreferenceStore(getEditorInput())
+ .removePropertyChangeListener(mAnnotationStyleListener);
mAnnotationStyleListener = null;
}
super.doSetInput(input);
-
- if (CasEditorPlugin.getDefault().
- getAndClearShowMigrationDialogFlag()) {
+
+ if (CasEditorPlugin.getDefault().getAndClearShowMigrationDialogFlag()) {
getSite().getShell().getDisplay().asyncExec(new Runnable() {
- @Override
- public void run() {
- MessageDialog.openInformation(getSite().getShell(),"Cas Editor Project Removed",
- "The Cas Editor Project support was removed from this release and" +
- " your existing Cas Editor Projects have been migrated. If you still want to use the " +
- "Cas Editor Project support please install the Cas Editor 2.3.1 again.\n\n" +
- "The Analysis Engine and Cas Consumer run support was also removed and " +
- "is replaced by the new Analysis Engine Launch plugin.");
- }
+ @Override
+ public void run() {
+ MessageDialog.openInformation(getSite().getShell(), "Cas Editor Project Removed",
+ "The Cas Editor Project support was removed from this release and"
+ + " your existing Cas Editor Projects have been migrated. If you still want to use the "
+ + "Cas Editor Project support please install the Cas Editor 2.3.1 again.\n\n"
+ + "The Analysis Engine and Cas Consumer run support was also removed and "
+ + "is replaced by the new Analysis Engine Launch plugin.");
+ }
});
}
-
+
if (getDocument() != null) {
-
+
AnnotationOutline outline = new AnnotationOutline(this);
mOutlinePage.setCASViewPage(outline);
shownAnnotationTypes.clear();
-
+
// Synchronize shown types with the editor
- String shownTypesString = getCasDocumentProvider().getSessionPreferenceStore(input).getString("LastShownTypes");
-
+ String shownTypesString = getCasDocumentProvider().getSessionPreferenceStore(input)
+ .getString("LastShownTypes");
+
String[] shownTypes = shownTypesString.split(";");
-
+
for (String shownType : shownTypes) {
-
+
Type type = getDocument().getType(shownType);
-
- // Types can be deleted from the type system but still be marked
+
+ // Types can be deleted from the type system but still be marked
// as shown in the .dotCorpus file, in that case the type
// name cannot be mapped to a type and should be ignored.
-
+
if (type != null)
shownAnnotationTypes.add(type);
}
-
+
if (getSourceViewer() != null) {
-
- // This branch is usually only executed when the
+
+ // This branch is usually only executed when the
// input was updated because it could not be opened the
// first time trough an error e.g. no type system available
//
@@ -980,32 +990,30 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
// Send a partBroughtToTop event to the views to update their content
// on this currently active editor.
IWorkbenchPage page = getSite().getWorkbenchWindow().getActivePage();
-
+
for (IWorkbenchPart view : page.getViews()) {
if (view instanceof PageBookView) {
((PageBookView) view).partBroughtToTop(getEditorSite().getPart());
}
}
}
- }
- else {
+ } else {
// Makes the outline book show the not available message page
mOutlinePage.setCASViewPage(null);
}
-
+
final ICasDocument newDocument = getDocument();
-
+
if (mEditorInputListener != null) {
-
+
// Iterate over the existing listeners, listeners might be removed
// or added during notification, since views are created or destroyed
// when this event is fired.
-
+
for (Object listener : mEditorInputListener.getListeners()) {
-
- final ICasEditorInputListener inputListener =
- (ICasEditorInputListener) listener;
-
+
+ final ICasEditorInputListener inputListener = (ICasEditorInputListener) listener;
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
@@ -1023,7 +1031,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
protected boolean isErrorStatus(IStatus status) {
return super.isErrorStatus(status) || getDocument().getCAS().getDocumentText() == null;
}
-
+
/**
* Initialized the UI from the freshly set document.
*
@@ -1031,9 +1039,9 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
*/
private void initiallySynchronizeUI() {
if (getDocument() != null) {
-
- mShowAnnotationsMenu = new ShowAnnotationsMenu(
- getDocument().getCAS().getTypeSystem(), shownAnnotationTypes);
+
+ mShowAnnotationsMenu = new ShowAnnotationsMenu(getDocument().getCAS().getTypeSystem(),
+ shownAnnotationTypes);
mShowAnnotationsMenu.addListener(new IShowAnnotationsListener() {
@Override
@@ -1051,50 +1059,49 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
for (Type type : newShownTypes) {
showAnnotationType(type, true);
}
-
+
// Repaint after annotations are changed
mPainter.paint(IPainter.CONFIGURATION);
-
+
setEditorSessionPreferences();
-
+
if (mEditorListener != null) {
- for (IAnnotationEditorModifyListener listener : mEditorListener)
+ for (IAnnotationEditorModifyListener listener : mEditorListener)
listener.showAnnotationsChanged(selection);
}
}
});
-
- IPreferenceStore sessionPreferences =
- getCasDocumentProvider().getSessionPreferenceStore(getEditorInput());
-
+
+ IPreferenceStore sessionPreferences = getCasDocumentProvider()
+ .getSessionPreferenceStore(getEditorInput());
+
// TODO: Define constants for these settings!
-
- Type annotationModeType = getDocument().getType(
- sessionPreferences.getString("LastUsedModeType"));
-
+
+ Type annotationModeType = getDocument()
+ .getType(sessionPreferences.getString("LastUsedModeType"));
+
// Note: The type in the configuration might not exist anymore, or there is
// no type stored yet, in these cases the built-in uima.tcas.Annotation type is used.
// Not setting the annotation type will cause NPEs after the editor opened.
-
+
if (annotationModeType == null) {
- annotationModeType = getDocument().getType(CAS.TYPE_NAME_ANNOTATION);
+ annotationModeType = getDocument().getType(CAS.TYPE_NAME_ANNOTATION);
}
-
+
setAnnotationMode(annotationModeType);
-
+
String lastActiveViewName = sessionPreferences.getString("LastActiveCasViewName");
-
+
try {
// TODO: Missing compatibility check!!!
getDocument().getCAS().getView(lastActiveViewName);
showView(lastActiveViewName);
- }
- catch (CASRuntimeException e) {
+ } catch (CASRuntimeException e) {
// ignore, view is not available
// Note: Using exceptions for control flow is very bad practice
// TODO: Is there a way to check which views are available?!
- // Maybe we should iterate over all available views, and then
- // check if it is available!
+ // Maybe we should iterate over all available views, and then
+ // check if it is available!
showView(CAS.NAME_DEFAULT_SOFA);
}
}
@@ -1108,8 +1115,9 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
menu.appendToGroup(IWorkbenchActionConstants.MB_ADDITIONS, new Separator());
menu.appendToGroup(IWorkbenchActionConstants.MB_ADDITIONS, getAction(SmartAnnotateAction.ID));
menu.appendToGroup(IWorkbenchActionConstants.MB_ADDITIONS, getAction(QuickAnnotateAction.ID));
- menu.appendToGroup(IWorkbenchActionConstants.MB_ADDITIONS, getAction(IWorkbenchActionDefinitionIds.DELETE));
-
+ menu.appendToGroup(IWorkbenchActionConstants.MB_ADDITIONS,
+ getAction(IWorkbenchActionDefinitionIds.DELETE));
+
TypeSystem typeSystem = getDocument().getCAS().getTypeSystem();
// mode menu
@@ -1117,15 +1125,16 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
menu.appendToGroup(IWorkbenchActionConstants.MB_ADDITIONS, modeMenuManager);
ModeMenu modeMenu = new ModeMenu(typeSystem, this);
- modeMenu.addListener(new IModeMenuListener(){
+ modeMenu.addListener(new IModeMenuListener() {
- @Override
- public void modeChanged(Type newMode) {
- IAction actionToExecute = new ChangeModeAction(newMode, newMode.getShortName(),
- AnnotationEditor.this);
+ @Override
+ public void modeChanged(Type newMode) {
+ IAction actionToExecute = new ChangeModeAction(newMode, newMode.getShortName(),
+ AnnotationEditor.this);
- actionToExecute.run();
- }});
+ actionToExecute.run();
+ }
+ });
modeMenuManager.add(modeMenu);
@@ -1133,7 +1142,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
MenuManager showAnnotationMenu = new MenuManager("Show Annotations");
menu.appendToGroup(IWorkbenchActionConstants.MB_ADDITIONS, showAnnotationMenu);
showAnnotationMenu.add(mShowAnnotationsMenu);
-
+
// view menu
MenuManager casViewMenuManager = new MenuManager("CAS Views");
menu.appendToGroup(IWorkbenchActionConstants.MB_ADDITIONS, casViewMenuManager);
@@ -1168,7 +1177,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
public void reopenEditorWithNewTypeSystem() {
setInput(getEditorInput());
}
-
+
/**
* Returns the current annotation type.
*
@@ -1181,7 +1190,8 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/**
* Sets the new annotation type.
*
- * @param type the new annotation mode
+ * @param type
+ * the new annotation mode
*/
public void setAnnotationMode(Type type) {
// TODO: check if this type is a subtype of Annotation
@@ -1213,12 +1223,14 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
public Collection<Type> getShownAnnotationTypes() {
return Collections.unmodifiableCollection(shownAnnotationTypes);
}
-
+
/**
* Sets the shown annotation type.
*
- * @param type the type
- * @param isShown the is shown
+ * @param type
+ * the type
+ * @param isShown
+ * the is shown
*/
public void setShownAnnotationType(Type type, boolean isShown) {
mShowAnnotationsMenu.setSelectedType(type, isShown);
@@ -1227,7 +1239,8 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/**
* Sets the shown annotation types.
*
- * @param types the new shown annotation types
+ * @param types
+ * the new shown annotation types
*/
public void setShownAnnotationTypes(Collection<Type> types) {
mShowAnnotationsMenu.setSelectedTypes(types);
@@ -1236,7 +1249,8 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/**
* Fire annotation type changed.
*
- * @param type the type
+ * @param type
+ * the type
*/
private void fireAnnotationTypeChanged(Type type) {
if (mEditorListener != null) {
@@ -1248,84 +1262,87 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/**
* Retrieves an <code>AnnotationStyle</code> from the underlying storage.
*
- * @param type the type
+ * @param type
+ * the type
* @return the annotation style
*/
public AnnotationStyle getAnnotationStyle(Type type) {
if (type == null)
throw new IllegalArgumentException("type parameter must not be null!");
-
- IPreferenceStore prefStore = getCasDocumentProvider().
- getTypeSystemPreferenceStore(getEditorInput());
-
+
+ IPreferenceStore prefStore = getCasDocumentProvider()
+ .getTypeSystemPreferenceStore(getEditorInput());
+
return AnnotationStyle.getAnnotationStyleFromStore(prefStore, type.getName());
}
-
+
/**
* Sets an annotation style.
*
* Note: Internal usage only!
*
- * @param style the new annotation style
+ * @param style
+ * the new annotation style
*/
// TODO: Disk must be accessed for every changed annotation style
// add a second method which can take all changed styles
public void setAnnotationStyle(AnnotationStyle style) {
- IPreferenceStore prefStore = getCasDocumentProvider().getTypeSystemPreferenceStore(getEditorInput());
+ IPreferenceStore prefStore = getCasDocumentProvider()
+ .getTypeSystemPreferenceStore(getEditorInput());
AnnotationStyle.putAnnotatationStyleToStore(prefStore, style);
-
+
getCasDocumentProvider().saveTypeSystemPreferenceStore(getEditorInput());
}
-
+
/**
* Set the shown annotation status of a type.
*
- * @param type the type
- * @param isVisible if true the type is shown, if false the type
- * it not shown
+ * @param type
+ * the type
+ * @param isVisible
+ * if true the type is shown, if false the type it not shown
*/
private void showAnnotationType(Type type, boolean isVisible) {
AnnotationStyle style = getAnnotationStyle(type);
-
+
if (isVisible) {
-
+
IDrawingStrategy strategy = DrawingStyle.createStrategy(style);
-
+
// It might not be possible to create the drawing strategy trough
// configuration errors, in this case the drawing strategy will be ignored
if (strategy != null) {
-
+
if (style.getStyle().equals(AnnotationStyle.Style.TAG)) {
getSourceViewer().getTextWidget().setLineSpacing(13);
}
-
+
mPainter.addDrawingStrategy(type.getName(), strategy);
mPainter.addAnnotationType(type.getName(), type.getName());
java.awt.Color color = style.getColor();
- mPainter.setAnnotationTypeColor(type.getName(), new Color(null, color.getRed(),
- color.getGreen(), color.getBlue()));
+ mPainter.setAnnotationTypeColor(type.getName(),
+ new Color(null, color.getRed(), color.getGreen(), color.getBlue()));
}
-
+
shownAnnotationTypes.add(type);
- }
- else {
+ } else {
mPainter.removeAnnotationType(type.getName());
shownAnnotationTypes.remove(type);
-
+
if (style.getStyle().equals(AnnotationStyle.Style.TAG)) {
// TODO: only if no more TAG styles are active
// How to figure that out ?!
boolean isKeepLineSpacing = false;
-
- for(Type shownType : shownAnnotationTypes) {
+
+ for (Type shownType : shownAnnotationTypes) {
AnnotationStyle potentialTagStyle = getAnnotationStyle(shownType);
-
+
if (AnnotationStyle.Style.TAG.equals(potentialTagStyle.getStyle())) {
isKeepLineSpacing = true;
break;
}
}
-
+
if (!isKeepLineSpacing)
getSourceViewer().getTextWidget().setLineSpacing(0);
}
@@ -1339,7 +1356,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
mPainter.removeAllAnnotationTypes();
getSourceViewer().getTextWidget().setLineSpacing(0);
-
+
for (Type displayType : mShowAnnotationsMenu.getSelectedTypes()) {
showAnnotationType(displayType, true);
}
@@ -1359,48 +1376,50 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
IAnnotationModel annotationModel = getDocumentProvider().getAnnotationModel(getEditorInput());
((IAnnotationModelExtension) annotationModel).removeAllAnnotations();
}
-
+
/**
* Sync annotations.
*/
private void syncAnnotations() {
-
+
removeAllAnnotations();
-
+
// Remove all annotation from the model
IAnnotationModel annotationModel = getDocumentProvider().getAnnotationModel(getEditorInput());
((IAnnotationModelExtension) annotationModel).removeAllAnnotations();
-
+
// Add all annotation to the model
// copy annotations into annotation model
final Iterator<AnnotationFS> mAnnotations = getDocument().getCAS().getAnnotationIndex()
.iterator();
-
+
// TODO: Build first a map, and then pass all annotations at once
Map annotationsToAdd = new HashMap();
-
+
while (mAnnotations.hasNext()) {
AnnotationFS annotationFS = mAnnotations.next();
annotationsToAdd.put(new EclipseAnnotationPeer(annotationFS), new Position(
annotationFS.getBegin(), annotationFS.getEnd() - annotationFS.getBegin()));
}
-
+
((IAnnotationModelExtension) annotationModel).replaceAnnotations(null, annotationsToAdd);
}
-
+
/**
* Adds the annotation listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
public void addAnnotationListener(IAnnotationEditorModifyListener listener) {
mEditorListener.add(listener);
}
-
+
/**
* Removes the annotation listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
public void removeAnnotationListener(IAnnotationEditorModifyListener listener) {
mEditorListener.remove(listener);
@@ -1410,12 +1429,12 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
public void addCasEditorInputListener(ICasEditorInputListener listener) {
mEditorInputListener.add(listener);
}
-
+
@Override
public void removeCasEditorInputListener(ICasEditorInputListener listener) {
mEditorInputListener.remove(listener);
}
-
+
/**
* Returns the selection.
*
@@ -1428,8 +1447,10 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/**
* Highlights the given range in the editor.
*
- * @param start the start
- * @param length the length
+ * @param start
+ * the start
+ * @param length
+ * the length
*/
private void highlight(int start, int length) {
ISourceViewer sourceViewer = getSourceViewer();
@@ -1448,8 +1469,8 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
}
if (length != 0) {
- mCurrentStyleRange = new StyleRange(start, length, text.getSelectionForeground(), text
- .getSelectionBackground());
+ mCurrentStyleRange = new StyleRange(start, length, text.getSelectionForeground(),
+ text.getSelectionBackground());
text.setStyleRange(mCurrentStyleRange);
}
@@ -1492,7 +1513,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
return selection;
}
-
+
/**
* Returns the caret position relative to the start of the text.
*
@@ -1501,64 +1522,65 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
public int getCaretOffset() {
return getSourceViewer().getTextWidget().getCaretOffset();
}
-
+
/**
* Show view.
*
- * @param viewName the view name
+ * @param viewName
+ * the view name
*/
public void showView(String viewName) {
-
+
// TODO: Check if set view is compatible .. if not display some message!
-
+
// TODO: Consider to clear selection if this is called in the
// selectionChanged method, is that the right place?!
-
+
// Clear all old selections, references FSes of current view
mFeatureStructureSelectionProvider.clearSelection();
-
+
// Move the caret before the first char, otherwise it
// might be placed on an index which is out of bounds in
// the changed text
if (getSourceViewer().getTextWidget().getText().length() > 0)
getSourceViewer().getTextWidget().setCaretOffset(0);
-
+
// De-highlight the text in the editor, because the highlight
- // method has to remember the highlighted text area
+ // method has to remember the highlighted text area
// After the text changed the offsets might be out of bound
highlight(0, 0);
-
+
// Remove all editor annotations
// Changing the text with annotations might fail, because the
// bounds might be invalid in the new text
removeAllAnnotations();
-
+
// Change the view in the input document
// TODO: Add support for this to the interface
getDocument().switchView(viewName);
-
+
// Retrieve the new (changed) text document and refresh the source viewer
getSourceViewer().setDocument((AnnotationDocument) getDocument(),
- getDocumentProvider().getAnnotationModel(getEditorInput()));
+ getDocumentProvider().getAnnotationModel(getEditorInput()));
getSourceViewer().invalidateTextPresentation();
-
+
// All annotations will be synchronized in the document listener
-
+
// Last opened view should be remembered, in case a new editor is opened
setEditorSessionPreferences();
-
+
// Check if CAS view is compatible, only if compatible the listeners
// to update the annotations in the editor can be registered
// and the annotations can be synchronized
if (!isErrorStatus(getCasDocumentProvider().getStatus(getEditorInput()))) {
-
+
// Synchronize all annotation from the document with
// the editor
syncAnnotations();
-
+
// Note: If a change from a compatible view to a compatible view
- // occurs there is no need be register the listeners again
-
+ // occurs there is no need be register the listeners again
+
// Register listener to synchronize annotations between the
// editor and the document in case the annotations
// change e.g. updated in a view
@@ -1566,46 +1588,45 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
mAnnotationSynchronizer = new DocumentListener();
getDocument().addChangeListener(mAnnotationSynchronizer);
}
-
+
// Register listener to synchronize annotation styles
// between multiple open annotation editors
if (mAnnotationStyleListener == null) {
mAnnotationStyleListener = new AnnotationStyleChangeListener() {
-
+
@Override
public void annotationStylesChanged(Collection<AnnotationStyle> styles) {
// TODO: Only sync changed types
syncAnnotationTypes();
}
};
-
- getCasDocumentProvider().getTypeSystemPreferenceStore(getEditorInput()).
- addPropertyChangeListener(mAnnotationStyleListener);
+
+ getCasDocumentProvider().getTypeSystemPreferenceStore(getEditorInput())
+ .addPropertyChangeListener(mAnnotationStyleListener);
}
-
+
getSite().getPage().addSelectionListener(this);
- }
- else {
+ } else {
// if not null ... then unregister ... listener
if (mAnnotationSynchronizer != null) {
getDocument().removeChangeListener(mAnnotationSynchronizer);
mAnnotationSynchronizer = null;
}
-
+
if (mAnnotationStyleListener != null) {
- getCasDocumentProvider().getTypeSystemPreferenceStore(getEditorInput()).
- removePropertyChangeListener(mAnnotationStyleListener);
+ getCasDocumentProvider().getTypeSystemPreferenceStore(getEditorInput())
+ .removePropertyChangeListener(mAnnotationStyleListener);
mAnnotationStyleListener = null;
}
-
+
getSite().getPage().removeSelectionListener(this);
}
-
+
// According to error status toggle between text editor or
// status page
updatePartControl(getEditorInput());
}
-
+
/**
* Text is not editable, cause of the nature of the annotation editor. This does not mean, that
* the annotations are not editable.
@@ -1620,53 +1641,54 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
/**
* Notifies the current instance about selection changes in the workbench.
*
- * @param part the part
- * @param selection the selection
+ * @param part
+ * the part
+ * @param selection
+ * the selection
*/
@Override
public void selectionChanged(IWorkbenchPart part, ISelection selection) {
if (selection instanceof StructuredSelection) {
-
+
AnnotationSelection annotations = new AnnotationSelection((StructuredSelection) selection);
// only process these selection if the annotations belong
// to the current editor instance
if (getSite().getPage().getActiveEditor() == this) {
-
+
if (!annotations.isEmpty()) {
- highlight(annotations.getFirst().getBegin(), annotations.getLast().getEnd()
- - annotations.getFirst().getBegin());
-
+ highlight(annotations.getFirst().getBegin(),
+ annotations.getLast().getEnd() - annotations.getFirst().getBegin());
+
// move caret to new position when selected outside of the editor
if (AnnotationEditor.this != part) {
-
+
// Note: The caret cannot be placed between line delimiters
// See bug UIMA-1470
int newCaretOffset = annotations.getLast().getEnd();
String text = getSourceViewer().getTextWidget().getText();
-
+
if (newCaretOffset > 0 && newCaretOffset < text.length()) {
- char beforeCaret = text.charAt(newCaretOffset -1);
+ char beforeCaret = text.charAt(newCaretOffset - 1);
char afterCaret = text.charAt(newCaretOffset);
-
+
final int cr = 0x0D;
final int lf = 0x0A;
if (beforeCaret == cr && afterCaret == lf) {
// In case the caret offset is in the middle
// of a multiple-char line delimiter place caret
// before
- newCaretOffset = newCaretOffset -1;
+ newCaretOffset = newCaretOffset - 1;
}
}
-
+
// check bounds, if out of text do nothing
getSourceViewer().getTextWidget().setCaretOffset(newCaretOffset);
getSourceViewer().revealRange(newCaretOffset, 0);
-
+
mFeatureStructureSelectionProvider.setSelection(selection);
}
- }
- else {
+ } else {
// Nothing selected, clear annotation selection
highlight(0, 0);
}
@@ -1684,38 +1706,35 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
// getSourceViewer() returns null here ... but why ?
return getSourceViewer().getTextWidget().getSelectionCount() != 0;
}
-
+
/**
- * Set the session data which should be used to initalize the next Cas Editor which
- * is opened.
+ * Set the session data which should be used to initalize the next Cas Editor which is opened.
*/
private void setEditorSessionPreferences() {
-
- // TODO: Define constants with prefix for these settings ... so they don't conflict with other plugins!
-
- IPreferenceStore sessionStore = getCasDocumentProvider().
- getSessionPreferenceStore(getEditorInput());
-
+
+ // TODO: Define constants with prefix for these settings ... so they don't conflict with other
+ // plugins!
+
+ IPreferenceStore sessionStore = getCasDocumentProvider()
+ .getSessionPreferenceStore(getEditorInput());
+
sessionStore.setValue("LastActiveCasViewName", getDocument().getCAS().getViewName());
sessionStore.setValue("LastUsedModeType", getAnnotationMode().getName());
-
+
StringBuilder shownTypesString = new StringBuilder();
-
+
for (Type shownType : getShownAnnotationTypes()) {
shownTypesString.append(shownType.getName());
shownTypesString.append(";");
}
-
+
sessionStore.setValue("LastShownTypes", shownTypesString.toString());
}
/**
* Creates custom annotation actions:
*
- * Annotate Action
- * Smart Annotate Action
- * Delete Annotations Action
- * Find Annotate Action.
+ * Annotate Action Smart Annotate Action Delete Annotations Action Find Annotate Action.
*/
@Override
protected void createActions() {
@@ -1726,12 +1745,13 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
getSite().setSelectionProvider(mFeatureStructureSelectionProvider);
// create annotate action
- QuickAnnotateAction quickAnnotateAction = new QuickAnnotateAction(getSourceViewer().getTextWidget());
+ QuickAnnotateAction quickAnnotateAction = new QuickAnnotateAction(
+ getSourceViewer().getTextWidget());
quickAnnotateAction.setActionDefinitionId(QuickAnnotateAction.ID);
quickAnnotateAction.setText("Quick Annotate");
setAction(QuickAnnotateAction.ID, quickAnnotateAction);
getSite().getSelectionProvider().addSelectionChangedListener(quickAnnotateAction);
-
+
SmartAnnotateAction smartAnnotateAction = new SmartAnnotateAction();
smartAnnotateAction.setActionDefinitionId(SmartAnnotateAction.ID);
smartAnnotateAction.setText("Annotate");
@@ -1739,8 +1759,7 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
getSite().getSelectionProvider().addSelectionChangedListener(smartAnnotateAction);
// create delete action
- DeleteFeatureStructureAction deleteAnnotationAction = new DeleteFeatureStructureAction(
- this);
+ DeleteFeatureStructureAction deleteAnnotationAction = new DeleteFeatureStructureAction(this);
deleteAnnotationAction.setText("Delete Annotation");
getSite().getSelectionProvider().addSelectionChangedListener(deleteAnnotationAction);
@@ -1750,37 +1769,40 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
setActionActivationCode(IWorkbenchActionDefinitionIds.DELETE, (char) 0, SWT.CR, SWT.NONE);
// create show annotation context editing action
- ShowAnnotationContextEditAction annotationContextEditAction =
- new ShowAnnotationContextEditAction();
+ ShowAnnotationContextEditAction annotationContextEditAction = new ShowAnnotationContextEditAction();
annotationContextEditAction.setActionDefinitionId(ITextEditorActionDefinitionIds.QUICK_ASSIST);
setAction(ITextEditorActionDefinitionIds.QUICK_ASSIST, annotationContextEditAction);
// Create find annotate action
- FindAnnotateAction findAnnotateAction = new FindAnnotateAction(this, getSourceViewer().getFindReplaceTarget());
+ FindAnnotateAction findAnnotateAction = new FindAnnotateAction(this,
+ getSourceViewer().getFindReplaceTarget());
findAnnotateAction.setActionDefinitionId(IWorkbenchActionDefinitionIds.FIND_REPLACE);
setAction(ITextEditorActionConstants.FIND, findAnnotateAction);
-
+
// Lower left side of annotation action
- LowerLeftAnnotationSideAction lowerLeftAnnotationSideAction = new LowerLeftAnnotationSideAction(this);
+ LowerLeftAnnotationSideAction lowerLeftAnnotationSideAction = new LowerLeftAnnotationSideAction(
+ this);
lowerLeftAnnotationSideAction.setActionDefinitionId(LowerLeftAnnotationSideAction.ID);
setAction(LowerLeftAnnotationSideAction.ID, lowerLeftAnnotationSideAction);
getSite().getSelectionProvider().addSelectionChangedListener(lowerLeftAnnotationSideAction);
-
+
// Wide left side of annotation action
WideLeftAnnotationSideAction wideLeftAnnotationSide = new WideLeftAnnotationSideAction(this);
wideLeftAnnotationSide.setActionDefinitionId(WideLeftAnnotationSideAction.ID);
setAction(WideLeftAnnotationSideAction.ID, wideLeftAnnotationSide);
getSite().getSelectionProvider().addSelectionChangedListener(wideLeftAnnotationSide);
-
+
// Lower right side of annotation
- LowerRightAnnotationSideAction lowerRightAnnotationSideAction = new LowerRightAnnotationSideAction(this);
+ LowerRightAnnotationSideAction lowerRightAnnotationSideAction = new LowerRightAnnotationSideAction(
+ this);
lowerRightAnnotationSideAction.setActionDefinitionId(LowerRightAnnotationSideAction.ID);
setAction(LowerRightAnnotationSideAction.ID, lowerRightAnnotationSideAction);
getSite().getSelectionProvider().addSelectionChangedListener(lowerRightAnnotationSideAction);
-
+
// Wide right side of annotation
- WideRightAnnotationSideAction wideRightAnnotationSideAction = new WideRightAnnotationSideAction(this);
+ WideRightAnnotationSideAction wideRightAnnotationSideAction = new WideRightAnnotationSideAction(
+ this);
wideRightAnnotationSideAction.setActionDefinitionId(WideRightAnnotationSideAction.ID);
setAction(WideRightAnnotationSideAction.ID, wideRightAnnotationSideAction);
getSite().getSelectionProvider().addSelectionChangedListener(wideRightAnnotationSideAction);
@@ -1800,23 +1822,25 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
}
CasDocumentProvider provider = getCasDocumentProvider();
-
+
if (provider != null) {
IPreferenceStore store = provider.getTypeSystemPreferenceStore(getEditorInput());
if (store != null)
store.removePropertyChangeListener(mAnnotationStyleListener);
}
-
+
if (preferenceStoreChangeListener != null)
- CasEditorPlugin.getDefault().getPreferenceStore().removePropertyChangeListener(preferenceStoreChangeListener);
-
+ CasEditorPlugin.getDefault().getPreferenceStore()
+ .removePropertyChangeListener(preferenceStoreChangeListener);
+
super.dispose();
}
/**
* Sets the annotation selection.
*
- * @param annotation the new annotation selection
+ * @param annotation
+ * the new annotation selection
*/
void setAnnotationSelection(AnnotationFS annotation) {
mFeatureStructureSelectionProvider.setSelection(getDocument(), annotation);
@@ -1850,85 +1874,85 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
return dirtyParts.toArray(new AnnotationEditor[dirtyParts.size()]);
}
-
+
@Override
protected Control createStatusControl(Composite parent, IStatus status) {
// Type System is missing in non Cas Editor Project case
if (status.getCode() == CasDocumentProvider.TYPE_SYSTEM_NOT_AVAILABLE_STATUS_CODE
- && getEditorInput() !=null) {
+ && getEditorInput() != null) {
// TODO: Is the null check on the editor input necessary ?!
-
+
// Show a form to select a type system in the document provider,
// afterwards the form calls reopenEditorWithNewTypesystem to reopen
// the editor on the input
return getCasDocumentProvider().createTypeSystemSelectorForm(this, parent, status);
- }
- else if (status.getCode() == IStatus.OK) {
-
+ } else if (status.getCode() == IStatus.OK) {
+
// TODO: Figure out which page should be shown
// TODO: Implement pages ...
// TODO: Each page needs an ability to switch the view back to something else ...
-
+
if (getDocument() != null && getDocument().getCAS().getDocumentText() == null) {
-
+
// TODO: Also display the current view name ...
-
+
Composite noTextComposite = new Composite(parent, SWT.NONE);
noTextComposite.setLayout(new GridLayout(1, false));
Label noTextLabel = new Label(noTextComposite, SWT.NONE);
noTextLabel.setText("Text sofa is not set!");
-
-
+
Label switchToView = new Label(noTextComposite, SWT.NONE);
switchToView.setText("Choose a view to switch to:");
-
+
final Combo viewSelectionCombo = new Combo(noTextComposite, SWT.READ_ONLY);
-
+
List<String> viewNames = new ArrayList<>();
- for (Iterator<CAS> it = getDocument().getCAS().getViewIterator(); it.hasNext(); ) {
+ for (Iterator<CAS> it = getDocument().getCAS().getViewIterator(); it.hasNext();) {
viewNames.add(it.next().getViewName());
}
-
+
viewSelectionCombo.setItems(viewNames.toArray(new String[viewNames.size()]));
-
+
// Preselect default view, will always be there
viewSelectionCombo.select(0);
-
+
Button switchView = new Button(noTextComposite, SWT.PUSH);
switchView.setText("Switch");
-
+
// TODO: Add a combo to select view ...
-
+
switchView.addSelectionListener(new SelectionListener() {
-
+
@Override
public void widgetSelected(SelectionEvent e) {
// TODO; Switch to selected view in combo ...
showView(viewSelectionCombo.getText());
}
-
+
@Override
public void widgetDefaultSelected(SelectionEvent e) {
}
});
-
+
return noTextComposite;
}
-
+
return super.createStatusControl(parent, status);
- }
- else {
+ } else {
return super.createStatusControl(parent, status);
}
}
-
+
/**
* Retrieves the annotations in the given span.
*
- * @param cas the cas
- * @param type the type
- * @param span the span
+ * @param cas
+ * the cas
+ * @param type
+ * the type
+ * @param span
+ * the span
* @return the annotation
*/
static Collection<AnnotationFS> getAnnotation(CAS cas, Type type, Span span) {
@@ -1954,22 +1978,22 @@ public final class AnnotationEditor extends StatusTextEditor implements ICasEdit
FSMatchConstraint annotationInSpanConstraint = cf.and(embeddedBegin, embeddedEnd);
- FSMatchConstraint annotationInSpanAndStrictTypeConstraint =
- cf.and(annotationInSpanConstraint, strictType);
+ FSMatchConstraint annotationInSpanAndStrictTypeConstraint = cf.and(annotationInSpanConstraint,
+ strictType);
FSIndex<AnnotationFS> allAnnotations = cas.getAnnotationIndex(type);
- FSIterator<AnnotationFS> annotationInsideSpanIndex =
- cas.createFilteredIterator(allAnnotations.iterator(),
- annotationInSpanAndStrictTypeConstraint);
+ FSIterator<AnnotationFS> annotationInsideSpanIndex = cas.createFilteredIterator(
+ allAnnotations.iterator(), annotationInSpanAndStrictTypeConstraint);
return DocumentUimaImpl.fsIteratorToCollection(annotationInsideSpanIndex);
}
-
+
/**
* Retrieves the view map.
*
- * @param annotationType the annotation type
+ * @param annotationType
+ * the annotation type
* @return the view
*/
private Map<Integer, AnnotationFS> getView(Type annotationType) {
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorActionContributor.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorActionContributor.java
index de6ecdb..a40f66b 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorActionContributor.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorActionContributor.java
@@ -25,7 +25,6 @@ import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.part.EditorActionBarContributor;
import org.eclipse.ui.texteditor.StatusLineContributionItem;
-
/**
* The <code>AnnotationEditor</code> action contributor.
*
@@ -46,7 +45,8 @@ public class AnnotationEditorActionContributor extends EditorActionBarContributo
/**
* Sets the active editor.
*
- * @param part the new active editor
+ * @param part
+ * the new active editor
*/
@Override
public void setActiveEditor(IEditorPart part) {
@@ -68,7 +68,8 @@ public class AnnotationEditorActionContributor extends EditorActionBarContributo
/**
* Contributes the status item to the status line.
*
- * @param statusLineManager the status line manager
+ * @param statusLineManager
+ * the status line manager
*/
@Override
public void contributeToStatusLine(IStatusLineManager statusLineManager) {
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferenceConstants.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferenceConstants.java
index 89005a1..6d98dee 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferenceConstants.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferenceConstants.java
@@ -21,22 +21,18 @@ package org.apache.uima.caseditor.editor;
import org.apache.uima.caseditor.CasEditorPlugin;
-
/**
* The Class AnnotationEditorPreferenceConstants.
*/
public class AnnotationEditorPreferenceConstants {
/** The Constant ANNOTATION_EDITOR_TEXT_SIZE. */
- public static final String ANNOTATION_EDITOR_TEXT_SIZE =
- CasEditorPlugin.ID + ".editor-text-size";
-
+ public static final String ANNOTATION_EDITOR_TEXT_SIZE = CasEditorPlugin.ID + ".editor-text-size";
+
/** The Constant EDITOR_LINE_LENGTH_HINT. */
- public static final String EDITOR_LINE_LENGTH_HINT =
- "EDITOR_LINE_LENGTH_HINT";
+ public static final String EDITOR_LINE_LENGTH_HINT = "EDITOR_LINE_LENGTH_HINT";
/** The Constant ANNOTATION_EDITOR_PARTIAL_TYPESYSTEM. */
public static final String ANNOTATION_EDITOR_PARTIAL_TYPESYSTEM = "ANNOTATION_EDITOR_PARTIAL_TYPESYSTEM";
-
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferenceInitializer.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferenceInitializer.java
index 6090e17..e3fce5c 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferenceInitializer.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferenceInitializer.java
@@ -33,6 +33,7 @@ public class AnnotationEditorPreferenceInitializer extends AbstractPreferenceIni
IPreferenceStore store = CasEditorPlugin.getDefault().getPreferenceStore();
store.setDefault(AnnotationEditorPreferenceConstants.EDITOR_LINE_LENGTH_HINT, 80);
store.setDefault(AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_TEXT_SIZE, 13);
- store.setDefault(AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_PARTIAL_TYPESYSTEM, false);
+ store.setDefault(AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_PARTIAL_TYPESYSTEM,
+ false);
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferencePage.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferencePage.java
index dc59824..201f301 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferencePage.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorPreferencePage.java
@@ -26,7 +26,6 @@ import org.eclipse.jface.preference.IntegerFieldEditor;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
-
/**
* Preference page to manage preferences for the Annotation Editor.
*/
@@ -35,7 +34,7 @@ public class AnnotationEditorPreferencePage extends FieldEditorPreferencePage
/** The m editor line length hint. */
private IntegerFieldEditor mEditorLineLengthHint;
-
+
/** The m editor text size. */
private IntegerFieldEditor mEditorTextSize;
@@ -51,22 +50,22 @@ public class AnnotationEditorPreferencePage extends FieldEditorPreferencePage
protected void createFieldEditors() {
// editor line length hint
mEditorLineLengthHint = new IntegerFieldEditor(
- AnnotationEditorPreferenceConstants.EDITOR_LINE_LENGTH_HINT,
- "Line Length Hint", getFieldEditorParent());
+ AnnotationEditorPreferenceConstants.EDITOR_LINE_LENGTH_HINT, "Line Length Hint",
+ getFieldEditorParent());
addField(mEditorLineLengthHint);
-
+
// editor text size
mEditorTextSize = new IntegerFieldEditor(
- AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_TEXT_SIZE,
- "Editor Text Size", getFieldEditorParent());
+ AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_TEXT_SIZE, "Editor Text Size",
+ getFieldEditorParent());
addField(mEditorTextSize);
-
+
// load CAS with partial type system
BooleanFieldEditor editorPartialTypesystem = new BooleanFieldEditor(
- AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_PARTIAL_TYPESYSTEM,
- "Load CAS leniently (WARNING: only for experienced users)", getFieldEditorParent());
+ AnnotationEditorPreferenceConstants.ANNOTATION_EDITOR_PARTIAL_TYPESYSTEM,
+ "Load CAS leniently (WARNING: only for experienced users)", getFieldEditorParent());
addField(editorPartialTypesystem);
-
+
}
@Override
@@ -76,21 +75,19 @@ public class AnnotationEditorPreferencePage extends FieldEditorPreferencePage
@Override
protected void checkState() {
super.checkState();
-
+
if (mEditorLineLengthHint.getIntValue() > 0) {
setErrorMessage(null);
setValid(true);
- }
- else {
+ } else {
setErrorMessage("Line length hint must be a larger than zero!");
setValid(false);
}
-
+
if (mEditorTextSize.getIntValue() > 5) {
setErrorMessage(null);
setValid(true);
- }
- else {
+ } else {
setErrorMessage("Editor text size must be a larger than five!");
setValid(false);
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorSelection.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorSelection.java
index 4c4f947..20bbf87 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorSelection.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorSelection.java
@@ -25,7 +25,6 @@ import java.util.List;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.jface.viewers.IStructuredSelection;
-
/**
* The Class AnnotationEditorSelection.
*/
@@ -33,17 +32,20 @@ class AnnotationEditorSelection implements ITextSelection, IStructuredSelection
/** The text selection. */
private ITextSelection textSelection;
-
+
/** The structured selection. */
private IStructuredSelection structuredSelection;
-
+
/**
* Instantiates a new annotation editor selection.
*
- * @param textSelection the text selection
- * @param structuredSelection the structured selection
+ * @param textSelection
+ * the text selection
+ * @param structuredSelection
+ * the structured selection
*/
- AnnotationEditorSelection(ITextSelection textSelection, IStructuredSelection structuredSelection) {
+ AnnotationEditorSelection(ITextSelection textSelection,
+ IStructuredSelection structuredSelection) {
this.textSelection = textSelection;
this.structuredSelection = structuredSelection;
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorView.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorView.java
index bc3bd7a..669af64 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorView.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationEditorView.java
@@ -27,10 +27,8 @@ import org.eclipse.ui.part.MessagePage;
import org.eclipse.ui.part.PageBook;
import org.eclipse.ui.part.PageBookView;
-
/**
- * Base view for views which show information about the {@link CAS} opened
- * in the editor.
+ * Base view for views which show information about the {@link CAS} opened in the editor.
*/
public abstract class AnnotationEditorView extends PageBookView {
@@ -40,7 +38,8 @@ public abstract class AnnotationEditorView extends PageBookView {
/**
* Instantiates a new annotation editor view.
*
- * @param editorNotAvailableMessage the editor not available message
+ * @param editorNotAvailableMessage
+ * the editor not available message
*/
public AnnotationEditorView(String editorNotAvailableMessage) {
this.editorNotAvailableMessage = editorNotAvailableMessage;
@@ -58,7 +57,8 @@ public abstract class AnnotationEditorView extends PageBookView {
/**
* Do create page.
*
- * @param editor the editor
+ * @param editor
+ * the editor
* @return the page rec
*/
protected abstract PageRec doCreatePage(ICasEditor editor);
@@ -96,7 +96,8 @@ public abstract class AnnotationEditorView extends PageBookView {
/**
* Look at {@link IPartListener#partBroughtToTop(IWorkbenchPart)}.
*
- * @param part the part
+ * @param part
+ * the part
*/
@Override
public void partBroughtToTop(IWorkbenchPart part) {
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationInformationProvider.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationInformationProvider.java
index ca67902..2a8423e 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationInformationProvider.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationInformationProvider.java
@@ -29,19 +29,19 @@ import org.eclipse.jface.text.information.IInformationProvider;
import org.eclipse.jface.text.information.IInformationProviderExtension;
import org.eclipse.swt.graphics.Point;
-
/**
* TODO: move this class to external file.
*/
class AnnotationInformationProvider implements IInformationProvider, IInformationProviderExtension {
-
+
/** The m editor. */
private AnnotationEditor mEditor;
/**
* Instantiates a new annotation information provider.
*
- * @param editor the editor
+ * @param editor
+ * the editor
*/
AnnotationInformationProvider(AnnotationEditor editor) {
mEditor = editor;
@@ -50,8 +50,10 @@ class AnnotationInformationProvider implements IInformationProvider, IInformatio
/**
* TODO: add comment.
*
- * @param textViewer the text viewer
- * @param offset the offset
+ * @param textViewer
+ * the text viewer
+ * @param offset
+ * the offset
* @return the region
*/
@Override
@@ -65,8 +67,10 @@ class AnnotationInformationProvider implements IInformationProvider, IInformatio
/**
* TODO: add comment.
*
- * @param textViewer the text viewer
- * @param subject the subject
+ * @param textViewer
+ * the text viewer
+ * @param subject
+ * the subject
* @return null
*/
@Override
@@ -77,8 +81,10 @@ class AnnotationInformationProvider implements IInformationProvider, IInformatio
/**
* TODO: add comment.
*
- * @param textViewer the text viewer
- * @param subject the subject
+ * @param textViewer
+ * the text viewer
+ * @param subject
+ * the subject
* @return the selected annotation
*/
@Override
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationSelectionListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationSelectionListener.java
index 07466b3..94cab95 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationSelectionListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationSelectionListener.java
@@ -26,10 +26,9 @@ import org.eclipse.jface.viewers.ISelection;
import org.eclipse.ui.ISelectionListener;
import org.eclipse.ui.IWorkbenchPart;
-
/**
* TODO: add javadoc here.
-
+ *
*/
public abstract class AnnotationSelectionListener implements ISelectionListener {
@@ -40,7 +39,8 @@ public abstract class AnnotationSelectionListener implements ISelectionListener
/**
* Selected annotation.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
protected abstract void selectedAnnotation(Collection<AnnotationFS> annotations);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationStyle.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationStyle.java
index cf55623..721017e 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationStyle.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationStyle.java
@@ -27,8 +27,6 @@ import java.util.Objects;
import org.apache.uima.caseditor.core.model.DefaultColors;
import org.eclipse.jface.preference.IPreferenceStore;
-
-
/**
* The <code>AnnotationStyle</code> describes the look of an certain annotation type in the
* <code>AnnotationEditor</code>.
@@ -73,7 +71,7 @@ public final class AnnotationStyle {
* The bracket style.
*/
BRACKET,
-
+
/** The tag. */
TAG
}
@@ -105,22 +103,25 @@ public final class AnnotationStyle {
/** The configuration. */
private final String configuration;
-
+
/**
* Initialize a new instance.
*
- * @param annotation -
- * the annotation type
- * @param style -
- * the drawing style
- * @param color -
- * annotation color
+ * @param annotation
+ * - the annotation type
+ * @param style
+ * - the drawing style
+ * @param color
+ * - annotation color
*
- * @param layer - drawing layer
+ * @param layer
+ * - drawing layer
*
- * @param configuration the configuration string for the style or null if no configuration
+ * @param configuration
+ * the configuration string for the style or null if no configuration
*/
- public AnnotationStyle(String annotation, Style style, Color color, int layer, String configuration) {
+ public AnnotationStyle(String annotation, Style style, Color color, int layer,
+ String configuration) {
if (annotation == null || style == null || color == null) {
throw new IllegalArgumentException("parameters must be not null!");
@@ -141,15 +142,19 @@ public final class AnnotationStyle {
/**
* Instantiates a new annotation style.
*
- * @param annotation the annotation
- * @param style the style
- * @param color the color
- * @param layer the layer
+ * @param annotation
+ * the annotation
+ * @param style
+ * the style
+ * @param color
+ * the color
+ * @param layer
+ * the layer
*/
public AnnotationStyle(String annotation, Style style, Color color, int layer) {
this(annotation, style, color, layer, null);
}
-
+
/**
* Retrieves the annotation type.
*
@@ -194,11 +199,12 @@ public final class AnnotationStyle {
public String getConfiguration() {
return configuration;
}
-
+
/**
* Compares if current is equal to another object.
*
- * @param object the object
+ * @param object
+ * the object
* @return true, if successful
*/
@Override
@@ -209,7 +215,7 @@ public final class AnnotationStyle {
isEqual = true;
} else if (object instanceof AnnotationStyle) {
AnnotationStyle style = (AnnotationStyle) object;
-
+
boolean isConfigEqual = Objects.equals(configuration, style.configuration);
isEqual = annotation.equals(style.annotation) && this.style.equals(style.style)
@@ -245,144 +251,149 @@ public final class AnnotationStyle {
annotationStyle += " Config: " + getConfiguration();
return annotationStyle;
}
-
+
// TODO: Format must be redefined, so that only one key/string pair is needed to save it!
-
+
// key -> type name + ."style"
// value -> key/value pairs -> key=value; key=value;
// split on ";" and then split on = to parse values into a map
/**
* Serialize properties.
*
- * @param properties the properties
+ * @param properties
+ * the properties
* @return the string
*/
// maybe make a util which can save a String, String map to a line, and load it from String ...
private static String serializeProperties(Map<String, String> properties) {
-
+
StringBuilder configString = new StringBuilder();
-
+
for (Map.Entry<String, String> entry : properties.entrySet()) {
configString.append(entry.getKey().trim());
configString.append("=");
configString.append(entry.getValue().trim());
configString.append(";");
}
-
+
return configString.toString();
}
-
+
/**
* Parses the properties.
*
- * @param line the line
+ * @param line
+ * the line
* @return the map
*/
private static Map<String, String> parseProperties(String line) {
Map<String, String> properties = new HashMap<>();
-
+
String keyValueStrings[] = line.split(";");
-
+
for (String keyValueString : keyValueStrings) {
- String keyValuePair[] = keyValueString.split("=");
-
- if (keyValuePair.length == 2) {
- properties.put(keyValuePair[0], keyValuePair[1]);
- }
+ String keyValuePair[] = keyValueString.split("=");
+
+ if (keyValuePair.length == 2) {
+ properties.put(keyValuePair[0], keyValuePair[1]);
+ }
}
-
+
return properties;
}
-
+
/**
- * Note: This method must not be called by user code! It is only public because the migration
- * code in the Cas Editor Ide Plugin needs to access this method.
+ * Note: This method must not be called by user code! It is only public because the migration code
+ * in the Cas Editor Ide Plugin needs to access this method.
*
- * @param store the store
- * @param style the style
+ * @param store
+ * the store
+ * @param style
+ * the style
*/
public static void putAnnotatationStyleToStore(IPreferenceStore store, AnnotationStyle style) {
-
+
Color color = new Color(style.getColor().getRed(), style.getColor().getGreen(),
style.getColor().getBlue());
-
+
Map<String, String> styleProperties = new HashMap<>();
-
+
styleProperties.put("color", Integer.toString(color.getRGB()));
styleProperties.put("strategy", style.getStyle().toString());
styleProperties.put("layer", Integer.toString(style.getLayer()));
-
+
if (style.getConfiguration() != null) {
styleProperties.put("config", style.getConfiguration());
}
-
+
store.setValue(style.getAnnotation() + ".style", serializeProperties(styleProperties));
}
-
+
/**
* Retrieves an annotation style from the provided preference store.
* <p>
- * Note: This method must not be called by user code! It is only public because the migration
- * code in the Cas Editor Ide Plugin needs to access this method.
+ * Note: This method must not be called by user code! It is only public because the migration code
+ * in the Cas Editor Ide Plugin needs to access this method.
*
- * @param store the store
- * @param typeName the type name
+ * @param store
+ * the store
+ * @param typeName
+ * the type name
* @return an annotation style from the provided preference store
*/
- public static AnnotationStyle getAnnotationStyleFromStore(IPreferenceStore store, String typeName) {
-
+ public static AnnotationStyle getAnnotationStyleFromStore(IPreferenceStore store,
+ String typeName) {
+
Map<String, String> styleProperties = parseProperties(store.getString(typeName + ".style"));
-
- // initialize with random background style for the case if the store contains no style information
+
+ // initialize with random background style for the case if the store contains no style
+ // information
AnnotationStyle.Style style = AnnotationStyle.Style.BACKGROUND;
- int index = (int) Math.round(Math.random() * (DefaultColors.COLORS.length-1));
+ int index = (int) Math.round(Math.random() * (DefaultColors.COLORS.length - 1));
Color color = DefaultColors.COLORS[index];
-
+
String styleString = styleProperties.get("strategy");
if (styleString != null && styleString.length() != 0) {
// TODO: Might throw exception, catch it and use default!
try {
style = AnnotationStyle.Style.valueOf(styleString);
- }
- catch (IllegalArgumentException e) {
+ } catch (IllegalArgumentException e) {
}
}
-
-
+
String colorString = styleProperties.get("color");
if (colorString != null && colorString.length() != 0) {
try {
int colorInteger = Integer.parseInt(colorString);
color = new Color(colorInteger);
- }
- catch (NumberFormatException e) {
+ } catch (NumberFormatException e) {
}
}
-
+
int layer = 0;
-
+
String layerString = styleProperties.get("layer");
-
+
if (layerString != null && layerString.length() != 0) {
try {
layer = Integer.parseInt(layerString);
- }
- catch (NumberFormatException e) {
+ } catch (NumberFormatException e) {
}
}
-
+
String configuration = styleProperties.get("config");
-
+
if (configuration != null && configuration.length() != 0)
configuration = null;
-
- AnnotationStyle annotationStyle = new AnnotationStyle(typeName, style, color, layer, configuration);
-
+
+ AnnotationStyle annotationStyle = new AnnotationStyle(typeName, style, color, layer,
+ configuration);
+
// store style if it is not known yet
- if(styleProperties == null || styleProperties.isEmpty()) {
+ if (styleProperties == null || styleProperties.isEmpty()) {
putAnnotatationStyleToStore(store, annotationStyle);
}
-
+
return annotationStyle;
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationStyleChangeListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationStyleChangeListener.java
index 1e34a38..b085c44 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationStyleChangeListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/AnnotationStyleChangeListener.java
@@ -25,23 +25,22 @@ import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
-
/**
- * Annotation Style Change Listener base class which converts annotation style change events from
- * a Preference Store to AnnotationStyle object change events.
+ * Annotation Style Change Listener base class which converts annotation style change events from a
+ * Preference Store to AnnotationStyle object change events.
* <p>
* An implementing class needs to override the annotationStylesChanged method.
*/
public abstract class AnnotationStyleChangeListener
- implements IPropertyChangeListener, IAnnotationStyleListener {
+ implements IPropertyChangeListener, IAnnotationStyleListener {
@Override
public void propertyChange(PropertyChangeEvent event) {
if (event.getProperty().endsWith(".style")) {
// extract type name ...
String typeName = event.getProperty().substring(0, event.getProperty().lastIndexOf(".style"));
- AnnotationStyle style = AnnotationStyle.getAnnotationStyleFromStore(
- (IPreferenceStore) event.getSource(), typeName);
+ AnnotationStyle style = AnnotationStyle
+ .getAnnotationStyleFromStore((IPreferenceStore) event.getSource(), typeName);
annotationStylesChanged(Collections.singleton(style));
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ArrayValue.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ArrayValue.java
index 7c13dd5..f612a3f 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ArrayValue.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ArrayValue.java
@@ -32,7 +32,6 @@ import org.apache.uima.cas.StringArrayFS;
import org.apache.uima.cas.text.AnnotationFS;
import org.eclipse.core.runtime.IAdaptable;
-
/**
* The Class ArrayValue.
*/
@@ -47,8 +46,10 @@ public class ArrayValue implements IAdaptable {
/**
* Instantiates a new array value.
*
- * @param arrayFS the array FS
- * @param slot the slot
+ * @param arrayFS
+ * the array FS
+ * @param slot
+ * the slot
*/
public ArrayValue(FeatureStructure arrayFS, int slot) {
@@ -81,7 +82,8 @@ public class ArrayValue implements IAdaptable {
/**
* Sets the.
*
- * @param value the value
+ * @param value
+ * the value
*/
public void set(String value) {
@@ -161,7 +163,8 @@ public class ArrayValue implements IAdaptable {
}
@Override
- public Object getAdapter(@SuppressWarnings("rawtypes") Class adapter) {
+ public Object getAdapter(@SuppressWarnings("rawtypes")
+ Class adapter) {
if (FeatureStructure.class.equals(adapter)) {
if (arrayFS instanceof ArrayFS) {
@@ -184,6 +187,6 @@ public class ArrayValue implements IAdaptable {
@Override
public String toString() {
- return Integer.toString(slot()) ;
+ return Integer.toString(slot());
}
}
\ No newline at end of file
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasDocumentProvider.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasDocumentProvider.java
index 1f88e13..1f1488c 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasDocumentProvider.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasDocumentProvider.java
@@ -32,7 +32,6 @@ import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.texteditor.IElementStateListener;
-
/**
* Provides the {@link org.apache.uima.caseditor.editor.ICasDocument} for the
* {@link AnnotationEditor}.
@@ -46,7 +45,7 @@ public abstract class CasDocumentProvider {
* The Class ElementInfo.
*/
protected static class ElementInfo {
-
+
/** The reference count. */
public int referenceCount;
@@ -56,7 +55,8 @@ public abstract class CasDocumentProvider {
/**
* Instantiates a new element info.
*
- * @param element the element
+ * @param element
+ * the element
*/
protected ElementInfo(Object element) {
this.element = element;
@@ -82,7 +82,8 @@ public abstract class CasDocumentProvider {
/**
* Creates the element info.
*
- * @param element the element
+ * @param element
+ * the element
* @return the element info
*/
protected ElementInfo createElementInfo(Object element) {
@@ -92,8 +93,10 @@ public abstract class CasDocumentProvider {
/**
* Dispose element info.
*
- * @param element the element
- * @param info the info
+ * @param element
+ * the element
+ * @param info
+ * the info
*/
protected void disposeElementInfo(Object element, ElementInfo info) {
}
@@ -102,20 +105,27 @@ public abstract class CasDocumentProvider {
* Creates the a new {@link AnnotationDocument} from the given {@link IEditorInput} element. For
* all other elements null is returned.
*
- * @param element the element
+ * @param element
+ * the element
* @return the i cas document
- * @throws CoreException the core exception
+ * @throws CoreException
+ * the core exception
*/
protected abstract ICasDocument createDocument(Object element) throws CoreException;
/**
* Do save document.
*
- * @param monitor the monitor
- * @param element the element
- * @param document the document
- * @param overwrite the overwrite
- * @throws CoreException the core exception
+ * @param monitor
+ * the monitor
+ * @param element
+ * the element
+ * @param document
+ * the document
+ * @param overwrite
+ * the overwrite
+ * @throws CoreException
+ * the core exception
*/
protected abstract void doSaveDocument(IProgressMonitor monitor, Object element,
ICasDocument document, boolean overwrite) throws CoreException;
@@ -123,7 +133,8 @@ public abstract class CasDocumentProvider {
/**
* Gets the status.
*
- * @param element the element
+ * @param element
+ * the element
* @return the status
*/
public IStatus getStatus(Object element) {
@@ -135,8 +146,10 @@ public abstract class CasDocumentProvider {
* relation to the type system, e.g. an ide plugin could save a preference file next to the type
* system file.
*
- * @param element the element
- * @return the preference store or null if it cannot be retrieved, e.g no document was created for the input.
+ * @param element
+ * the element
+ * @return the preference store or null if it cannot be retrieved, e.g no document was created for
+ * the input.
*/
// Problem: Keys maybe should be pre-fixed depending on the plugin which is storing values
// TODO: Should it be renamed to getPersistentPreferenceStore?
@@ -145,7 +158,8 @@ public abstract class CasDocumentProvider {
/**
* Save type system preference store.
*
- * @param element the element
+ * @param element
+ * the element
*/
// Might fail silently, only log an error
public abstract void saveTypeSystemPreferenceStore(Object element);
@@ -154,7 +168,8 @@ public abstract class CasDocumentProvider {
* Retrieves the session preference store. This preference store is used to store session data
* which should be used to initialize a freshly opened editor.
*
- * @param element the element
+ * @param element
+ * the element
* @return the session preference store
*/
public abstract IPreferenceStore getSessionPreferenceStore(Object element);
@@ -169,9 +184,12 @@ public abstract class CasDocumentProvider {
/**
* Creates the type system selector form.
*
- * @param editor the editor
- * @param parent the parent
- * @param status the status
+ * @param editor
+ * the editor
+ * @param parent
+ * the parent
+ * @param status
+ * the status
* @return the composite
*/
public abstract Composite createTypeSystemSelectorForm(ICasEditor editor, Composite parent,
@@ -180,7 +198,8 @@ public abstract class CasDocumentProvider {
/**
* Adds the element state listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
public void addElementStateListener(IElementStateListener listener) {
elementStateListeners.add(listener);
@@ -189,7 +208,8 @@ public abstract class CasDocumentProvider {
/**
* Removes the element state listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
public void removeElementStateListener(IElementStateListener listener) {
elementStateListeners.remove(listener);
@@ -198,7 +218,8 @@ public abstract class CasDocumentProvider {
/**
* Fire element deleted.
*
- * @param element the element
+ * @param element
+ * the element
*/
protected void fireElementDeleted(Object element) {
for (IElementStateListener listener : elementStateListeners) {
@@ -209,7 +230,8 @@ public abstract class CasDocumentProvider {
/**
* Fire element changed.
*
- * @param element the element
+ * @param element
+ * the element
*/
protected void fireElementChanged(Object element) {
for (IElementStateListener listener : elementStateListeners) {
@@ -220,8 +242,10 @@ public abstract class CasDocumentProvider {
/**
* Fire element dirty state changed.
*
- * @param element the element
- * @param isDirty the is dirty
+ * @param element
+ * the element
+ * @param isDirty
+ * the is dirty
*/
protected void fireElementDirtyStateChanged(Object element, boolean isDirty) {
for (IElementStateListener listener : elementStateListeners) {
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasDocumentProviderFactory.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasDocumentProviderFactory.java
index eb53f6f..95b475e 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasDocumentProviderFactory.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasDocumentProviderFactory.java
@@ -30,7 +30,6 @@ import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.Platform;
import org.eclipse.ui.IEditorInput;
-
/**
* Factory class to produce and lookup an appropriate document provider.
*/
@@ -46,14 +45,14 @@ class CasDocumentProviderFactory {
/** The document providers. */
// map class_name to provider
private Map<String, CasDocumentProvider> documentProviders = new HashMap<>();
-
+
/**
* Instantiates a new cas document provider factory.
*/
CasDocumentProviderFactory() {
- IConfigurationElement[] config =
- Platform.getExtensionRegistry().getConfigurationElementsFor(CAS_EDITOR_EXTENSION);
+ IConfigurationElement[] config = Platform.getExtensionRegistry()
+ .getConfigurationElementsFor(CAS_EDITOR_EXTENSION);
for (IConfigurationElement element : config) {
@@ -62,7 +61,7 @@ class CasDocumentProviderFactory {
// extract id element
String id = element.getAttribute("id");
String inputType = element.getAttribute("inputType");
-
+
Object documentProviderObject;
try {
documentProviderObject = element.createExecutableExtension("class");
@@ -70,7 +69,7 @@ class CasDocumentProviderFactory {
CasEditorPlugin.log("Failed to load document provider with id: " + id, e);
documentProviderObject = null;
}
-
+
if (documentProviderObject instanceof CasDocumentProvider) {
documentProviders.put(inputType, (CasDocumentProvider) documentProviderObject);
}
@@ -80,48 +79,49 @@ class CasDocumentProviderFactory {
}
/**
- * Looks up a document provider for the provided editor input.
- * The editor input type must be cast-able to the specified inputType.
- * The implementation tries first to map class types, and then interface types.
+ * Looks up a document provider for the provided editor input. The editor input type must be
+ * cast-able to the specified inputType. The implementation tries first to map class types, and
+ * then interface types.
*
- * @param input the input
+ * @param input
+ * the input
* @return the document provider
*/
CasDocumentProvider getDocumentProvider(IEditorInput input) {
// A class can have many types, they are defined by super classes
// and implemented interfaces
-
+
// First try to match the input type to the editor input type
// or one of its super class
List<Class<?>> classList = new ArrayList<>();
-
+
for (Class<?> inputClass = input.getClass(); inputClass != null;) {
classList.add(inputClass);
inputClass = inputClass.getSuperclass();
}
-
+
CasDocumentProvider provider = null;
for (Class<?> inputClass : classList) {
provider = documentProviders.get(inputClass.getName());
-
+
if (provider != null)
return provider;
}
-
+
// Now try to match an implemented interface to the input type
// either of the editor input class or for one of its super classes
if (provider == null) {
for (Class<?> inputClass : classList) {
for (Class<?> inputClassInterface : inputClass.getInterfaces()) {
provider = documentProviders.get(inputClassInterface.getName());
-
+
if (provider != null)
return provider;
}
}
}
-
+
return provider;
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorError.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorError.java
index a769aa6..e6dee5a 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorError.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorError.java
@@ -19,20 +19,19 @@
package org.apache.uima.caseditor.editor;
-
/**
* A general {@link RuntimeException} which is thrown if something unexpected happens.
*/
public class CasEditorError extends RuntimeException {
-
/** The Constant serialVersionUID. */
private static final long serialVersionUID = 1L;
/**
* Initializes the current instance.
*
- * @param message the message
+ * @param message
+ * the message
*/
public CasEditorError(String message) {
super(message);
@@ -41,8 +40,10 @@ public class CasEditorError extends RuntimeException {
/**
* Initializes the current instance.
*
- * @param message the message
- * @param cause the cause
+ * @param message
+ * the message
+ * @param cause
+ * the cause
*/
public CasEditorError(String message, Throwable cause) {
super(message, cause);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorView.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorView.java
index 6f9c77a..e662a8c 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorView.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorView.java
@@ -34,13 +34,11 @@ import org.eclipse.ui.part.MessagePage;
import org.eclipse.ui.part.PageBook;
import org.eclipse.ui.part.PageBookView;
-
/**
- * Base class for views which show information about the {@link CAS} opened
- * in the editor.
+ * Base class for views which show information about the {@link CAS} opened in the editor.
* <p>
- * The view page created with {@link #doCreatePage(ICasEditor)} will be disposed
- * and re-created on every Cas Editor input change or CAS view change.
+ * The view page created with {@link #doCreatePage(ICasEditor)} will be disposed and re-created on
+ * every Cas Editor input change or CAS view change.
* <p>
* In the case the view should no be re-created on a CAS view change
* {@link #isRecreatePageOnCASViewSwitch()} must be overridden and return false.
@@ -52,17 +50,16 @@ public abstract class CasEditorView extends PageBookView {
private final String editorNotAvailableMessage;
/** The editor listener map. */
- private Map<ICasEditor, ICasEditorInputListener> editorListenerMap =
- new HashMap<>();
-
+ private Map<ICasEditor, ICasEditorInputListener> editorListenerMap = new HashMap<>();
+
/** The document listener map. */
- private Map<ICasEditor, ICasDocumentListener> documentListenerMap =
- new HashMap<>();
-
+ private Map<ICasEditor, ICasDocumentListener> documentListenerMap = new HashMap<>();
+
/**
* Instantiates a new cas editor view.
*
- * @param editorNotAvailableMessage the editor not available message
+ * @param editorNotAvailableMessage
+ * the editor not available message
*/
public CasEditorView(String editorNotAvailableMessage) {
this.editorNotAvailableMessage = editorNotAvailableMessage;
@@ -72,14 +69,12 @@ public abstract class CasEditorView extends PageBookView {
* Implementors should overwrite if they want that. Default is false.
* <p>
* Note:<br>
- * The implementation uses the ICasDocumentListener.viewChanged event
- * to recognize view changes. If the view implementation also listens for
- * this event the view might already be disposed when the listener is called.
- * It is therefore strongly recommended either to listen for the event and
+ * The implementation uses the ICasDocumentListener.viewChanged event to recognize view changes.
+ * If the view implementation also listens for this event the view might already be disposed when
+ * the listener is called. It is therefore strongly recommended either to listen for the event and
* update the view or don't list for the event and rely on a page re-creation.
*
- * @return true if page should be disposed/re-created on CAS view change,
- * or false if not.
+ * @return true if page should be disposed/re-created on CAS view change, or false if not.
*/
protected boolean isRecreatePageOnCASViewSwitch() {
return false;
@@ -98,7 +93,8 @@ public abstract class CasEditorView extends PageBookView {
/**
* Do create page.
*
- * @param editor the editor
+ * @param editor
+ * the editor
* @return the i page book view page
*/
// Will be recreated on view switch (need a flag to disable that) and input cas switch
@@ -107,11 +103,13 @@ public abstract class CasEditorView extends PageBookView {
/**
* Creates the view page.
*
- * @param casViewPageBookedPage the cas view page booked page
- * @param editor the editor
+ * @param casViewPageBookedPage
+ * the cas view page booked page
+ * @param editor
+ * the editor
*/
- private void createViewPage( CasEditorViewPage casViewPageBookedPage, ICasEditor editor) {
-
+ private void createViewPage(CasEditorViewPage casViewPageBookedPage, ICasEditor editor) {
+
IPageBookViewPage page = doCreatePage(editor);
if (page != null) {
try {
@@ -119,10 +117,9 @@ public abstract class CasEditorView extends PageBookView {
} catch (PartInitException e) {
CasEditorPlugin.log(e);
}
-
+
casViewPageBookedPage.setCASViewPage(page);
- }
- else {
+ } else {
casViewPageBookedPage.setCASViewPage(null);
}
}
@@ -131,12 +128,13 @@ public abstract class CasEditorView extends PageBookView {
protected final PageRec doCreatePage(final IWorkbenchPart part) {
PageRec result = null;
-
+
if (part instanceof ICasEditor) {
final ICasEditor editor = (ICasEditor) part;
-
- final CasEditorViewPage casViewPageBookedPage = new CasEditorViewPage(editorNotAvailableMessage);
-
+
+ final CasEditorViewPage casViewPageBookedPage = new CasEditorViewPage(
+ editorNotAvailableMessage);
+
if (editor.getDocument() != null) {
ICasDocumentListener documentListener = new AbstractDocumentListener() {
@Override
@@ -146,48 +144,47 @@ public abstract class CasEditorView extends PageBookView {
}
}
};
-
+
editor.getDocument().addChangeListener(documentListener);
-
+
// remember on map
documentListenerMap.put(editor, documentListener);
}
-
+
ICasEditorInputListener inputListener = new ICasEditorInputListener() {
-
+
@Override
public void casDocumentChanged(IEditorInput oldInput, ICasDocument oldDocument,
IEditorInput newInput, ICasDocument newDocument) {
-
+
createViewPage(casViewPageBookedPage, editor);
-
+
ICasDocumentListener changeListener = documentListenerMap.get(editor);
-
+
if (changeListener != null) {
if (oldDocument != null)
oldDocument.removeChangeListener(changeListener);
-
+
if (newDocument != null)
newDocument.addChangeListener(changeListener);
}
-
+
}
};
editorListenerMap.put(editor, inputListener);
editor.addCasEditorInputListener(inputListener);
-
- // BUG: This does not work!
-
-
+
+ // BUG: This does not work!
+
initPage(casViewPageBookedPage);
-
+
casViewPageBookedPage.createControl(getPageBook());
-
+
createViewPage(casViewPageBookedPage, editor);
-
+
result = new PageRec(editor, casViewPageBookedPage);
}
-
+
return result;
}
@@ -198,23 +195,23 @@ public abstract class CasEditorView extends PageBookView {
@Override
protected void doDestroyPage(IWorkbenchPart part, PageRec pageRecord) {
-
+
if (part instanceof ICasEditor) {
ICasEditor editor = (ICasEditor) part;
ICasEditorInputListener editorListener = editorListenerMap.remove(part);
-
+
if (editorListener != null) {
editor.removeCasEditorInputListener(editorListener);
}
-
+
ICasDocumentListener documentListener = documentListenerMap.remove(part);
ICasDocument document = editor.getDocument();
-
+
if (documentListener != null && document != null) {
document.removeChangeListener(documentListener);
}
}
-
+
pageRecord.page.dispose();
pageRecord.dispose();
}
@@ -228,7 +225,8 @@ public abstract class CasEditorView extends PageBookView {
/**
* Look at {@link IPartListener#partBroughtToTop(IWorkbenchPart)}.
*
- * @param part the part
+ * @param part
+ * the part
*/
@Override
public void partBroughtToTop(IWorkbenchPart part) {
@@ -237,24 +235,22 @@ public abstract class CasEditorView extends PageBookView {
@Override
public void dispose() {
-
- for (Map.Entry<ICasEditor, ICasEditorInputListener> entry :
- editorListenerMap.entrySet()) {
+
+ for (Map.Entry<ICasEditor, ICasEditorInputListener> entry : editorListenerMap.entrySet()) {
entry.getKey().removeCasEditorInputListener(entry.getValue());
}
-
+
editorListenerMap.clear();
-
- for (Map.Entry<ICasEditor, ICasDocumentListener> entry :
- documentListenerMap.entrySet()) {
-
+
+ for (Map.Entry<ICasEditor, ICasDocumentListener> entry : documentListenerMap.entrySet()) {
+
ICasDocument document = entry.getKey().getDocument();
if (document != null)
document.removeChangeListener(entry.getValue());
}
-
+
documentListenerMap.clear();
-
+
super.dispose();
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorViewPage.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorViewPage.java
index 87471cb..dc0917b 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorViewPage.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CasEditorViewPage.java
@@ -41,7 +41,6 @@ import org.eclipse.ui.part.IPageBookViewPage;
import org.eclipse.ui.part.Page;
import org.eclipse.ui.part.PageBook;
-
/**
* The Class CasEditorViewPage.
*/
@@ -49,31 +48,32 @@ public class CasEditorViewPage extends Page implements ISelectionProvider {
/** The selection changed listeners. */
private ListenerList selectionChangedListeners = new ListenerList();
-
+
/** The not available message. */
private final String notAvailableMessage;
-
+
/** The book. */
protected PageBook book;
-
+
/** The cas view page. */
protected IPageBookViewPage casViewPage;
/** The sub action bar. */
private SubActionBars subActionBar;
-
+
/** The message text. */
private Text messageText;
-
+
/**
* Instantiates a new cas editor view page.
*
- * @param notAvailableMessage the not available message
+ * @param notAvailableMessage
+ * the not available message
*/
protected CasEditorViewPage(String notAvailableMessage) {
this.notAvailableMessage = notAvailableMessage;
}
-
+
/**
* Refresh action handlers.
*/
@@ -87,8 +87,7 @@ public class CasEditorViewPage extends Page implements ISelectionProvider {
if (newActionHandlers != null) {
Set<Map.Entry> keys = newActionHandlers.entrySet();
for (Map.Entry entry : keys) {
- actionBars.setGlobalActionHandler((String) entry.getKey(),
- (IAction) entry.getValue());
+ actionBars.setGlobalActionHandler((String) entry.getKey(), (IAction) entry.getValue());
}
}
}
@@ -104,19 +103,19 @@ public class CasEditorViewPage extends Page implements ISelectionProvider {
public void removeSelectionChangedListener(ISelectionChangedListener listener) {
selectionChangedListeners.remove(listener);
}
-
+
/**
* Selection changed.
*
- * @param event the event
+ * @param event
+ * the event
*/
public void selectionChanged(final SelectionChangedEvent event) {
-
+
for (Object listener : selectionChangedListeners.getListeners()) {
-
- final ISelectionChangedListener selectionChangedListener =
- (ISelectionChangedListener) listener;
-
+
+ final ISelectionChangedListener selectionChangedListener = (ISelectionChangedListener) listener;
+
SafeRunner.run(new SafeRunnable() {
@Override
public void run() {
@@ -125,13 +124,12 @@ public class CasEditorViewPage extends Page implements ISelectionProvider {
});
}
}
-
+
@Override
public ISelection getSelection() {
if (casViewPage != null && casViewPage.getSite().getSelectionProvider() != null) {
return casViewPage.getSite().getSelectionProvider().getSelection();
- }
- else {
+ } else {
return StructuredSelection.EMPTY;
}
}
@@ -142,72 +140,72 @@ public class CasEditorViewPage extends Page implements ISelectionProvider {
casViewPage.getSite().getSelectionProvider().setSelection(selection);
}
}
-
+
@Override
public void createControl(Composite parent) {
book = new PageBook(parent, SWT.NONE);
-
+
messageText = new Text(book, SWT.WRAP | SWT.READ_ONLY);
messageText.setBackground(parent.getShell().getBackground());
messageText.setText(notAvailableMessage);
-
+
getSite().setSelectionProvider(this);
-
+
// Page might be set before the page is initialized
initializeAndShowPage(casViewPage);
}
-
+
/**
- * Creates and shows the page, if page is null
- * the not available message will be shown.
+ * Creates and shows the page, if page is null the not available message will be shown.
*
- * @param page the page
+ * @param page
+ * the page
*/
protected void initializeAndShowPage(IPageBookViewPage page) {
if (book != null) {
if (page != null) {
page.createControl(book);
casViewPage = page;
-
+
// Note: If page is in background event listening must be disabled!
ISelectionProvider selectionProvider = page.getSite().getSelectionProvider();
selectionProvider.addSelectionChangedListener(CasEditorViewPage.this::selectionChanged);
-
+
subActionBar = (SubActionBars) casViewPage.getSite().getActionBars();
-
+
casViewPage.setActionBars(subActionBar);
subActionBar.activate();
subActionBar.updateActionBars();
refreshActionHandlers();
-
+
book.showPage(page.getControl());
- }
- else {
+ } else {
book.showPage(messageText);
getSite().getActionBars().updateActionBars();
}
}
}
-
+
/**
* Sets the CAS view page.
*
- * @param page the new CAS view page
+ * @param page
+ * the new CAS view page
*/
public void setCASViewPage(IPageBookViewPage page) {
-
+
if (book != null && casViewPage != null) {
casViewPage.dispose();
subActionBar.dispose();
}
-
+
casViewPage = page;
-
+
initializeAndShowPage(page);
}
-
+
@Override
public Control getControl() {
return book;
@@ -217,7 +215,7 @@ public class CasEditorViewPage extends Page implements ISelectionProvider {
public void setFocus() {
book.setFocus();
}
-
+
@Override
public void dispose() {
super.dispose();
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ChangeModeAction.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ChangeModeAction.java
index 0be503e..13aa48b 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ChangeModeAction.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ChangeModeAction.java
@@ -22,7 +22,6 @@ package org.apache.uima.caseditor.editor;
import org.apache.uima.cas.Type;
import org.eclipse.jface.action.Action;
-
/**
* The {@link ChangeModeAction} changes the editor annotation mode to the newly selected one.
*/
@@ -40,9 +39,12 @@ final class ChangeModeAction extends Action {
/**
* Initializes a new instance.
*
- * @param newMode -target mode
- * @param name - name of the action
- * @param editor the editor
+ * @param newMode
+ * -target mode
+ * @param name
+ * - name of the action
+ * @param editor
+ * the editor
*/
ChangeModeAction(Type newMode, String name, AnnotationEditor editor) {
mMode = newMode;
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CustomInformationControl.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CustomInformationControl.java
index 07a0d93..c6a8fd3 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CustomInformationControl.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/CustomInformationControl.java
@@ -33,12 +33,12 @@ import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
-
/**
* TODO: add javadoc here.
*/
-public class CustomInformationControl implements IInformationControl, IInformationControlExtension2 {
-
+public class CustomInformationControl
+ implements IInformationControl, IInformationControlExtension2 {
+
/** The m shell. */
private Shell mShell;
@@ -51,8 +51,10 @@ public class CustomInformationControl implements IInformationControl, IInformati
/**
* Initializes a new instance.
*
- * @param parent the parent
- * @param contentHandler the content handler
+ * @param parent
+ * the parent
+ * @param contentHandler
+ * the content handler
*/
public CustomInformationControl(Shell parent,
ICustomInformationControlContentHandler contentHandler) {
@@ -68,7 +70,8 @@ public class CustomInformationControl implements IInformationControl, IInformati
/**
* Sets the viewer control.
*
- * @param viewerControl the new control
+ * @param viewerControl
+ * the new control
*/
public void setControl(Control viewerControl) {
mControl = viewerControl;
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/DocumentUimaImpl.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/DocumentUimaImpl.java
index 998ab4c..b4990e1 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/DocumentUimaImpl.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/DocumentUimaImpl.java
@@ -71,7 +71,6 @@ import org.eclipse.jdt.internal.core.JavaProject;
import org.eclipse.jdt.launching.JavaRuntime;
import org.eclipse.jface.preference.IPreferenceStore;
-
/**
* This document implementation is based on an uima cas object.
*/
@@ -79,7 +78,7 @@ public class DocumentUimaImpl extends AbstractDocument {
/** The Constant JAVA_NATURE. */
public static final String JAVA_NATURE = "org.eclipse.jdt.core.javanature";
-
+
/** The m CAS. */
private CAS mCAS;
@@ -92,10 +91,14 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Initializes a new instance.
*
- * @param cas the cas
- * @param casFile the cas file
- * @param typeSystemText type system string
- * @throws CoreException the core exception
+ * @param cas
+ * the cas
+ * @param casFile
+ * the cas file
+ * @param typeSystemText
+ * type system string
+ * @throws CoreException
+ * the core exception
*/
public DocumentUimaImpl(CAS cas, IFile casFile, String typeSystemText) throws CoreException {
mCAS = cas;
@@ -123,7 +126,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Internally removes an annotation from the {@link CAS}.
*
- * @param featureStructure the feature structure
+ * @param featureStructure
+ * the feature structure
*/
private void addFeatureStructureInternal(FeatureStructure featureStructure) {
getCAS().getIndexRepository().addFS(featureStructure);
@@ -132,7 +136,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Adds the given annotation to the {@link CAS}.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
@Override
public void addFeatureStructure(FeatureStructure annotation) {
@@ -155,7 +160,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Internally removes an annotation from the {@link CAS}.
*
- * @param featureStructure the feature structure
+ * @param featureStructure
+ * the feature structure
*/
private void removeAnnotationInternal(FeatureStructure featureStructure) {
getCAS().getIndexRepository().removeFS(featureStructure);
@@ -164,7 +170,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Removes the annotations from the {@link CAS}.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
@Override
public void removeFeatureStructure(FeatureStructure annotation) {
@@ -176,7 +183,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Removes the given annotations from the {@link CAS}.
*
- * @param annotationsToRemove the annotations to remove
+ * @param annotationsToRemove
+ * the annotations to remove
*/
@Override
public void removeFeatureStructures(Collection<? extends FeatureStructure> annotationsToRemove) {
@@ -193,7 +201,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Notifies clients about the changed annotation.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
@Override
public void update(FeatureStructure annotation) {
@@ -203,7 +212,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Notifies clients about the changed annotation.
*
- * @param annotations the annotations
+ * @param annotations
+ * the annotations
*/
@Override
public void updateFeatureStructure(Collection<? extends FeatureStructure> annotations) {
@@ -218,7 +228,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Retrieves annotations of the given type from the {@link CAS}.
*
- * @param type the type
+ * @param type
+ * the type
* @return the annotations
*/
@Override
@@ -236,7 +247,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Fs iterator to collection.
*
- * @param iterator the iterator
+ * @param iterator
+ * the iterator
* @return the collection
*/
static Collection<AnnotationFS> fsIteratorToCollection(FSIterator<AnnotationFS> iterator) {
@@ -253,7 +265,8 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Retrieves the given type from the {@link TypeSystem}.
*
- * @param type the type
+ * @param type
+ * the type
* @return the type
*/
@Override
@@ -273,8 +286,10 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Sets the content. The XCAS {@link InputStream} gets parsed.
*
- * @param casFile the new content
- * @throws CoreException the core exception
+ * @param casFile
+ * the new content
+ * @throws CoreException
+ * the core exception
*/
private void setContent(IFile casFile) throws CoreException {
@@ -298,8 +313,10 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Throw core exception.
*
- * @param e the e
- * @throws CoreException the core exception
+ * @param e
+ * the e
+ * @throws CoreException
+ * the core exception
*/
private void throwCoreException(Exception e) throws CoreException {
String message = e.getMessage() != null ? e.getMessage() : "";
@@ -310,8 +327,10 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Serializes the {@link CAS} to the given {@link OutputStream} in the XCAS format.
*
- * @param out the out
- * @throws CoreException the core exception
+ * @param out
+ * the out
+ * @throws CoreException
+ * the core exception
*/
public void serialize(OutputStream out) throws CoreException {
try {
@@ -320,13 +339,15 @@ public class DocumentUimaImpl extends AbstractDocument {
throwCoreException(e);
}
}
-
+
/**
* Gets the virgin CAS.
*
- * @param extensionTypeSystemFile the type system file
+ * @param extensionTypeSystemFile
+ * the type system file
* @return the virgin CAS
- * @throws CoreException the core exception
+ * @throws CoreException
+ * the core exception
*/
public static CAS getVirginCAS(IFile extensionTypeSystemFile) throws CoreException {
ResourceSpecifierFactory resourceSpecifierFactory = UIMAFramework.getResourceSpecifierFactory();
@@ -351,16 +372,15 @@ public class DocumentUimaImpl extends AbstractDocument {
IProject project = extensionTypeSystemFile.getProject();
ClassLoader classLoader = getProjectClassLoader(project);
-
+
ResourceManager resourceManager;
- if(classLoader != null) {
+ if (classLoader != null) {
resourceManager = new ResourceManager_impl(classLoader);
} else {
resourceManager = UIMAFramework.newDefaultResourceManager();
}
-
- String dataPath = project
- .getPersistentProperty((new QualifiedName("", "CDEdataPath")));
+
+ String dataPath = project.getPersistentProperty((new QualifiedName("", "CDEdataPath")));
if (dataPath != null) {
resourceManager.setDataPath(dataPath);
}
@@ -394,15 +414,17 @@ public class DocumentUimaImpl extends AbstractDocument {
/**
* Gets the project class loader.
*
- * @param project the project
+ * @param project
+ * the project
* @return the project class loader
- * @throws CoreException the core exception
+ * @throws CoreException
+ * the core exception
*/
public static ClassLoader getProjectClassLoader(IProject project) throws CoreException {
IProjectNature javaNature = project.getNature(JAVA_NATURE);
if (javaNature != null) {
JavaProject javaProject = (JavaProject) JavaCore.create(project);
-
+
String[] runtimeClassPath = JavaRuntime.computeDefaultRuntimeClassPath(javaProject);
List<URL> urls = new ArrayList<>();
for (String cp : runtimeClassPath) {
@@ -413,7 +435,7 @@ public class DocumentUimaImpl extends AbstractDocument {
}
}
return new URLClassLoader(urls.toArray(new URL[0]));
- }
+ }
return null;
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelection.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelection.java
index 66a14ff..9c24d98 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelection.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelection.java
@@ -29,13 +29,11 @@ import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.StructuredSelection;
-
-
/**
* The Class FeatureStructureSelection.
*/
public class FeatureStructureSelection {
-
+
/** The m feature structures. */
private List<FeatureStructure> mFeatureStructures;
@@ -43,14 +41,15 @@ public class FeatureStructureSelection {
* Initializes a the current instance with all FeatureStructure object that are contained in the
* {@link StructuredSelection}.
*
- * @param selection the selection
+ * @param selection
+ * the selection
*/
public FeatureStructureSelection(IStructuredSelection selection) {
mFeatureStructures = new ArrayList<>(selection.size());
for (Object item : selection.toList()) {
- FeatureStructure annotation = (FeatureStructure) Platform.getAdapterManager().getAdapter(
- item, FeatureStructure.class);
+ FeatureStructure annotation = (FeatureStructure) Platform.getAdapterManager().getAdapter(item,
+ FeatureStructure.class);
// TODO: fix it
if (annotation == null && item instanceof IAdaptable) {
@@ -94,6 +93,7 @@ public class FeatureStructureSelection {
/**
* Retrieves a human readable string.
+ *
* @return human readable string
*/
@Override
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelectionIterator.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelectionIterator.java
index 1bf60ad..7c8ad8c 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelectionIterator.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelectionIterator.java
@@ -27,7 +27,6 @@ import org.apache.uima.cas.text.AnnotationFS;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.jface.viewers.IStructuredSelection;
-
/**
* Iterates over all selected {@link FeatureStructure}s.
*/
@@ -42,7 +41,8 @@ public class FeatureStructureSelectionIterator implements Iterator<FeatureStruct
/**
* Initializes the current instance.
*
- * @param selection the selection
+ * @param selection
+ * the selection
*/
public FeatureStructureSelectionIterator(IStructuredSelection selection) {
mSelectionIterator = selection.iterator();
@@ -86,7 +86,8 @@ public class FeatureStructureSelectionIterator implements Iterator<FeatureStruct
/**
* Not supported, it throws an {@link UnsupportedOperationException}.
*
- * @throws UnsupportedOperationException -
+ * @throws UnsupportedOperationException
+ * -
*/
@Override
public void remove() {
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelectionProvider.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelectionProvider.java
index 59472f2..0f1bf77 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelectionProvider.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureStructureSelectionProvider.java
@@ -33,7 +33,6 @@ import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredSelection;
-
/**
* This class is a {@link ISelectionProvider} and informs its listeners about the currently selected
* {@link FeatureStructure}s.
@@ -49,7 +48,8 @@ class FeatureStructureSelectionProvider implements ISelectionProvider {
/**
* Adds an {@link ISelectionChangedListener} to this provider.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
@Override
public void addSelectionChangedListener(ISelectionChangedListener listener) {
@@ -82,7 +82,8 @@ class FeatureStructureSelectionProvider implements ISelectionProvider {
/**
* Sets the current selection.
*
- * @param selection the new selection
+ * @param selection
+ * the new selection
*/
@Override
public void setSelection(ISelection selection) {
@@ -100,8 +101,10 @@ class FeatureStructureSelectionProvider implements ISelectionProvider {
/**
* Sets the current selection to the given {@link AnnotationFS} object.
*
- * @param document the document
- * @param annotation the annotation
+ * @param document
+ * the document
+ * @param annotation
+ * the annotation
*/
public void setSelection(ICasDocument document, AnnotationFS annotation) {
if (annotation == null) {
@@ -114,8 +117,10 @@ class FeatureStructureSelectionProvider implements ISelectionProvider {
/**
* Sets the selection.
*
- * @param document the document
- * @param selection the selection
+ * @param document
+ * the document
+ * @param selection
+ * the selection
*/
public void setSelection(ICasDocument document, List<AnnotationFS> selection) {
setSelection(new StructuredSelection(ModelFeatureStructure.create(document, selection)));
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureValue.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureValue.java
index 0e05411..16ab07c 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureValue.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FeatureValue.java
@@ -19,7 +19,6 @@
package org.apache.uima.caseditor.editor;
-
import org.apache.uima.cas.Feature;
import org.apache.uima.cas.FeatureStructure;
import org.apache.uima.cas.text.AnnotationFS;
@@ -27,12 +26,11 @@ import org.apache.uima.caseditor.editor.util.Primitives;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IAdaptable;
-
/**
* The Class FeatureValue.
*/
public final class FeatureValue implements IAdaptable {
-
+
/** The m structure. */
private FeatureStructure mStructure;
@@ -42,14 +40,17 @@ public final class FeatureValue implements IAdaptable {
/**
* Initializes a new instance.
*
- * @param document the document
- * @param structure the structure
- * @param feature the feature
+ * @param document
+ * the document
+ * @param structure
+ * the structure
+ * @param feature
+ * the feature
*/
public FeatureValue(ICasDocument document, FeatureStructure structure, Feature feature) {
Assert.isNotNull(document);
// TODO: Remove document parameter ? Not needed anymore!
-
+
Assert.isNotNull(feature);
mFeature = feature;
@@ -80,7 +81,8 @@ public final class FeatureValue implements IAdaptable {
}
@Override
- public Object getAdapter(@SuppressWarnings("rawtypes") Class adapter) {
+ public Object getAdapter(@SuppressWarnings("rawtypes")
+ Class adapter) {
if (AnnotationFS.class.equals(adapter)) {
if (getValue() instanceof AnnotationFS) {
return getValue();
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FindAnnotateAction.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FindAnnotateAction.java
index ff5d797..bdc8bc4 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FindAnnotateAction.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FindAnnotateAction.java
@@ -23,7 +23,6 @@ import org.eclipse.jface.action.Action;
import org.eclipse.jface.text.IFindReplaceTarget;
import org.eclipse.swt.widgets.Display;
-
/**
* An Action to open the Find/Annotate Dialog.
*
@@ -33,15 +32,17 @@ public class FindAnnotateAction extends Action {
/** The editor. */
private AnnotationEditor editor;
-
+
/** The target. */
private IFindReplaceTarget target;
/**
* Instantiates a new find annotate action.
*
- * @param editor the editor
- * @param target the target
+ * @param editor
+ * the editor
+ * @param target
+ * the target
*/
FindAnnotateAction(AnnotationEditor editor, IFindReplaceTarget target) {
this.editor = editor;
@@ -50,8 +51,7 @@ public class FindAnnotateAction extends Action {
@Override
public void run() {
- FindAnnotateDialog dialog = new FindAnnotateDialog(
- Display.getCurrent().getActiveShell(),
+ FindAnnotateDialog dialog = new FindAnnotateDialog(Display.getCurrent().getActiveShell(),
editor.getDocument(), target, editor.getAnnotationMode());
dialog.open();
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FindAnnotateDialog.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FindAnnotateDialog.java
index 72a5ba8..7c8e1c2 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FindAnnotateDialog.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/FindAnnotateDialog.java
@@ -46,80 +46,80 @@ import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
-
/**
* A dialog to find and annotate a piece of text in the document.
*
- * TODO:
- * Add option to only search in text which is not covered by the annotation type.
- * Add buttons to modify annotation bounds
- * Match whole annotation: e.g. Token
- * Scope search in annotations of type
- * Add history to search field
+ * TODO: Add option to only search in text which is not covered by the annotation type. Add buttons
+ * to modify annotation bounds Match whole annotation: e.g. Token Scope search in annotations of
+ * type Add history to search field
*/
class FindAnnotateDialog extends Dialog {
/** The Constant FIND_BUTTON. */
private static final int FIND_BUTTON = 100;
-
+
/** The Constant ANNOTATE_FIND_BUTTON. */
private static final int ANNOTATE_FIND_BUTTON = 101;
-
+
/** The Constant ANNOTATE_BUTTON. */
private static final int ANNOTATE_BUTTON = 102;
-
+
/** The Constant ANNOTATE_ALL_BUTTON. */
private static final int ANNOTATE_ALL_BUTTON = 103;
-
+
/** The close button. */
private static int CLOSE_BUTTON = 104;
-
+
/** The find replace target. */
private final IFindReplaceTarget findReplaceTarget;
-
+
/** The document. */
private final ICasDocument document;
-
+
/** The mode type. */
private final Type modeType;
-
+
/** The find field. */
private Combo findField;
-
+
/** The type field. */
private TypeCombo typeField;
-
+
/** The wide left side button. */
private Button wideLeftSideButton;
-
+
/** The lower left side button. */
private Button lowerLeftSideButton;
-
+
/** The lower right side button. */
private Button lowerRightSideButton;
-
+
/** The wide right side button. */
private Button wideRightSideButton;
-
+
/** The forward radio button. */
private Button forwardRadioButton;
-
+
/**
- * Annotation created by the user with the Annotate button.
- * Contains null if no search was done or search was continued after
- * an annotation was created.
+ * Annotation created by the user with the Annotate button. Contains null if no search was done or
+ * search was continued after an annotation was created.
*/
private AnnotationFS currentAnnotation;
-
+
/**
* Instantiates a new find annotate dialog.
*
- * @param parentShell the parent shell
- * @param document the document
- * @param findReplaceTarget the find replace target
- * @param modeType the mode type
+ * @param parentShell
+ * the parent shell
+ * @param document
+ * the document
+ * @param findReplaceTarget
+ * the find replace target
+ * @param modeType
+ * the mode type
*/
- FindAnnotateDialog(Shell parentShell, ICasDocument document, IFindReplaceTarget findReplaceTarget, Type modeType) {
+ FindAnnotateDialog(Shell parentShell, ICasDocument document, IFindReplaceTarget findReplaceTarget,
+ Type modeType) {
super(parentShell);
this.document = document;
this.findReplaceTarget = findReplaceTarget;
@@ -141,21 +141,22 @@ class FindAnnotateDialog extends Dialog {
/**
* Creates the search string input field.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
private Composite createInputPanel(Composite parent) {
- Composite panel= new Composite(parent, SWT.NULL);
- GridLayout layout= new GridLayout();
- layout.numColumns= 2;
+ Composite panel = new Composite(parent, SWT.NULL);
+ GridLayout layout = new GridLayout();
+ layout.numColumns = 2;
panel.setLayout(layout);
// find label
- Label findLabel= new Label(panel, SWT.LEFT);
+ Label findLabel = new Label(panel, SWT.LEFT);
findLabel.setText("Find:");
GridData labelData = new GridData();
- labelData.horizontalAlignment = SWT.LEFT;
+ labelData.horizontalAlignment = SWT.LEFT;
findLabel.setLayoutData(labelData);
// find combo box
@@ -167,10 +168,10 @@ class FindAnnotateDialog extends Dialog {
findField.setLayoutData(findFieldData);
// type label
- Label typeLabel= new Label(panel, SWT.LEFT);
+ Label typeLabel = new Label(panel, SWT.LEFT);
typeLabel.setText("Type:");
GridData typeData = new GridData();
- typeData.horizontalAlignment = SWT.LEFT;
+ typeData.horizontalAlignment = SWT.LEFT;
typeLabel.setLayoutData(typeData);
typeField = new TypeCombo(panel);
@@ -189,7 +190,8 @@ class FindAnnotateDialog extends Dialog {
/**
* Creates the group to specify the direction of the search.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
private Composite createDirectionGroup(Composite parent) {
@@ -199,9 +201,9 @@ class FindAnnotateDialog extends Dialog {
layout.marginHeight = 0;
panel.setLayout(layout);
- Group group= new Group(panel, SWT.SHADOW_ETCHED_IN);
+ Group group = new Group(panel, SWT.SHADOW_ETCHED_IN);
group.setText("Direction");
- GridLayout groupLayout= new GridLayout();
+ GridLayout groupLayout = new GridLayout();
groupLayout.numColumns = 2;
group.setLayout(groupLayout);
group.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
@@ -210,7 +212,7 @@ class FindAnnotateDialog extends Dialog {
forwardRadioButton.setText("Forward");
forwardRadioButton.setSelection(true);
- Button backwardRadioButton= new Button(group, SWT.RADIO | SWT.LEFT);
+ Button backwardRadioButton = new Button(group, SWT.RADIO | SWT.LEFT);
backwardRadioButton.setText("Backward");
return panel;
@@ -219,7 +221,8 @@ class FindAnnotateDialog extends Dialog {
/**
* Creates the annotation buttons.
*
- * @param parent the parent
+ * @param parent
+ * the parent
*/
private void createAnnotationButtons(Composite parent) {
Composite panel = new Composite(parent, SWT.NONE);
@@ -228,19 +231,19 @@ class FindAnnotateDialog extends Dialog {
layout.marginHeight = 0;
panel.setLayout(layout);
- Group group= new Group(panel, SWT.SHADOW_ETCHED_IN);
+ Group group = new Group(panel, SWT.SHADOW_ETCHED_IN);
group.setText("Annotation");
- GridLayout groupLayout= new GridLayout();
+ GridLayout groupLayout = new GridLayout();
groupLayout.numColumns = 4;
group.setLayout(groupLayout);
group.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
wideLeftSideButton = new Button(group, SWT.PUSH | SWT.LEFT);
- wideLeftSideButton.setImage(CasEditorPlugin.getTaeImageDescriptor(
- Images.WIDE_LEFT_SIDE).createImage());
+ wideLeftSideButton
+ .setImage(CasEditorPlugin.getTaeImageDescriptor(Images.WIDE_LEFT_SIDE).createImage());
wideLeftSideButton.setEnabled(false);
-
- wideLeftSideButton.addSelectionListener(new SelectionListener(){
+
+ wideLeftSideButton.addSelectionListener(new SelectionListener() {
@Override
public void widgetDefaultSelected(SelectionEvent e) {
// never called, do not implement
@@ -251,12 +254,12 @@ class FindAnnotateDialog extends Dialog {
WideLeftAnnotationSideAction.wideLeftAnnotationSide(document, currentAnnotation);
}
});
-
+
lowerLeftSideButton = new Button(group, SWT.PUSH | SWT.LEFT);
- lowerLeftSideButton.setImage(CasEditorPlugin.getTaeImageDescriptor(
- Images.LOWER_LEFT_SIDE).createImage());
+ lowerLeftSideButton
+ .setImage(CasEditorPlugin.getTaeImageDescriptor(Images.LOWER_LEFT_SIDE).createImage());
lowerLeftSideButton.setEnabled(false);
- lowerLeftSideButton.addSelectionListener(new SelectionListener(){
+ lowerLeftSideButton.addSelectionListener(new SelectionListener() {
@Override
public void widgetDefaultSelected(SelectionEvent e) {
// never called, do not implement
@@ -269,10 +272,10 @@ class FindAnnotateDialog extends Dialog {
});
lowerRightSideButton = new Button(group, SWT.PUSH | SWT.LEFT);
- lowerRightSideButton.setImage(CasEditorPlugin.getTaeImageDescriptor(
- Images.LOWER_RIGHT_SIDE).createImage());
+ lowerRightSideButton
+ .setImage(CasEditorPlugin.getTaeImageDescriptor(Images.LOWER_RIGHT_SIDE).createImage());
lowerRightSideButton.setEnabled(false);
- lowerRightSideButton.addSelectionListener(new SelectionListener(){
+ lowerRightSideButton.addSelectionListener(new SelectionListener() {
@Override
public void widgetDefaultSelected(SelectionEvent e) {
// never called, do not implement
@@ -285,10 +288,10 @@ class FindAnnotateDialog extends Dialog {
});
wideRightSideButton = new Button(group, SWT.PUSH | SWT.LEFT);
- wideRightSideButton.setImage(CasEditorPlugin.getTaeImageDescriptor(
- Images.WIDE_RIGHT_SIDE).createImage());
+ wideRightSideButton
+ .setImage(CasEditorPlugin.getTaeImageDescriptor(Images.WIDE_RIGHT_SIDE).createImage());
wideRightSideButton.setEnabled(false);
- wideRightSideButton.addSelectionListener(new SelectionListener(){
+ wideRightSideButton.addSelectionListener(new SelectionListener() {
@Override
public void widgetDefaultSelected(SelectionEvent e) {
// never called, do not implement
@@ -316,7 +319,8 @@ class FindAnnotateDialog extends Dialog {
/**
* Creates the find and annotate buttons.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
private Composite createButtonSection(Composite parent) {
@@ -325,19 +329,19 @@ class FindAnnotateDialog extends Dialog {
GridLayout layout = new GridLayout();
// Number of columns should be 2, for each button added to the panel the
- // createButton methods increments numColumns. That means after adding
+ // createButton methods increments numColumns. That means after adding
// 3 buttons numColumns is 2.
layout.numColumns = -1;
panel.setLayout(layout);
- createButton(panel, FIND_BUTTON, "Fi&nd",true);
+ createButton(panel, FIND_BUTTON, "Fi&nd", true);
createButton(panel, ANNOTATE_FIND_BUTTON, "Annotate/Fin&d", false);
createButton(panel, ANNOTATE_BUTTON, "&Annotate", false);
- // createButton(panel, ANNOTATE_ALL_BUTTON, "Anno&tate All", false);
+ // createButton(panel, ANNOTATE_ALL_BUTTON, "Anno&tate All", false);
return panel;
}
@@ -345,29 +349,30 @@ class FindAnnotateDialog extends Dialog {
/**
* Creates the status and close button.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the composite
*/
private Composite createStatusAndCloseButton(Composite parent) {
- Composite panel= new Composite(parent, SWT.NULL);
- GridLayout layout= new GridLayout();
- layout.numColumns= 2;
- layout.marginWidth= 0;
- layout.marginHeight= 0;
+ Composite panel = new Composite(parent, SWT.NULL);
+ GridLayout layout = new GridLayout();
+ layout.numColumns = 2;
+ layout.marginWidth = 0;
+ layout.marginHeight = 0;
panel.setLayout(layout);
- Label statusLabel= new Label(panel, SWT.LEFT);
+ Label statusLabel = new Label(panel, SWT.LEFT);
GridData statusData = new GridData();
statusData.horizontalAlignment = SWT.FILL;
- statusData.grabExcessHorizontalSpace= true;
+ statusData.grabExcessHorizontalSpace = true;
statusLabel.setLayoutData(statusData);
Button closeButton = createButton(panel, CLOSE_BUTTON, "Close", false);
GridData closeData = new GridData();
closeData.horizontalAlignment = SWT.RIGHT;
closeButton.setLayoutData(closeData);
- // setGridData(closeButton, SWT.RIGHT, false, SWT.BOTTOM, false);
+ // setGridData(closeButton, SWT.RIGHT, false, SWT.BOTTOM, false);
return panel;
}
@@ -376,14 +381,14 @@ class FindAnnotateDialog extends Dialog {
protected Control createContents(Composite parent) {
Composite panel = new Composite(parent, SWT.NULL);
- GridLayout layout= new GridLayout();
- layout.numColumns= 1;
- layout.makeColumnsEqualWidth= true;
+ GridLayout layout = new GridLayout();
+ layout.numColumns = 1;
+ layout.makeColumnsEqualWidth = true;
panel.setLayout(layout);
Composite inputPanel = createInputPanel(panel);
GridData inputPanelData = new GridData();
- inputPanelData.horizontalAlignment = SWT.FILL;
+ inputPanelData.horizontalAlignment = SWT.FILL;
inputPanelData.grabExcessHorizontalSpace = true;
inputPanelData.verticalAlignment = SWT.TOP;
inputPanelData.grabExcessVerticalSpace = false;
@@ -392,7 +397,7 @@ class FindAnnotateDialog extends Dialog {
createDirectionGroup(panel);
createAnnotationButtons(panel);
-
+
Composite buttonFindAnnotatePanel = createButtonSection(panel);
GridData buttonFindAnnotatePanelData = new GridData();
buttonFindAnnotatePanelData.horizontalAlignment = SWT.RIGHT;
@@ -411,8 +416,7 @@ class FindAnnotateDialog extends Dialog {
}
/**
- * Finds the next occurrence of the search string and selects it in
- * the editor.
+ * Finds the next occurrence of the search string and selects it in the editor.
*/
private void findAndSelectNext() {
@@ -422,12 +426,12 @@ class FindAnnotateDialog extends Dialog {
if (isForwardSearch) {
textOffset = findReplaceTarget.getSelection().x + findReplaceTarget.getSelection().y;
- }
- else {
+ } else {
textOffset = findReplaceTarget.getSelection().x - 1;
}
- int result = findReplaceTarget.findAndSelect(textOffset, findField.getText(), isForwardSearch, false, false);
+ int result = findReplaceTarget.findAndSelect(textOffset, findField.getText(), isForwardSearch,
+ false, false);
if (result == -1) {
findReplaceTarget.findAndSelect(-1, findField.getText(), isForwardSearch, false, false);
@@ -442,11 +446,11 @@ class FindAnnotateDialog extends Dialog {
private AnnotationFS annotateSelection() {
Point selection = findReplaceTarget.getSelection();
- AnnotationFS newAnnotation = document.getCAS().createAnnotation(
- typeField.getType(), selection.x, selection.x + selection.y);
+ AnnotationFS newAnnotation = document.getCAS().createAnnotation(typeField.getType(),
+ selection.x, selection.x + selection.y);
document.getCAS().addFsToIndexes(newAnnotation);
document.addFeatureStructure(newAnnotation);
-
+
return newAnnotation;
}
@@ -456,27 +460,22 @@ class FindAnnotateDialog extends Dialog {
if (FIND_BUTTON == buttonID) {
findAndSelectNext();
currentAnnotation = null;
- }
- else if (ANNOTATE_BUTTON == buttonID) {
+ } else if (ANNOTATE_BUTTON == buttonID) {
currentAnnotation = annotateSelection();
- }
- else if (ANNOTATE_FIND_BUTTON == buttonID) {
+ } else if (ANNOTATE_FIND_BUTTON == buttonID) {
annotateSelection();
findAndSelectNext();
-
+
// TODO: Should be disabled when annotate was pressed
- }
- else if (ANNOTATE_ALL_BUTTON == buttonID) {
+ } else if (ANNOTATE_ALL_BUTTON == buttonID) {
// TODO: Should it be implemented ???
- }
- else if (CLOSE_BUTTON == buttonID) {
+ } else if (CLOSE_BUTTON == buttonID) {
close();
return;
- }
- else {
+ } else {
throw new TaeError("Unkown button!");
}
-
+
updateAnnotationButtons();
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IAnnotationEditorModifyListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IAnnotationEditorModifyListener.java
index c909151..03bfe71 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IAnnotationEditorModifyListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IAnnotationEditorModifyListener.java
@@ -23,29 +23,28 @@ import java.util.Collection;
import org.apache.uima.cas.Type;
-
/**
- * The listener interface for receiving IAnnotationEditorModify events.
- * The class that is interested in processing a IAnnotationEditorModify
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addIAnnotationEditorModifyListener</code> method. When
- * the IAnnotationEditorModify event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving IAnnotationEditorModify events. The class that is interested
+ * in processing a IAnnotationEditorModify event implements this interface, and the object created
+ * with that class is registered with a component using the component's
+ * <code>addIAnnotationEditorModifyListener</code> method. When the IAnnotationEditorModify event
+ * occurs, that object's appropriate method is invoked.
*/
public interface IAnnotationEditorModifyListener {
/**
* Called when the editor annotation mode changed.
*
- * @param newMode the new mode
+ * @param newMode
+ * the new mode
*/
void annotationModeChanged(Type newMode);
/**
* Called when the shown annotation types in the editor are changed.
*
- * @param shownAnnotationTypes the shown annotation types
+ * @param shownAnnotationTypes
+ * the shown annotation types
*/
void showAnnotationsChanged(Collection<Type> shownAnnotationTypes);
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IAnnotationStyleListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IAnnotationStyleListener.java
index fad810c..8897a30 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IAnnotationStyleListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IAnnotationStyleListener.java
@@ -21,22 +21,20 @@ package org.apache.uima.caseditor.editor;
import java.util.Collection;
-
/**
- * The listener interface for receiving IAnnotationStyle events.
- * The class that is interested in processing a IAnnotationStyle
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addIAnnotationStyleListener</code> method. When
- * the IAnnotationStyle event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving IAnnotationStyle events. The class that is interested in
+ * processing a IAnnotationStyle event implements this interface, and the object created with that
+ * class is registered with a component using the component's
+ * <code>addIAnnotationStyleListener</code> method. When the IAnnotationStyle event occurs, that
+ * object's appropriate method is invoked.
*/
public interface IAnnotationStyleListener {
-
+
/**
* Annotation styles changed.
*
- * @param styles the styles
+ * @param styles
+ * the styles
*/
void annotationStylesChanged(Collection<AnnotationStyle> styles);
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasDocument.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasDocument.java
index 74f66bf..cfa7d0f 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasDocument.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasDocument.java
@@ -26,7 +26,6 @@ import org.apache.uima.cas.FeatureStructure;
import org.apache.uima.cas.Type;
import org.apache.uima.cas.text.AnnotationFS;
-
/**
* The {@link ICasDocument} represents texts with meta information.
*
@@ -43,14 +42,16 @@ public interface ICasDocument {
/**
* Adds a given change listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
void addChangeListener(ICasDocumentListener listener);
/**
* Removes the given change listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
void removeChangeListener(ICasDocumentListener listener);
@@ -72,7 +73,8 @@ public interface ICasDocument {
/**
* Adds the {@link FeatureStructure}s.
*
- * @param structures the structures
+ * @param structures
+ * the structures
*/
void addFeatureStructures(Collection<? extends FeatureStructure> structures);
@@ -87,21 +89,24 @@ public interface ICasDocument {
/**
* Removes the given {@link FeatureStructure}s.
*
- * @param structuresToRemove the structures to remove
+ * @param structuresToRemove
+ * the structures to remove
*/
void removeFeatureStructures(Collection<? extends FeatureStructure> structuresToRemove);
/**
* Updates the given {@link FeatureStructure}.
*
- * @param structure the structure
+ * @param structure
+ * the structure
*/
void update(FeatureStructure structure);
/**
* Updates the given {@link FeatureStructure}s.
*
- * @param structures the structures
+ * @param structures
+ * the structures
*/
void updateFeatureStructure(Collection<? extends FeatureStructure> structures);
@@ -123,14 +128,16 @@ public interface ICasDocument {
/**
* Switches the view of the underlying CAS to the provided view name.
*
- * @param viewName the view name
+ * @param viewName
+ * the view name
*/
void switchView(String viewName);
/**
* Retrieves the requested type.
*
- * @param type the type
+ * @param type
+ * the type
* @return the type
*/
Type getType(String type);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasDocumentListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasDocumentListener.java
index 13e9bb6..1865437 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasDocumentListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasDocumentListener.java
@@ -23,7 +23,6 @@ import java.util.Collection;
import org.apache.uima.cas.FeatureStructure;
-
/**
* This interface is used to notifies clients about {@link FeatureStructure} changes.
*/
@@ -63,14 +62,16 @@ public interface ICasDocumentListener {
/**
* This method is called if the {@link FeatureStructure} changed.
*
- * @param featureStructure the feature structure
+ * @param featureStructure
+ * the feature structure
*/
void updated(FeatureStructure featureStructure);
/**
* This method is called if the {@link FeatureStructure}s changed.
*
- * @param featureStructure the feature structure
+ * @param featureStructure
+ * the feature structure
*/
void updated(Collection<FeatureStructure> featureStructure);
@@ -86,10 +87,11 @@ public interface ICasDocumentListener {
* does not indicate a structural change, but usually feature structures must be completely
* synchronized afterward.
*
- * @param oldViewName the old view name
- * @param newViewName the new view name
+ * @param oldViewName
+ * the old view name
+ * @param newViewName
+ * the new view name
*/
void viewChanged(String oldViewName, String newViewName);
-
}
\ No newline at end of file
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasEditor.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasEditor.java
index 38451c9..24395da 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasEditor.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasEditor.java
@@ -22,47 +22,48 @@ package org.apache.uima.caseditor.editor;
import org.apache.uima.cas.CAS;
import org.eclipse.ui.IEditorPart;
-
/**
- * A Cas Editor is an extension to the {@link IEditorPart} interface and
- * is responsible to view and edit a {@link CAS} object.
+ * A Cas Editor is an extension to the {@link IEditorPart} interface and is responsible to view and
+ * edit a {@link CAS} object.
*/
public interface ICasEditor extends IEditorPart {
-
+
// TODO: Add a method to get the document provider, could needed
- // by various views to store configuration linked to the ts!
-
+ // by various views to store configuration linked to the ts!
+
/**
* Gets the document.
*
* @return the document
*/
ICasDocument getDocument();
-
+
/**
* Gets the cas document provider.
*
* @return the cas document provider
*/
CasDocumentProvider getCasDocumentProvider();
-
+
/**
* Reopen editor with new type system.
*/
void reopenEditorWithNewTypeSystem();
-
+
/**
* Adds the cas editor input listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
void addCasEditorInputListener(ICasEditorInputListener listener);
-
+
/**
* Removes the cas editor input listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
void removeCasEditorInputListener(ICasEditorInputListener listener);
-
+
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasEditorInputListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasEditorInputListener.java
index 6f3fe55..5e2c825 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasEditorInputListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICasEditorInputListener.java
@@ -21,29 +21,30 @@ package org.apache.uima.caseditor.editor;
import org.eclipse.ui.IEditorInput;
-
/**
- * The listener interface for receiving ICasEditorInput events.
- * The class that is interested in processing a ICasEditorInput
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addICasEditorInputListener</code> method. When
- * the ICasEditorInput event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving ICasEditorInput events. The class that is interested in
+ * processing a ICasEditorInput event implements this interface, and the object created with that
+ * class is registered with a component using the component's
+ * <code>addICasEditorInputListener</code> method. When the ICasEditorInput event occurs, that
+ * object's appropriate method is invoked.
*/
public interface ICasEditorInputListener {
/**
- * This method is called if an {@link ICasDocument} is exchanged.
- * The arguments of this methods can be null under certain circumstances.
- * For example, if a document is opened where the type system cannot be found
- * for, then the new document will be null.
+ * This method is called if an {@link ICasDocument} is exchanged. The arguments of this methods
+ * can be null under certain circumstances. For example, if a document is opened where the type
+ * system cannot be found for, then the new document will be null.
*
- * @param oldInput the old input
- * @param oldDocument - the replaced, old document {@link ICasDocument}.
- * @param newInput the new input
- * @param newDocument - the new, current document {@link ICasDocument}.
+ * @param oldInput
+ * the old input
+ * @param oldDocument
+ * - the replaced, old document {@link ICasDocument}.
+ * @param newInput
+ * the new input
+ * @param newDocument
+ * - the new, current document {@link ICasDocument}.
*/
- void casDocumentChanged(IEditorInput oldInput, ICasDocument oldDocument, IEditorInput newInput, ICasDocument newDocument);
-
+ void casDocumentChanged(IEditorInput oldInput, ICasDocument oldDocument, IEditorInput newInput,
+ ICasDocument newDocument);
+
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICustomInformationControlContentHandler.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICustomInformationControlContentHandler.java
index 3208c2c..e106871 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICustomInformationControlContentHandler.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ICustomInformationControlContentHandler.java
@@ -19,17 +19,18 @@
package org.apache.uima.caseditor.editor;
-
/**
* The Interface ICustomInformationControlContentHandler.
*/
public interface ICustomInformationControlContentHandler {
-
+
/**
* Sets the input object.
*
- * @param control the control
- * @param input the input
+ * @param control
+ * the control
+ * @param input
+ * the input
*/
void setInput(CustomInformationControl control, Object input);
}
\ No newline at end of file
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IEditorSelectionListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IEditorSelectionListener.java
index 6c8dba2..36b2b88 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IEditorSelectionListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/IEditorSelectionListener.java
@@ -19,15 +19,12 @@
package org.apache.uima.caseditor.editor;
-
/**
- * The listener interface for receiving IEditorSelection events.
- * The class that is interested in processing a IEditorSelection
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addIEditorSelectionListener</code> method. When
- * the IEditorSelection event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving IEditorSelection events. The class that is interested in
+ * processing a IEditorSelection event implements this interface, and the object created with that
+ * class is registered with a component using the component's
+ * <code>addIEditorSelectionListener</code> method. When the IEditorSelection event occurs, that
+ * object's appropriate method is invoked.
*/
public interface IEditorSelectionListener {
/**
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ModelFeatureStructure.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ModelFeatureStructure.java
index 229e8e4..dd5c0a0 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ModelFeatureStructure.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/ModelFeatureStructure.java
@@ -28,15 +28,11 @@ import org.apache.uima.cas.text.AnnotationFS;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.Platform;
-
/**
- * TODO:
- * set feature value to null
- * delete feature value structure
- * create feature value structure.
+ * TODO: set feature value to null delete feature value structure create feature value structure.
*/
public class ModelFeatureStructure implements IAdaptable {
-
+
/** The m document. */
private ICasDocument mDocument;
@@ -46,8 +42,10 @@ public class ModelFeatureStructure implements IAdaptable {
/**
* Initializes a new instance.
*
- * @param document the document
- * @param featureStructre the feature structre
+ * @param document
+ * the document
+ * @param featureStructre
+ * the feature structre
*/
public ModelFeatureStructure(ICasDocument document, FeatureStructure featureStructre) {
mDocument = document;
@@ -75,7 +73,8 @@ public class ModelFeatureStructure implements IAdaptable {
/**
* Sets the feature null.
*
- * @param feature the new feature null
+ * @param feature
+ * the new feature null
*/
public void setFeatureNull(Feature feature) {
mFeatureStructre.setFeatureValue(feature, null);
@@ -84,7 +83,8 @@ public class ModelFeatureStructure implements IAdaptable {
/**
* Delete feature value.
*
- * @param feature the feature
+ * @param feature
+ * the feature
*/
public void deleteFeatureValue(Feature feature) {
// get value and call remove
@@ -93,7 +93,8 @@ public class ModelFeatureStructure implements IAdaptable {
/**
* Creates the feature value.
*
- * @param feature the feature
+ * @param feature
+ * the feature
*/
public void createFeatureValue(Feature feature) {
// create, add and link
@@ -102,19 +103,22 @@ public class ModelFeatureStructure implements IAdaptable {
/**
* Creates the feature value array.
*
- * @param feature the feature
- * @param size the size
+ * @param feature
+ * the feature
+ * @param size
+ * the size
*/
public void createFeatureValueArray(Feature feature, int size) {
// create add and link
}
-
/**
* Creates the.
*
- * @param document the document
- * @param annotations the annotations
+ * @param document
+ * the document
+ * @param annotations
+ * the annotations
* @return the list
*/
public static List<ModelFeatureStructure> create(ICasDocument document,
@@ -129,7 +133,8 @@ public class ModelFeatureStructure implements IAdaptable {
}
@Override
- public Object getAdapter(@SuppressWarnings("rawtypes") Class adapter) {
+ public Object getAdapter(@SuppressWarnings("rawtypes")
+ Class adapter) {
if (FeatureStructure.class.equals(adapter)) {
return getStructre();
} else if (AnnotationFS.class.equals(adapter) && getStructre() instanceof AnnotationFS) {
@@ -151,8 +156,7 @@ public class ModelFeatureStructure implements IAdaptable {
if (obj == this) {
return true;
- }
- else if (obj instanceof ModelFeatureStructure) {
+ } else if (obj instanceof ModelFeatureStructure) {
ModelFeatureStructure foreignFS = (ModelFeatureStructure) obj;
return mFeatureStructre.equals(foreignFS.mFeatureStructre);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/QuickTypeSelectionDialog.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/QuickTypeSelectionDialog.java
index 9c47e00..93fdf0e 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/QuickTypeSelectionDialog.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/QuickTypeSelectionDialog.java
@@ -61,7 +61,6 @@ import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swt.widgets.TreeItem;
-
/**
* This is a lightweight popup dialog which creates an annotation of the chosen type.
*/
@@ -82,8 +81,10 @@ class QuickTypeSelectionDialog extends PopupDialog {
/**
* Initializes the current instance.
*
- * @param parent the parent
- * @param editor the editor
+ * @param parent
+ * the parent
+ * @param editor
+ * the editor
*/
@SuppressWarnings("deprecation")
QuickTypeSelectionDialog(Shell parent, AnnotationEditor editor) {
@@ -162,8 +163,10 @@ class QuickTypeSelectionDialog extends PopupDialog {
/**
* Put shortcut.
*
- * @param shortcut the shortcut
- * @param type the type
+ * @param shortcut
+ * the shortcut
+ * @param type
+ * the type
*/
private void putShortcut(Character shortcut, Type type) {
shortcutTypeMap.put(shortcut, type);
@@ -179,26 +182,26 @@ class QuickTypeSelectionDialog extends PopupDialog {
TypeSystem typeSystem = editor.getDocument().getCAS().getTypeSystem();
- List<Type> types =
- typeSystem.getProperlySubsumedTypes(typeSystem.getType(CAS.TYPE_NAME_ANNOTATION));
+ List<Type> types = typeSystem
+ .getProperlySubsumedTypes(typeSystem.getType(CAS.TYPE_NAME_ANNOTATION));
types.add(typeSystem.getType(CAS.TYPE_NAME_ANNOTATION));
-
+
return types.toArray(new Type[types.size()]);
}
/**
* Annotate and close.
*
- * @param annotationType the annotation type
+ * @param annotationType
+ * the annotation type
*/
private void annotateAndClose(Type annotationType) {
if (annotationType != null) {
Point textSelection = editor.getSelection();
- AnnotationFS annotation =
- editor.getDocument().getCAS().createAnnotation(annotationType, textSelection.x,
- textSelection.y);
+ AnnotationFS annotation = editor.getDocument().getCAS().createAnnotation(annotationType,
+ textSelection.x, textSelection.y);
editor.getDocument().addFeatureStructure(annotation);
@@ -226,8 +229,8 @@ class QuickTypeSelectionDialog extends PopupDialog {
separator.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
final TreeViewer typeTree = new TreeViewer(composite, SWT.SINGLE | SWT.V_SCROLL);
- typeTree.getControl().setLayoutData(
- new GridData(GridData.FILL_HORIZONTAL | GridData.FILL_VERTICAL));
+ typeTree.getControl()
+ .setLayoutData(new GridData(GridData.FILL_HORIZONTAL | GridData.FILL_VERTICAL));
typeTree.getControl().setFocus();
@@ -377,11 +380,11 @@ class QuickTypeSelectionDialog extends PopupDialog {
annotateAndClose((Type) selection.getFirstElement());
}
});
-
+
Collection<Type> shownAnnotationTypes = editor.getShownAnnotationTypes();
-
+
Type[] types = shownAnnotationTypes.toArray(new Type[shownAnnotationTypes.size()]);
-
+
typeTree.setInput(types);
ISelection modeSelection = new StructuredSelection(new Object[] { editor.getAnnotationMode() });
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/SubPageSite.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/SubPageSite.java
index 1c8e842..ee6f108 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/SubPageSite.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/SubPageSite.java
@@ -28,7 +28,6 @@ import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.SubActionBars;
import org.eclipse.ui.part.IPageSite;
-
/**
* The Class SubPageSite.
*/
@@ -36,34 +35,38 @@ public class SubPageSite implements IPageSite {
/** The site. */
private final IPageSite site;
-
+
/** The sub action bars. */
- private SubActionBars subActionBars;
-
+ private SubActionBars subActionBars;
+
/** The selection provider. */
private ISelectionProvider selectionProvider;
/**
* Instantiates a new sub page site.
*
- * @param site the site
+ * @param site
+ * the site
*/
public SubPageSite(IPageSite site) {
this.site = site;
}
-
+
@Override
- public boolean hasService(@SuppressWarnings("rawtypes") Class api) {
+ public boolean hasService(@SuppressWarnings("rawtypes")
+ Class api) {
return site.hasService(api);
}
@Override
- public Object getService(@SuppressWarnings("rawtypes") Class api) {
+ public Object getService(@SuppressWarnings("rawtypes")
+ Class api) {
return site.getService(api);
}
@Override
- public Object getAdapter(@SuppressWarnings("rawtypes") Class adapter) {
+ public Object getAdapter(@SuppressWarnings("rawtypes")
+ Class adapter) {
return site.getAdapter(adapter);
}
@@ -100,7 +103,7 @@ public class SubPageSite implements IPageSite {
@Override
public IActionBars getActionBars() {
-
+
if (subActionBars == null) {
subActionBars = new SubActionBars(site.getActionBars());
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/TextDocumentProvider.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/TextDocumentProvider.java
index 3a8b4d9..d2233c6 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/TextDocumentProvider.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/TextDocumentProvider.java
@@ -28,64 +28,66 @@ import org.eclipse.jface.text.source.IAnnotationModel;
import org.eclipse.ui.texteditor.AbstractDocumentProvider;
import org.eclipse.ui.texteditor.IElementStateListener;
-
/**
* The Class TextDocumentProvider.
*/
class TextDocumentProvider extends AbstractDocumentProvider {
-
+
/**
* The Class CasElementInfo.
*/
private class CasElementInfo extends AbstractDocumentProvider.ElementInfo {
-
+
/** The cas info. */
private CasDocumentProvider.ElementInfo casInfo;
-
+
/**
* Instantiates a new cas element info.
*
- * @param document the document
- * @param model the model
+ * @param document
+ * the document
+ * @param model
+ * the model
*/
public CasElementInfo(IDocument document, IAnnotationModel model) {
super(document, model);
}
}
-
+
/** The document provider. */
private final CasDocumentProvider documentProvider;
-
+
/**
* Instantiates a new text document provider.
*
- * @param documentProvider the document provider
+ * @param documentProvider
+ * the document provider
*/
public TextDocumentProvider(CasDocumentProvider documentProvider) {
this.documentProvider = documentProvider;
-
+
this.documentProvider.addElementStateListener(new IElementStateListener() {
-
+
@Override
public void elementMoved(Object originalElement, Object movedElement) {
fireElementMoved(originalElement, movedElement);
}
-
+
@Override
public void elementDirtyStateChanged(Object element, boolean isDirty) {
fireElementDirtyStateChanged(element, isDirty);
}
-
+
@Override
public void elementDeleted(Object element) {
fireElementDeleted(element);
}
-
+
@Override
public void elementContentReplaced(Object element) {
fireElementContentReplaced(element);
}
-
+
@Override
public void elementContentAboutToBeReplaced(Object element) {
fireElementContentAboutToBeReplaced(element);
@@ -100,14 +102,13 @@ class TextDocumentProvider extends AbstractDocumentProvider {
@Override
protected IDocument createDocument(Object element) throws CoreException {
- ICasDocument casDocument = documentProvider.createDocument(element);
-
+ ICasDocument casDocument = documentProvider.createDocument(element);
+
if (casDocument != null) {
AnnotationDocument document = new AnnotationDocument();
document.setDocument(casDocument);
return document;
- }
- else {
+ } else {
return null;
}
}
@@ -115,10 +116,11 @@ class TextDocumentProvider extends AbstractDocumentProvider {
@Override
protected void doSaveDocument(IProgressMonitor monitor, Object element, IDocument document,
boolean overwrite) throws CoreException {
-
+
if (document instanceof AnnotationDocument) {
AnnotationDocument annotationDocument = (AnnotationDocument) document;
- documentProvider.doSaveDocument(monitor, element, annotationDocument.getDocument(), overwrite);
+ documentProvider.doSaveDocument(monitor, element, annotationDocument.getDocument(),
+ overwrite);
}
// TODO:
// else throw exception ->
@@ -131,19 +133,19 @@ class TextDocumentProvider extends AbstractDocumentProvider {
@Override
protected ElementInfo createElementInfo(Object element) throws CoreException {
-
+
ElementInfo elementInfo = super.createElementInfo(element);
CasElementInfo casElementInfo = new CasElementInfo(elementInfo.fDocument, elementInfo.fModel);
casElementInfo.casInfo = documentProvider.createElementInfo(element);
-
+
return casElementInfo;
}
@Override
protected void disposeElementInfo(Object element, ElementInfo info) {
-
+
super.disposeElementInfo(element, info);
-
+
CasElementInfo casElementInfo = (CasElementInfo) info;
documentProvider.disposeElementInfo(element, casElementInfo.casInfo);
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/DeleteFeatureStructureAction.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/DeleteFeatureStructureAction.java
index 56fcce8..bdbd57a 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/DeleteFeatureStructureAction.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/DeleteFeatureStructureAction.java
@@ -19,25 +19,24 @@
package org.apache.uima.caseditor.editor.action;
-
import org.apache.uima.caseditor.editor.FeatureStructureSelection;
import org.apache.uima.caseditor.editor.ICasEditor;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.ui.actions.BaseSelectionListenerAction;
-
/**
* Deletes all selected annotations.
*/
public class DeleteFeatureStructureAction extends BaseSelectionListenerAction {
-
+
/** The editor. */
private ICasEditor editor;
/**
* Initializes the current instance.
*
- * @param editor the editor
+ * @param editor
+ * the editor
*/
public DeleteFeatureStructureAction(ICasEditor editor) {
super("DeleteAction");
@@ -49,8 +48,7 @@ public class DeleteFeatureStructureAction extends BaseSelectionListenerAction {
@Override
protected boolean updateSelection(IStructuredSelection selection) {
- FeatureStructureSelection featureStructures =
- new FeatureStructureSelection(selection);
+ FeatureStructureSelection featureStructures = new FeatureStructureSelection(selection);
return featureStructures.size() > 0;
}
@@ -61,8 +59,8 @@ public class DeleteFeatureStructureAction extends BaseSelectionListenerAction {
@Override
public void run() {
- FeatureStructureSelection featureStructures =
- new FeatureStructureSelection(getStructuredSelection());
+ FeatureStructureSelection featureStructures = new FeatureStructureSelection(
+ getStructuredSelection());
editor.getDocument().removeFeatureStructures(featureStructures.toList());
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/LowerLeftAnnotationSideAction.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/LowerLeftAnnotationSideAction.java
index bab3e05..418ec92 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/LowerLeftAnnotationSideAction.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/LowerLeftAnnotationSideAction.java
@@ -19,7 +19,6 @@
package org.apache.uima.caseditor.editor.action;
-
import org.apache.uima.cas.Feature;
import org.apache.uima.cas.Type;
import org.apache.uima.cas.text.AnnotationFS;
@@ -29,22 +28,22 @@ import org.apache.uima.caseditor.editor.util.AnnotationSelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.ui.actions.BaseSelectionListenerAction;
-
/**
* Lowers the left side of the currently selected annotation by one.
*/
public final class LowerLeftAnnotationSideAction extends BaseSelectionListenerAction {
-
+
/** The Constant ID. */
public static final String ID = "LowerLeftAnnotationSide";
-
+
/** The editor. */
private ICasEditor editor;
/**
* Initializes a new instance.
*
- * @param editor the editor
+ * @param editor
+ * the editor
*/
public LowerLeftAnnotationSideAction(ICasEditor editor) {
super(ID);
@@ -64,8 +63,10 @@ public final class LowerLeftAnnotationSideAction extends BaseSelectionListenerAc
/**
* Lower left annotation side.
*
- * @param document the document
- * @param annotation the annotation
+ * @param document
+ * the document
+ * @param annotation
+ * the annotation
*/
public static void lowerLeftAnnotationSide(ICasDocument document, AnnotationFS annotation) {
Type annotationType = annotation.getType();
@@ -77,7 +78,7 @@ public final class LowerLeftAnnotationSideAction extends BaseSelectionListenerAc
document.update(annotation);
}
-
+
/**
* Increases the begin index of an annotation by one.
*/
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/LowerRightAnnotationSideAction.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/LowerRightAnnotationSideAction.java
index a29cde0..67414cb 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/LowerRightAnnotationSideAction.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/LowerRightAnnotationSideAction.java
@@ -19,7 +19,6 @@
package org.apache.uima.caseditor.editor.action;
-
import org.apache.uima.cas.Feature;
import org.apache.uima.cas.Type;
import org.apache.uima.cas.text.AnnotationFS;
@@ -29,22 +28,22 @@ import org.apache.uima.caseditor.editor.util.AnnotationSelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.ui.actions.BaseSelectionListenerAction;
-
/**
* Lowers the right side of the currently selected annotation by one.
*/
public final class LowerRightAnnotationSideAction extends BaseSelectionListenerAction {
-
+
/** The Constant ID. */
public static final String ID = "LowerRightAnnotationSide";
-
+
/** The editor. */
private ICasEditor editor;
/**
* Initializes the current instance.
*
- * @param editor the editor
+ * @param editor
+ * the editor
*/
public LowerRightAnnotationSideAction(ICasEditor editor) {
super(ID);
@@ -64,21 +63,23 @@ public final class LowerRightAnnotationSideAction extends BaseSelectionListenerA
/**
* Lower right annotation side.
*
- * @param document the document
- * @param annotation the annotation
+ * @param document
+ * the document
+ * @param annotation
+ * the annotation
*/
public static void lowerRightAnnotationSide(ICasDocument document, AnnotationFS annotation) {
-
+
Type annotationType = annotation.getType();
Feature endFeature = annotationType.getFeatureByBaseName("end");
-
+
if (annotation.getBegin() < annotation.getEnd()) {
annotation.setIntValue(endFeature, annotation.getEnd() - 1);
}
-
+
document.update(annotation);
}
-
+
/**
* Decreases the end index of an annotation by one.
*/
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/MergeAnnotationAction.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/MergeAnnotationAction.java
index 5c7e9c3..a90f77c 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/MergeAnnotationAction.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/MergeAnnotationAction.java
@@ -19,7 +19,6 @@
package org.apache.uima.caseditor.editor.action;
-
import org.apache.uima.cas.CAS;
import org.apache.uima.cas.text.AnnotationFS;
import org.apache.uima.caseditor.editor.ICasDocument;
@@ -28,26 +27,26 @@ import org.apache.uima.caseditor.editor.util.AnnotationSelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.ui.actions.BaseSelectionListenerAction;
-
/**
* Merges two or more annotations.
*
- * TODO: also merge features - if one is null or primitive has default value take the the other one -
- * in conflict case do nothing
+ * TODO: also merge features - if one is null or primitive has default value take the the other one
+ * - in conflict case do nothing
*/
public class MergeAnnotationAction extends BaseSelectionListenerAction {
-
+
/** The editor. */
private ICasEditor editor;
/**
* Initializes the current instance.
*
- * @param editor the editor
+ * @param editor
+ * the editor
*/
public MergeAnnotationAction(ICasEditor editor) {
super("MergeAnnotationAction");
-
+
this.editor = editor;
setEnabled(false);
@@ -68,7 +67,7 @@ public class MergeAnnotationAction extends BaseSelectionListenerAction {
AnnotationSelection annotations = new AnnotationSelection(getStructuredSelection());
ICasDocument document = editor.getDocument();
-
+
CAS documentCAS = document.getCAS();
AnnotationFS mergedAnnotation = documentCAS.createAnnotation(annotations.getFirst().getType(),
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/WideLeftAnnotationSideAction.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/WideLeftAnnotationSideAction.java
index 45ccb72..0783ef4 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/WideLeftAnnotationSideAction.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/WideLeftAnnotationSideAction.java
@@ -19,7 +19,6 @@
package org.apache.uima.caseditor.editor.action;
-
import org.apache.uima.cas.Feature;
import org.apache.uima.cas.Type;
import org.apache.uima.cas.text.AnnotationFS;
@@ -29,22 +28,22 @@ import org.apache.uima.caseditor.editor.util.AnnotationSelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.ui.actions.BaseSelectionListenerAction;
-
/**
* Widens the left side of the currently selected annotation by one.
*/
public final class WideLeftAnnotationSideAction extends BaseSelectionListenerAction {
-
+
/** The Constant ID. */
public static final String ID = "WideLeftAnnotationSide";
-
+
/** The editor. */
private ICasEditor editor;
/**
* Initializes a new instance.
*
- * @param editor the editor
+ * @param editor
+ * the editor
*/
public WideLeftAnnotationSideAction(ICasEditor editor) {
super("WideLeftAnnotationSside");
@@ -62,11 +61,12 @@ public final class WideLeftAnnotationSideAction extends BaseSelectionListenerAct
}
/**
- * Widens the annotation and sends and sends an update notification
- * to the provided document.
+ * Widens the annotation and sends and sends an update notification to the provided document.
*
- * @param document the document
- * @param annotation the annotation
+ * @param document
+ * the document
+ * @param annotation
+ * the annotation
*/
public static void wideLeftAnnotationSide(ICasDocument document, AnnotationFS annotation) {
Type annotationType = annotation.getType();
@@ -78,7 +78,7 @@ public final class WideLeftAnnotationSideAction extends BaseSelectionListenerAct
document.update(annotation);
}
-
+
/**
* Decreases the begin index of an annotation by one.
*/
@@ -87,7 +87,7 @@ public final class WideLeftAnnotationSideAction extends BaseSelectionListenerAct
AnnotationSelection annotations = new AnnotationSelection(getStructuredSelection());
AnnotationFS annotation = annotations.getFirst();
-
+
wideLeftAnnotationSide(editor.getDocument(), annotation);
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/WideRightAnnotationSideAction.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/WideRightAnnotationSideAction.java
index 9f4f3ac..21df6e8 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/WideRightAnnotationSideAction.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/action/WideRightAnnotationSideAction.java
@@ -19,7 +19,6 @@
package org.apache.uima.caseditor.editor.action;
-
import org.apache.uima.cas.Feature;
import org.apache.uima.cas.Type;
import org.apache.uima.cas.text.AnnotationFS;
@@ -29,22 +28,22 @@ import org.apache.uima.caseditor.editor.util.AnnotationSelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.ui.actions.BaseSelectionListenerAction;
-
/**
* Widens the right side of the currently selected annotation by one.
*/
public final class WideRightAnnotationSideAction extends BaseSelectionListenerAction {
-
+
/** The Constant ID. */
public static final String ID = "WideRightAnnotationSide";
-
+
/** The editor. */
private ICasEditor editor;
/**
* Initializes a new instance.
*
- * @param editor the editor
+ * @param editor
+ * the editor
*/
public WideRightAnnotationSideAction(ICasEditor editor) {
super(ID);
@@ -64,20 +63,22 @@ public final class WideRightAnnotationSideAction extends BaseSelectionListenerAc
/**
* Wide right annotation side.
*
- * @param document the document
- * @param annotation the annotation
+ * @param document
+ * the document
+ * @param annotation
+ * the annotation
*/
public static void wideRightAnnotationSide(ICasDocument document, AnnotationFS annotation) {
Type annotationType = annotation.getType();
Feature endFeature = annotationType.getFeatureByBaseName("end");
-
+
if (annotation.getEnd() < document.getCAS().getDocumentText().length()) {
annotation.setIntValue(endFeature, annotation.getEnd() + 1);
}
-
+
document.update(annotation);
}
-
+
/**
* Increases the end index of an annotation by one.
*/
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BackgroundDrawingStrategy.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BackgroundDrawingStrategy.java
index f758f73..a6d9462 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BackgroundDrawingStrategy.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BackgroundDrawingStrategy.java
@@ -33,29 +33,34 @@ import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
-
/**
* Fills the background of an annotation.
*/
final class BackgroundDrawingStrategy implements IDrawingStrategy {
-
+
/**
* Fill the background of the given annotation in the specified color.
*
- * @param annotation the annotation
- * @param gc the gc
- * @param textWidget the text widget
- * @param offset the offset
- * @param length the length
- * @param color the color
+ * @param annotation
+ * the annotation
+ * @param gc
+ * the gc
+ * @param textWidget
+ * the text widget
+ * @param offset
+ * the offset
+ * @param length
+ * the length
+ * @param color
+ * the color
*/
@Override
- public void draw(Annotation annotation, GC gc, StyledText textWidget, int annotationBegin, int length,
- Color color) {
+ public void draw(Annotation annotation, GC gc, StyledText textWidget, int annotationBegin,
+ int length, Color color) {
if (length != 0) {
if (gc != null) {
- int annotationEnd = annotationBegin + length;
-
+ int annotationEnd = annotationBegin + length;
+
Rectangle bounds = textWidget.getTextBounds(annotationBegin, annotationEnd - 1);
// Selection in the text widget are drawn before the annotations are drawn,
@@ -63,80 +68,79 @@ final class BackgroundDrawingStrategy implements IDrawingStrategy {
// rectangle
//
// The annotation background to be drawn is a span which has a begin and end offset.
- // Inside the background are areas (spans) which should not be over drawn.
- // That can be visualized like this (annotation goes from first to last z, an
+ // Inside the background are areas (spans) which should not be over drawn.
+ // That can be visualized like this (annotation goes from first to last z, an
// X is the selection which should not be overdrawn):
//
// zzzzXXXzzzzXXXXzzzXX
//
// The z offsets should be drawn, the X offsets should not be overdrawn. That is solved
// by drawing for every z offset area one background rectangle.
-
+
List<Span> dontOverDrawSpans = new ArrayList<>();
-
+
Span annotationSpan = new Span(annotationBegin, length);
-
+
// add all style ranges to the list in the range of the annotation
for (StyleRange styleRange : textWidget.getStyleRanges(annotationBegin, length)) {
- Span styleRangeSpan = new Span(styleRange.start, styleRange.length);
- if (styleRangeSpan.getLength() > 0)
- dontOverDrawSpans.add(styleRangeSpan);
+ Span styleRangeSpan = new Span(styleRange.start, styleRange.length);
+ if (styleRangeSpan.getLength() > 0)
+ dontOverDrawSpans.add(styleRangeSpan);
}
-
+
// add text selection to the list if intersects with annotation
Point selection = textWidget.getSelection();
Span selectionSpan = new Span(selection.x, selection.y - selection.x);
if (annotationSpan.isIntersecting(selectionSpan) && selectionSpan.getLength() > 0) {
dontOverDrawSpans.add(selectionSpan);
}
-
+
Collections.sort(dontOverDrawSpans);
// TODO: Asks on mailing list for help ...
// strange that we need that here ...
- Collections.reverse(dontOverDrawSpans);
-
+ Collections.reverse(dontOverDrawSpans);
+
gc.setBackground(color);
-
+
if (dontOverDrawSpans.size() > 0) {
- int zBegin = annotationBegin;
- for (Span xSpan : dontOverDrawSpans) {
- if (xSpan.getLength() > 0 && zBegin < xSpan.getStart()) {
- Rectangle selectionBounds = textWidget.getTextBounds(zBegin, xSpan.getStart() -1);
- gc.fillRectangle(selectionBounds);
- }
-
- if (zBegin < xSpan.getEnd())
- zBegin = xSpan.getEnd();
- }
-
- // If the annotation ends with z offsets these must still be drawn
- if (zBegin < annotationEnd) {
- Rectangle selectionBounds = textWidget.getTextBounds(zBegin, annotationEnd -1);
- gc.fillRectangle(selectionBounds);
- }
- }
- else {
- Rectangle selectionBounds = textWidget.getTextBounds(annotationBegin, annotationEnd -1);
- gc.fillRectangle(selectionBounds);
+ int zBegin = annotationBegin;
+ for (Span xSpan : dontOverDrawSpans) {
+ if (xSpan.getLength() > 0 && zBegin < xSpan.getStart()) {
+ Rectangle selectionBounds = textWidget.getTextBounds(zBegin, xSpan.getStart() - 1);
+ gc.fillRectangle(selectionBounds);
+ }
+
+ if (zBegin < xSpan.getEnd())
+ zBegin = xSpan.getEnd();
+ }
+
+ // If the annotation ends with z offsets these must still be drawn
+ if (zBegin < annotationEnd) {
+ Rectangle selectionBounds = textWidget.getTextBounds(zBegin, annotationEnd - 1);
+ gc.fillRectangle(selectionBounds);
+ }
+ } else {
+ Rectangle selectionBounds = textWidget.getTextBounds(annotationBegin, annotationEnd - 1);
+ gc.fillRectangle(selectionBounds);
}
-
+
int end = annotationBegin + length - 1;
gc.setForeground(new Color(gc.getDevice(), 0, 0, 0));
-
+
// Instead of a tab draw textWidget.getTabs() spaces
String annotationText = textWidget.getText(annotationBegin, end);
-
+
if (annotationText.contains("\t")) {
- char replacementSpaces[] = new char[textWidget.getTabs()];
- for (int i = 0; i < replacementSpaces.length; i++) {
- replacementSpaces[i] = ' ';
- }
- annotationText = annotationText.replace(new String(new char[]{'\t'}), new String(replacementSpaces));
+ char replacementSpaces[] = new char[textWidget.getTabs()];
+ for (int i = 0; i < replacementSpaces.length; i++) {
+ replacementSpaces[i] = ' ';
+ }
+ annotationText = annotationText.replace(new String(new char[] { '\t' }),
+ new String(replacementSpaces));
}
gc.drawText(annotationText, bounds.x, bounds.y, true);
- }
- else {
+ } else {
textWidget.redrawRange(annotationBegin, length, true);
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BoxDrawingStrategy.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BoxDrawingStrategy.java
index 2ff0fac..8c8bda7 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BoxDrawingStrategy.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BoxDrawingStrategy.java
@@ -26,21 +26,26 @@ import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Rectangle;
-
/**
* Draws a box around an annotation.
*/
final class BoxDrawingStrategy implements IDrawingStrategy {
-
+
/**
* Draws a box around the given annotation.
*
- * @param annotation the annotation
- * @param gc the gc
- * @param textWidget the text widget
- * @param offset the offset
- * @param length the length
- * @param color the color
+ * @param annotation
+ * the annotation
+ * @param gc
+ * the gc
+ * @param textWidget
+ * the text widget
+ * @param offset
+ * the offset
+ * @param length
+ * the length
+ * @param color
+ * the color
*/
@Override
public void draw(Annotation annotation, GC gc, StyledText textWidget, int offset, int length,
@@ -52,21 +57,20 @@ final class BoxDrawingStrategy implements IDrawingStrategy {
gc.setForeground(color);
int correctedHeight;
-
+
if (bounds.height > 0) {
- correctedHeight = bounds.height -1;
- }
- else {
+ correctedHeight = bounds.height - 1;
+ } else {
correctedHeight = bounds.height;
}
-
+
int correctedWidth;
-
+
if (bounds.width > 0)
- correctedWidth = bounds.width -1;
+ correctedWidth = bounds.width - 1;
else
correctedWidth = bounds.width;
-
+
gc.drawRectangle(bounds.x, bounds.y, correctedWidth, correctedHeight);
} else {
textWidget.redrawRange(offset, length, true);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BracketDrawingStrategy.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BracketDrawingStrategy.java
index 7aef8f6..533e688 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BracketDrawingStrategy.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/BracketDrawingStrategy.java
@@ -27,24 +27,29 @@ import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Rectangle;
-
/**
* Draws brackets around an annotation.
*/
public class BracketDrawingStrategy implements IDrawingStrategy {
-
+
/** The Constant BRACKET_WIDTH. */
private static final int BRACKET_WIDTH = 3;
/**
* Draws an opening bracket to the begin and a closing bracket to the end of the given annotation.
*
- * @param annotation the annotation
- * @param gc the gc
- * @param textWidget the text widget
- * @param offset the offset
- * @param length the length
- * @param color the color
+ * @param annotation
+ * the annotation
+ * @param gc
+ * the gc
+ * @param textWidget
+ * the text widget
+ * @param offset
+ * the offset
+ * @param length
+ * the length
+ * @param color
+ * the color
*/
@Override
public void draw(Annotation annotation, GC gc, StyledText textWidget, int offset, int length,
@@ -60,8 +65,8 @@ public class BracketDrawingStrategy implements IDrawingStrategy {
boolean isDrawOpenBracket = annotationFS.getBegin() == offset;
if (isDrawOpenBracket) {
- gc.drawLine(bounds.x, bounds.y + bounds.height - 1, bounds.x + BRACKET_WIDTH, bounds.y
- + bounds.height - 1);
+ gc.drawLine(bounds.x, bounds.y + bounds.height - 1, bounds.x + BRACKET_WIDTH,
+ bounds.y + bounds.height - 1);
gc.drawLine(bounds.x, bounds.y, bounds.x, bounds.y + bounds.height - 1);
@@ -70,11 +75,11 @@ public class BracketDrawingStrategy implements IDrawingStrategy {
boolean isDrawCloseBracket = annotationFS.getEnd() == offset + length;
if (isDrawCloseBracket) {
- gc.drawLine(bounds.x + bounds.width, bounds.y + bounds.height - 1, bounds.x
- + bounds.width - BRACKET_WIDTH, bounds.y + bounds.height - 1);
+ gc.drawLine(bounds.x + bounds.width, bounds.y + bounds.height - 1,
+ bounds.x + bounds.width - BRACKET_WIDTH, bounds.y + bounds.height - 1);
- gc.drawLine(bounds.x + bounds.width - 1, bounds.y, bounds.x + bounds.width - 1, bounds.y
- + bounds.height - 1);
+ gc.drawLine(bounds.x + bounds.width - 1, bounds.y, bounds.x + bounds.width - 1,
+ bounds.y + bounds.height - 1);
gc.drawLine(bounds.x + bounds.width, bounds.y, bounds.x + bounds.width - BRACKET_WIDTH,
bounds.y);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/DrawingStyle.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/DrawingStyle.java
index 107ea61..f144ab4 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/DrawingStyle.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/DrawingStyle.java
@@ -26,24 +26,22 @@ import org.apache.uima.caseditor.editor.AnnotationStyle;
import org.apache.uima.caseditor.editor.AnnotationStyle.Style;
import org.eclipse.jface.text.source.AnnotationPainter.IDrawingStrategy;
-
/**
* A factory for drawing styles.
*
- * @see org.apache.uima.caseditor.editor.AnnotationStyle.Style
+ * @see org.apache.uima.caseditor.editor.AnnotationStyle.Style
*/
public class DrawingStyle {
/** The stateless styles. */
- private static Map<AnnotationStyle.Style, IDrawingStrategy> statelessStyles =
- new HashMap<>();
-
+ private static Map<AnnotationStyle.Style, IDrawingStrategy> statelessStyles = new HashMap<>();
+
static {
statelessStyles.put(Style.BACKGROUND, new BackgroundDrawingStrategy());
statelessStyles.put(Style.TEXT_COLOR, new TextColorDrawingStrategy());
statelessStyles.put(Style.TOKEN, new TokenDrawingStrategy());
// deprecated since 3.4, but minimum version is 3.3
- statelessStyles.put(Style.SQUIGGLES,
+ statelessStyles.put(Style.SQUIGGLES,
new org.eclipse.jface.text.source.AnnotationPainter.SquigglesStrategy());
statelessStyles.put(Style.BOX, new BoxDrawingStrategy());
statelessStyles.put(Style.UNDERLINE, new UnderlineDrawingStrategy());
@@ -59,17 +57,19 @@ public class DrawingStyle {
/**
* Retrieves the {@link IDrawingStrategy}.
*
- * @param style the style
+ * @param style
+ * the style
* @return the {@link IDrawingStrategy} or null if does not exist.
*/
public static IDrawingStrategy createStrategy(AnnotationStyle style) {
-
+
IDrawingStrategy strategy = statelessStyles.get(style.getStyle());
-
- if (strategy == null && Style.TAG.equals(style.getStyle()) && style.getConfiguration() != null) {
+
+ if (strategy == null && Style.TAG.equals(style.getStyle())
+ && style.getConfiguration() != null) {
strategy = new TagDrawingStrategy(style.getConfiguration());
}
-
+
return strategy;
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/EclipseAnnotationPeer.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/EclipseAnnotationPeer.java
index b0cd4e6..3eb7fd5 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/EclipseAnnotationPeer.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/EclipseAnnotationPeer.java
@@ -21,10 +21,9 @@ package org.apache.uima.caseditor.editor.annotation;
import org.apache.uima.cas.text.AnnotationFS;
-
/**
- * This class is used to provide additional information about the {@link AnnotationFS}
- * object to the custom drawing strategies.
+ * This class is used to provide additional information about the {@link AnnotationFS} object to the
+ * custom drawing strategies.
*/
public class EclipseAnnotationPeer extends org.eclipse.jface.text.source.Annotation {
@@ -34,7 +33,8 @@ public class EclipseAnnotationPeer extends org.eclipse.jface.text.source.Annotat
/**
* Initializes a new instance.
*
- * @param annotation the annotation
+ * @param annotation
+ * the annotation
*/
public EclipseAnnotationPeer(AnnotationFS annotation) {
super(annotation.getType().getName(), false, "");
@@ -50,7 +50,6 @@ public class EclipseAnnotationPeer extends org.eclipse.jface.text.source.Annotat
public AnnotationFS getAnnotationFS() {
return annotation;
}
-
@Override
public int hashCode() {
@@ -61,13 +60,11 @@ public class EclipseAnnotationPeer extends org.eclipse.jface.text.source.Annotat
public boolean equals(Object obj) {
if (obj == this) {
return true;
- }
- else if (obj instanceof EclipseAnnotationPeer) {
+ } else if (obj instanceof EclipseAnnotationPeer) {
EclipseAnnotationPeer peer = (EclipseAnnotationPeer) obj;
-
+
return annotation.equals(peer.annotation);
- }
- else {
+ } else {
return false;
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TagDrawingStrategy.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TagDrawingStrategy.java
index 7a180cb..1bcf1ac 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TagDrawingStrategy.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TagDrawingStrategy.java
@@ -30,127 +30,122 @@ import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
-
-
-
// TODO: Check if its possible to increase the space between characters,
/**
* The Class TagDrawingStrategy.
*/
-// or suggest to use mono space font for long tags ...
+// or suggest to use mono space font for long tags ...
class TagDrawingStrategy implements IDrawingStrategy {
/** The Constant TAG_FONT_SIZE. */
private static final int TAG_FONT_SIZE = 11;
-
+
/** The Constant MAX_LEFT_TAG_OVERLAP. */
private static final int MAX_LEFT_TAG_OVERLAP = 1;
-
+
/** The Constant MAX_RIGHT_TAG_OVERLAP. */
private static final int MAX_RIGHT_TAG_OVERLAP = 1;
-
+
/** The Constant TAG_OVERLAP. */
private static final int TAG_OVERLAP = MAX_LEFT_TAG_OVERLAP + MAX_RIGHT_TAG_OVERLAP;
-
+
/** The annotation drawing style. */
private IDrawingStrategy annotationDrawingStyle = new BoxDrawingStrategy();
-
+
/**
* The name of the feature to print.
*/
private final String featureName;
-
+
/**
* Instantiates a new tag drawing strategy.
*
- * @param featureName the feature name
+ * @param featureName
+ * the feature name
*/
TagDrawingStrategy(String featureName) {
-
+
if (featureName == null)
throw new IllegalArgumentException("featureName must not be null!");
-
+
this.featureName = featureName;
}
-
+
@Override
public void draw(Annotation annotation, GC gc, StyledText textWidget, int offset, int length,
Color color) {
-
+
// Always draw a box around the annotation itself
-
+
// TODO: It seems that the call to the box drawing strategy is rather
// expensive, test how fast it is when the box drawing is "inlined".
// The box drawing strategy could be changed to do the drawing via
// static methods
annotationDrawingStyle.draw(annotation, gc, textWidget, offset, length, color);
-
+
if (annotation instanceof EclipseAnnotationPeer) {
AnnotationFS annotationFS = ((EclipseAnnotationPeer) annotation).getAnnotationFS();
-
+
Feature feature = annotationFS.getType().getFeatureByBaseName(featureName);
-
+
if (feature != null && feature.getRange().isPrimitive()) {
-
+
String featureValue = annotationFS.getFeatureValueAsString(feature);
-
+
// Annotation can be rendered into multiple lines, always draw
// the tag in the first line where annotation starts
if (featureValue != null && annotationFS.getBegin() == offset) {
-
+
// Calculate how much overhang on both sides of the annotation for a tag is allowed
int lineIndex = textWidget.getLineAtOffset(offset);
int firstCharInLineOffset = textWidget.getOffsetAtLine(lineIndex);
-
+
int maxBeginOverhang;
if (firstCharInLineOffset == offset) {
maxBeginOverhang = 0;
- }
- else {
+ } else {
maxBeginOverhang = MAX_LEFT_TAG_OVERLAP;
}
-
+
int maxEndOverhang;
int lineLength;
int lineCount = textWidget.getLineCount();
- if (lineCount > lineIndex +1) {
+ if (lineCount > lineIndex + 1) {
int offsetNextLine = textWidget.getOffsetAtLine(lineIndex + 1);
- lineLength = offsetNextLine - firstCharInLineOffset -1;
- }
- else {
+ lineLength = offsetNextLine - firstCharInLineOffset - 1;
+ } else {
// Its the last line
lineLength = textWidget.getCharCount() - offset;
}
-
+
if ((firstCharInLineOffset + lineLength) == offset + length) {
maxEndOverhang = 0;
- }
- else {
+ } else {
maxEndOverhang = MAX_RIGHT_TAG_OVERLAP;
}
-
+
Rectangle bounds = textWidget.getTextBounds(offset, offset + length);
-
+
if (gc != null) {
int lastCharIndex;
-
+
if (length == 0)
lastCharIndex = offset;
else
lastCharIndex = offset + length - 1;
-
- Point annotationStringExtent = gc.stringExtent(
- textWidget.getText(offset, lastCharIndex));
-
+
+ Point annotationStringExtent = gc
+ .stringExtent(textWidget.getText(offset, lastCharIndex));
+
Font currentFont = gc.getFont();
-
+
// TODO: Figure out if that is safe
Font tagFont = new Font(currentFont.getDevice(), currentFont.getFontData()[0].getName(),
TAG_FONT_SIZE, currentFont.getFontData()[0].getStyle());
gc.setFont(tagFont);
gc.setForeground(color);
-
+
// Cutoffs the tag if two chars longer than annotation
// and replaces it with a scissor
int maxAllowedLength = length + maxBeginOverhang + maxEndOverhang;
@@ -159,66 +154,64 @@ class TagDrawingStrategy implements IDrawingStrategy {
// Trim featureValue to substring which is length -1 + scissor symbol
char scissorChar = (char) 0x2704;
featureValue = featureValue.substring(0, maxAllowedLength - 1) + scissorChar;
- }
- else
+ } else
// If zero length annotation, just draw nothing
featureValue = "";
}
-
+
// Drawing after the end of a line, and before the begin does not work ...
Point tagStringExtent = gc.stringExtent(featureValue);
-
+
int centerOfAnnotation = annotationStringExtent.x / 2;
int centerOfTag = tagStringExtent.x / 2;
-
+
// Tag can be positioned at three different places
// if there is an overhang on both side, its centered
int newX = bounds.x + centerOfAnnotation - centerOfTag;
-
+
// Figure out if there is an overhang allowed, and recalculate the position.
-
+
// No overhang means that the annotation is the first or last in the line,
// in this case the tag should be placed as close as possible to the begin
// or end of the annotation boundary.
-
- // if no overhang on the left side allowed,
+
+ // if no overhang on the left side allowed,
// the tag must start with the annotation bound
if (maxBeginOverhang == 0) {
newX = bounds.x;
}
- // if no overhang on the right side allowed,
+ // if no overhang on the right side allowed,
// the tag must end with the annotation bound
else if (maxEndOverhang == 0) {
newX = bounds.x + (annotationStringExtent.x - tagStringExtent.x);
}
-
+
// TODO: Might not be too safe, if bounds.height == 0,
// passed parameter could be -1
gc.drawString(featureValue, newX, bounds.y + bounds.height - 1, true);
gc.setFont(currentFont);
-
+
// After done using the tag font it must be disposed, otherwise
// eclipse on windows runs out of handles and crashes
tagFont.dispose();
} else {
-
+
// The area into which the tag will be drawn must be marked
// to be redrawn, that requires a calculation of that area.
-
+
// Note: Did not find a way to calculate the tag extent correctly here
// GC.stringExtent cannot be called, because the passed GC is null
- //
+ //
// The width is assumed to be the font size multiplied by the length
// of annotation string + TAG_OVERLAP, this is not optimal, but should give
// a little to large estimate
- //
+ //
// Note: It unknown what happens if a too big area is drawn
// Doesn't seem to cause a crash on OS X
// TODO: Test that on windows 7, Windows XP and Linux
-
- textWidget.redraw(bounds.x - TAG_FONT_SIZE * TAG_OVERLAP, bounds.y + bounds.height -1,
- TAG_FONT_SIZE * (length + TAG_OVERLAP),
- bounds.height, true);
+
+ textWidget.redraw(bounds.x - TAG_FONT_SIZE * TAG_OVERLAP, bounds.y + bounds.height - 1,
+ TAG_FONT_SIZE * (length + TAG_OVERLAP), bounds.height, true);
}
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TextColorDrawingStrategy.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TextColorDrawingStrategy.java
index 7d3b9f5..3c5bf33 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TextColorDrawingStrategy.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TextColorDrawingStrategy.java
@@ -26,14 +26,14 @@ import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Rectangle;
-
/**
* The Class TextColorDrawingStrategy.
*/
public class TextColorDrawingStrategy implements IDrawingStrategy {
@Override
- public void draw(Annotation annotation, GC gc, StyledText textWidget, int start, int length, Color color) {
+ public void draw(Annotation annotation, GC gc, StyledText textWidget, int start, int length,
+ Color color) {
if (length > 0) {
if (annotation instanceof EclipseAnnotationPeer) {
if (gc != null) {
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TokenDrawingStrategy.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TokenDrawingStrategy.java
index 6fb1add..c736405 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TokenDrawingStrategy.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/TokenDrawingStrategy.java
@@ -27,20 +27,21 @@ import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Rectangle;
-
/**
* The Class TokenDrawingStrategy.
*/
public class TokenDrawingStrategy implements IDrawingStrategy {
-
+
/** The Constant BRACKET_WIDTH. */
private static final int BRACKET_WIDTH = 5;
/**
* Checks if is whitespace.
*
- * @param text the text
- * @param offset the offset
+ * @param text
+ * the text
+ * @param offset
+ * the offset
* @return true, if is whitespace
*/
private static boolean isWhitespace(String text, int offset) {
@@ -60,9 +61,10 @@ public class TokenDrawingStrategy implements IDrawingStrategy {
boolean isDrawOpenBracket = annotationFS.getBegin() == offset;
// and no space before offset
- if (isDrawOpenBracket && offset > 1 && !isWhitespace(annotationFS.getCAS().getDocumentText(), offset - 1)) {
- gc.drawLine(bounds.x, bounds.y + bounds.height - 1, bounds.x + BRACKET_WIDTH, bounds.y
- + bounds.height - 1);
+ if (isDrawOpenBracket && offset > 1
+ && !isWhitespace(annotationFS.getCAS().getDocumentText(), offset - 1)) {
+ gc.drawLine(bounds.x, bounds.y + bounds.height - 1, bounds.x + BRACKET_WIDTH,
+ bounds.y + bounds.height - 1);
gc.drawLine(bounds.x, bounds.y, bounds.x, bounds.y + bounds.height - 1);
@@ -73,8 +75,8 @@ public class TokenDrawingStrategy implements IDrawingStrategy {
// and no space after offset
if (isDrawCloseBracket && offset + length < textWidget.getText().length()
&& !isWhitespace(annotationFS.getCAS().getDocumentText(), offset + length)) {
- gc.drawLine(bounds.x + bounds.width, bounds.y + bounds.height - 1, bounds.x
- + bounds.width - BRACKET_WIDTH, bounds.y + bounds.height - 1);
+ gc.drawLine(bounds.x + bounds.width, bounds.y + bounds.height - 1,
+ bounds.x + bounds.width - BRACKET_WIDTH, bounds.y + bounds.height - 1);
gc.drawLine(bounds.x + bounds.width - 1, bounds.y, bounds.x + bounds.width - 1,
bounds.y + bounds.height - 1);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/UnderlineDrawingStrategy.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/UnderlineDrawingStrategy.java
index a3e336a..af8a337 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/UnderlineDrawingStrategy.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/annotation/UnderlineDrawingStrategy.java
@@ -27,7 +27,6 @@ import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
-
/**
* Draws an line under an annotation.
*/
@@ -36,12 +35,18 @@ public class UnderlineDrawingStrategy implements IDrawingStrategy {
/**
* Draws a line under under a given annotation.
*
- * @param annotation the annotation
- * @param gc the gc
- * @param textWidget the text widget
- * @param offset the offset
- * @param length the length
- * @param color the color
+ * @param annotation
+ * the annotation
+ * @param gc
+ * the gc
+ * @param textWidget
+ * the text widget
+ * @param offset
+ * the offset
+ * @param length
+ * the length
+ * @param color
+ * the color
*/
@Override
public void draw(Annotation annotation, GC gc, StyledText textWidget, int offset, int length,
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/context/AnnotationEditingControl.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/context/AnnotationEditingControl.java
index 4d07235..b3927d6 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/context/AnnotationEditingControl.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/context/AnnotationEditingControl.java
@@ -25,13 +25,13 @@ import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
-
public class AnnotationEditingControl extends Composite {
/**
* Initializes the current instance.
*
- * @param parent the parent
+ * @param parent
+ * the parent
*/
public AnnotationEditingControl(Composite parent) {
super(parent, SWT.NONE);
@@ -47,7 +47,8 @@ public class AnnotationEditingControl extends Composite {
/**
* Display this feature structure.
*
- * @param structure the structure
+ * @param structure
+ * the structure
*/
public void displayFeatureStructure(FeatureStructure structure) {
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/context/AnnotationEditingControlCreator.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/context/AnnotationEditingControlCreator.java
index abee8d9..877e744 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/context/AnnotationEditingControlCreator.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/context/AnnotationEditingControlCreator.java
@@ -19,7 +19,6 @@
package org.apache.uima.caseditor.editor.context;
-
import org.apache.uima.cas.FeatureStructure;
import org.apache.uima.caseditor.editor.CustomInformationControl;
import org.apache.uima.caseditor.editor.ICustomInformationControlContentHandler;
@@ -27,7 +26,6 @@ import org.eclipse.jface.text.IInformationControl;
import org.eclipse.jface.text.IInformationControlCreator;
import org.eclipse.swt.widgets.Shell;
-
/**
* TODO: add javadoc here.
*/
@@ -36,7 +34,8 @@ public class AnnotationEditingControlCreator implements IInformationControlCreat
/**
* Creates the information control.
*
- * @param parent the parent
+ * @param parent
+ * the parent
* @return the new control
*/
@Override
@@ -57,8 +56,8 @@ public class AnnotationEditingControlCreator implements IInformationControlCreat
CustomInformationControl control = new CustomInformationControl(parent, contentHandler);
- AnnotationEditingControl annotationEditingControl = new AnnotationEditingControl(control
- .getParent());
+ AnnotationEditingControl annotationEditingControl = new AnnotationEditingControl(
+ control.getParent());
control.setControl(annotationEditingControl);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/IModeMenuListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/IModeMenuListener.java
index c187384..23983c5 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/IModeMenuListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/IModeMenuListener.java
@@ -21,22 +21,19 @@ package org.apache.uima.caseditor.editor.contextmenu;
import org.apache.uima.cas.Type;
-
/**
- * The listener interface for receiving IModeMenu events.
- * The class that is interested in processing a IModeMenu
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addIModeMenuListener</code> method. When
- * the IModeMenu event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving IModeMenu events. The class that is interested in processing
+ * a IModeMenu event implements this interface, and the object created with that class is registered
+ * with a component using the component's <code>addIModeMenuListener</code> method. When the
+ * IModeMenu event occurs, that object's appropriate method is invoked.
*/
public interface IModeMenuListener {
-
- /**
- * Mode was changed to a new mode.
- *
- * @param newMode the new mode
- */
- void modeChanged(Type newMode);
+
+ /**
+ * Mode was changed to a new mode.
+ *
+ * @param newMode
+ * the new mode
+ */
+ void modeChanged(Type newMode);
}
\ No newline at end of file
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/IShowAnnotationsListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/IShowAnnotationsListener.java
index 5955ba2..453e1a6 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/IShowAnnotationsListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/IShowAnnotationsListener.java
@@ -23,22 +23,20 @@ import java.util.Collection;
import org.apache.uima.cas.Type;
-
/**
- * The listener interface for receiving IShowAnnotations events.
- * The class that is interested in processing a IShowAnnotations
- * event implements this interface, and the object created
- * with that class is registered with a component using the
- * component's <code>addIShowAnnotationsListener</code> method. When
- * the IShowAnnotations event occurs, that object's appropriate
- * method is invoked.
+ * The listener interface for receiving IShowAnnotations events. The class that is interested in
+ * processing a IShowAnnotations event implements this interface, and the object created with that
+ * class is registered with a component using the component's
+ * <code>addIShowAnnotationsListener</code> method. When the IShowAnnotations event occurs, that
+ * object's appropriate method is invoked.
*/
public interface IShowAnnotationsListener {
-
- /**
- * Selection changed.
- *
- * @param selection the selection
- */
- void selectionChanged(Collection<Type> selection);
- }
\ No newline at end of file
+
+ /**
+ * Selection changed.
+ *
+ * @param selection
+ * the selection
+ */
+ void selectionChanged(Collection<Type> selection);
+}
\ No newline at end of file
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/ModeMenu.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/ModeMenu.java
index 14f5fc7..3c80d77 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/ModeMenu.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/ModeMenu.java
@@ -32,23 +32,24 @@ import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
-
/**
* Creates the mode context sub menu.
*/
public class ModeMenu extends TypeMenu {
-
+
/** The editor. */
private AnnotationEditor editor;
-
+
/** The listeners. */
private Set<IModeMenuListener> listeners = new HashSet<>();
/**
* Initializes a new instance.
*
- * @param typeSystem the type system
- * @param editor the editor
+ * @param typeSystem
+ * the type system
+ * @param editor
+ * the editor
*/
public ModeMenu(TypeSystem typeSystem, AnnotationEditor editor) {
super(typeSystem.getType(CAS.TYPE_NAME_ANNOTATION), typeSystem);
@@ -58,36 +59,38 @@ public class ModeMenu extends TypeMenu {
/**
* Adds the listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
public void addListener(IModeMenuListener listener) {
- listeners.add(listener);
+ listeners.add(listener);
}
-
+
/**
* Removes the listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
public void removeListener(IModeMenuListener listener) {
- listeners.remove(listener);
+ listeners.remove(listener);
}
@Override
protected void insertAction(final Type type, Menu parentMenu) {
MenuItem actionItem = new MenuItem(parentMenu, SWT.CHECK);
actionItem.setText(type.getName());
-
+
if (type.equals(editor.getAnnotationMode()))
- actionItem.setSelection(true);
-
+ actionItem.setSelection(true);
+
actionItem.addListener(SWT.Selection, new Listener() {
@Override
public void handleEvent(Event e) {
- for (IModeMenuListener listener : listeners) {
- listener.modeChanged(type);
- }
+ for (IModeMenuListener listener : listeners) {
+ listener.modeChanged(type);
+ }
}
});
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/ShowAnnotationsMenu.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/ShowAnnotationsMenu.java
index be40786..e779f87 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/ShowAnnotationsMenu.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/ShowAnnotationsMenu.java
@@ -34,167 +34,171 @@ import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
-
/**
* Creates the show annotations context sub menu.
*/
public class ShowAnnotationsMenu extends TypeMenu {
- /** The listeners. */
- private Set<IShowAnnotationsListener> listeners = new HashSet<>();
-
- /**
- * This collection contains all type names which are displayed in the
- * editor.
- */
- private Collection<Type> typesToDisplay = new HashSet<>();
-
- /**
- * Editor annotation mode type. This variable is only set if the editor
- * annotation mode type is not already included in the typesToDisplay
- * collection
- */
- private Type editorAnnotationMode;
-
- /**
- * Initializes a new instance.
- *
- * @param typeSystem the type system
- * @param shownTypes the shown types
- */
- public ShowAnnotationsMenu(TypeSystem typeSystem, Collection<Type> shownTypes) {
- super(typeSystem.getType(CAS.TYPE_NAME_ANNOTATION), typeSystem);
-
- typesToDisplay.addAll(shownTypes);
- }
-
- /**
- * Adds the listener.
- *
- * @param listener the listener
- */
- public void addListener(IShowAnnotationsListener listener) {
- listeners.add(listener);
- }
-
- /**
- * Removes the listener.
- *
- * @param listener the listener
- */
- public void removeListener(IShowAnnotationsListener listener) {
- listeners.remove(listener);
- }
-
- @Override
- protected void insertAction(final Type type, Menu parentMenu) {
- final MenuItem actionItem = new MenuItem(parentMenu, SWT.CHECK);
- actionItem.setText(type.getName());
-
- // TODO: find another way to select the annotation mode also
- if (editorAnnotationMode != null && editorAnnotationMode.equals(type)) {
- actionItem.setSelection(true);
- }
-
- if (typesToDisplay.contains(type)) {
- actionItem.setSelection(true);
- }
-
- // TODO: move this to an action
- // do not access mTypesToDisplay directly !!!
- actionItem.addListener(SWT.Selection, new Listener() {
- @Override
+ /** The listeners. */
+ private Set<IShowAnnotationsListener> listeners = new HashSet<>();
+
+ /**
+ * This collection contains all type names which are displayed in the editor.
+ */
+ private Collection<Type> typesToDisplay = new HashSet<>();
+
+ /**
+ * Editor annotation mode type. This variable is only set if the editor annotation mode type is
+ * not already included in the typesToDisplay collection
+ */
+ private Type editorAnnotationMode;
+
+ /**
+ * Initializes a new instance.
+ *
+ * @param typeSystem
+ * the type system
+ * @param shownTypes
+ * the shown types
+ */
+ public ShowAnnotationsMenu(TypeSystem typeSystem, Collection<Type> shownTypes) {
+ super(typeSystem.getType(CAS.TYPE_NAME_ANNOTATION), typeSystem);
+
+ typesToDisplay.addAll(shownTypes);
+ }
+
+ /**
+ * Adds the listener.
+ *
+ * @param listener
+ * the listener
+ */
+ public void addListener(IShowAnnotationsListener listener) {
+ listeners.add(listener);
+ }
+
+ /**
+ * Removes the listener.
+ *
+ * @param listener
+ * the listener
+ */
+ public void removeListener(IShowAnnotationsListener listener) {
+ listeners.remove(listener);
+ }
+
+ @Override
+ protected void insertAction(final Type type, Menu parentMenu) {
+ final MenuItem actionItem = new MenuItem(parentMenu, SWT.CHECK);
+ actionItem.setText(type.getName());
+
+ // TODO: find another way to select the annotation mode also
+ if (editorAnnotationMode != null && editorAnnotationMode.equals(type)) {
+ actionItem.setSelection(true);
+ }
+
+ if (typesToDisplay.contains(type)) {
+ actionItem.setSelection(true);
+ }
+
+ // TODO: move this to an action
+ // do not access mTypesToDisplay directly !!!
+ actionItem.addListener(SWT.Selection, new Listener() {
+ @Override
public void handleEvent(Event e) {
- if (actionItem.getSelection()) {
- typesToDisplay.add(type);
-
- } else {
- typesToDisplay.remove(type);
- }
-
- fireChanged();
- }
- });
- }
-
- /**
- * Gets the selected types.
- *
- * @return the selected types
- */
- public Collection<Type> getSelectedTypes() {
- Collection<Type> selectedTypes = new LinkedList<>();
-
- if (editorAnnotationMode != null) {
- selectedTypes.add(editorAnnotationMode);
- }
-
- selectedTypes.addAll(typesToDisplay);
-
- return Collections.unmodifiableCollection(selectedTypes);
- }
-
- /**
- * Fire changed.
- */
- private void fireChanged() {
- for (IShowAnnotationsListener listener : listeners) {
- listener.selectionChanged(getSelectedTypes());
- }
- }
-
- /**
- * Sets the selected type.
- *
- * @param type the type
- * @param isShown the is shown
- */
- public void setSelectedType(Type type, boolean isShown) {
-
- if (typesToDisplay.contains(type)) {
- if (!isShown) {
- typesToDisplay.remove(type);
- fireChanged();
- }
- }
- else {
- if (isShown) {
- typesToDisplay.add(type);
- fireChanged();
- }
- }
- }
-
- /**
- * Sets the selected types.
- *
- * @param types the new selected types
- */
- public void setSelectedTypes(Collection<Type> types) {
- typesToDisplay = new HashSet<>();
- typesToDisplay.addAll(types);
-
- for (IShowAnnotationsListener listener : listeners) {
- listener.selectionChanged(getSelectedTypes());
- }
- }
-
- /**
- * Sets the editor annotation mode.
- *
- * @param newMode the new editor annotation mode
- */
- public void setEditorAnnotationMode(Type newMode) {
-
- if (typesToDisplay.contains(newMode)) {
- if (editorAnnotationMode != null) {
- editorAnnotationMode = null;
- fireChanged();
- }
- } else {
- editorAnnotationMode = newMode;
-
- fireChanged();
- }
- }
+ if (actionItem.getSelection()) {
+ typesToDisplay.add(type);
+
+ } else {
+ typesToDisplay.remove(type);
+ }
+
+ fireChanged();
+ }
+ });
+ }
+
+ /**
+ * Gets the selected types.
+ *
+ * @return the selected types
+ */
+ public Collection<Type> getSelectedTypes() {
+ Collection<Type> selectedTypes = new LinkedList<>();
+
+ if (editorAnnotationMode != null) {
+ selectedTypes.add(editorAnnotationMode);
+ }
+
+ selectedTypes.addAll(typesToDisplay);
+
+ return Collections.unmodifiableCollection(selectedTypes);
+ }
+
+ /**
+ * Fire changed.
+ */
+ private void fireChanged() {
+ for (IShowAnnotationsListener listener : listeners) {
+ listener.selectionChanged(getSelectedTypes());
+ }
+ }
+
+ /**
+ * Sets the selected type.
+ *
+ * @param type
+ * the type
+ * @param isShown
+ * the is shown
+ */
+ public void setSelectedType(Type type, boolean isShown) {
+
+ if (typesToDisplay.contains(type)) {
+ if (!isShown) {
+ typesToDisplay.remove(type);
+ fireChanged();
+ }
+ } else {
+ if (isShown) {
+ typesToDisplay.add(type);
+ fireChanged();
+ }
+ }
+ }
+
+ /**
+ * Sets the selected types.
+ *
+ * @param types
+ * the new selected types
+ */
+ public void setSelectedTypes(Collection<Type> types) {
+ typesToDisplay = new HashSet<>();
+ typesToDisplay.addAll(types);
+
+ for (IShowAnnotationsListener listener : listeners) {
+ listener.selectionChanged(getSelectedTypes());
+ }
+ }
+
+ /**
+ * Sets the editor annotation mode.
+ *
+ * @param newMode
+ * the new editor annotation mode
+ */
+ public void setEditorAnnotationMode(Type newMode) {
+
+ if (typesToDisplay.contains(newMode)) {
+ if (editorAnnotationMode != null) {
+ editorAnnotationMode = null;
+ fireChanged();
+ }
+ } else {
+ editorAnnotationMode = newMode;
+
+ fireChanged();
+ }
+ }
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/TypeMenu.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/TypeMenu.java
index c7df532..15ca66c 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/TypeMenu.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/contextmenu/TypeMenu.java
@@ -28,87 +28,92 @@ import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
-
/**
* Abstract base class for menus which display the type hierarchy.
*/
abstract class TypeMenu extends ContributionItem {
-
- /** The m parent type. */
- private Type mParentType;
-
- /** The m type system. */
- private TypeSystem mTypeSystem;
-
- /**
- * Initializes a new instance.
- *
- * @param parentType the parent type
- * @param typeSystem the type system
- */
- TypeMenu(Type parentType, TypeSystem typeSystem) {
- mParentType = parentType;
- mTypeSystem = typeSystem;
- }
- /**
- * Fills the menu with type entries.
- *
- * @param menu the menu
- * @param index the index
- */
- @Override
- public void fill(Menu menu, int index) {
- fillTypeMenu(mParentType, menu, false);
- }
+ /** The m parent type. */
+ private Type mParentType;
+
+ /** The m type system. */
+ private TypeSystem mTypeSystem;
+
+ /**
+ * Initializes a new instance.
+ *
+ * @param parentType
+ * the parent type
+ * @param typeSystem
+ * the type system
+ */
+ TypeMenu(Type parentType, TypeSystem typeSystem) {
+ mParentType = parentType;
+ mTypeSystem = typeSystem;
+ }
+
+ /**
+ * Fills the menu with type entries.
+ *
+ * @param menu
+ * the menu
+ * @param index
+ * the index
+ */
+ @Override
+ public void fill(Menu menu, int index) {
+ fillTypeMenu(mParentType, menu, false);
+ }
+
+ /**
+ * Fill type menu.
+ *
+ * @param parentType
+ * the parent type
+ * @param parentMenu
+ * the parent menu
+ * @param isParentIncluded
+ * the is parent included
+ */
+ private void fillTypeMenu(Type parentType, Menu parentMenu, boolean isParentIncluded) {
- /**
- * Fill type menu.
- *
- * @param parentType the parent type
- * @param parentMenu the parent menu
- * @param isParentIncluded the is parent included
- */
- private void fillTypeMenu(Type parentType, Menu parentMenu,
- boolean isParentIncluded) {
-
- List<Type> childs = mTypeSystem.getDirectSubtypes(parentType);
-
- Menu newSubMenu;
-
- // has this type sub types ?
- // yes
- if (childs.size() != 0) {
-
- if (isParentIncluded) {
- MenuItem subMenuItem = new MenuItem(parentMenu, SWT.CASCADE);
- subMenuItem.setText(parentType.getName());
-
- newSubMenu = new Menu(subMenuItem);
- subMenuItem.setMenu(newSubMenu);
- }
- else {
- newSubMenu = parentMenu;
- }
-
- insertAction(parentType, newSubMenu);
-
- for (Type child : childs) {
- fillTypeMenu(child, newSubMenu, true);
- }
+ List<Type> childs = mTypeSystem.getDirectSubtypes(parentType);
+
+ Menu newSubMenu;
+
+ // has this type sub types ?
+ // yes
+ if (childs.size() != 0) {
+
+ if (isParentIncluded) {
+ MenuItem subMenuItem = new MenuItem(parentMenu, SWT.CASCADE);
+ subMenuItem.setText(parentType.getName());
+
+ newSubMenu = new Menu(subMenuItem);
+ subMenuItem.setMenu(newSubMenu);
+ } else {
+ newSubMenu = parentMenu;
}
- // no
- else {
- insertAction(parentType, parentMenu);
+
+ insertAction(parentType, newSubMenu);
+
+ for (Type child : childs) {
+ fillTypeMenu(child, newSubMenu, true);
}
}
-
- /**
- * Implementing classes must implement this method to insert
- * actions into the type menu.
- *
- * @param type the type
- * @param parentMenu the parent menu
- */
- protected abstract void insertAction(final Type type, Menu parentMenu);
+ // no
+ else {
+ insertAction(parentType, parentMenu);
+ }
}
+
+ /**
+ * Implementing classes must implement this method to insert actions into the type menu.
+ *
+ * @param type
+ * the type
+ * @param parentMenu
+ * the parent menu
+ */
+ protected abstract void insertAction(final Type type, Menu parentMenu);
+}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/CreateFeatureStructureDialog.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/CreateFeatureStructureDialog.java
index f263148..a89948d 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/CreateFeatureStructureDialog.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/CreateFeatureStructureDialog.java
@@ -15,7 +15,8 @@
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
- */package org.apache.uima.caseditor.editor.editview;
+ */
+package org.apache.uima.caseditor.editor.editview;
import java.util.Collection;
import java.util.HashSet;
@@ -39,7 +40,6 @@ import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
-
/**
* The Class CreateFeatureStructureDialog.
*/
@@ -75,9 +75,12 @@ public class CreateFeatureStructureDialog extends IconAndMessageDialog {
/**
* Initializes a the current instance.
*
- * @param parentShell the parent shell
- * @param superType the super type
- * @param typeSystem the type system
+ * @param parentShell
+ * the parent shell
+ * @param superType
+ * the super type
+ * @param typeSystem
+ * the type system
*/
protected CreateFeatureStructureDialog(Shell parentShell, Type superType, TypeSystem typeSystem) {
@@ -118,7 +121,8 @@ public class CreateFeatureStructureDialog extends IconAndMessageDialog {
/**
* Enable size enter.
*
- * @param parent the parent
+ * @param parent
+ * the parent
*/
private void enableSizeEnter(Composite parent) {
@@ -178,13 +182,13 @@ public class CreateFeatureStructureDialog extends IconAndMessageDialog {
labelAndText.setLayoutData(labelAndTextData);
if (!superType.isArray()) {
-
+
Composite typePanel = new Composite(labelAndText, SWT.NULL);
-
+
GridLayout typePanelLayout = new GridLayout();
typePanelLayout.numColumns = 2;
typePanel.setLayout(typePanelLayout);
-
+
Label typeLabel = new Label(typePanel, SWT.NONE);
typeLabel.setText("Type: ");
@@ -224,7 +228,6 @@ public class CreateFeatureStructureDialog extends IconAndMessageDialog {
return labelAndText;
}
-
@Override
protected void createButtonsForButtonBar(Composite parent) {
createButton(parent, IDialogConstants.OK_ID, "Create", true);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/EditView.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/EditView.java
index cd39594..e3ae5a8 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/EditView.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/EditView.java
@@ -24,9 +24,8 @@ import org.apache.uima.caseditor.editor.ICasDocument;
import org.apache.uima.caseditor.editor.ICasEditor;
import org.eclipse.ui.part.IPageBookViewPage;
-
public final class EditView extends CasEditorView {
-
+
/**
* The ID of the feature structure view.
*/
@@ -39,7 +38,7 @@ public final class EditView extends CasEditorView {
* Instantiates a new edits the view.
*/
public EditView() {
- super("The edit view is currently not available.");
+ super("The edit view is currently not available.");
}
@Override
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/EditViewPage.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/EditViewPage.java
index b8c03d8..7205fe5 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/EditViewPage.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/EditViewPage.java
@@ -85,15 +85,13 @@ import org.eclipse.ui.actions.ActionFactory;
import org.eclipse.ui.actions.BaseSelectionListenerAction;
import org.eclipse.ui.part.Page;
-
/**
- * The {@link EditViewPage} provides basic editing support for {@link FeatureStructure}s.
- * It shows always the selected {@link FeatureStructure}, but for editing a certain
- * {@link FeatureStructure} can be pinned to the view (selection updates disabled).
+ * The {@link EditViewPage} provides basic editing support for {@link FeatureStructure}s. It shows
+ * always the selected {@link FeatureStructure}, but for editing a certain {@link FeatureStructure}
+ * can be pinned to the view (selection updates disabled).
*
- * For editing the {@link Feature}s of the {@link FeatureStructure} are shown in
- * a tree with two columns. The values of the {@link Feature} can be changed with
- * cell editors.
+ * For editing the {@link Feature}s of the {@link FeatureStructure} are shown in a tree with two
+ * columns. The values of the {@link Feature} can be changed with cell editors.
*
* Note: Lists type are currently not supported
*/
@@ -103,11 +101,12 @@ final class EditViewPage extends Page implements ISelectionListener {
* The Class ValueEditingSupport.
*/
private final class ValueEditingSupport extends EditingSupport {
-
+
/**
* Instantiates a new value editing support.
*
- * @param viewer the viewer
+ * @param viewer
+ * the viewer
*/
private ValueEditingSupport(ColumnViewer viewer) {
super(viewer);
@@ -120,8 +119,7 @@ final class EditViewPage extends Page implements ISelectionListener {
FeatureValue value = (FeatureValue) element;
return value.getFeature().getRange().isPrimitive();
- }
- else if (element instanceof ArrayValue) {
+ } else if (element instanceof ArrayValue) {
ArrayValue value = (ArrayValue) element;
@@ -129,16 +127,12 @@ final class EditViewPage extends Page implements ISelectionListener {
if (arrayFS instanceof ArrayFS) {
return false;
- }
- else if (arrayFS instanceof CommonArrayFS ||
- arrayFS instanceof StringArrayFS) {
+ } else if (arrayFS instanceof CommonArrayFS || arrayFS instanceof StringArrayFS) {
return true;
- }
- else {
+ } else {
throw new CasEditorError("Unkown array type");
}
- }
- else {
+ } else {
throw new CasEditorError("Unkown element type!");
}
}
@@ -155,16 +149,15 @@ final class EditViewPage extends Page implements ISelectionListener {
if (value.getFeature().getRange().getName().equals(CAS.TYPE_NAME_BOOLEAN)) {
editor = new CheckboxCellEditor(viewer.getTree(), SWT.CHECK);
- }
- else {
+ } else {
editor = new TextCellEditor(viewer.getTree());
editor.setValidator(CellEditorValidatorFacotory.createValidator(Primitives
- .getPrimitiveClass(value.getFeatureStructure().getCAS().getTypeSystem(), value.getFeature())));
+ .getPrimitiveClass(value.getFeatureStructure().getCAS().getTypeSystem(),
+ value.getFeature())));
}
return editor;
- }
- else {
+ } else {
return null;
}
} else if (element instanceof ArrayValue) {
@@ -177,39 +170,30 @@ final class EditViewPage extends Page implements ISelectionListener {
if (arrayFS instanceof BooleanArrayFS) {
editor = new CheckboxCellEditor(viewer.getTree(), SWT.CHECK);
- }
- else {
+ } else {
editor = new TextCellEditor(viewer.getTree());
if (arrayFS instanceof ByteArrayFS) {
editor.setValidator(CellEditorValidatorFacotory.createValidator(Byte.class));
- }
- else if (arrayFS instanceof ShortArrayFS) {
+ } else if (arrayFS instanceof ShortArrayFS) {
editor.setValidator(CellEditorValidatorFacotory.createValidator(Short.class));
- }
- else if (arrayFS instanceof IntArrayFS) {
+ } else if (arrayFS instanceof IntArrayFS) {
editor.setValidator(CellEditorValidatorFacotory.createValidator(Integer.class));
- }
- else if (arrayFS instanceof LongArrayFS) {
+ } else if (arrayFS instanceof LongArrayFS) {
editor.setValidator(CellEditorValidatorFacotory.createValidator(Long.class));
- }
- else if (arrayFS instanceof FloatArrayFS) {
+ } else if (arrayFS instanceof FloatArrayFS) {
editor.setValidator(CellEditorValidatorFacotory.createValidator(Float.class));
- }
- else if (arrayFS instanceof DoubleArrayFS) {
+ } else if (arrayFS instanceof DoubleArrayFS) {
editor.setValidator(CellEditorValidatorFacotory.createValidator(Double.class));
- }
- else if (arrayFS instanceof StringArrayFS) {
+ } else if (arrayFS instanceof StringArrayFS) {
// no validator needed
- }
- else {
+ } else {
throw new CasEditorError("Unknown array type: " + arrayFS.getClass().getName());
}
}
return editor;
- }
- else {
+ } else {
throw new CasEditorError("Unknown element type: " + element.getClass().getName());
}
}
@@ -222,28 +206,26 @@ final class EditViewPage extends Page implements ISelectionListener {
// if not a boolean return string value,
// otherwise return boolean number
- if (!featureValue.getFeature().getRange().getName().equals(
- CAS.TYPE_NAME_BOOLEAN)) {
- return Primitives.getPrimitive(featureValue.getFeatureStructure(), featureValue.getFeature()).toString();
- }
- else {
+ if (!featureValue.getFeature().getRange().getName().equals(CAS.TYPE_NAME_BOOLEAN)) {
+ return Primitives
+ .getPrimitive(featureValue.getFeatureStructure(), featureValue.getFeature())
+ .toString();
+ } else {
// for booleans
- return Primitives.getPrimitive(featureValue.getFeatureStructure(), featureValue.getFeature());
+ return Primitives.getPrimitive(featureValue.getFeatureStructure(),
+ featureValue.getFeature());
}
- }
- else if (element instanceof ArrayValue) {
- ArrayValue value = (ArrayValue) element;
+ } else if (element instanceof ArrayValue) {
+ ArrayValue value = (ArrayValue) element;
- // if not a boolean array return string value
- if (!(value.getFeatureStructure() instanceof BooleanArrayFS)) {
- return value.get().toString();
- }
- else {
- return value.get();
- }
- }
- else {
+ // if not a boolean array return string value
+ if (!(value.getFeatureStructure() instanceof BooleanArrayFS)) {
+ return value.get().toString();
+ } else {
+ return value.get();
+ }
+ } else {
throw new CasEditorError("Unkown element type!");
}
}
@@ -258,18 +240,17 @@ final class EditViewPage extends Page implements ISelectionListener {
FeatureValue featureValue = (FeatureValue) element;
// for all other than boolean values
- if (!featureValue.getFeature().getRange().getName().equals(
- CAS.TYPE_NAME_BOOLEAN)) {
+ if (!featureValue.getFeature().getRange().getName().equals(CAS.TYPE_NAME_BOOLEAN)) {
if (featureValue.getFeature().getRange().isPrimitive()) {
// TODO: try to prevent setting of invalid annotation span values
- featureValue.getFeatureStructure().setFeatureValueFromString(featureValue.getFeature(),
- (String) value);
+ featureValue.getFeatureStructure()
+ .setFeatureValueFromString(featureValue.getFeature(), (String) value);
}
- }
- else {
- featureValue.getFeatureStructure().setBooleanValue(featureValue.getFeature(),(Boolean) value);
+ } else {
+ featureValue.getFeatureStructure().setBooleanValue(featureValue.getFeature(),
+ (Boolean) value);
}
document.update(featureValue.getFeatureStructure());
@@ -281,8 +262,7 @@ final class EditViewPage extends Page implements ISelectionListener {
if (!(arrayValue.getFeatureStructure() instanceof BooleanArrayFS)) {
arrayValue.set((String) value);
- }
- else {
+ } else {
arrayValue.set(value.toString());
}
@@ -295,7 +275,6 @@ final class EditViewPage extends Page implements ISelectionListener {
}
}
-
/**
* The Class DeleteFeatureStructureValue.
*/
@@ -325,13 +304,13 @@ final class EditViewPage extends Page implements ISelectionListener {
document.update(featureValue.getFeatureStructure());
}
} else if (element instanceof ArrayValue) {
- ArrayValue arrayValue = (ArrayValue) element;
+ ArrayValue arrayValue = (ArrayValue) element;
- ArrayFS array = (ArrayFS) arrayValue.getFeatureStructure();
+ ArrayFS array = (ArrayFS) arrayValue.getFeatureStructure();
- array.set(arrayValue.slot(), null);
+ array.set(arrayValue.slot(), null);
- document.update(array);
+ document.update(array);
}
}
@@ -344,17 +323,16 @@ final class EditViewPage extends Page implements ISelectionListener {
if (selection.getFirstElement() instanceof FeatureValue) {
FeatureValue featureValue = (FeatureValue) selection.getFirstElement();
- result = !featureValue.getFeature().getRange().isPrimitive() &&
- featureValue.getFeatureStructure().getFeatureValue(featureValue.getFeature()) != null;
- }
- else if (selection.getFirstElement() instanceof ArrayValue) {
+ result = !featureValue.getFeature().getRange().isPrimitive() && featureValue
+ .getFeatureStructure().getFeatureValue(featureValue.getFeature()) != null;
+ } else if (selection.getFirstElement() instanceof ArrayValue) {
ArrayValue arrayValue = (ArrayValue) selection.getFirstElement();
- if (arrayValue.getFeatureStructure() instanceof ArrayFS) {
- ArrayFS array = (ArrayFS) arrayValue.getFeatureStructure();
+ if (arrayValue.getFeatureStructure() instanceof ArrayFS) {
+ ArrayFS array = (ArrayFS) arrayValue.getFeatureStructure();
- result = array.get(arrayValue.slot()) != null;
- }
+ result = array.get(arrayValue.slot()) != null;
+ }
}
}
@@ -377,12 +355,13 @@ final class EditViewPage extends Page implements ISelectionListener {
setEnabled(false);
}
-
/**
* Creates the FS.
*
- * @param type the type
- * @param arraySize the array size
+ * @param type
+ * the type
+ * @param arraySize
+ * the array size
* @return the feature structure
*/
FeatureStructure createFS(Type type, int arraySize) {
@@ -427,28 +406,25 @@ final class EditViewPage extends Page implements ISelectionListener {
default:
throw new CasEditorError("Unkown array type: " + type.getName() + "!");
}
- }
- else if (ts.subsumes(ts.getType(CAS.TYPE_NAME_ANNOTATION), type)) {
+ } else if (ts.subsumes(ts.getType(CAS.TYPE_NAME_ANNOTATION), type)) {
- // get begin of selection from editor, if any
- // TODO: Add an interface to retrieve the span from the editor
+ // get begin of selection from editor, if any
+ // TODO: Add an interface to retrieve the span from the editor
- int begin = 0;
- int end = 0;
+ int begin = 0;
+ int end = 0;
- if (editor instanceof AnnotationEditor) {
- Point selection = ((AnnotationEditor) editor).getSelection();
+ if (editor instanceof AnnotationEditor) {
+ Point selection = ((AnnotationEditor) editor).getSelection();
- begin = selection.x;
- end = selection.y;
- }
+ begin = selection.x;
+ end = selection.y;
+ }
- fs = document.getCAS().createAnnotation(type, begin, end);
- }
- else if (!type.isArray()) {
+ fs = document.getCAS().createAnnotation(type, begin, end);
+ } else if (!type.isArray()) {
fs = document.getCAS().createFS(type);
- }
- else {
+ } else {
throw new TaeError("Unexpected error!");
}
@@ -467,29 +443,27 @@ final class EditViewPage extends Page implements ISelectionListener {
Type fsSuperType = featureValue.getFeature().getRange();
if (!fsSuperType.isArray()) {
- List<Type> subTypes =
- document.getCAS().getTypeSystem().getProperlySubsumedTypes(fsSuperType);
+ List<Type> subTypes = document.getCAS().getTypeSystem()
+ .getProperlySubsumedTypes(fsSuperType);
Type typeToCreate;
int arraySize = -1;
if (subTypes.size() == 0) {
typeToCreate = fsSuperType;
- }
- else {
- CreateFeatureStructureDialog createFsDialog =
- new CreateFeatureStructureDialog(Display.getCurrent()
- .getActiveShell(), fsSuperType, document.getCAS().getTypeSystem());
-
- int returnCode = createFsDialog.open();
-
- if (returnCode == IDialogConstants.OK_ID) {
- typeToCreate = createFsDialog.getType();
- arraySize = createFsDialog.getArraySize();
- }
- else {
- return;
- }
+ } else {
+ CreateFeatureStructureDialog createFsDialog = new CreateFeatureStructureDialog(
+ Display.getCurrent().getActiveShell(), fsSuperType,
+ document.getCAS().getTypeSystem());
+
+ int returnCode = createFsDialog.open();
+
+ if (returnCode == IDialogConstants.OK_ID) {
+ typeToCreate = createFsDialog.getType();
+ arraySize = createFsDialog.getArraySize();
+ } else {
+ return;
+ }
}
newValue = createFS(typeToCreate, arraySize);
@@ -498,8 +472,9 @@ final class EditViewPage extends Page implements ISelectionListener {
} else {
Type arrayType = featureValue.getFeature().getRange();
- CreateFeatureStructureDialog createArrayDialog = new CreateFeatureStructureDialog(Display.getCurrent()
- .getActiveShell(), arrayType, document.getCAS().getTypeSystem());
+ CreateFeatureStructureDialog createArrayDialog = new CreateFeatureStructureDialog(
+ Display.getCurrent().getActiveShell(), arrayType,
+ document.getCAS().getTypeSystem());
int returnCode = createArrayDialog.open();
@@ -512,17 +487,14 @@ final class EditViewPage extends Page implements ISelectionListener {
featureValue.getFeatureStructure().setFeatureValue(featureValue.getFeature(), newValue);
document.update(featureValue.getFeatureStructure());
- }
- else if (selection.getFirstElement() instanceof ArrayValue) {
+ } else if (selection.getFirstElement() instanceof ArrayValue) {
ArrayValue value = (ArrayValue) selection.getFirstElement();
-
TypeSystem typeSystem = document.getCAS().getTypeSystem();
- CreateFeatureStructureDialog createFsDialog =
- new CreateFeatureStructureDialog(Display.getCurrent()
- .getActiveShell(), typeSystem.getType(CAS.TYPE_NAME_TOP),
- typeSystem);
+ CreateFeatureStructureDialog createFsDialog = new CreateFeatureStructureDialog(
+ Display.getCurrent().getActiveShell(), typeSystem.getType(CAS.TYPE_NAME_TOP),
+ typeSystem);
int returnCode = createFsDialog.open();
@@ -548,10 +520,9 @@ final class EditViewPage extends Page implements ISelectionListener {
if (selection.getFirstElement() instanceof FeatureValue) {
FeatureValue featureValue = (FeatureValue) selection.getFirstElement();
- result = !featureValue.getFeature().getRange().isPrimitive() &&
- featureValue.getFeatureStructure().getFeatureValue(featureValue.getFeature()) == null;
- }
- else if (selection.getFirstElement() instanceof ArrayValue) {
+ result = !featureValue.getFeature().getRange().isPrimitive() && featureValue
+ .getFeatureStructure().getFeatureValue(featureValue.getFeature()) == null;
+ } else if (selection.getFirstElement() instanceof ArrayValue) {
ArrayValue value = (ArrayValue) selection.getFirstElement();
if (value.getFeatureStructure() instanceof ArrayFS) {
@@ -572,7 +543,7 @@ final class EditViewPage extends Page implements ISelectionListener {
* The Class PinAction.
*/
private static final class PinAction extends Action {
-
+
/**
* Instantiates a new pin action.
*/
@@ -586,7 +557,7 @@ final class EditViewPage extends Page implements ISelectionListener {
/** The document. */
private ICasDocument document;
-
+
/** The editor. */
private ICasEditor editor;
@@ -599,15 +570,18 @@ final class EditViewPage extends Page implements ISelectionListener {
/**
* Instantiates a new edits the view page.
*
- * @param editView the edit view
- * @param editor the editor
- * @param document the document
+ * @param editView
+ * the edit view
+ * @param editor
+ * the editor
+ * @param document
+ * the document
*/
EditViewPage(EditView editView, ICasEditor editor, ICasDocument document) {
- if (editView == null || document == null) {
- throw new IllegalArgumentException("Parameters must not be null!");
- }
+ if (editView == null || document == null) {
+ throw new IllegalArgumentException("Parameters must not be null!");
+ }
this.editView = editView;
this.editor = editor;
@@ -639,9 +613,7 @@ final class EditViewPage extends Page implements ISelectionListener {
valueColumn.setEditingSupport(new ValueEditingSupport(viewer));
-
- FeatureStructureContentProvider contentProvider =
- new FeatureStructureContentProvider(document);
+ FeatureStructureContentProvider contentProvider = new FeatureStructureContentProvider(document);
viewer.setContentProvider(contentProvider);
@@ -741,7 +713,6 @@ final class EditViewPage extends Page implements ISelectionListener {
}
});
-
DragSource source = new DragSource(viewer.getTree(), DND.DROP_COPY);
source.setTransfer(new Transfer[] { FeatureStructureTransfer.getInstance() });
@@ -823,8 +794,7 @@ final class EditViewPage extends Page implements ISelectionListener {
getSite().getSelectionProvider().addSelectionChangedListener(deleteAction);
- actionBars.getToolBarManager().add(
- ActionFactory.DELETE.create(getSite().getWorkbenchWindow()));
+ actionBars.getToolBarManager().add(ActionFactory.DELETE.create(getSite().getWorkbenchWindow()));
}
@Override
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/FeatureColumnLabelProvider.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/FeatureColumnLabelProvider.java
index 493ffb9..c95ad6c 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/FeatureColumnLabelProvider.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/FeatureColumnLabelProvider.java
@@ -25,7 +25,6 @@ import org.apache.uima.caseditor.editor.FeatureValue;
import org.eclipse.jface.viewers.CellLabelProvider;
import org.eclipse.jface.viewers.ViewerCell;
-
/**
* The Class FeatureColumnLabelProvider.
*/
@@ -41,13 +40,11 @@ final class FeatureColumnLabelProvider extends CellLabelProvider {
cell.setText(featureValue.getFeature().getShortName());
- }
- else if (element instanceof ArrayValue) {
+ } else if (element instanceof ArrayValue) {
ArrayValue arrayValue = (ArrayValue) cell.getElement();
cell.setText(Integer.toString(arrayValue.slot()));
- }
- else {
+ } else {
throw new CasEditorError("Unkown element!");
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/FeatureStructureContentProvider.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/FeatureStructureContentProvider.java
index cfbe244..1802f08 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/FeatureStructureContentProvider.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/FeatureStructureContentProvider.java
@@ -37,7 +37,6 @@ import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.swt.widgets.Display;
-
/**
* The Class FeatureStructureContentProvider.
*/
@@ -53,7 +52,8 @@ final class FeatureStructureContentProvider extends AbstractDocumentListener
/**
* Instantiates a new feature structure content provider.
*
- * @param document the document
+ * @param document
+ * the document
*/
FeatureStructureContentProvider(ICasDocument document) {
@@ -67,7 +67,8 @@ final class FeatureStructureContentProvider extends AbstractDocumentListener
/**
* Array size.
*
- * @param value the value
+ * @param value
+ * the value
* @return the int
*/
private int arraySize(FeatureStructure value) {
@@ -115,8 +116,7 @@ final class FeatureStructureContentProvider extends AbstractDocumentListener
}
return featureValues.toArray();
- }
- else {
+ } else {
int size = arraySize(featureStructure);
ArrayValue arrayValues[] = new ArrayValue[size];
@@ -170,7 +170,7 @@ final class FeatureStructureContentProvider extends AbstractDocumentListener
@Override
public void removed(Collection<FeatureStructure> deletedFeatureStructure) {
- for(FeatureStructure fs : deletedFeatureStructure) {
+ for (FeatureStructure fs : deletedFeatureStructure) {
if (viewer.getInput() == fs) {
viewer.setInput(null);
break;
@@ -210,8 +210,7 @@ final class FeatureStructureContentProvider extends AbstractDocumentListener
ArrayFS array = (ArrayFS) value.getFeatureStructure();
return getElements(array.get(value.slot()));
- }
- else {
+ } else {
throw new CasEditorError("Unexpected element type!");
}
}
@@ -224,14 +223,14 @@ final class FeatureStructureContentProvider extends AbstractDocumentListener
/**
* Checks for children.
*
- * @param value the value
+ * @param value
+ * the value
* @return true, if successful
*/
private boolean hasChildren(FeatureStructure value) {
boolean result;
-
if (value != null) {
if (value.getType().isArray()) {
@@ -255,8 +254,7 @@ final class FeatureStructureContentProvider extends AbstractDocumentListener
if (value.getFeature().getRange().isPrimitive()) {
return false;
- }
- else {
+ } else {
return hasChildren((FeatureStructure) value.getValue());
}
} else if (element instanceof ArrayValue) {
@@ -268,13 +266,11 @@ final class FeatureStructureContentProvider extends AbstractDocumentListener
ArrayFS array = (ArrayFS) value.getFeatureStructure();
return hasChildren(array.get(value.slot()));
- }
- else {
+ } else {
// false for primitive arrays
return false;
}
- }
- else {
+ } else {
throw new CasEditorError("Unkown element type");
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/ValueColumnLabelProvider.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/ValueColumnLabelProvider.java
index cf756f7..77825e0 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/ValueColumnLabelProvider.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/ValueColumnLabelProvider.java
@@ -28,7 +28,6 @@ import org.apache.uima.caseditor.editor.util.Primitives;
import org.eclipse.jface.viewers.CellLabelProvider;
import org.eclipse.jface.viewers.ViewerCell;
-
/**
* Provides the labels for the edit view.
*/
@@ -43,9 +42,10 @@ final class ValueColumnLabelProvider extends CellLabelProvider {
FeatureValue featureValue = (FeatureValue) element;
if (featureValue.getFeature().getRange().isPrimitive()) {
- cell.setText(Primitives.getPrimitive(featureValue.getFeatureStructure(), featureValue.getFeature()).toString());
- }
- else {
+ cell.setText(Primitives
+ .getPrimitive(featureValue.getFeatureStructure(), featureValue.getFeature())
+ .toString());
+ } else {
FeatureStructure value = (FeatureStructure) featureValue.getValue();
if (value == null) {
@@ -54,8 +54,7 @@ final class ValueColumnLabelProvider extends CellLabelProvider {
cell.setText("[" + value.getType().getShortName() + "]");
}
}
- }
- else if (element instanceof ArrayValue) {
+ } else if (element instanceof ArrayValue) {
ArrayValue value = (ArrayValue) element;
@@ -66,16 +65,13 @@ final class ValueColumnLabelProvider extends CellLabelProvider {
if (fs == null) {
cell.setText("null");
- }
- else {
+ } else {
cell.setText("[" + fs.getType().getShortName() + "]");
}
- }
- else {
+ } else {
cell.setText(value.get().toString());
}
- }
- else {
+ } else {
throw new CasEditorError("Unknown element!");
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/ByteCellEditorValidator.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/ByteCellEditorValidator.java
index f146a47..63f3a14 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/ByteCellEditorValidator.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/ByteCellEditorValidator.java
@@ -21,9 +21,9 @@ package org.apache.uima.caseditor.editor.editview.validator;
import org.eclipse.jface.viewers.ICellEditorValidator;
-
/**
- * This {@link ICellEditorValidator} validates {@link String} values which represents a {@link Byte}.
+ * This {@link ICellEditorValidator} validates {@link String} values which represents a
+ * {@link Byte}.
*
* For validation {@link Byte#parseByte(String)} is used.
*/
@@ -32,7 +32,8 @@ public class ByteCellEditorValidator implements ICellEditorValidator {
/**
* Checks if the given value is a valid {@link Byte}.
*
- * @param value the value
+ * @param value
+ * the value
* @return null if valid otherwise an error message
*/
@Override
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/CellEditorValidatorFacotory.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/CellEditorValidatorFacotory.java
index 86db772..fce4fcc 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/CellEditorValidatorFacotory.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/CellEditorValidatorFacotory.java
@@ -24,12 +24,11 @@ import java.util.Map;
import org.eclipse.jface.viewers.ICellEditorValidator;
-
/**
* TODO: add javadoc here.
*/
public class CellEditorValidatorFacotory {
-
+
/** The s validator map. */
private static Map<Class<?>, ICellEditorValidator> sValidatorMap = new HashMap<>();
@@ -52,7 +51,8 @@ public class CellEditorValidatorFacotory {
* Retrieves the appropriate {@link ICellEditorValidator} for the given class or none if not
* available.
*
- * @param type the type
+ * @param type
+ * the type
* @return {@link ICellEditorValidator} or null
*/
public static ICellEditorValidator createValidator(Class<?> type) {
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/FloatCellEditorValidator.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/FloatCellEditorValidator.java
index 0760ff5..aec109c 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/FloatCellEditorValidator.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/FloatCellEditorValidator.java
@@ -21,7 +21,6 @@ package org.apache.uima.caseditor.editor.editview.validator;
import org.eclipse.jface.viewers.ICellEditorValidator;
-
/**
* This {@link ICellEditorValidator} validates {@link String} values which represents a
* {@link Float}.
@@ -29,11 +28,12 @@ import org.eclipse.jface.viewers.ICellEditorValidator;
* For validation {@link Float#parseFloat(String)} is used.
*/
class FloatCellEditorValidator implements ICellEditorValidator {
-
+
/**
* Checks if the given value is a valid {@link Float}.
*
- * @param value the value
+ * @param value
+ * the value
* @return null if valid otherwise an error message
*/
@Override
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/IntegerCellEditorValidator.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/IntegerCellEditorValidator.java
index 9c07c09..f87974b 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/IntegerCellEditorValidator.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/IntegerCellEditorValidator.java
@@ -21,7 +21,6 @@ package org.apache.uima.caseditor.editor.editview.validator;
import org.eclipse.jface.viewers.ICellEditorValidator;
-
/**
* This {@link ICellEditorValidator} validates {@link String} values which represents a
* {@link Integer}.
@@ -29,11 +28,12 @@ import org.eclipse.jface.viewers.ICellEditorValidator;
* For validation {@link Integer#parseInt(String)} is used.
*/
class IntegerCellEditorValidator implements ICellEditorValidator {
-
+
/**
* Checks if the given value is a valid {@link Integer}.
*
- * @param value the value
+ * @param value
+ * the value
* @return null if valid otherwise an error message
*/
@Override
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/LongCellEditorValidator.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/LongCellEditorValidator.java
index f642950..ed188c4 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/LongCellEditorValidator.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/LongCellEditorValidator.java
@@ -21,9 +21,9 @@ package org.apache.uima.caseditor.editor.editview.validator;
import org.eclipse.jface.viewers.ICellEditorValidator;
-
/**
- * This {@link ICellEditorValidator} validates {@link String} values which represents a {@link Long}.
+ * This {@link ICellEditorValidator} validates {@link String} values which represents a
+ * {@link Long}.
*
* For validation {@link Long#parseLong(String)} is used.
*/
@@ -32,7 +32,8 @@ public class LongCellEditorValidator implements ICellEditorValidator {
/**
* Checks if the given value is a valid {@link Long}.
*
- * @param value the value
+ * @param value
+ * the value
* @return null if valid otherwise an error message
*/
@Override
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/ShortCellEditorValidator.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/ShortCellEditorValidator.java
index 12b142c..248d659 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/ShortCellEditorValidator.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/editview/validator/ShortCellEditorValidator.java
@@ -21,7 +21,6 @@ package org.apache.uima.caseditor.editor.editview.validator;
import org.eclipse.jface.viewers.ICellEditorValidator;
-
/**
* This {@link ICellEditorValidator} validates {@link String} values which represents a
* {@link Short}.
@@ -33,7 +32,8 @@ public class ShortCellEditorValidator implements ICellEditorValidator {
/**
* Checks if the given value is a valid {@link Short}.
*
- * @param value the value
+ * @param value
+ * the value
* @return null if valid otherwise an error message
*/
@Override
@@ -49,4 +49,3 @@ public class ShortCellEditorValidator implements ICellEditorValidator {
return null;
}
}
-
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureBrowserView.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureBrowserView.java
index 7672af5..84c6b5e 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureBrowserView.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureBrowserView.java
@@ -24,10 +24,9 @@ import org.apache.uima.caseditor.editor.ICasDocument;
import org.apache.uima.caseditor.editor.ICasEditor;
import org.eclipse.ui.part.IPageBookViewPage;
-
/**
- * The Feature Structure Browser View displays a list of feature structures which
- * belong to the selected type.
+ * The Feature Structure Browser View displays a list of feature structures which belong to the
+ * selected type.
*/
public final class FeatureStructureBrowserView extends CasEditorView {
/**
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureBrowserViewPage.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureBrowserViewPage.java
index 5d89b44..baeefb5 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureBrowserViewPage.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureBrowserViewPage.java
@@ -61,15 +61,14 @@ import org.eclipse.ui.IActionBars;
import org.eclipse.ui.actions.ActionFactory;
import org.eclipse.ui.part.Page;
-
/**
* The actual view page which contains the ui code for this view.
*/
public final class FeatureStructureBrowserViewPage extends Page {
-
+
/** The Constant LAST_SELECTED_FS_TYPE. */
private static final String LAST_SELECTED_FS_TYPE = "lastSelectedFeatureStructureBrowserViewType";
-
+
/**
* The Class FeatureStructureTreeContentProvider.
*/
@@ -85,7 +84,8 @@ public final class FeatureStructureBrowserViewPage extends Page {
/**
* Instantiates a new feature structure tree content provider.
*
- * @param document the document
+ * @param document
+ * the document
*/
FeatureStructureTreeContentProvider(ICasDocument document) {
mDocument = document;
@@ -105,8 +105,7 @@ public final class FeatureStructureBrowserViewPage extends Page {
List<ModelFeatureStructure> featureStructureList = new LinkedList<>();
while (strictTypeIterator.hasNext()) {
- featureStructureList.add(new ModelFeatureStructure(mDocument,
- strictTypeIterator.next()));
+ featureStructureList.add(new ModelFeatureStructure(mDocument, strictTypeIterator.next()));
}
ModelFeatureStructure[] featureStructureArray = new ModelFeatureStructure[featureStructureList
@@ -151,7 +150,8 @@ public final class FeatureStructureBrowserViewPage extends Page {
/**
* Retrieves children for a FeatureStrcuture and for FeatureValues if they have children.
*
- * @param parentElement the parent element
+ * @param parentElement
+ * the parent element
* @return the children
*/
@Override
@@ -241,8 +241,7 @@ public final class FeatureStructureBrowserViewPage extends Page {
@Override
public void added(Collection<FeatureStructure> structures) {
- final LinkedList<ModelFeatureStructure> featureStructureList =
- new LinkedList<>();
+ final LinkedList<ModelFeatureStructure> featureStructureList = new LinkedList<>();
for (FeatureStructure structure : structures) {
if (structure.getType() == mCurrentType) {
@@ -352,7 +351,7 @@ public final class FeatureStructureBrowserViewPage extends Page {
/** The m cas editor. */
private ICasEditor mCasEditor;
-
+
/** The m FS list. */
private ListViewer mFSList;
@@ -374,17 +373,18 @@ public final class FeatureStructureBrowserViewPage extends Page {
/**
* Initializes a new instance.
*
- * @param editor the editor
+ * @param editor
+ * the editor
*/
public FeatureStructureBrowserViewPage(ICasEditor editor) {
- if (editor == null)
- throw new IllegalArgumentException("editor parameter must not be null!");
+ if (editor == null)
+ throw new IllegalArgumentException("editor parameter must not be null!");
mDocument = editor.getDocument();
mCasEditor = editor;
-
+
mDeleteAction = new DeleteFeatureStructureAction(this.mCasEditor);
mSelectAllAction = new SelectAllAction();
@@ -438,27 +438,26 @@ public final class FeatureStructureBrowserViewPage extends Page {
layout.numColumns = 1;
mInstanceComposite.setLayout(layout);
-
+
Composite typePanel = new Composite(mInstanceComposite, SWT.NULL);
-
+
GridData typePanelData = new GridData();
typePanelData.grabExcessHorizontalSpace = true;
typePanelData.grabExcessVerticalSpace = false;
typePanelData.horizontalAlignment = SWT.FILL;
typePanel.setLayoutData(typePanelData);
-
+
GridLayout typePanelLayout = new GridLayout();
typePanelLayout.numColumns = 2;
typePanel.setLayout(typePanelLayout);
-
+
Label typeLabel = new Label(typePanel, SWT.NONE);
typeLabel.setText("Type: ");
GridData typeLabelData = new GridData();
typeLabelData.horizontalAlignment = SWT.LEFT;
typeLabel.setLayoutData(typeLabelData);
-
-
+
TypeCombo typeCombo = new TypeCombo(typePanel);
typeCombo.setInput(mDocument.getCAS().getTypeSystem().getType(CAS.TYPE_NAME_TOP),
mDocument.getCAS().getTypeSystem(), filterTypes);
@@ -466,24 +465,24 @@ public final class FeatureStructureBrowserViewPage extends Page {
typeComboData.horizontalAlignment = SWT.FILL;
typeComboData.grabExcessHorizontalSpace = true;
typeCombo.setLayoutData(typeComboData);
-
- final IPreferenceStore store = mCasEditor.getCasDocumentProvider().
- getSessionPreferenceStore(mCasEditor.getEditorInput());
-
+
+ final IPreferenceStore store = mCasEditor.getCasDocumentProvider()
+ .getSessionPreferenceStore(mCasEditor.getEditorInput());
+
Type lastUsedType = mDocument.getType(store.getString(LAST_SELECTED_FS_TYPE));
-
+
if (lastUsedType != null) {
typeCombo.select(lastUsedType);
}
-
+
typeCombo.addListener(new ITypePaneListener() {
-
+
@Override
public void typeChanged(Type newType) {
store.setValue(LAST_SELECTED_FS_TYPE, newType.getName());
}
});
-
+
mFSList = new ListViewer(mInstanceComposite, SWT.MULTI | SWT.V_SCROLL | SWT.BORDER);
GridData instanceListData = new GridData();
instanceListData.grabExcessHorizontalSpace = true;
@@ -507,7 +506,7 @@ public final class FeatureStructureBrowserViewPage extends Page {
if (lastUsedType != null)
mFSList.setInput(lastUsedType);
-
+
getSite().setSelectionProvider(mFSList);
}
@@ -525,9 +524,12 @@ public final class FeatureStructureBrowserViewPage extends Page {
* Adds the following actions to the toolbar: {@link FeatureStructureBrowserViewPage.CreateAction}
* DeleteAction
*
- * @param menuManager the menu manager
- * @param toolBarManager the tool bar manager
- * @param statusLineManager the status line manager
+ * @param menuManager
+ * the menu manager
+ * @param toolBarManager
+ * the tool bar manager
+ * @param statusLineManager
+ * the status line manager
*/
@Override
public void makeContributions(IMenuManager menuManager, IToolBarManager toolBarManager,
@@ -545,7 +547,8 @@ public final class FeatureStructureBrowserViewPage extends Page {
/**
* Sets global action handlers for: delete select all.
*
- * @param actionBars the new action bars
+ * @param actionBars
+ * the new action bars
*/
@Override
public void setActionBars(IActionBars actionBars) {
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureLabelProvider.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureLabelProvider.java
index ef05cc2..9cc6034 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureLabelProvider.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/FeatureStructureLabelProvider.java
@@ -27,7 +27,6 @@ import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.ILabelProviderListener;
import org.eclipse.swt.graphics.Image;
-
/**
* Provide the labels for the given {@link FeatureStructure}s.
*/
@@ -48,24 +47,20 @@ public final class FeatureStructureLabelProvider implements ILabelProvider {
}
return featureValue.getFeature().getShortName();
- }
- else if (element instanceof IAdaptable) {
+ } else if (element instanceof IAdaptable) {
FeatureStructure structure = null;
if (((IAdaptable) element).getAdapter(AnnotationFS.class) != null) {
- structure = (AnnotationFS) ((IAdaptable) element)
- .getAdapter(AnnotationFS.class);
+ structure = (AnnotationFS) ((IAdaptable) element).getAdapter(AnnotationFS.class);
}
if (structure == null) {
structure = (FeatureStructure) ((IAdaptable) element).getAdapter(FeatureStructure.class);
}
- return structure.getType().getShortName() + " (id=" +
- structure._id() + ")";
- }
- else {
+ return structure.getType().getShortName() + " (id=" + structure._id() + ")";
+ } else {
assert false : "Unexpected element!";
return element.toString();
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/ITypePaneListener.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/ITypePaneListener.java
index 123c686..56168fe 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/ITypePaneListener.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/ITypePaneListener.java
@@ -21,16 +21,16 @@ package org.apache.uima.caseditor.editor.fsview;
import org.apache.uima.cas.Type;
-
/**
* Notifies clients about type changes.
*/
public interface ITypePaneListener {
-
+
/**
* Called after the type was changed.
*
- * @param newType the new type
+ * @param newType
+ * the new type
*/
void typeChanged(Type newType);
}
\ No newline at end of file
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/TypeCombo.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/TypeCombo.java
index 7eb21f8..62bb493 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/TypeCombo.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/fsview/TypeCombo.java
@@ -35,7 +35,6 @@ import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
-
/**
* A combo box which contains UIMA Types.
*
@@ -43,7 +42,7 @@ import org.eclipse.swt.widgets.Composite;
* @see TypeSystem
*/
public class TypeCombo extends Composite {
-
+
/** The listeners. */
private Set<ITypePaneListener> listeners = new HashSet<>();
@@ -52,14 +51,15 @@ public class TypeCombo extends Composite {
/** The type combo. */
private Combo typeCombo;
-
+
/** The type name list. */
private List<String> typeNameList;
-
+
/**
* Instantiates a new type combo.
*
- * @param parent the parent
+ * @param parent
+ * the parent
*/
public TypeCombo(Composite parent) {
super(parent, SWT.NONE);
@@ -67,7 +67,7 @@ public class TypeCombo extends Composite {
setLayout(new FillLayout());
typeCombo = new Combo(this, SWT.READ_ONLY | SWT.DROP_DOWN | SWT.BORDER);
-
+
typeCombo.addModifyListener(new ModifyListener() {
@Override
public void modifyText(ModifyEvent e) {
@@ -79,18 +79,20 @@ public class TypeCombo extends Composite {
}
});
}
-
+
/**
* Sets the input.
*
- * @param superType the super type
- * @param typeSystem the type system
- * @param filterTypes the filter types
+ * @param superType
+ * the super type
+ * @param typeSystem
+ * the type system
+ * @param filterTypes
+ * the filter types
*/
- public void setInput(Type superType, TypeSystem typeSystem,
- Collection<Type> filterTypes) {
+ public void setInput(Type superType, TypeSystem typeSystem, Collection<Type> filterTypes) {
this.typeSystem = typeSystem;
-
+
typeNameList = new LinkedList<>();
typeNameList.add(superType.getName());
@@ -107,54 +109,57 @@ public class TypeCombo extends Composite {
// select the super type, its the first element (and must be there)
typeCombo.select(0);
}
-
+
/**
* Sets the input.
*
- * @param superType the super type
- * @param typeSystem the type system
+ * @param superType
+ * the super type
+ * @param typeSystem
+ * the type system
*/
public void setInput(Type superType, TypeSystem typeSystem) {
setInput(superType, typeSystem, Collections.emptyList());
}
-
+
/**
- * Selects the given type or does nothing if the
- * type is not listed.
+ * Selects the given type or does nothing if the type is not listed.
*
- * @param type the type
+ * @param type
+ * the type
*/
public void select(Type type) {
Integer typeIndex = typeNameList.indexOf(type.getName());
-
+
if (typeIndex != null) {
typeCombo.select(typeIndex);
}
}
-
+
/**
- * Retrieves the selected type. Behavior is undefined when called
- * before setInput.
+ * Retrieves the selected type. Behavior is undefined when called before setInput.
*
* @return the selected type
*/
public Type getType() {
return typeSystem.getType(typeCombo.getText());
}
-
+
/**
* Adds the listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
public void addListener(ITypePaneListener listener) {
listeners.add(listener);
}
-
+
/**
* Removes the listener.
*
- * @param listener the listener
+ * @param listener
+ * the listener
*/
public void removeListener(ITypePaneListener listener) {
listeners.remove(listener);
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationOutline.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationOutline.java
index 2b4c860..cbf0c22 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationOutline.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationOutline.java
@@ -65,14 +65,12 @@ import org.eclipse.ui.part.IPage;
import org.eclipse.ui.views.contentoutline.ContentOutline;
import org.eclipse.ui.views.contentoutline.ContentOutlinePage;
-
/**
- * This outline view displays all <code>AnnotationFS</code>s of the current
- * mode/type from the binded editor.
+ * This outline view displays all <code>AnnotationFS</code>s of the current mode/type from the
+ * binded editor.
*/
-public final class AnnotationOutline extends ContentOutlinePage
- implements ISelectionListener {
-
+public final class AnnotationOutline extends ContentOutlinePage implements ISelectionListener {
+
/**
* This listener receive events from the bound editor.
*/
@@ -81,7 +79,8 @@ public final class AnnotationOutline extends ContentOutlinePage
/**
* Called if the editor annotation mode was changed.
*
- * @param newMode the new mode
+ * @param newMode
+ * the new mode
*/
@Override
public void annotationModeChanged(Type newMode) {
@@ -112,10 +111,10 @@ public final class AnnotationOutline extends ContentOutlinePage
/** The editor change listener. */
private IAnnotationEditorModifyListener editorChangeListener;
-
+
/** The style. */
private OutlineStyles style = OutlineStyles.TYPE;
-
+
/** The m outline composite. */
private Composite mOutlineComposite;
@@ -130,8 +129,8 @@ public final class AnnotationOutline extends ContentOutlinePage
/**
* Creates a new <code>AnnotationOutline</code> object.
*
- * @param editor -
- * the editor to bind
+ * @param editor
+ * - the editor to bind
*/
public AnnotationOutline(AnnotationEditor editor) {
this.editor = editor;
@@ -140,7 +139,8 @@ public final class AnnotationOutline extends ContentOutlinePage
/**
* Creates the outline table control.
*
- * @param parent the parent
+ * @param parent
+ * the parent
*/
@Override
public void createControl(Composite parent) {
@@ -152,7 +152,7 @@ public final class AnnotationOutline extends ContentOutlinePage
getSite().getPage().addSelectionListener(this);
getSite().setSelectionProvider(mTableViewer);
-
+
changeAnnotationMode();
editorChangeListener = new EditorListener();
@@ -205,7 +205,8 @@ public final class AnnotationOutline extends ContentOutlinePage
* Adds the these actions to the global action handler: {@link DeleteFeatureStructureAction}
* SelectAllAction.
*
- * @param actionBars the new action bars
+ * @param actionBars
+ * the new action bars
*/
@Override
public void setActionBars(IActionBars actionBars) {
@@ -216,24 +217,25 @@ public final class AnnotationOutline extends ContentOutlinePage
getSite().getSelectionProvider().addSelectionChangedListener(deleteAction);
actionBars.setGlobalActionHandler(ActionFactory.SELECT_ALL.getId(), new SelectAllAction());
-
+
Action action = new SwitchStyleAction(this);
-
+
IMenuManager dropDownMenu = actionBars.getMenuManager();
dropDownMenu.add(action);
-
+
IToolBarManager toolBarManager = actionBars.getToolBarManager();
-
+
// wide left annotation side action
WideLeftAnnotationSideAction wideLeftAnnotationSideAction = new WideLeftAnnotationSideAction(
editor);
wideLeftAnnotationSideAction.setActionDefinitionId(WideLeftAnnotationSideAction.ID);
wideLeftAnnotationSideAction.setText("Wides the left annotation side");
- wideLeftAnnotationSideAction.setImageDescriptor(CasEditorPlugin
- .getTaeImageDescriptor(Images.WIDE_LEFT_SIDE));
+ wideLeftAnnotationSideAction
+ .setImageDescriptor(CasEditorPlugin.getTaeImageDescriptor(Images.WIDE_LEFT_SIDE));
getSite().getSelectionProvider().addSelectionChangedListener(wideLeftAnnotationSideAction);
- actionBars.setGlobalActionHandler(WideLeftAnnotationSideAction.ID, wideLeftAnnotationSideAction);
+ actionBars.setGlobalActionHandler(WideLeftAnnotationSideAction.ID,
+ wideLeftAnnotationSideAction);
toolBarManager.add(wideLeftAnnotationSideAction);
// lower left annotation side action
@@ -241,23 +243,25 @@ public final class AnnotationOutline extends ContentOutlinePage
editor);
lowerLeftAnnotationSideAction.setActionDefinitionId(LowerLeftAnnotationSideAction.ID);
lowerLeftAnnotationSideAction.setText("Lowers the left annotation side");
- lowerLeftAnnotationSideAction.setImageDescriptor(CasEditorPlugin
- .getTaeImageDescriptor(Images.LOWER_LEFT_SIDE));
+ lowerLeftAnnotationSideAction
+ .setImageDescriptor(CasEditorPlugin.getTaeImageDescriptor(Images.LOWER_LEFT_SIDE));
getSite().getSelectionProvider().addSelectionChangedListener(lowerLeftAnnotationSideAction);
- actionBars.setGlobalActionHandler(LowerLeftAnnotationSideAction.ID, lowerLeftAnnotationSideAction);
+ actionBars.setGlobalActionHandler(LowerLeftAnnotationSideAction.ID,
+ lowerLeftAnnotationSideAction);
toolBarManager.add(lowerLeftAnnotationSideAction);
// lower right annotation side action
- LowerRightAnnotationSideAction lowerRightAnnotationSideAction =
- new LowerRightAnnotationSideAction(editor);
+ LowerRightAnnotationSideAction lowerRightAnnotationSideAction = new LowerRightAnnotationSideAction(
+ editor);
lowerRightAnnotationSideAction.setActionDefinitionId(LowerRightAnnotationSideAction.ID);
lowerRightAnnotationSideAction.setText("Lowers the right annotation side");
- lowerRightAnnotationSideAction.setImageDescriptor(CasEditorPlugin
- .getTaeImageDescriptor(Images.LOWER_RIGHT_SIDE));
+ lowerRightAnnotationSideAction
+ .setImageDescriptor(CasEditorPlugin.getTaeImageDescriptor(Images.LOWER_RIGHT_SIDE));
getSite().getSelectionProvider().addSelectionChangedListener(lowerRightAnnotationSideAction);
- actionBars.setGlobalActionHandler(LowerRightAnnotationSideAction.ID, lowerRightAnnotationSideAction);
+ actionBars.setGlobalActionHandler(LowerRightAnnotationSideAction.ID,
+ lowerRightAnnotationSideAction);
toolBarManager.add(lowerRightAnnotationSideAction);
// wide right annotation side action
@@ -265,11 +269,12 @@ public final class AnnotationOutline extends ContentOutlinePage
editor);
wideRightAnnotationSideAction.setActionDefinitionId(WideRightAnnotationSideAction.ID);
wideRightAnnotationSideAction.setText("Wides the right annotation side");
- wideRightAnnotationSideAction.setImageDescriptor(CasEditorPlugin
- .getTaeImageDescriptor(Images.WIDE_RIGHT_SIDE));
+ wideRightAnnotationSideAction
+ .setImageDescriptor(CasEditorPlugin.getTaeImageDescriptor(Images.WIDE_RIGHT_SIDE));
getSite().getSelectionProvider().addSelectionChangedListener(wideRightAnnotationSideAction);
- actionBars.setGlobalActionHandler(WideRightAnnotationSideAction.ID, wideRightAnnotationSideAction);
+ actionBars.setGlobalActionHandler(WideRightAnnotationSideAction.ID,
+ wideRightAnnotationSideAction);
toolBarManager.add(wideRightAnnotationSideAction);
// merge action
@@ -281,7 +286,7 @@ public final class AnnotationOutline extends ContentOutlinePage
// delete action
toolBarManager.add(ActionFactory.DELETE.create(getSite().getWorkbenchWindow()));
-
+
super.setActionBars(actionBars);
}
@@ -291,31 +296,30 @@ public final class AnnotationOutline extends ContentOutlinePage
* @return the outline styles
*/
OutlineStyles currentStyle() {
- return style;
+ return style;
}
-
+
/**
* Switch style.
*
- * @param style the style
+ * @param style
+ * the style
*/
void switchStyle(OutlineStyles style) {
-
- this.style = style;
-
- if (OutlineStyles.MODE.equals(style)) {
- mTableViewer.setContentProvider(new ModeSensitiveContentProvider(
- editor, mTableViewer));
- } else if (OutlineStyles.TYPE.equals(style)) {
- mTableViewer.setContentProvider(new TypeGroupedContentProvider(
- editor, mTableViewer));
- } else {
- throw new CasEditorError("Unknown style!");
- }
-
- mTableViewer.refresh();
+
+ this.style = style;
+
+ if (OutlineStyles.MODE.equals(style)) {
+ mTableViewer.setContentProvider(new ModeSensitiveContentProvider(editor, mTableViewer));
+ } else if (OutlineStyles.TYPE.equals(style)) {
+ mTableViewer.setContentProvider(new TypeGroupedContentProvider(editor, mTableViewer));
+ } else {
+ throw new CasEditorError("Unknown style!");
+ }
+
+ mTableViewer.refresh();
}
-
+
/**
* Sets the focus.
*/
@@ -335,7 +339,8 @@ public final class AnnotationOutline extends ContentOutlinePage
/**
* Creates the table viewer.
*
- * @param parent the parent
+ * @param parent
+ * the parent
*/
private void createTableViewer(Composite parent) {
int style = SWT.MULTI | SWT.BORDER | SWT.H_SCROLL | SWT.V_SCROLL | SWT.FULL_SELECTION;
@@ -363,30 +368,28 @@ public final class AnnotationOutline extends ContentOutlinePage
// Note: The type style is considered as the default
mTableViewer.setContentProvider(new TypeGroupedContentProvider(editor, mTableViewer));
-
- mTableViewer.setFilters(new ViewerFilter[]{new ViewerFilter() {
-
- // TODO: Improve this filter ... it is to sloooooooooow
- @Override
- public boolean select(Viewer viewer, Object parentElement,
- Object element) {
- Collection<Type> shownTypes = editor.getShownAnnotationTypes();
-
- if (element instanceof AnnotationTypeTreeNode) {
- AnnotationTypeTreeNode typeNode = (AnnotationTypeTreeNode) element;
-
- return shownTypes.contains(typeNode.getType());
- }
- else if (element instanceof AnnotationTreeNode) {
- AnnotationTreeNode annotationNode = (AnnotationTreeNode) element;
-
- return shownTypes.contains(annotationNode.getAnnotation().getType());
- }
- else {
- throw new CasEditorError("Unexpected element type!");
- }
- }}});
-
+
+ mTableViewer.setFilters(new ViewerFilter[] { new ViewerFilter() {
+
+ // TODO: Improve this filter ... it is to sloooooooooow
+ @Override
+ public boolean select(Viewer viewer, Object parentElement, Object element) {
+ Collection<Type> shownTypes = editor.getShownAnnotationTypes();
+
+ if (element instanceof AnnotationTypeTreeNode) {
+ AnnotationTypeTreeNode typeNode = (AnnotationTypeTreeNode) element;
+
+ return shownTypes.contains(typeNode.getType());
+ } else if (element instanceof AnnotationTreeNode) {
+ AnnotationTreeNode annotationNode = (AnnotationTreeNode) element;
+
+ return shownTypes.contains(annotationNode.getAnnotation().getType());
+ } else {
+ throw new CasEditorError("Unexpected element type!");
+ }
+ }
+ } });
+
mTableViewer.setLabelProvider(new OutlineLabelProvider());
mTableViewer.setSorter(new OutlineTableSorter());
@@ -398,14 +401,14 @@ public final class AnnotationOutline extends ContentOutlinePage
@Override
public void selectionChanged(IWorkbenchPart part, ISelection selection) {
-
+
boolean isForeignSelection = true;
-
+
if (part instanceof ContentOutline) {
ContentOutline contentOutline = (ContentOutline) part;
-
+
IPage currentPage = contentOutline.getCurrentPage();
-
+
if (currentPage instanceof OutlinePageBook) {
OutlinePageBook pageBook = (OutlinePageBook) currentPage;
isForeignSelection = pageBook.getCasViewPage() != this;
@@ -417,8 +420,8 @@ public final class AnnotationOutline extends ContentOutlinePage
AnnotationSelection annotations = new AnnotationSelection((StructuredSelection) selection);
if (!annotations.isEmpty()) {
- ISelection tableSelection = new StructuredSelection(new AnnotationTreeNode(editor
- .getDocument(), annotations.getFirst()));
+ ISelection tableSelection = new StructuredSelection(
+ new AnnotationTreeNode(editor.getDocument(), annotations.getFirst()));
mTableViewer.setSelection(tableSelection, true);
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationTreeNode.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationTreeNode.java
index 3b9755e..75634ae 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationTreeNode.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationTreeNode.java
@@ -27,12 +27,11 @@ import org.apache.uima.caseditor.editor.ICasDocument;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IAdaptable;
-
/**
* TODO: add javadoc here.
*/
public class AnnotationTreeNode implements IAdaptable {
-
+
/** The m parent. */
private AnnotationTreeNode mParent;
@@ -45,8 +44,10 @@ public class AnnotationTreeNode implements IAdaptable {
/**
* Instantiates a new annotation tree node.
*
- * @param document the document
- * @param annotation the annotation
+ * @param document
+ * the document
+ * @param annotation
+ * the annotation
*/
AnnotationTreeNode(ICasDocument document, AnnotationFS annotation) {
Assert.isNotNull(document);
@@ -87,7 +88,8 @@ public class AnnotationTreeNode implements IAdaptable {
/**
* Checks if the given node is completly contained by the current node instance.
*
- * @param node the node
+ * @param node
+ * the node
* @return true if completly contained otherwise false
*/
boolean isChild(AnnotationTreeNode node) {
@@ -98,7 +100,8 @@ public class AnnotationTreeNode implements IAdaptable {
/**
* Adds the child.
*
- * @param node the node
+ * @param node
+ * the node
*/
void addChild(AnnotationTreeNode node) {
node.mParent = this;
@@ -108,9 +111,9 @@ public class AnnotationTreeNode implements IAdaptable {
mChildren.buildTree();
}
-
@Override
- public Object getAdapter(@SuppressWarnings("rawtypes") Class adapter) {
+ public Object getAdapter(@SuppressWarnings("rawtypes")
+ Class adapter) {
// TODO:
// use ModelFeatureStructure
// create a AdapterFactory which just calls the
@@ -118,8 +121,7 @@ public class AnnotationTreeNode implements IAdaptable {
if (AnnotationFS.class.equals(adapter) || FeatureStructure.class.equals(adapter)) {
return getAnnotation();
- }
- else {
+ } else {
return null;
}
}
@@ -131,16 +133,14 @@ public class AnnotationTreeNode implements IAdaptable {
@Override
public boolean equals(Object obj) {
-
+
if (this == obj) {
return true;
- }
- else if (obj instanceof AnnotationTreeNode) {
+ } else if (obj instanceof AnnotationTreeNode) {
AnnotationTreeNode other = (AnnotationTreeNode) obj;
-
+
return other.getAnnotation().equals(mAnnotation);
- }
- else {
+ } else {
return false;
}
}
diff --git a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationTreeNodeList.java b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationTreeNodeList.java
index ce7cdc7..c19cffb 100644
--- a/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationTreeNodeList.java
+++ b/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/editor/outline/AnnotationTreeNodeList.java
@@ -27,18 +27,16 @@ import java.util.List;
import org.apache.uima.cas.text.AnnotationFS;
import org.apache.uima.caseditor.editor.ICasDocument;
-
/**
- * The {@link AnnotationTreeNodeList} class can build a tree of
- * {@link AnnotationTreeNode} objects.
+ * The {@link AnnotationTreeNodeList} class can build a tree of {@link AnnotationTreeNode} objects.
*
- * Currently this is not used, because it slows down the Cas Editor UI
- * if the document contains to many annotations.
... 3203 lines suppressed ...
[uima-uimaj] 11/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit 585a8fe6cea1d1f7d0a496896333f376c8a40625
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:18:08 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../uima/caseditor/ide/CasEditorIdePlugin.java | 172 +++++++--------
.../ide/CasEditorIdePreferenceConstants.java | 11 +-
.../ide/CasEditorIdePreferenceInitializer.java | 20 +-
.../caseditor/ide/CasEditorIdePreferencePage.java | 7 +-
.../caseditor/ide/CasEditorPerspectiveFactory.java | 32 ++-
.../caseditor/ide/CasEditorPreferencePage.java | 8 +-
.../caseditor/ide/DefaultCasDocumentProvider.java | 74 +++----
.../org/apache/uima/caseditor/ide/NlpProject.java | 4 +-
.../ide/TypeSystemLocationPropertyPage.java | 92 ++++----
.../caseditor/ide/WorkspaceResourceDialog.java | 100 ++++-----
.../TypeSystemSearchStrategyFactory.java | 4 +-
.../ide/wizards/ContainerElementFilter.java | 2 +-
.../wizards/DocumentImportStructureProvider.java | 3 +-
.../ide/wizards/ImportDocumentWizard.java | 60 +++---
.../ide/wizards/ImportDocumentWizardPage.java | 236 ++++++++++-----------
.../uima/caseditor/ide/wizards/OverwriteQuery.java | 28 ++-
16 files changed, 415 insertions(+), 438 deletions(-)
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePlugin.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePlugin.java
index 8e8d40e..d5ad178 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePlugin.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePlugin.java
@@ -47,7 +47,7 @@ public class CasEditorIdePlugin extends AbstractUIPlugin {
*/
private static CasEditorIdePlugin sPlugin;
- /**
+ /**
* The constructor.
*/
public CasEditorIdePlugin() {
@@ -57,101 +57,104 @@ public class CasEditorIdePlugin extends AbstractUIPlugin {
/**
* This method is called upon plug-in activation
*
- * @param context -
- * @throws Exception -
+ * @param context
+ * -
+ * @throws Exception
+ * -
*/
@Override
public void start(BundleContext context) throws Exception {
- super.start(context);
-
- // Backward compatibility: Migrate old Cas Editor Projects
-
- // Scan for all Nlp nature projects
- IProject projects[] = ResourcesPlugin.getWorkspace().getRoot().getProjects();
-
- for (IProject project : projects) {
- // if nlp nature project
-
- if (project.isOpen() && project.hasNature("org.apache.uima.caseditor.NLPProject")) {
-
- // if ts property is not set ...
- String typeSystemLocation;
- try {
- typeSystemLocation = project.getPersistentProperty(new QualifiedName("",
- TypeSystemLocationPropertyPage.TYPE_SYSTEM_PROPERTY));
- } catch (CoreException e) {
- typeSystemLocation = null;
- }
-
- if (typeSystemLocation == null) {
- // 1. Read dotCorpus
- IFile dotCorpusFile = project.getFile(".corpus");
-
-
- if (dotCorpusFile.exists()) {
-
- InputStream dotCorpusIn = null;
-
- try {
- dotCorpusIn = dotCorpusFile.getContents();
- }
- catch (CoreException e) {
- log(e);
- }
-
- IFile typeSystemFile = null;
- if (dotCorpusIn != null) {
- try {
- DotCorpus dotCorpus = DotCorpusSerializer.parseDotCorpus(dotCorpusIn);
-
- if (dotCorpus.getTypeSystemFileName() != null) {
- typeSystemFile = project.getFile(dotCorpus.getTypeSystemFileName());
- }
- }
- finally {
- try {
- dotCorpusIn.close();
- }
- catch (IOException e) {
- log(e);
- }
- }
- }
-
- if (typeSystemFile != null && typeSystemFile.exists()) {
- // 2. Set type system file accordingly
- TypeSystemLocationPropertyPage.setTypeSystemLocation(project, typeSystemFile.getFullPath().toString());
-
- // 3. Try to copy dotCorpus file to type system location
- try {
- dotCorpusFile.copy(project.getFile(typeSystemFile.getParent().getProjectRelativePath() + "/"
- + ".style-" + typeSystemFile.getName()).getFullPath(), true, null);
- CasEditorPlugin.getDefault().setShowMigrationDialog();
- } catch (CoreException e) {
- log(e);
- }
- }
- }
- }
- }
- }
- }
+ super.start(context);
+
+ // Backward compatibility: Migrate old Cas Editor Projects
+
+ // Scan for all Nlp nature projects
+ IProject projects[] = ResourcesPlugin.getWorkspace().getRoot().getProjects();
+
+ for (IProject project : projects) {
+ // if nlp nature project
+
+ if (project.isOpen() && project.hasNature("org.apache.uima.caseditor.NLPProject")) {
+
+ // if ts property is not set ...
+ String typeSystemLocation;
+ try {
+ typeSystemLocation = project.getPersistentProperty(
+ new QualifiedName("", TypeSystemLocationPropertyPage.TYPE_SYSTEM_PROPERTY));
+ } catch (CoreException e) {
+ typeSystemLocation = null;
+ }
+
+ if (typeSystemLocation == null) {
+ // 1. Read dotCorpus
+ IFile dotCorpusFile = project.getFile(".corpus");
+
+ if (dotCorpusFile.exists()) {
+
+ InputStream dotCorpusIn = null;
+
+ try {
+ dotCorpusIn = dotCorpusFile.getContents();
+ } catch (CoreException e) {
+ log(e);
+ }
+
+ IFile typeSystemFile = null;
+ if (dotCorpusIn != null) {
+ try {
+ DotCorpus dotCorpus = DotCorpusSerializer.parseDotCorpus(dotCorpusIn);
+
+ if (dotCorpus.getTypeSystemFileName() != null) {
+ typeSystemFile = project.getFile(dotCorpus.getTypeSystemFileName());
+ }
+ } finally {
+ try {
+ dotCorpusIn.close();
+ } catch (IOException e) {
+ log(e);
+ }
+ }
+ }
+
+ if (typeSystemFile != null && typeSystemFile.exists()) {
+ // 2. Set type system file accordingly
+ TypeSystemLocationPropertyPage.setTypeSystemLocation(project,
+ typeSystemFile.getFullPath().toString());
+
+ // 3. Try to copy dotCorpus file to type system location
+ try {
+ dotCorpusFile.copy(
+ project.getFile(typeSystemFile.getParent().getProjectRelativePath() + "/"
+ + ".style-" + typeSystemFile.getName()).getFullPath(),
+ true, null);
+ CasEditorPlugin.getDefault().setShowMigrationDialog();
+ } catch (CoreException e) {
+ log(e);
+ }
+ }
+ }
+ }
+ }
+ }
+ }
/**
* This method is called when the plug-in is stopped.
*
- * @param context -
- * @throws Exception -
+ * @param context
+ * -
+ * @throws Exception
+ * -
*/
@Override
public void stop(BundleContext context) throws Exception {
super.stop(context);
sPlugin = null;
- /**
- * Resource bundle.
- */
- ResourceBundle mResourceBundle = null;
+ /**
+ * Resource bundle.
+ */
+ ResourceBundle mResourceBundle = null;
}
/**
@@ -166,7 +169,8 @@ public class CasEditorIdePlugin extends AbstractUIPlugin {
/**
* Log the throwable.
*
- * @param t -
+ * @param t
+ * -
*/
public static void log(Throwable t) {
getDefault().getLog().log(new Status(IStatus.ERROR, ID, IStatus.OK, t.getMessage(), t));
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferenceConstants.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferenceConstants.java
index 18278d9..2a3ffce 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferenceConstants.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferenceConstants.java
@@ -22,12 +22,11 @@ package org.apache.uima.caseditor.ide;
public class CasEditorIdePreferenceConstants {
public static final String STRING_DELIMITER = ";";
-
- public static final String CAS_IMPORT_WIZARD_LAST_USED_LANG =
- "CAS_IMPORT_WIZARD_LAST_USED_LANG";
-
+
+ public static final String CAS_IMPORT_WIZARD_LAST_USED_LANG = "CAS_IMPORT_WIZARD_LAST_USED_LANG";
+
public static final String CAS_IMPORT_WIZARD_LAST_USED_ENCODINGS = "CAS_IMPORT_WIZARD_ENCODINGS";
-
+
public static final String CAS_EDITOR_REMEMBER_TYPESYSTEM = "CAS_EDITOR_REMEMBER_TYPESYSTEM";
-
+
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferenceInitializer.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferenceInitializer.java
index dbfa745..875b302 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferenceInitializer.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferenceInitializer.java
@@ -27,16 +27,16 @@ import org.eclipse.jface.preference.IPreferenceStore;
public class CasEditorIdePreferenceInitializer extends AbstractPreferenceInitializer {
- @Override
+ @Override
public void initializeDefaultPreferences() {
- IPreferenceStore store = CasEditorIdePlugin.getDefault().getPreferenceStore();
- store.setDefault(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_LANG,
- CAS.DEFAULT_LANGUAGE_NAME);
-
- store.setDefault(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_ENCODINGS,
- Charset.defaultCharset().displayName());
-
+ IPreferenceStore store = CasEditorIdePlugin.getDefault().getPreferenceStore();
+ store.setDefault(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_LANG,
+ CAS.DEFAULT_LANGUAGE_NAME);
+
+ store.setDefault(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_ENCODINGS,
+ Charset.defaultCharset().displayName());
+
store.setDefault(CasEditorIdePreferenceConstants.CAS_EDITOR_REMEMBER_TYPESYSTEM, true);
-
- }
+
+ }
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferencePage.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferencePage.java
index 6e0807e..2df1fd8 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferencePage.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorIdePreferencePage.java
@@ -37,10 +37,11 @@ public class CasEditorIdePreferencePage extends FieldEditorPreferencePage
@Override
protected void createFieldEditors() {
-
+
// should the editor use the last selected type system to open the cas?
- BooleanFieldEditor mEditorRememberTypesystem = new BooleanFieldEditor(CasEditorIdePreferenceConstants.CAS_EDITOR_REMEMBER_TYPESYSTEM,
- "Use the previously selected type system to open a CAS", getFieldEditorParent());
+ BooleanFieldEditor mEditorRememberTypesystem = new BooleanFieldEditor(
+ CasEditorIdePreferenceConstants.CAS_EDITOR_REMEMBER_TYPESYSTEM,
+ "Use the previously selected type system to open a CAS", getFieldEditorParent());
addField(mEditorRememberTypesystem);
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorPerspectiveFactory.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorPerspectiveFactory.java
index acf7045..ec33646 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorPerspectiveFactory.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorPerspectiveFactory.java
@@ -19,7 +19,6 @@
package org.apache.uima.caseditor.ide;
-
import org.apache.uima.caseditor.editor.editview.EditView;
import org.apache.uima.caseditor.editor.fsview.FeatureStructureBrowserView;
import org.apache.uima.caseditor.editor.styleview.AnnotationStyleView;
@@ -28,17 +27,15 @@ import org.eclipse.ui.IPageLayout;
import org.eclipse.ui.IPerspectiveFactory;
/**
- * This <code>PerspectiveFactory</code> generates the initial layout
- * for the NLP perspective.
+ * This <code>PerspectiveFactory</code> generates the initial layout for the NLP perspective.
*/
public class CasEditorPerspectiveFactory implements IPerspectiveFactory {
-
+
/**
- * ID of the perspective factory. Use this ID for example in the plugin.xml
- * file.
+ * ID of the perspective factory. Use this ID for example in the plugin.xml file.
*
- * Note: This id should also be changed, but that will break existing
- * perspectives, and might confuse users.
+ * Note: This id should also be changed, but that will break existing perspectives, and might
+ * confuse users.
*/
public static String ID = "org.apache.uima.caseditor.perspective.NLP";
@@ -58,7 +55,6 @@ public class CasEditorPerspectiveFactory implements IPerspectiveFactory {
layout.addShowViewShortcut(IPageLayout.ID_OUTLINE);
layout.addShowViewShortcut(AnnotationStyleView.ID);
-
// add "open perspective"
layout.addPerspectiveShortcut(CasEditorPerspectiveFactory.ID);
}
@@ -67,29 +63,27 @@ public class CasEditorPerspectiveFactory implements IPerspectiveFactory {
String editorArea = layout.getEditorArea();
// left views
- IFolderLayout left = layout.createFolder("left", IPageLayout.LEFT,
- 0.19f, editorArea);
+ IFolderLayout left = layout.createFolder("left", IPageLayout.LEFT, 0.19f, editorArea);
left.addView("org.eclipse.ui.navigator.ProjectExplorer");
// right views
- IFolderLayout right = layout.createFolder("right", IPageLayout.RIGHT,
- 0.70f, editorArea);
+ IFolderLayout right = layout.createFolder("right", IPageLayout.RIGHT, 0.70f, editorArea);
right.addView(IPageLayout.ID_OUTLINE);
right.addView(FeatureStructureBrowserView.ID);
-
- IFolderLayout rightBottomCorner = layout.createFolder("rightBottomCorner", IPageLayout.BOTTOM,
+
+ IFolderLayout rightBottomCorner = layout.createFolder("rightBottomCorner", IPageLayout.BOTTOM,
0.75f, "right");
rightBottomCorner.addView(AnnotationStyleView.ID);
// bottom views
- IFolderLayout rightBottom = layout.createFolder("rightBottom",
- IPageLayout.BOTTOM, 0.75f, editorArea);
+ IFolderLayout rightBottom = layout.createFolder("rightBottom", IPageLayout.BOTTOM, 0.75f,
+ editorArea);
rightBottom.addView(EditView.ID);
- IFolderLayout leftBottom = layout.createFolder("leftBottom",
- IPageLayout.RIGHT, 0.5f, EditView.ID);
+ IFolderLayout leftBottom = layout.createFolder("leftBottom", IPageLayout.RIGHT, 0.5f,
+ EditView.ID);
leftBottom.addView(EditView.ID_2);
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorPreferencePage.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorPreferencePage.java
index 8053fbc..bef2a06 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorPreferencePage.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/CasEditorPreferencePage.java
@@ -24,21 +24,21 @@ import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
public class CasEditorPreferencePage extends FieldEditorPreferencePage
- implements IWorkbenchPreferencePage {
+ implements IWorkbenchPreferencePage {
public CasEditorPreferencePage() {
// TODO uncomment, if you really want to use this page
// setPreferenceStore(CasEditorPlugin.getDefault().getPreferenceStore());
setDescription("General Cas Editor Preferences.");
}
-
+
@Override
public void init(IWorkbench arg0) {
-
+
}
@Override
protected void createFieldEditors() {
-
+
}
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/DefaultCasDocumentProvider.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/DefaultCasDocumentProvider.java
index 7c98225..ecab50f 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/DefaultCasDocumentProvider.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/DefaultCasDocumentProvider.java
@@ -70,8 +70,8 @@ import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.ui.part.FileEditorInput;
-public class DefaultCasDocumentProvider extends
- org.apache.uima.caseditor.editor.CasDocumentProvider {
+public class DefaultCasDocumentProvider
+ extends org.apache.uima.caseditor.editor.CasDocumentProvider {
/**
* Listens for resource events: If the input file for the editor is removed the editor will be
@@ -100,7 +100,7 @@ public class DefaultCasDocumentProvider extends
if (delta.getKind() == IResourceDelta.REMOVED) {
handleElementDeleted(fileInput);
} else if (delta.getKind() == IResourceDelta.CHANGED) {
-
+
if (isFileChangeTrackingEnabled)
handleElementChanged(fileInput);
}
@@ -168,13 +168,13 @@ public class DefaultCasDocumentProvider extends
private Map<String, String> documentToTypeSystemMap = new HashMap<>();
/**
- * This map stores temporarily the type system that should be used to open the next document.
- * This functionality is separated from documentToTypeSystemMap since the preference for using
- * the previously selected type system can be deactivated. The inlined file choose, for example,
- * uses this field to remember the chosen type system.
+ * This map stores temporarily the type system that should be used to open the next document. This
+ * functionality is separated from documentToTypeSystemMap since the preference for using the
+ * previously selected type system can be deactivated. The inlined file choose, for example, uses
+ * this field to remember the chosen type system.
*/
private Map<String, String> typeSystemForNextDocumentOnly = new HashMap<>();
-
+
private Map<String, IPreferenceStore> sessionPreferenceStores = new HashMap<>();
/**
@@ -182,7 +182,7 @@ public class DefaultCasDocumentProvider extends
* while the editor is open.
*/
private Map<String, PreferenceStore> typeSystemPreferences = new HashMap<>();
-
+
private boolean isFileChangeTrackingEnabled = true;
// UIMA-2245 Remove this method together with the migration code below one day
@@ -226,20 +226,19 @@ public class DefaultCasDocumentProvider extends
// set by the editor for this specific CAS.
// apply that type system only if the setting is active in the preferences
String typeSystemFileString = null;
-
+
String document = casFile.getFullPath().toPortableString();
- if(typeSystemForNextDocumentOnly.get(document) != null) {
+ if (typeSystemForNextDocumentOnly.get(document) != null) {
// the type system was already set internally. Use this one and forget the information.
typeSystemFileString = typeSystemForNextDocumentOnly.get(document);
typeSystemForNextDocumentOnly.put(document, null);
}
-
+
IPreferenceStore prefStore = CasEditorIdePlugin.getDefault().getPreferenceStore();
boolean useLastTypesystem = prefStore
.getBoolean(CasEditorIdePreferenceConstants.CAS_EDITOR_REMEMBER_TYPESYSTEM);
if (typeSystemFileString == null && useLastTypesystem) {
- typeSystemFileString = documentToTypeSystemMap
- .get(document);
+ typeSystemFileString = documentToTypeSystemMap.get(document);
}
if (typeSystemFileString != null)
typeSystemFile = ResourcesPlugin.getWorkspace().getRoot()
@@ -278,15 +277,11 @@ public class DefaultCasDocumentProvider extends
// colors could change completely when the a type is
// added or removed to the type system
- IFile prefFile = ResourcesPlugin
- .getWorkspace()
- .getRoot()
- .getFile(
- new Path(getPreferenceFileForTypeSystem(typeSystemFile.getFullPath()
- .toPortableString())));
+ IFile prefFile = ResourcesPlugin.getWorkspace().getRoot().getFile(new Path(
+ getPreferenceFileForTypeSystem(typeSystemFile.getFullPath().toPortableString())));
- PreferenceStore tsPrefStore = typeSystemPreferences.get(prefFile.getFullPath()
- .toPortableString());
+ PreferenceStore tsPrefStore = typeSystemPreferences
+ .get(prefFile.getFullPath().toPortableString());
// If lookup for store failed ...
if (tsPrefStore == null) {
@@ -304,12 +299,8 @@ public class DefaultCasDocumentProvider extends
// If there is DotCorpus style file and not yet a preference store file
// the settings from the DotCorpus style file should be written into a preference store
// file.
- IFile styleFile = ResourcesPlugin
- .getWorkspace()
- .getRoot()
- .getFile(
- new Path(getStyleFileForTypeSystem(typeSystemFile.getFullPath()
- .toPortableString())));
+ IFile styleFile = ResourcesPlugin.getWorkspace().getRoot().getFile(new Path(
+ getStyleFileForTypeSystem(typeSystemFile.getFullPath().toPortableString())));
if (styleFile.exists()) {
InputStream styleFileIn = null;
@@ -372,8 +363,7 @@ public class DefaultCasDocumentProvider extends
typeSystemPreferences.put(prefFile.getFullPath().toPortableString(), tsPrefStore);
}
- documentToTypeSystemMap.put(document, typeSystemFile
- .getFullPath().toPortableString());
+ documentToTypeSystemMap.put(document, typeSystemFile.getFullPath().toPortableString());
IPreferenceStore store = sessionPreferenceStores.get(getTypesystemId(element));
@@ -382,12 +372,13 @@ public class DefaultCasDocumentProvider extends
sessionPreferenceStores.put(getTypesystemId(element), newStore);
newStore.addPropertyChangeListener(new SaveSessionPreferencesTrigger(element));
- String sessionPreferenceString = typeSystemFile.getPersistentProperty(new QualifiedName(
- "", CAS_EDITOR_SESSION_PROPERTIES));
+ String sessionPreferenceString = typeSystemFile
+ .getPersistentProperty(new QualifiedName("", CAS_EDITOR_SESSION_PROPERTIES));
if (sessionPreferenceString != null) {
try {
- newStore.load(new ByteArrayInputStream(sessionPreferenceString.getBytes(StandardCharsets.UTF_8)));
+ newStore.load(new ByteArrayInputStream(
+ sessionPreferenceString.getBytes(StandardCharsets.UTF_8)));
} catch (IOException e) {
CasEditorPlugin.log(e);
}
@@ -400,7 +391,8 @@ public class DefaultCasDocumentProvider extends
CAS cas = DocumentUimaImpl.getVirginCAS(typeSystemFile);
- ICasDocument doc = new DocumentUimaImpl(cas, casFile, typeSystemFile.getFullPath().makeRelative().toString());
+ ICasDocument doc = new DocumentUimaImpl(cas, casFile,
+ typeSystemFile.getFullPath().makeRelative().toString());
elementErrorStatus.remove(element);
@@ -442,13 +434,12 @@ public class DefaultCasDocumentProvider extends
documentImpl.serialize(outStream);
InputStream stream = new ByteArrayInputStream(outStream.toByteArray());
-
+
isFileChangeTrackingEnabled = false;
-
+
try {
file.setContents(stream, true, false, null);
- }
- finally {
+ } finally {
isFileChangeTrackingEnabled = true;
}
}
@@ -522,8 +513,7 @@ public class DefaultCasDocumentProvider extends
void setTypeSystemForNextDocumentOnly(String document, String typeSystem) {
typeSystemForNextDocumentOnly.put(document, typeSystem);
}
-
-
+
@Override
public Composite createTypeSystemSelectorForm(final ICasEditor editor, Composite parent,
IStatus status) {
@@ -546,8 +536,8 @@ public class DefaultCasDocumentProvider extends
public void widgetSelected(SelectionEvent e) {
// Open a dialog to let the user choose a type system
- IResource resource = WorkspaceResourceDialog.getWorkspaceResourceElement(Display
- .getCurrent().getActiveShell(), ResourcesPlugin.getWorkspace().getRoot(),
+ IResource resource = WorkspaceResourceDialog.getWorkspaceResourceElement(
+ Display.getCurrent().getActiveShell(), ResourcesPlugin.getWorkspace().getRoot(),
"Select a Type System", "Please select a Type System:");
if (resource != null) {
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/NlpProject.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/NlpProject.java
index ff932eb..ca6b0e1 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/NlpProject.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/NlpProject.java
@@ -26,11 +26,11 @@ import org.eclipse.core.runtime.CoreException;
public final class NlpProject implements IProjectNature {
private IProject project;
-
+
@Override
public void configure() throws CoreException {
}
-
+
@Override
public void deconfigure() throws CoreException {
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/TypeSystemLocationPropertyPage.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/TypeSystemLocationPropertyPage.java
index 0bbe14d..b6ce30c 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/TypeSystemLocationPropertyPage.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/TypeSystemLocationPropertyPage.java
@@ -45,8 +45,7 @@ import org.eclipse.ui.model.WorkbenchContentProvider;
import org.eclipse.ui.model.WorkbenchLabelProvider;
/**
- * Type System Property Page to set the default type system location
- * of a project.
+ * Type System Property Page to set the default type system location of a project.
*/
public class TypeSystemLocationPropertyPage extends PropertyPage {
@@ -56,25 +55,23 @@ public class TypeSystemLocationPropertyPage extends PropertyPage {
private Text typeSystemText;
-
IProject getProject() {
return (IProject) getElement().getAdapter(IProject.class);
}
-
+
String getDefaultTypeSystemLocation() {
-
+
IProject project = getProject();
-
+
if (project != null) {
- return project.getFile(DEFAULT_TYPE_SYSTEM_PATH).getFullPath().toString();
- }
- else {
- return "";
+ return project.getFile(DEFAULT_TYPE_SYSTEM_PATH).getFullPath().toString();
+ } else {
+ return "";
}
}
-
+
@Override
-protected Control createContents(Composite parent) {
+ protected Control createContents(Composite parent) {
Composite composite = new Composite(parent, SWT.NONE);
GridLayout layout = new GridLayout();
layout.numColumns = 2;
@@ -92,38 +89,39 @@ protected Control createContents(Composite parent) {
gd.grabExcessHorizontalSpace = true;
instructions.setLayoutData(gd);
- typeSystemText = new Text(composite,SWT.BORDER);
+ typeSystemText = new Text(composite, SWT.BORDER);
gd = new GridData(GridData.FILL_HORIZONTAL);
typeSystemText.setLayoutData(gd);
typeSystemText.addModifyListener(new ModifyListener() {
-
+
@Override
- public void modifyText(ModifyEvent event) {
+ public void modifyText(ModifyEvent event) {
updateApplyButton();
}
});
-
+
try {
- String typeSystemPath = ((IResource) getElement()).getPersistentProperty(new QualifiedName("",
- TYPE_SYSTEM_PROPERTY));
- typeSystemText.setText((typeSystemPath != null) ? typeSystemPath : getDefaultTypeSystemLocation());
+ String typeSystemPath = ((IResource) getElement())
+ .getPersistentProperty(new QualifiedName("", TYPE_SYSTEM_PROPERTY));
+ typeSystemText
+ .setText((typeSystemPath != null) ? typeSystemPath : getDefaultTypeSystemLocation());
} catch (CoreException e) {
typeSystemText.setText(DEFAULT_TYPE_SYSTEM_PATH);
}
-
+
Button browseButton = new Button(composite, SWT.PUSH);
browseButton.setText("Browse ...");
browseButton.addSelectionListener(new SelectionAdapter() {
@Override
- public void widgetSelected(SelectionEvent e) {
+ public void widgetSelected(SelectionEvent e) {
ElementTreeSelectionDialog dialog = new ElementTreeSelectionDialog(getShell(),
new WorkbenchLabelProvider(), new WorkbenchContentProvider());
dialog.setTitle("Select descriptor");
dialog.setMessage("Select descriptor");
dialog.setInput(ResourcesPlugin.getWorkspace().getRoot());
- dialog.setInitialSelection(ResourcesPlugin.getWorkspace().getRoot().
- findMember(typeSystemText.getText()));
+ dialog.setInitialSelection(
+ ResourcesPlugin.getWorkspace().getRoot().findMember(typeSystemText.getText()));
if (dialog.open() == IDialogConstants.OK_ID) {
IResource resource = (IResource) dialog.getFirstResult();
if (resource != null) {
@@ -133,24 +131,24 @@ protected Control createContents(Composite parent) {
}
}
});
-
+
return composite;
}
@Override
-protected void performDefaults() {
+ protected void performDefaults() {
typeSystemText.setText(getDefaultTypeSystemLocation());
}
-
+
@Override
-public boolean performOk() {
-
+ public boolean performOk() {
+
// have check, so performOk is only done when ts file is a valid file string
-
+
// store the value in the owner text field
try {
- ((IResource) getElement()).setPersistentProperty(
- new QualifiedName("", TYPE_SYSTEM_PROPERTY), typeSystemText.getText());
+ ((IResource) getElement()).setPersistentProperty(new QualifiedName("", TYPE_SYSTEM_PROPERTY),
+ typeSystemText.getText());
} catch (CoreException e) {
return false;
}
@@ -160,29 +158,32 @@ public boolean performOk() {
/**
* Retrieves the type system or null if its not set.
*
- * @param project -
+ * @param project
+ * -
* @return the type system location or null if its not set
*/
public static IFile getTypeSystemLocation(IProject project) {
-
+
IFile defaultTypeSystemFile = project.getFile(DEFAULT_TYPE_SYSTEM_PATH);
-
+
String typeSystemLocation;
try {
- typeSystemLocation = project.getPersistentProperty(new QualifiedName("", TYPE_SYSTEM_PROPERTY));
+ typeSystemLocation = project
+ .getPersistentProperty(new QualifiedName("", TYPE_SYSTEM_PROPERTY));
} catch (CoreException e) {
typeSystemLocation = null;
}
-
+
IFile typeSystemFile = null;
-
+
// Type system location is null when it was never set it anyway,
if (typeSystemLocation != null) {
-
+
if (typeSystemLocation.length() > 0) {
- IResource potentialTypeSystemResource = ResourcesPlugin.getWorkspace().getRoot().findMember(typeSystemLocation);
- if (potentialTypeSystemResource instanceof IFile) {
- typeSystemFile = (IFile) potentialTypeSystemResource;
+ IResource potentialTypeSystemResource = ResourcesPlugin.getWorkspace().getRoot()
+ .findMember(typeSystemLocation);
+ if (potentialTypeSystemResource instanceof IFile) {
+ typeSystemFile = (IFile) potentialTypeSystemResource;
}
}
// Empty string means user does not want a type system to be set
@@ -190,18 +191,19 @@ public boolean performOk() {
return null;
}
}
-
+
if (typeSystemFile == null) {
typeSystemFile = defaultTypeSystemFile;
}
-
+
return typeSystemFile;
}
public static void setTypeSystemLocation(IProject project, String typeSystemLocation) {
-
+
try {
- project.setPersistentProperty(new QualifiedName("", TYPE_SYSTEM_PROPERTY), typeSystemLocation);
+ project.setPersistentProperty(new QualifiedName("", TYPE_SYSTEM_PROPERTY),
+ typeSystemLocation);
} catch (CoreException e) {
CasEditorPlugin.log(e);
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/WorkspaceResourceDialog.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/WorkspaceResourceDialog.java
index bce5621..68ded5b 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/WorkspaceResourceDialog.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/WorkspaceResourceDialog.java
@@ -33,57 +33,57 @@ import org.eclipse.ui.views.navigator.ResourceSorter;
*
*
*/
-public class WorkspaceResourceDialog
-{
- public static IResource getWorkspaceResourceElement (Shell shell, IResource root,
- String dialogTitle, String dialogMessage)
- {
- IResource resource = null;
-
- ElementTreeSelectionDialog dialog = new ElementTreeSelectionDialog(shell,
- new WorkbenchLabelProvider(), new WorkbenchContentProvider());
- dialog.setTitle(dialogTitle);
- dialog.setMessage(dialogMessage);
- dialog.setInput(root);
- dialog.setSorter(new ResourceSorter(ResourceSorter.NAME));
- int buttonId = dialog.open();
- if (buttonId == IDialogConstants.OK_ID) {
- resource = (IResource) dialog.getFirstResult();
- if (!resource.isAccessible()) {
- return null;
- }
- if (resource instanceof IContainer) {
- }
- String arg = resource.getFullPath().toString();
- // String fileLoc = VariablesPlugin.getDefault().getStringVariableManager().generateVariableExpression("workspace_loc", arg); //$NON-NLS-1$
- // Trace.trace("resource.getFullPath().toString():" + arg);
- // Trace.trace(fileLoc);
- // selectedElement = resource.getLocation().toOSString();
- }
- return resource;
- }
+public class WorkspaceResourceDialog {
+ public static IResource getWorkspaceResourceElement(Shell shell, IResource root,
+ String dialogTitle, String dialogMessage) {
+ IResource resource = null;
+ ElementTreeSelectionDialog dialog = new ElementTreeSelectionDialog(shell,
+ new WorkbenchLabelProvider(), new WorkbenchContentProvider());
+ dialog.setTitle(dialogTitle);
+ dialog.setMessage(dialogMessage);
+ dialog.setInput(root);
+ dialog.setSorter(new ResourceSorter(ResourceSorter.NAME));
+ int buttonId = dialog.open();
+ if (buttonId == IDialogConstants.OK_ID) {
+ resource = (IResource) dialog.getFirstResult();
+ if (!resource.isAccessible()) {
+ return null;
+ }
+ if (resource instanceof IContainer) {
+ }
+ String arg = resource.getFullPath().toString();
+ // String fileLoc =
+ // VariablesPlugin.getDefault().getStringVariableManager().generateVariableExpression("workspace_loc",
+ // arg); //$NON-NLS-1$
+ // Trace.trace("resource.getFullPath().toString():" + arg);
+ // Trace.trace(fileLoc);
+ // selectedElement = resource.getLocation().toOSString();
+ }
+ return resource;
+ }
- public static IResource getWorkspaceResourceElement (Shell shell)
- {
- IResource resource = null;
- ElementTreeSelectionDialog dialog = new ElementTreeSelectionDialog(shell,
- new WorkbenchLabelProvider(), new WorkbenchContentProvider());
- dialog.setTitle("Select Cpe descriptor");
- dialog.setMessage("Select Cpe Xml descriptor file");
- dialog.setInput(ResourcesPlugin.getWorkspace().getRoot());
- dialog.setSorter(new ResourceSorter(ResourceSorter.NAME));
- int buttonId = dialog.open();
- if (buttonId == IDialogConstants.OK_ID) {
- resource = (IResource) dialog.getFirstResult();
- if (!resource.isAccessible()) {
- return null;
- }
- String arg = resource.getFullPath().toString();
- // String fileLoc = VariablesPlugin.getDefault().getStringVariableManager().generateVariableExpression("workspace_loc", arg); //$NON-NLS-1$
- // Trace.trace(fileLoc);
- // selectedElement = resource.getLocation().toOSString();
- }
- return resource;
+ public static IResource getWorkspaceResourceElement(Shell shell) {
+ IResource resource = null;
+ ElementTreeSelectionDialog dialog = new ElementTreeSelectionDialog(shell,
+ new WorkbenchLabelProvider(), new WorkbenchContentProvider());
+ dialog.setTitle("Select Cpe descriptor");
+ dialog.setMessage("Select Cpe Xml descriptor file");
+ dialog.setInput(ResourcesPlugin.getWorkspace().getRoot());
+ dialog.setSorter(new ResourceSorter(ResourceSorter.NAME));
+ int buttonId = dialog.open();
+ if (buttonId == IDialogConstants.OK_ID) {
+ resource = (IResource) dialog.getFirstResult();
+ if (!resource.isAccessible()) {
+ return null;
+ }
+ String arg = resource.getFullPath().toString();
+ // String fileLoc =
+ // VariablesPlugin.getDefault().getStringVariableManager().generateVariableExpression("workspace_loc",
+ // arg); //$NON-NLS-1$
+ // Trace.trace(fileLoc);
+ // selectedElement = resource.getLocation().toOSString();
}
+ return resource;
+ }
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/searchstrategy/TypeSystemSearchStrategyFactory.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/searchstrategy/TypeSystemSearchStrategyFactory.java
index 120affc..a903a5a 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/searchstrategy/TypeSystemSearchStrategyFactory.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/searchstrategy/TypeSystemSearchStrategyFactory.java
@@ -37,8 +37,8 @@ public class TypeSystemSearchStrategyFactory {
private TypeSystemSearchStrategyFactory() {
- IConfigurationElement[] config = Platform.getExtensionRegistry().getConfigurationElementsFor(
- SEARCH_STRATEGY_EXTENSION);
+ IConfigurationElement[] config = Platform.getExtensionRegistry()
+ .getConfigurationElementsFor(SEARCH_STRATEGY_EXTENSION);
for (IConfigurationElement element : config) {
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ContainerElementFilter.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ContainerElementFilter.java
index 5d6fa9a..d690aa8 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ContainerElementFilter.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ContainerElementFilter.java
@@ -32,7 +32,7 @@ public class ContainerElementFilter extends ViewerFilter {
if (element instanceof IAdaptable) {
IResource resourceElement = (IResource) ((IAdaptable) element).getAdapter(IResource.class);
-
+
if (resourceElement != null)
element = resourceElement;
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/DocumentImportStructureProvider.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/DocumentImportStructureProvider.java
index 0de6f7d..84c71e2 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/DocumentImportStructureProvider.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/DocumentImportStructureProvider.java
@@ -153,8 +153,7 @@ final class DocumentImportStructureProvider implements IImportStructureProvider
} else if (fileName.endsWith(".txt")) {
try {
String text = new String(Files.readAllBytes(fileToImport.toPath()), importEncoding);
- return getDocument(fileToImport.getAbsolutePath(), text, language,
- casFormat);
+ return getDocument(fileToImport.getAbsolutePath(), text, language, casFormat);
} catch (IOException e) {
return null;
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ImportDocumentWizard.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ImportDocumentWizard.java
index acb20db..6fab9f3 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ImportDocumentWizard.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ImportDocumentWizard.java
@@ -41,7 +41,7 @@ import org.eclipse.ui.wizards.datatransfer.ImportOperation;
* is supported.
*/
public final class ImportDocumentWizard extends Wizard implements IImportWizard {
-
+
private ImportDocumentWizardPage mMainPage;
private IStructuredSelection mCurrentResourceSelection;
@@ -64,49 +64,47 @@ public final class ImportDocumentWizard extends Wizard implements IImportWizard
@Override
public boolean performFinish() {
-
+
String usedEncoding = mMainPage.getTextEncoding();
-
+
IPreferenceStore store = CasEditorIdePlugin.getDefault().getPreferenceStore();
-
- String lastUsedEncodingsString = store.getString(
- CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_ENCODINGS);
-
- List<String> lastUsedEncodings = new ArrayList<>(Arrays.asList(lastUsedEncodingsString.split(
- CasEditorIdePreferenceConstants.STRING_DELIMITER)));
-
+
+ String lastUsedEncodingsString = store
+ .getString(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_ENCODINGS);
+
+ List<String> lastUsedEncodings = new ArrayList<>(Arrays.asList(
+ lastUsedEncodingsString.split(CasEditorIdePreferenceConstants.STRING_DELIMITER)));
+
int usedEncodingIndex = lastUsedEncodings.indexOf(usedEncoding);
-
+
if (usedEncodingIndex != -1) {
lastUsedEncodings.remove(usedEncodingIndex);
}
-
+
lastUsedEncodings.add(0, usedEncoding);
-
+
int maxUserItemCount = 10;
-
+
if (lastUsedEncodings.size() > maxUserItemCount) {
lastUsedEncodings = lastUsedEncodings.subList(0, maxUserItemCount - 1);
}
-
+
StringBuilder updatedLastUsedEncodingsString = new StringBuilder();
-
+
for (String encoding : lastUsedEncodings) {
updatedLastUsedEncodingsString.append(encoding);
- updatedLastUsedEncodingsString.append(
- CasEditorIdePreferenceConstants.STRING_DELIMITER);
+ updatedLastUsedEncodingsString.append(CasEditorIdePreferenceConstants.STRING_DELIMITER);
}
-
+
store.setValue(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_ENCODINGS,
updatedLastUsedEncodingsString.toString());
-
- IImportStructureProvider importProvider = new DocumentImportStructureProvider(mMainPage.getLanguage(),
- mMainPage.getTextEncoding(), mMainPage.getCasFormat());
-
+
+ IImportStructureProvider importProvider = new DocumentImportStructureProvider(
+ mMainPage.getLanguage(), mMainPage.getTextEncoding(), mMainPage.getCasFormat());
+
// BUG: We cannot pass null here for the overwrite query
- ImportOperation operation =
- new ImportOperation(mMainPage.getImportDestinationPath(), importProvider, new OverwriteQuery(getShell()),
- mMainPage.getFilesToImport());
+ ImportOperation operation = new ImportOperation(mMainPage.getImportDestinationPath(),
+ importProvider, new OverwriteQuery(getShell()), mMainPage.getFilesToImport());
operation.setContext(getShell());
@@ -116,18 +114,18 @@ public final class ImportDocumentWizard extends Wizard implements IImportWizard
getContainer().run(true, true, operation);
} catch (InvocationTargetException e) {
CasEditorPlugin.log(e);
-
+
String message = "Unkown error during import, see the log file for details";
-
+
Throwable cause = e.getCause();
if (cause != null) {
-
+
String causeMessage = cause.getMessage();
-
+
if (causeMessage != null)
message = causeMessage;
}
-
+
MessageDialog.openError(getContainer().getShell(), "Import failed", message);
return false;
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ImportDocumentWizardPage.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ImportDocumentWizardPage.java
index 4a3ec06..687fa07 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ImportDocumentWizardPage.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/ImportDocumentWizardPage.java
@@ -76,10 +76,10 @@ import org.eclipse.ui.model.WorkbenchLabelProvider;
final class ImportDocumentWizardPage extends WizardPage {
private static final Set<String> defaultEncodings;
-
+
static {
Set<String> encodings = new HashSet<>();
-
+
encodings.add("US-ASCII");
encodings.add("ISO-8859-1");
encodings.add("UTF-8");
@@ -87,66 +87,62 @@ final class ImportDocumentWizardPage extends WizardPage {
encodings.add("UTF-16LE");
encodings.add("UTF-16");
encodings.add(Charset.defaultCharset().displayName());
-
+
defaultEncodings = Collections.unmodifiableSet(encodings);
}
-
+
private IPath importDestinationPath;
private String importEncoding;
-
+
private String language;
-
+
private SerialFormat documentFormat;
-
+
private TableViewer fileTable;
private IContainer containerElement;
protected ImportDocumentWizardPage(String pageName,
- IStructuredSelection currentResourceSelection) {
+ IStructuredSelection currentResourceSelection) {
super(pageName);
setTitle("Import Text Files");
// TODO: Pre select the selected foler ..
-// if (!currentResourceSelection.isEmpty()) {
-// if (currentResourceSelection.getFirstElement() instanceof CorpusElement) {
-// containerElement = (IContainer) currentResourceSelection.getFirstElement();
-// importDestinationPath = containerElement.getFullPath();
-// }
-// }
-
+ // if (!currentResourceSelection.isEmpty()) {
+ // if (currentResourceSelection.getFirstElement() instanceof CorpusElement) {
+ // containerElement = (IContainer) currentResourceSelection.getFirstElement();
+ // importDestinationPath = containerElement.getFullPath();
+ // }
+ // }
+
setPageComplete(false);
}
private void updatePageState() {
-
- boolean isEncodingSupported = false;
-
- try {
- isEncodingSupported = Charset.isSupported(importEncoding);
- }
- catch (IllegalCharsetNameException e) {
- // Name of the Charset is incorrect, that means
- // it cannot exist
-
- }
-
- String errorMessage = null;
- if (!isEncodingSupported)
- errorMessage ="Invalid text import encoding!";
-
- // error message is always displayed instead of status message
- // if both are set
- setErrorMessage(errorMessage);
- setMessage("Please select the documents to import.");
-
-
-
- setPageComplete(importDestinationPath != null &&
- fileTable.getTable().getItemCount() > 0
- && isEncodingSupported);
+
+ boolean isEncodingSupported = false;
+
+ try {
+ isEncodingSupported = Charset.isSupported(importEncoding);
+ } catch (IllegalCharsetNameException e) {
+ // Name of the Charset is incorrect, that means
+ // it cannot exist
+
+ }
+
+ String errorMessage = null;
+ if (!isEncodingSupported)
+ errorMessage = "Invalid text import encoding!";
+
+ // error message is always displayed instead of status message
+ // if both are set
+ setErrorMessage(errorMessage);
+ setMessage("Please select the documents to import.");
+
+ setPageComplete(importDestinationPath != null && fileTable.getTable().getItemCount() > 0
+ && isEncodingSupported);
}
@Override
@@ -159,8 +155,8 @@ final class ImportDocumentWizardPage extends WizardPage {
GridDataFactory.fillDefaults().grab(true, true).span(2, 4).applyTo(fileTable.getControl());
Button addButton = new Button(composite, SWT.PUSH);
- addButton.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_FILL
- | GridData.VERTICAL_ALIGN_BEGINNING));
+ addButton.setLayoutData(
+ new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_BEGINNING));
addButton.setText("Add");
addButton.addSelectionListener(new SelectionListener() {
@@ -178,8 +174,8 @@ final class ImportDocumentWizardPage extends WizardPage {
// open a file dialog
FileDialog fd = new FileDialog(Display.getCurrent().getActiveShell(), SWT.MULTI);
fd.setText("Choose text files");
- fd.setFilterExtensions(new String[] { "*.txt;*.rtf", "*.*"});
- fd.setFilterNames(new String[] {"Text Files", "All Files (*)"});
+ fd.setFilterExtensions(new String[] { "*.txt;*.rtf", "*.*" });
+ fd.setFilterNames(new String[] { "Text Files", "All Files (*)" });
if (fd.open() != null) {
for (String fileItem : fd.getFileNames()) {
fileTable.add(new File(fd.getFilterPath() + File.separator + fileItem));
@@ -191,8 +187,8 @@ final class ImportDocumentWizardPage extends WizardPage {
});
Button removeButton = new Button(composite, SWT.PUSH);
- removeButton.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_FILL
- | GridData.VERTICAL_ALIGN_BEGINNING));
+ removeButton.setLayoutData(
+ new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_BEGINNING));
removeButton.setText("Remove");
removeButton.addSelectionListener(new SelectionListener() {
@@ -224,8 +220,8 @@ final class ImportDocumentWizardPage extends WizardPage {
});
Button selectAllButton = new Button(composite, SWT.PUSH);
- selectAllButton.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_FILL
- | GridData.VERTICAL_ALIGN_BEGINNING));
+ selectAllButton.setLayoutData(
+ new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_BEGINNING));
selectAllButton.setText("Select All");
selectAllButton.addSelectionListener(new SelectionListener() {
@@ -245,8 +241,8 @@ final class ImportDocumentWizardPage extends WizardPage {
});
Button deselectAllButton = new Button(composite, SWT.PUSH);
- deselectAllButton.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_FILL
- | GridData.VERTICAL_ALIGN_BEGINNING));
+ deselectAllButton.setLayoutData(
+ new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_BEGINNING));
deselectAllButton.setText("Deselect All");
deselectAllButton.addSelectionListener(new SelectionListener() {
@@ -265,7 +261,7 @@ final class ImportDocumentWizardPage extends WizardPage {
}
});
- // Into Corpus folder
+ // Into Corpus folder
Label intoFolderLabel = new Label(composite, SWT.NONE);
intoFolderLabel.setText("Into folder:");
@@ -277,8 +273,8 @@ final class ImportDocumentWizardPage extends WizardPage {
}
Button browseForFolder = new Button(composite, SWT.NONE);
- browseForFolder.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_FILL
- | GridData.VERTICAL_ALIGN_BEGINNING));
+ browseForFolder.setLayoutData(
+ new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_BEGINNING));
browseForFolder.setText("Browse");
browseForFolder.addSelectionListener(new SelectionListener() {
@@ -295,8 +291,9 @@ final class ImportDocumentWizardPage extends WizardPage {
public void widgetSelected(SelectionEvent e) {
final ElementTreeSelectionDialog folderSelectionDialog = new ElementTreeSelectionDialog(
- getShell(), new DecoratingLabelProvider(new WorkbenchLabelProvider(), PlatformUI
- .getWorkbench().getDecoratorManager().getLabelDecorator()),
+ getShell(),
+ new DecoratingLabelProvider(new WorkbenchLabelProvider(),
+ PlatformUI.getWorkbench().getDecoratorManager().getLabelDecorator()),
new BaseWorkbenchContentProvider());
folderSelectionDialog.addFilter(new ContainerElementFilter());
@@ -315,20 +312,21 @@ final class ImportDocumentWizardPage extends WizardPage {
public IStatus validate(Object[] selection) {
if (selection.length == 1) {
-
+
Object selectedElement = selection[0];
-
+
if (selectedElement instanceof IAdaptable) {
Object resourceElement = ((IAdaptable) selectedElement).getAdapter(IResource.class);
if (resourceElement != null)
selectedElement = resourceElement;
}
-
+
if (selectedElement instanceof IContainer)
return new Status(IStatus.OK, CasEditorPlugin.ID, 0, "", null);
}
- return new Status(IStatus.ERROR, CasEditorPlugin.ID, 0, "Please select a folder!", null);
+ return new Status(IStatus.ERROR, CasEditorPlugin.ID, 0, "Please select a folder!",
+ null);
}
});
@@ -339,19 +337,17 @@ final class ImportDocumentWizardPage extends WizardPage {
if (results != null && results.length > 0) {
// validator makes sure that an IContainer or an IAdaptable
// element which can provide an IContainer is selected
-
+
if (results[0] instanceof IContainer) {
containerElement = (IContainer) results[0];
- }
- else if (results[0] instanceof IAdaptable) {
+ } else if (results[0] instanceof IAdaptable) {
IAdaptable adaptableElement = (IAdaptable) results[0];
-
+
containerElement = (IContainer) adaptableElement.getAdapter(IResource.class);
- }
- else {
+ } else {
throw new IllegalStateException("Unexpected selection!");
}
-
+
importDestinationPath = containerElement.getFullPath();
corpusText.setText(importDestinationPath.toString());
@@ -369,81 +365,79 @@ final class ImportDocumentWizardPage extends WizardPage {
GridData importOptionsGridData = new GridData(GridData.FILL, GridData.CENTER, true, false);
importOptionsGridData.horizontalSpan = 3;
importOptions.setLayoutData(importOptionsGridData);
-
+
Label languageLabel = new Label(importOptions, SWT.NONE);
languageLabel.setText("Language:");
-
+
final IPreferenceStore store = CasEditorIdePlugin.getDefault().getPreferenceStore();
-
+
final Text languageText = new Text(importOptions, SWT.BORDER);
languageText.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
- language = store.getString(
- CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_LANG);
+ language = store.getString(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_LANG);
languageText.setText(language);
languageText.addModifyListener(new ModifyListener() {
-
+
@Override
public void modifyText(ModifyEvent e) {
language = languageText.getText();
store.setValue(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_LANG, language);
}
});
-
+
// Text file encoding
Label encodingLabel = new Label(importOptions, SWT.NONE);
encodingLabel.setText("Text Encoding:");
-
+
// combo box ...
final Combo encodingCombo = new Combo(importOptions, SWT.NONE);
encodingCombo.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
-
Set<String> charsets = new HashSet<>(defaultEncodings);
-
- String lastUsedEncodingsString =
- store.getString(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_ENCODINGS);
-
- String lastUsedEncodings[] = lastUsedEncodingsString.split(CasEditorIdePreferenceConstants.STRING_DELIMITER);
+
+ String lastUsedEncodingsString = store
+ .getString(CasEditorIdePreferenceConstants.CAS_IMPORT_WIZARD_LAST_USED_ENCODINGS);
+
+ String lastUsedEncodings[] = lastUsedEncodingsString
+ .split(CasEditorIdePreferenceConstants.STRING_DELIMITER);
charsets.addAll(Arrays.asList(lastUsedEncodings));
if (lastUsedEncodings.length > 0) {
importEncoding = lastUsedEncodings[0];
- }
- else {
+ } else {
importEncoding = Charset.defaultCharset().displayName();
}
-
+
encodingCombo.setItems(charsets.toArray(new String[charsets.size()]));
encodingCombo.setText(importEncoding);
encodingCombo.addSelectionListener(new SelectionListener() {
-
- @Override
+
+ @Override
public void widgetSelected(SelectionEvent e) {
- importEncoding = encodingCombo.getText();
- updatePageState();
- }
-
- @Override
+ importEncoding = encodingCombo.getText();
+ updatePageState();
+ }
+
+ @Override
public void widgetDefaultSelected(SelectionEvent e) {
- }
- });
-
+ }
+ });
+
encodingCombo.addKeyListener(new KeyListener() {
-
- @Override
+
+ @Override
public void keyReleased(KeyEvent e) {
- importEncoding = encodingCombo.getText();
- updatePageState();
- }
-
- @Override
+ importEncoding = encodingCombo.getText();
+ updatePageState();
+ }
+
+ @Override
public void keyPressed(KeyEvent e) {
- }
- });
-
+ }
+ });
+
Label casFormatLabel = new Label(importOptions, SWT.NONE);
casFormatLabel.setText("Cas Format:");
-
+
final Combo casFormatCombo = new Combo(importOptions, SWT.READ_ONLY);
casFormatCombo.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
SerialFormat[] values = SerialFormat.values();
@@ -454,21 +448,21 @@ final class ImportDocumentWizardPage extends WizardPage {
casFormatCombo.setItems(stringValues);
documentFormat = SerialFormat.XMI;
casFormatCombo.select(0);
-
+
casFormatCombo.addSelectionListener(new SelectionListener() {
-
- @Override
+
+ @Override
public void widgetSelected(SelectionEvent e) {
- documentFormat = SerialFormat.valueOf(casFormatCombo.getText());
- }
-
- @Override
+ documentFormat = SerialFormat.valueOf(casFormatCombo.getText());
+ }
+
+ @Override
public void widgetDefaultSelected(SelectionEvent e) {
- }
- });
-
+ }
+ });
+
updatePageState();
-
+
setControl(composite);
}
@@ -491,16 +485,16 @@ final class ImportDocumentWizardPage extends WizardPage {
return files;
}
-
+
String getTextEncoding() {
- return importEncoding;
+ return importEncoding;
}
-
+
String getLanguage() {
return language;
}
-
+
SerialFormat getCasFormat() {
- return documentFormat;
+ return documentFormat;
}
}
diff --git a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/OverwriteQuery.java b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/OverwriteQuery.java
index c7e0c81..f019e6d 100644
--- a/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/OverwriteQuery.java
+++ b/uimaj-ep-cas-editor-ide/src/main/java/org/apache/uima/caseditor/ide/wizards/OverwriteQuery.java
@@ -26,43 +26,39 @@ import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.dialogs.IOverwriteQuery;
/**
- * Overwrite Query to ask user how to deal with fields that need
- * to be overwritten.
+ * Overwrite Query to ask user how to deal with fields that need to be overwritten.
*/
class OverwriteQuery implements IOverwriteQuery {
private final Shell shell;
private String result = CANCEL;
-
+
OverwriteQuery(Shell shell) {
this.shell = shell;
}
-
+
@Override
public String queryOverwrite(final String pathString) {
if (ALL.equals(result)) {
return ALL;
}
-
- final String[] options = {
- IDialogConstants.YES_LABEL,
- IDialogConstants.YES_TO_ALL_LABEL,
- IDialogConstants.NO_LABEL,
- IDialogConstants.CANCEL_LABEL
- };
-
+
+ final String[] options = { IDialogConstants.YES_LABEL, IDialogConstants.YES_TO_ALL_LABEL,
+ IDialogConstants.NO_LABEL, IDialogConstants.CANCEL_LABEL };
+
// Must executed synchronously, otherwise the result is not available
// when the return statement is executed
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
- MessageDialog dialog = new MessageDialog(shell, "CAS target file already exists" , null,
- "The CAS target file already exists: \n" + pathString +
- "\n\nPlease choose an action.", MessageDialog.QUESTION, options, 0);
+ MessageDialog dialog = new MessageDialog(shell, "CAS target file already exists", null,
+ "The CAS target file already exists: \n" + pathString
+ + "\n\nPlease choose an action.",
+ MessageDialog.QUESTION, options, 0);
dialog.open();
-
+
String codes[] = { YES, ALL, NO, CANCEL };
result = codes[dialog.getReturnCode()];
}
[uima-uimaj] 03/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit f30abaad14d8c1f86c46a64fa8eca1b65a95d897
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 14:59:15 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../soap/AxisAnalysisEngineServiceStub.java | 27 ++++----
.../soap/AxisAnalysisEngineService_impl.java | 16 +++--
.../adapter/soap/AxisResourceServiceManager.java | 13 ++--
.../uima/adapter/soap/AxisResourceServiceStub.java | 4 +-
.../uima/adapter/soap/BinaryDeserializer.java | 57 ++++++++++------
.../adapter/soap/BinaryDeserializerFactory.java | 9 ++-
.../apache/uima/adapter/soap/BinarySerializer.java | 36 ++++++----
.../uima/adapter/soap/BinarySerializerFactory.java | 12 ++--
.../soap/SoapAnalysisEngineServiceAdapter.java | 26 ++++----
.../apache/uima/adapter/soap/XmlDeserializer.java | 67 ++++++++++++-------
.../uima/adapter/soap/XmlDeserializerFactory.java | 9 ++-
.../apache/uima/adapter/soap/XmlSerializer.java | 77 ++++++++++++++--------
.../uima/adapter/soap/XmlSerializerFactory.java | 9 ++-
.../soap/axis11/BinaryDeserializer_Axis11.java | 56 ++++++++++------
.../soap/axis11/BinarySerializer_Axis11.java | 35 ++++++----
.../soap/axis11/XmlDeserializer_Axis11.java | 66 ++++++++++++-------
.../adapter/soap/axis11/XmlSerializer_Axis11.java | 76 +++++++++++++--------
17 files changed, 384 insertions(+), 211 deletions(-)
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisAnalysisEngineServiceStub.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisAnalysisEngineServiceStub.java
index 8e6e92c..ce65ecb 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisAnalysisEngineServiceStub.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisAnalysisEngineServiceStub.java
@@ -41,15 +41,14 @@ import org.apache.uima.cas.CASException;
import org.apache.uima.resource.ResourceServiceException;
import org.apache.uima.resource.ResourceServiceStub;
-
/**
- * Proxy to an {@link AnalysisEngineService_impl} that makes use of Axis SOAP to communicate with the
- * service.
+ * Proxy to an {@link AnalysisEngineService_impl} that makes use of Axis SOAP to communicate with
+ * the service.
*
*
*/
-public class AxisAnalysisEngineServiceStub extends AxisResourceServiceStub implements
- AnalysisEngineServiceStub {
+public class AxisAnalysisEngineServiceStub extends AxisResourceServiceStub
+ implements AnalysisEngineServiceStub {
/** Whether attachments should be used to send binary-serialized data. */
private boolean mUseAttachments;
@@ -92,8 +91,10 @@ public class AxisAnalysisEngineServiceStub extends AxisResourceServiceStub imple
/**
* Call process.
*
- * @param aCAS the a CAS
- * @throws ResourceServiceException the resource service exception
+ * @param aCAS
+ * the a CAS
+ * @throws ResourceServiceException
+ * the resource service exception
* @see AnalysisEngineServiceStub#callProcess(CAS)
*/
@Override
@@ -152,8 +153,8 @@ public class AxisAnalysisEngineServiceStub extends AxisResourceServiceStub imple
resultCargo = (ServiceDataCargo) result;
} else {
throw new ResourceServiceException(
- ResourceServiceException.UNEXPECTED_SERVICE_RETURN_VALUE_TYPE, new Object[] {
- ServiceDataCargo.class.getName(),
+ ResourceServiceException.UNEXPECTED_SERVICE_RETURN_VALUE_TYPE,
+ new Object[] { ServiceDataCargo.class.getName(),
resultCargo == null ? "null" : resultCargo.getClass().getName() });
}
@@ -180,7 +181,9 @@ public class AxisAnalysisEngineServiceStub extends AxisResourceServiceStub imple
// no resources to clean up
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.analysis_engine.AnalysisEngineServiceStub#callBatchProcessComplete()
*/
@Override
@@ -188,7 +191,9 @@ public class AxisAnalysisEngineServiceStub extends AxisResourceServiceStub imple
// currently not implemented for SOAP services
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.analysis_engine.AnalysisEngineServiceStub#callCollectionProcessComplete()
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisAnalysisEngineService_impl.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisAnalysisEngineService_impl.java
index 6ff8377..053785f 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisAnalysisEngineService_impl.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisAnalysisEngineService_impl.java
@@ -28,7 +28,6 @@ import org.apache.uima.resource.ResourceServiceException;
import org.apache.uima.resource.metadata.ResourceMetaData;
import org.apache.uima.util.Level;
-
/**
* A class used to deploy a {@link AnalysisEngineService_impl} as an Axis (SOAP) service.
*/
@@ -41,7 +40,8 @@ public class AxisAnalysisEngineService_impl {
/**
* Constructor, responsible for initializing the service.
*
- * @throws AxisFault the axis fault
+ * @throws AxisFault
+ * the axis fault
*/
public AxisAnalysisEngineService_impl() throws AxisFault {
mServiceImpl = (AnalysisEngineService_impl) AxisResourceServiceManager
@@ -52,7 +52,8 @@ public class AxisAnalysisEngineService_impl {
* Gets metadata for this Resource service.
*
* @return metadata
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
*/
public ResourceMetaData getMetaData() throws ResourceServiceException {
try {
@@ -69,10 +70,13 @@ public class AxisAnalysisEngineService_impl {
/**
* Processes an entity.
*
- * @param aData data to be processed
- * @param aResultSpec specifies which results the Analysis Engine should produce
+ * @param aData
+ * data to be processed
+ * @param aResultSpec
+ * specifies which results the Analysis Engine should produce
* @return the results of analysis
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
*/
public ServiceDataCargo process(ServiceDataCargo aData, ResultSpecification aResultSpec)
throws ResourceServiceException {
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisResourceServiceManager.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisResourceServiceManager.java
index e15633a..b3ef4ef 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisResourceServiceManager.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisResourceServiceManager.java
@@ -34,7 +34,6 @@ import org.apache.uima.util.Level;
import org.apache.uima.util.Logger;
import org.apache.uima.util.XMLInputSource;
-
/**
* Utility class for deploying Resources as Axis (SOAP) services. This class mantains a map between
* Axis service names and the {@link ResourceService_impl} classes that provide the implementation
@@ -84,10 +83,12 @@ public class AxisResourceServiceManager {
* returned. Otherwise, a new <code>ResourceService_impl</code> object will be created from the
* information in the MessageContext.
*
- * @param aServiceImplClass the class that will be instantiated when a new <code>ResourceService_impl</code> is
- * to be created. This must be a subclass of ResourceService_impl.
+ * @param aServiceImplClass
+ * the class that will be instantiated when a new <code>ResourceService_impl</code> is to
+ * be created. This must be a subclass of ResourceService_impl.
* @return the service impl
- * @throws AxisFault if the configuration information could not be read
+ * @throws AxisFault
+ * if the configuration information could not be read
*/
public static ResourceService_impl getServiceImpl(Class aServiceImplClass) throws AxisFault {
try {
@@ -121,8 +122,8 @@ public class AxisResourceServiceManager {
+ " not Defined. Check your deployment descriptor file (WSDD)");
}
// parse ResourceSpecifier
- ResourceSpecifier resourceSpecifier = UIMAFramework.getXMLParser().parseResourceSpecifier(
- new XMLInputSource(resourceSpecifierPath));
+ ResourceSpecifier resourceSpecifier = UIMAFramework.getXMLParser()
+ .parseResourceSpecifier(new XMLInputSource(resourceSpecifierPath));
// Get the number of instances to create
String numInstancesStr = (String) self.getOption(PARAM_NUM_INSTANCES);
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisResourceServiceStub.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisResourceServiceStub.java
index d522262..8c45a6c 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisResourceServiceStub.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/AxisResourceServiceStub.java
@@ -32,7 +32,6 @@ import org.apache.uima.resource.ResourceServiceStub;
import org.apache.uima.resource.metadata.ResourceMetaData;
import org.apache.uima.resource.service.impl.ResourceService_impl;
-
/**
* Proxy to a {@link ResourceService_impl} that uses Axis SOAP to communicate with the service.
*
@@ -70,7 +69,8 @@ public abstract class AxisResourceServiceStub implements ResourceServiceStub {
* Call get meta data.
*
* @return the resource meta data
- * @throws ResourceServiceException the resource service exception
+ * @throws ResourceServiceException
+ * the resource service exception
* @see ResourceService_impl#getMetaData()
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinaryDeserializer.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinaryDeserializer.java
index 3619f98..3d2ccfb 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinaryDeserializer.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinaryDeserializer.java
@@ -38,7 +38,6 @@ import org.apache.uima.internal.util.SerializationUtils;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
-
/**
* An Axis deserializer for {@link Serializable} objects. The serialized bytes are Base-64 encoded
* for transport via SOAP.
@@ -53,12 +52,15 @@ public class BinaryDeserializer extends DeserializerImpl {
/** The buf. */
private StringBuffer buf = new StringBuffer();
- /* (non-Javadoc)
- * @see org.apache.axis.encoding.DeserializerImpl#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes, org.apache.axis.encoding.DeserializationContext)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.axis.encoding.DeserializerImpl#startElement(java.lang.String, java.lang.String,
+ * java.lang.String, org.xml.sax.Attributes, org.apache.axis.encoding.DeserializationContext)
*/
@Override
- public void startElement(String namespace, String localName, String prefix,
- Attributes attributes, DeserializationContext context) throws SAXException {
+ public void startElement(String namespace, String localName, String prefix, Attributes attributes,
+ DeserializationContext context) throws SAXException {
// System.out.println("startElement(" + namespace + "," + localName + "," + prefix + ")");
if (!context.isDoneParsing()) {
@@ -122,13 +124,20 @@ public class BinaryDeserializer extends DeserializerImpl {
/**
* On start element.
*
- * @param namespace the namespace
- * @param localName the local name
- * @param prefix the prefix
- * @param attributes the attributes
- * @param context the context
- * @throws SAXException the SAX exception
- * @see org.apache.axis.message.SOAPHandler#onStartChild(String, String, String, Attributes, DeserializationContext)
+ * @param namespace
+ * the namespace
+ * @param localName
+ * the local name
+ * @param prefix
+ * the prefix
+ * @param attributes
+ * the attributes
+ * @param context
+ * the context
+ * @throws SAXException
+ * the SAX exception
+ * @see org.apache.axis.message.SOAPHandler#onStartChild(String, String, String, Attributes,
+ * DeserializationContext)
*/
@Override
public void onStartElement(String namespace, String localName, String prefix,
@@ -139,10 +148,14 @@ public class BinaryDeserializer extends DeserializerImpl {
/**
* On end element.
*
- * @param arg0 the arg 0
- * @param arg1 the arg 1
- * @param arg2 the arg 2
- * @throws SAXException the SAX exception
+ * @param arg0
+ * the arg 0
+ * @param arg1
+ * the arg 1
+ * @param arg2
+ * the arg 2
+ * @throws SAXException
+ * the SAX exception
* @see org.apache.axis.encoding.Deserializer#onEndElement(java.lang.String, java.lang.String,
* org.apache.axis.encoding.DeserializationContext)
*/
@@ -171,10 +184,14 @@ public class BinaryDeserializer extends DeserializerImpl {
/**
* Characters.
*
- * @param ch the ch
- * @param start the start
- * @param length the length
- * @throws SAXException the SAX exception
+ * @param ch
+ * the ch
+ * @param start
+ * the start
+ * @param length
+ * the length
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#characters(char[], int, int)
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinaryDeserializerFactory.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinaryDeserializerFactory.java
index 05ac1f4..2abf1d2 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinaryDeserializerFactory.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinaryDeserializerFactory.java
@@ -27,7 +27,6 @@ import org.apache.axis.Version;
import org.apache.axis.encoding.DeserializerFactory;
import org.apache.uima.adapter.soap.axis11.BinaryDeserializer_Axis11;
-
/**
* An Axis deserializer factory that constructs instances of {@link BinaryDeserializer}.
*
@@ -41,7 +40,9 @@ public class BinaryDeserializerFactory implements DeserializerFactory {
/** The mechanisms. */
private Vector mechanisms;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.DeserializerFactory#getDeserializerAs(java.lang.String)
*/
@Override
@@ -59,7 +60,9 @@ public class BinaryDeserializerFactory implements DeserializerFactory {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.DeserializerFactory#getSupportedMechanismTypes()
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinarySerializer.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinarySerializer.java
index 8d8ecf6..76030f7 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinarySerializer.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinarySerializer.java
@@ -41,7 +41,6 @@ import org.w3c.dom.Element;
import org.xml.sax.Attributes;
import org.xml.sax.helpers.AttributesImpl;
-
/**
* An Axis serializer for {@link Serializable} objects. The serialized bytes are Base-64 encoded for
* transport via SOAP.
@@ -66,7 +65,8 @@ public class BinarySerializer implements Serializer {
/**
* Instantiates a new binary serializer.
*
- * @param aUseAttachments the a use attachments
+ * @param aUseAttachments
+ * the a use attachments
*/
public BinarySerializer(boolean aUseAttachments) {
mUseAttachments = aUseAttachments;
@@ -75,11 +75,16 @@ public class BinarySerializer implements Serializer {
/**
* Serialize an element named name, with the indicated attributes and value.
*
- * @param name is the element name
- * @param attributes are the attributes...serializer is free to add more.
- * @param value is the value
- * @param context is the SerializationContext
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param name
+ * is the element name
+ * @param attributes
+ * are the attributes...serializer is free to add more.
+ * @param value
+ * is the value
+ * @param context
+ * is the SerializationContext
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
@Override
public void serialize(QName name, Attributes attributes, Object value,
@@ -102,8 +107,8 @@ public class BinarySerializer implements Serializer {
if (useAttachments) {
// System.out.println("Creating attachment"); //DEBUG
SOAPConstants soapConstants = context.getMessageContext().getSOAPConstants();
- DataHandler dataHandler = new DataHandler(new OctetStreamDataSource("test",
- new OctetStream(bytes)));
+ DataHandler dataHandler = new DataHandler(
+ new OctetStreamDataSource("test", new OctetStream(bytes)));
Part attachmentPart = attachments.createAttachmentPart(dataHandler);
AttributesImpl attrs = new AttributesImpl();
@@ -135,7 +140,9 @@ public class BinarySerializer implements Serializer {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.Serializer#getMechanismType()
*/
@Override
@@ -146,10 +153,13 @@ public class BinarySerializer implements Serializer {
/**
* Write schema.
*
- * @param javaType the java type
- * @param types the types
+ * @param javaType
+ * the java type
+ * @param types
+ * the types
* @return the element
- * @throws Exception the exception
+ * @throws Exception
+ * the exception
* @see org.apache.axis.encoding.Serializer#writeSchema(java.lang.Class,
* org.apache.axis.wsdl.fromJava.Types)
*/
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinarySerializerFactory.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinarySerializerFactory.java
index 9e978ff..b2b56ed 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinarySerializerFactory.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/BinarySerializerFactory.java
@@ -29,7 +29,6 @@ import org.apache.axis.Version;
import org.apache.axis.encoding.SerializerFactory;
import org.apache.uima.adapter.soap.axis11.BinarySerializer_Axis11;
-
/**
* An Axis serializer factory that constructs instances of {@link BinarySerializer}.
*
@@ -53,13 +52,16 @@ public class BinarySerializerFactory implements SerializerFactory {
/**
* Instantiates a new binary serializer factory.
*
- * @param aUseAttachments the a use attachments
+ * @param aUseAttachments
+ * the a use attachments
*/
public BinarySerializerFactory(boolean aUseAttachments) {
// TODO: attachments never used?
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.SerializerFactory#getSerializerAs(java.lang.String)
*/
@Override
@@ -77,7 +79,9 @@ public class BinarySerializerFactory implements SerializerFactory {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.SerializerFactory#getSupportedMechanismTypes()
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/SoapAnalysisEngineServiceAdapter.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/SoapAnalysisEngineServiceAdapter.java
index 6fb4cd8..a968dc7 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/SoapAnalysisEngineServiceAdapter.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/SoapAnalysisEngineServiceAdapter.java
@@ -29,7 +29,6 @@ import org.apache.uima.resource.ResourceInitializationException;
import org.apache.uima.resource.ResourceSpecifier;
import org.apache.uima.resource.URISpecifier;
-
/**
* Reference implementation of {@link AnalysisEngineServiceAdapter} for SOAP.
*
@@ -40,10 +39,13 @@ public class SoapAnalysisEngineServiceAdapter extends AnalysisEngineServiceAdapt
/**
* Initialize.
*
- * @param aSpecifier the a specifier
- * @param aAdditionalParams the a additional params
+ * @param aSpecifier
+ * the a specifier
+ * @param aAdditionalParams
+ * the a additional params
* @return true, if successful
- * @throws ResourceInitializationException the resource initialization exception
+ * @throws ResourceInitializationException
+ * the resource initialization exception
* @see org.apache.uima.resource.Resource#initialize(ResourceSpecifier, Map)
*/
@Override
@@ -66,8 +68,9 @@ public class SoapAnalysisEngineServiceAdapter extends AnalysisEngineServiceAdapt
try {
// create proxy to service
- AnalysisEngineServiceStub stub = new AxisAnalysisEngineServiceStub(uriSpec.getUri(), uriSpec
- .getTimeout(), uriSpec.getProtocol().equals(Constants.PROTOCOL_SOAP_WITH_ATTACHMENTS));
+ AnalysisEngineServiceStub stub = new AxisAnalysisEngineServiceStub(uriSpec.getUri(),
+ uriSpec.getTimeout(),
+ uriSpec.getProtocol().equals(Constants.PROTOCOL_SOAP_WITH_ATTACHMENTS));
setStub(stub);
// finish initialization. This requires access to metadata, so must be called
@@ -78,13 +81,14 @@ public class SoapAnalysisEngineServiceAdapter extends AnalysisEngineServiceAdapt
throw new ResourceInitializationException(ResourceInitializationException.MALFORMED_URL,
new Object[] { uriSpec.getUri(), uriSpec.getSourceUrlString() }, e);
}
-
- // Sofa mappings are currently not implemented for remote AEs. Catch this
+
+ // Sofa mappings are currently not implemented for remote AEs. Catch this
// and report an error.
if (getUimaContextAdmin().getSofaMap().size() > 0) {
- throw new ResourceInitializationException(ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE,
- new Object[]{getMetaData().getName()});
- }
+ throw new ResourceInitializationException(
+ ResourceInitializationException.SOFA_MAPPING_NOT_SUPPORTED_FOR_REMOTE,
+ new Object[] { getMetaData().getName() });
+ }
return true;
}
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlDeserializer.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlDeserializer.java
index 22a99de..fe45013 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlDeserializer.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlDeserializer.java
@@ -33,7 +33,6 @@ import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.LocatorImpl;
-
/**
* An Axis deserializer for any {@link XMLizable} object.
*
@@ -70,13 +69,19 @@ public class XmlDeserializer extends DeserializerImpl {
/**
* This method is invoked when an element start tag is encountered.
*
- * @param namespace is the namespace of the element
- * @param localName is the name of the element
- * @param prefix is the element's prefix
- * @param attributes are the attributes on the element...used to get the type
- * @param context is the DeserializationContext
+ * @param namespace
+ * is the namespace of the element
+ * @param localName
+ * is the name of the element
+ * @param prefix
+ * is the element's prefix
+ * @param attributes
+ * are the attributes on the element...used to get the type
+ * @param context
+ * is the DeserializationContext
* @return the SOAP handler
- * @throws SAXException the SAX exception
+ * @throws SAXException
+ * the SAX exception
*/
@Override
public SOAPHandler onStartChild(String namespace, String localName, String prefix,
@@ -87,13 +92,20 @@ public class XmlDeserializer extends DeserializerImpl {
/**
* On start element.
*
- * @param arg0 the arg 0
- * @param arg1 the arg 1
- * @param arg2 the arg 2
- * @param arg3 the arg 3
- * @param arg4 the arg 4
- * @throws SAXException the SAX exception
- * @see org.apache.axis.message.SOAPHandler#onStartChild(String, String, String, Attributes, DeserializationContext)
+ * @param arg0
+ * the arg 0
+ * @param arg1
+ * the arg 1
+ * @param arg2
+ * the arg 2
+ * @param arg3
+ * the arg 3
+ * @param arg4
+ * the arg 4
+ * @throws SAXException
+ * the SAX exception
+ * @see org.apache.axis.message.SOAPHandler#onStartChild(String, String, String, Attributes,
+ * DeserializationContext)
*/
@Override
public void onStartElement(String arg0, String arg1, String arg2, Attributes arg3,
@@ -112,10 +124,14 @@ public class XmlDeserializer extends DeserializerImpl {
/**
* Characters.
*
- * @param ch the ch
- * @param start the start
- * @param length the length
- * @throws SAXException the SAX exception
+ * @param ch
+ * the ch
+ * @param start
+ * the start
+ * @param length
+ * the length
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#characters(char[], int, int)
*/
@Override
@@ -128,10 +144,14 @@ public class XmlDeserializer extends DeserializerImpl {
/**
* On end element.
*
- * @param arg0 the arg 0
- * @param arg1 the arg 1
- * @param arg2 the arg 2
- * @throws SAXException the SAX exception
+ * @param arg0
+ * the arg 0
+ * @param arg1
+ * the arg 1
+ * @param arg2
+ * the arg 2
+ * @throws SAXException
+ * the SAX exception
* @see org.apache.axis.encoding.Deserializer#onEndElement(java.lang.String, java.lang.String,
* org.apache.axis.encoding.DeserializationContext)
*/
@@ -149,7 +169,8 @@ public class XmlDeserializer extends DeserializerImpl {
/**
* Value complete.
*
- * @throws SAXException the SAX exception
+ * @throws SAXException
+ * the SAX exception
* @see org.apache.axis.encoding.Deserializer#valueComplete()
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlDeserializerFactory.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlDeserializerFactory.java
index 071ddd4..c72c679 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlDeserializerFactory.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlDeserializerFactory.java
@@ -27,7 +27,6 @@ import org.apache.axis.Version;
import org.apache.axis.encoding.DeserializerFactory;
import org.apache.uima.adapter.soap.axis11.XmlDeserializer_Axis11;
-
/**
* An Axis deserializer factory that constructs instances of {@link XmlDeserializer}.
*
@@ -41,7 +40,9 @@ public class XmlDeserializerFactory implements DeserializerFactory {
/** The mechanisms. */
private Vector mechanisms;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.DeserializerFactory#getDeserializerAs(java.lang.String)
*/
@Override
@@ -59,7 +60,9 @@ public class XmlDeserializerFactory implements DeserializerFactory {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.DeserializerFactory#getSupportedMechanismTypes()
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlSerializer.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlSerializer.java
index 9728725..ef7a4d4 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlSerializer.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlSerializer.java
@@ -33,7 +33,6 @@ import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
-
/**
* An Axis serializer for any {@link XMLizable} object.
*
@@ -47,11 +46,16 @@ public class XmlSerializer implements Serializer {
/**
* Serialize an element named name, with the indicated attributes and value.
*
- * @param name is the element name
- * @param attributes are the attributes...serializer is free to add more.
- * @param value is the value
- * @param context is the SerializationContext
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param name
+ * is the element name
+ * @param attributes
+ * are the attributes...serializer is free to add more.
+ * @param value
+ * is the value
+ * @param context
+ * is the SerializationContext
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
@Override
public void serialize(QName name, Attributes attributes, Object value,
@@ -68,12 +72,14 @@ public class XmlSerializer implements Serializer {
throw new IOException("SAXException: " + e.getMessage());
}
} else {
- throw new IOException("Can't serialize a " + value.getClass().getName()
- + " with an XmlSerializer.");
+ throw new IOException(
+ "Can't serialize a " + value.getClass().getName() + " with an XmlSerializer.");
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.Serializer#getMechanismType()
*/
@Override
@@ -84,10 +90,13 @@ public class XmlSerializer implements Serializer {
/**
* Write schema.
*
- * @param javaType the java type
- * @param types the types
+ * @param javaType
+ * the java type
+ * @param types
+ * the types
* @return the element
- * @throws Exception the exception
+ * @throws Exception
+ * the exception
* @see org.apache.axis.encoding.Serializer#writeSchema(java.lang.Class,
* org.apache.axis.wsdl.fromJava.Types)
*/
@@ -103,14 +112,15 @@ public class XmlSerializer implements Serializer {
*
*/
static class SerializerContentHandler extends DefaultHandler {
-
+
/** The m context. */
private SerializationContext mContext;
/**
* Instantiates a new serializer content handler.
*
- * @param aContext the a context
+ * @param aContext
+ * the a context
*/
SerializerContentHandler(SerializationContext aContext) {
mContext = aContext;
@@ -119,10 +129,14 @@ public class XmlSerializer implements Serializer {
/**
* Characters.
*
- * @param ch the ch
- * @param start the start
- * @param length the length
- * @throws SAXException the SAX exception
+ * @param ch
+ * the ch
+ * @param start
+ * the start
+ * @param length
+ * the length
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#characters(char[], int, int)
*/
@Override
@@ -138,10 +152,14 @@ public class XmlSerializer implements Serializer {
/**
* End element.
*
- * @param uri the uri
- * @param localName the local name
- * @param qName the q name
- * @throws SAXException the SAX exception
+ * @param uri
+ * the uri
+ * @param localName
+ * the local name
+ * @param qName
+ * the q name
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#endElement(java.lang.String, java.lang.String,
* java.lang.String)
*/
@@ -158,11 +176,16 @@ public class XmlSerializer implements Serializer {
/**
* Start element.
*
- * @param uri the uri
- * @param localName the local name
- * @param qName the q name
- * @param attributes the attributes
- * @throws SAXException the SAX exception
+ * @param uri
+ * the uri
+ * @param localName
+ * the local name
+ * @param qName
+ * the q name
+ * @param attributes
+ * the attributes
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#startElement(java.lang.String, java.lang.String,
* java.lang.String, org.xml.sax.Attributes)
*/
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlSerializerFactory.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlSerializerFactory.java
index 48cfca7..d8cd0dd 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlSerializerFactory.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/XmlSerializerFactory.java
@@ -29,7 +29,6 @@ import org.apache.axis.Version;
import org.apache.axis.encoding.SerializerFactory;
import org.apache.uima.adapter.soap.axis11.XmlSerializer_Axis11;
-
/**
* An AxisSerializer factory that constructs instances of {@link XmlSerializer}.
*
@@ -43,7 +42,9 @@ public class XmlSerializerFactory implements SerializerFactory {
/** The mechanisms. */
private Vector mechanisms;
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.SerializerFactory#getSerializerAs(java.lang.String)
*/
@Override
@@ -61,7 +62,9 @@ public class XmlSerializerFactory implements SerializerFactory {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.SerializerFactory#getSupportedMechanismTypes()
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/BinaryDeserializer_Axis11.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/BinaryDeserializer_Axis11.java
index ebd034a..986f5cb 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/BinaryDeserializer_Axis11.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/BinaryDeserializer_Axis11.java
@@ -52,12 +52,15 @@ public class BinaryDeserializer_Axis11 extends DeserializerImpl {
/** The buf. */
private StringBuffer buf = new StringBuffer();
- /* (non-Javadoc)
- * @see org.apache.axis.encoding.DeserializerImpl#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes, org.apache.axis.encoding.DeserializationContext)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.axis.encoding.DeserializerImpl#startElement(java.lang.String, java.lang.String,
+ * java.lang.String, org.xml.sax.Attributes, org.apache.axis.encoding.DeserializationContext)
*/
@Override
- public void startElement(String namespace, String localName, String prefix,
- Attributes attributes, DeserializationContext context) throws SAXException {
+ public void startElement(String namespace, String localName, String prefix, Attributes attributes,
+ DeserializationContext context) throws SAXException {
// System.out.println("startElement(" + namespace + "," + localName + "," + prefix + ")");
if (!context.isDoneParsing()) {
@@ -121,13 +124,20 @@ public class BinaryDeserializer_Axis11 extends DeserializerImpl {
/**
* On start element.
*
- * @param namespace the namespace
- * @param localName the local name
- * @param prefix the prefix
- * @param attributes the attributes
- * @param context the context
- * @throws SAXException the SAX exception
- * @see org.apache.axis.message.SOAPHandler#onStartChild(String, String, String, Attributes, DeserializationContext)
+ * @param namespace
+ * the namespace
+ * @param localName
+ * the local name
+ * @param prefix
+ * the prefix
+ * @param attributes
+ * the attributes
+ * @param context
+ * the context
+ * @throws SAXException
+ * the SAX exception
+ * @see org.apache.axis.message.SOAPHandler#onStartChild(String, String, String, Attributes,
+ * DeserializationContext)
*/
@Override
public void onStartElement(String namespace, String localName, String prefix,
@@ -138,10 +148,14 @@ public class BinaryDeserializer_Axis11 extends DeserializerImpl {
/**
* On end element.
*
- * @param arg0 the arg 0
- * @param arg1 the arg 1
- * @param arg2 the arg 2
- * @throws SAXException the SAX exception
+ * @param arg0
+ * the arg 0
+ * @param arg1
+ * the arg 1
+ * @param arg2
+ * the arg 2
+ * @throws SAXException
+ * the SAX exception
* @see org.apache.axis.encoding.Deserializer#onEndElement(java.lang.String, java.lang.String,
* org.apache.axis.encoding.DeserializationContext)
*/
@@ -170,10 +184,14 @@ public class BinaryDeserializer_Axis11 extends DeserializerImpl {
/**
* Characters.
*
- * @param ch the ch
- * @param start the start
- * @param length the length
- * @throws SAXException the SAX exception
+ * @param ch
+ * the ch
+ * @param start
+ * the start
+ * @param length
+ * the length
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#characters(char[], int, int)
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/BinarySerializer_Axis11.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/BinarySerializer_Axis11.java
index 4f5e8f4..1d983ab 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/BinarySerializer_Axis11.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/BinarySerializer_Axis11.java
@@ -65,7 +65,8 @@ public class BinarySerializer_Axis11 implements Serializer {
/**
* Instantiates a new binary serializer axis 11.
*
- * @param aUseAttachments the a use attachments
+ * @param aUseAttachments
+ * the a use attachments
*/
public BinarySerializer_Axis11(boolean aUseAttachments) {
mUseAttachments = aUseAttachments;
@@ -74,11 +75,16 @@ public class BinarySerializer_Axis11 implements Serializer {
/**
* Serialize an element named name, with the indicated attributes and value.
*
- * @param name is the element name
- * @param attributes are the attributes...serializer is free to add more.
- * @param value is the value
- * @param context is the SerializationContext
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param name
+ * is the element name
+ * @param attributes
+ * are the attributes...serializer is free to add more.
+ * @param value
+ * is the value
+ * @param context
+ * is the SerializationContext
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
@Override
public void serialize(QName name, Attributes attributes, Object value,
@@ -101,8 +107,8 @@ public class BinarySerializer_Axis11 implements Serializer {
if (useAttachments) {
// System.out.println("Creating attachment"); //DEBUG
SOAPConstants soapConstants = context.getMessageContext().getSOAPConstants();
- DataHandler dataHandler = new DataHandler(new OctetStreamDataSource("test",
- new OctetStream(bytes)));
+ DataHandler dataHandler = new DataHandler(
+ new OctetStreamDataSource("test", new OctetStream(bytes)));
Part attachmentPart = attachments.createAttachmentPart(dataHandler);
AttributesImpl attrs = new AttributesImpl();
@@ -134,7 +140,9 @@ public class BinarySerializer_Axis11 implements Serializer {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.Serializer#getMechanismType()
*/
@Override
@@ -145,10 +153,13 @@ public class BinarySerializer_Axis11 implements Serializer {
/**
* Write schema.
*
- * @param javaType the java type
- * @param types the types
+ * @param javaType
+ * the java type
+ * @param types
+ * the types
* @return the element
- * @throws Exception the exception
+ * @throws Exception
+ * the exception
* @see org.apache.axis.encoding.Serializer#writeSchema(java.lang.Class,
* org.apache.axis.wsdl.fromJava.Types)
*/
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/XmlDeserializer_Axis11.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/XmlDeserializer_Axis11.java
index 4e935e1..09e6a9f 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/XmlDeserializer_Axis11.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/XmlDeserializer_Axis11.java
@@ -69,10 +69,14 @@ public class XmlDeserializer_Axis11 extends DeserializerImpl {
/**
* Characters.
*
- * @param ch the ch
- * @param start the start
- * @param length the length
- * @throws SAXException the SAX exception
+ * @param ch
+ * the ch
+ * @param start
+ * the start
+ * @param length
+ * the length
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#characters(char[], int, int)
*/
@Override
@@ -85,10 +89,14 @@ public class XmlDeserializer_Axis11 extends DeserializerImpl {
/**
* On end element.
*
- * @param arg0 the arg 0
- * @param arg1 the arg 1
- * @param arg2 the arg 2
- * @throws SAXException the SAX exception
+ * @param arg0
+ * the arg 0
+ * @param arg1
+ * the arg 1
+ * @param arg2
+ * the arg 2
+ * @throws SAXException
+ * the SAX exception
* @see org.apache.axis.encoding.Deserializer#onEndElement(java.lang.String, java.lang.String,
* org.apache.axis.encoding.DeserializationContext)
*/
@@ -106,13 +114,19 @@ public class XmlDeserializer_Axis11 extends DeserializerImpl {
/**
* This method is invoked when an element start tag is encountered.
*
- * @param namespace is the namespace of the element
- * @param localName is the name of the element
- * @param prefix is the element's prefix
- * @param attributes are the attributes on the element...used to get the type
- * @param context is the DeserializationContext
+ * @param namespace
+ * is the namespace of the element
+ * @param localName
+ * is the name of the element
+ * @param prefix
+ * is the element's prefix
+ * @param attributes
+ * are the attributes on the element...used to get the type
+ * @param context
+ * is the DeserializationContext
* @return the SOAP handler
- * @throws SAXException the SAX exception
+ * @throws SAXException
+ * the SAX exception
*/
@Override
public SOAPHandler onStartChild(String namespace, String localName, String prefix,
@@ -123,13 +137,20 @@ public class XmlDeserializer_Axis11 extends DeserializerImpl {
/**
* On start element.
*
- * @param arg0 the arg 0
- * @param arg1 the arg 1
- * @param arg2 the arg 2
- * @param arg3 the arg 3
- * @param arg4 the arg 4
- * @throws SAXException the SAX exception
- * @see org.apache.axis.message.SOAPHandler#onStartChild(String, String, String, Attributes, DeserializationContext)
+ * @param arg0
+ * the arg 0
+ * @param arg1
+ * the arg 1
+ * @param arg2
+ * the arg 2
+ * @param arg3
+ * the arg 3
+ * @param arg4
+ * the arg 4
+ * @throws SAXException
+ * the SAX exception
+ * @see org.apache.axis.message.SOAPHandler#onStartChild(String, String, String, Attributes,
+ * DeserializationContext)
*/
@Override
public void onStartElement(String arg0, String arg1, String arg2, Attributes arg3,
@@ -148,7 +169,8 @@ public class XmlDeserializer_Axis11 extends DeserializerImpl {
/**
* Value complete.
*
- * @throws SAXException the SAX exception
+ * @throws SAXException
+ * the SAX exception
* @see org.apache.axis.encoding.Deserializer#valueComplete()
*/
@Override
diff --git a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/XmlSerializer_Axis11.java b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/XmlSerializer_Axis11.java
index e5f709a..6d074d2 100644
--- a/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/XmlSerializer_Axis11.java
+++ b/uimaj-adapter-soap/src/main/java/org/apache/uima/adapter/soap/axis11/XmlSerializer_Axis11.java
@@ -46,11 +46,16 @@ public class XmlSerializer_Axis11 implements Serializer {
/**
* Serialize an element named name, with the indicated attributes and value.
*
- * @param name is the element name
- * @param attributes are the attributes...serializer is free to add more.
- * @param value is the value
- * @param context is the SerializationContext
- * @throws IOException Signals that an I/O exception has occurred.
+ * @param name
+ * is the element name
+ * @param attributes
+ * are the attributes...serializer is free to add more.
+ * @param value
+ * is the value
+ * @param context
+ * is the SerializationContext
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
*/
@Override
public void serialize(QName name, Attributes attributes, Object value,
@@ -67,12 +72,14 @@ public class XmlSerializer_Axis11 implements Serializer {
throw new IOException("SAXException: " + e.getMessage());
}
} else {
- throw new IOException("Can't serialize a " + value.getClass().getName()
- + " with an XmlSerializer.");
+ throw new IOException(
+ "Can't serialize a " + value.getClass().getName() + " with an XmlSerializer.");
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see javax.xml.rpc.encoding.Serializer#getMechanismType()
*/
@Override
@@ -83,10 +90,13 @@ public class XmlSerializer_Axis11 implements Serializer {
/**
* Write schema.
*
- * @param javaType the java type
- * @param types the types
+ * @param javaType
+ * the java type
+ * @param types
+ * the types
* @return the element
- * @throws Exception the exception
+ * @throws Exception
+ * the exception
* @see org.apache.axis.encoding.Serializer#writeSchema(java.lang.Class,
* org.apache.axis.wsdl.fromJava.Types)
*/
@@ -102,14 +112,15 @@ public class XmlSerializer_Axis11 implements Serializer {
*
*/
static class SerializerContentHandler extends DefaultHandler {
-
+
/** The m context. */
private SerializationContext mContext;
/**
* Instantiates a new serializer content handler.
*
- * @param aContext the a context
+ * @param aContext
+ * the a context
*/
SerializerContentHandler(SerializationContext aContext) {
mContext = aContext;
@@ -118,10 +129,14 @@ public class XmlSerializer_Axis11 implements Serializer {
/**
* Characters.
*
- * @param ch the ch
- * @param start the start
- * @param length the length
- * @throws SAXException the SAX exception
+ * @param ch
+ * the ch
+ * @param start
+ * the start
+ * @param length
+ * the length
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#characters(char[], int, int)
*/
@Override
@@ -137,10 +152,14 @@ public class XmlSerializer_Axis11 implements Serializer {
/**
* End element.
*
- * @param uri the uri
- * @param localName the local name
- * @param qName the q name
- * @throws SAXException the SAX exception
+ * @param uri
+ * the uri
+ * @param localName
+ * the local name
+ * @param qName
+ * the q name
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#endElement(java.lang.String, java.lang.String,
* java.lang.String)
*/
@@ -157,11 +176,16 @@ public class XmlSerializer_Axis11 implements Serializer {
/**
* Start element.
*
- * @param uri the uri
- * @param localName the local name
- * @param qName the q name
- * @param attributes the attributes
- * @throws SAXException the SAX exception
+ * @param uri
+ * the uri
+ * @param localName
+ * the local name
+ * @param qName
+ * the q name
+ * @param attributes
+ * the attributes
+ * @throws SAXException
+ * the SAX exception
* @see org.xml.sax.ContentHandler#startElement(java.lang.String, java.lang.String,
* java.lang.String, org.xml.sax.Attributes)
*/
[uima-uimaj] 04/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit de6c1f50ec8784c80ac398c6ad5160c89331e8d5
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 14:59:56 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../apache/uima/pear/tools/PearPackagingMojo.java | 522 ++++++++++-----------
1 file changed, 256 insertions(+), 266 deletions(-)
diff --git a/PearPackagingMavenPlugin/src/main/java/org/apache/uima/pear/tools/PearPackagingMojo.java b/PearPackagingMavenPlugin/src/main/java/org/apache/uima/pear/tools/PearPackagingMojo.java
index 0e2f2a5..5d5e7a1 100644
--- a/PearPackagingMavenPlugin/src/main/java/org/apache/uima/pear/tools/PearPackagingMojo.java
+++ b/PearPackagingMavenPlugin/src/main/java/org/apache/uima/pear/tools/PearPackagingMojo.java
@@ -38,10 +38,9 @@ import org.apache.uima.UIMAFramework;
import org.apache.uima.util.Level;
/**
- * PearPackagingMojo which generates an UIMA PEAR package. All the necessary
- * information from the UIMA nature is gathered and added to the PEAR package.
- * Additionally the generated jar file from the Maven build is added with the
- * according classpath information.
+ * PearPackagingMojo which generates an UIMA PEAR package. All the necessary information from the
+ * UIMA nature is gathered and added to the PEAR package. Additionally the generated jar file from
+ * the Maven build is added with the according classpath information.
*/
@Mojo(name = "package", defaultPhase = LifecyclePhase.PACKAGE)
public class PearPackagingMojo extends AbstractMojo {
@@ -50,37 +49,37 @@ public class PearPackagingMojo extends AbstractMojo {
* Main component directory of the UIMA project that contains the UIMA nature.
*/
@Parameter(defaultValue = "${basedir}", property = "basedir", required = true)
- private String mainComponentDir = null;
+ private String mainComponentDir = null;
/**
* Required classpath settings for the PEAR package.
*/
@Parameter(defaultValue = "${pear.classpath}", property = "pear.classpath")
- private String classpath = null;
+ private String classpath = null;
/**
* Main Component Descriptor path relative to the main component directory
*/
@Parameter(defaultValue = "${pear.mainComponentDesc}", property = "pear.mainComponentDesc", required = true)
- private String mainComponentDesc = null;
+ private String mainComponentDesc = null;
/**
* PEAR package component ID
*/
@Parameter(defaultValue = "${pear.componentId}", property = "pear.componentId", required = true)
- private String componentId = null;
+ private String componentId = null;
/**
* Target directory for the PEAR package
*/
@Parameter(defaultValue = "${basedir}/target", required = true)
- private String targetDir = null;
+ private String targetDir = null;
/**
* Required UIMA datapath settings for the PEAR package
*/
@Parameter(defaultValue = "$main_root/resources")
- private String datapath = null;
+ private String datapath = null;
/**
* Required environment variables for the PEAR package
@@ -88,17 +87,17 @@ public class PearPackagingMojo extends AbstractMojo {
*
*/
@Parameter
- private Properties props = null;
+ private Properties props = null;
/**
* The maven project.
*/
- @Parameter( defaultValue = "${project}", readonly = true )
- private MavenProject project;
+ @Parameter(defaultValue = "${project}", readonly = true)
+ private MavenProject project;
// the PEAR packaging directory contains all the stuff that is added to
// the PEAR
- private File pearPackagingDir;
+ private File pearPackagingDir;
private ArrayList<String> classpathsInOrder;
@@ -106,275 +105,266 @@ public class PearPackagingMojo extends AbstractMojo {
private Log log;
- /*
- * (non-Javadoc)
- *
- * @see org.apache.maven.plugin.AbstractMojo#execute()
- */
- @Override
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.maven.plugin.AbstractMojo#execute()
+ */
+ @Override
public void execute() throws MojoExecutionException {
- // create the PEAR packaging directory in the target directory
- this.pearPackagingDir = new File(this.targetDir, "pearPackaging");
-
- // save current UIMA log level
- Level level = getCurrentUIMALogLevel();
- // change UIMA log level to only log warnings and errors
- UIMAFramework.getLogger().setLevel(Level.WARNING);
-
- // create final PEAR file object
- File finalPearFileName = new File(this.targetDir, this.componentId
- + ".pear");
-
- log = getLog();
- log.info("Start building PEAR package for component " + this.componentId);
- log.debug("UIMA PEAR INFORMATION ");
- log.debug("======================");
- log.debug("main component dir: " + this.mainComponentDir);
- log.debug("main component desc: " + this.mainComponentDesc);
- log.debug("component id: " + this.componentId);
- log.debug("classpath: " + this.classpath);
- log.debug("datapath: " + this.datapath);
- log.debug("target dir: " + this.targetDir);
- log.debug("pear packaging dir: "
- + this.pearPackagingDir.getAbsolutePath());
- log.debug("final PEAR file: " + finalPearFileName.getAbsolutePath());
-
- // check Maven project packaging type - only jar packaging is supported
- if (!this.project.getPackaging().equals("jar")) {
- throw new MojoExecutionException(
- "Wrong packaging type, only 'jar' packaging is supported");
+ // create the PEAR packaging directory in the target directory
+ this.pearPackagingDir = new File(this.targetDir, "pearPackaging");
+
+ // save current UIMA log level
+ Level level = getCurrentUIMALogLevel();
+ // change UIMA log level to only log warnings and errors
+ UIMAFramework.getLogger().setLevel(Level.WARNING);
+
+ // create final PEAR file object
+ File finalPearFileName = new File(this.targetDir, this.componentId + ".pear");
+
+ log = getLog();
+ log.info("Start building PEAR package for component " + this.componentId);
+ log.debug("UIMA PEAR INFORMATION ");
+ log.debug("======================");
+ log.debug("main component dir: " + this.mainComponentDir);
+ log.debug("main component desc: " + this.mainComponentDesc);
+ log.debug("component id: " + this.componentId);
+ log.debug("classpath: " + this.classpath);
+ log.debug("datapath: " + this.datapath);
+ log.debug("target dir: " + this.targetDir);
+ log.debug("pear packaging dir: " + this.pearPackagingDir.getAbsolutePath());
+ log.debug("final PEAR file: " + finalPearFileName.getAbsolutePath());
+
+ // check Maven project packaging type - only jar packaging is supported
+ if (!this.project.getPackaging().equals("jar")) {
+ throw new MojoExecutionException("Wrong packaging type, only 'jar' packaging is supported");
+ }
+
+ try {
+ // copies all PEAR data to the PEAR packaging directory
+ copyPearData();
+
+ // copy created jar package to the PEAR packaging lib directory
+ // get jar file name
+ String jarFileName = this.project.getBuild().getFinalName() + ".jar";
+ // get jar file location
+ File finalJarFile = new File(this.project.getBuild().getDirectory(), jarFileName);
+ // check if the jar file exist
+ if (finalJarFile.exists()) {
+ // specify the target directory for the jar file
+ File target = new File(this.pearPackagingDir, InstallationController.PACKAGE_LIB_DIR);
+ File targetFile = new File(target, jarFileName);
+ // copy the jar file to the target directory
+ FileUtils.copyFile(finalJarFile, targetFile);
+ } else {
+ // jar file does not exist - build was not successful
+ String errorMessage = "Jar package " + finalJarFile.getAbsolutePath() + " not found";
+ log.debug(errorMessage);
+ throw new IOException(errorMessage);
+ }
+
+ // classpath handling:
+ // 1) keep order:
+ // jar for this artifact if it exists,
+ // followed by user-specified,
+ // followed by jars in lib
+ // 2) remove duplicates
+ // 3) paths that are generated are in form $main_root/lib/jar-name
+
+ classpathsInOrder = new ArrayList<>();
+ classpathsDefined = new HashSet<>();
+
+ String pathToLib = String.format("$main_root/%s", InstallationController.PACKAGE_LIB_DIR);
+ log.debug("pear pathToLib = " + pathToLib);
+ String mainJar = String.format("%s/%s.jar", pathToLib,
+ this.project.getBuild().getFinalName());
+
+ maybeAddClasspath(mainJar);
+
+ if (classpath != null && !classpath.equals("")) {
+ if (classpath.indexOf(':') != -1) {
+ throw new MojoExecutionException(
+ "classpath: " + classpath + " must use semicolons as separators.");
+ }
+ String[] userClasspath = classpath.split(";");
+ for (String ucp : userClasspath) {
+ maybeAddClasspath(ucp);
+ }
}
- try {
- // copies all PEAR data to the PEAR packaging directory
- copyPearData();
-
- // copy created jar package to the PEAR packaging lib directory
- // get jar file name
- String jarFileName = this.project.getBuild().getFinalName() + ".jar";
- // get jar file location
- File finalJarFile = new File(this.project.getBuild().getDirectory(),
- jarFileName);
- // check if the jar file exist
- if (finalJarFile.exists()) {
- // specify the target directory for the jar file
- File target = new File(this.pearPackagingDir,
- InstallationController.PACKAGE_LIB_DIR);
- File targetFile = new File(target, jarFileName);
- // copy the jar file to the target directory
- FileUtils.copyFile(finalJarFile, targetFile);
- } else {
- // jar file does not exist - build was not successful
- String errorMessage = "Jar package "
- + finalJarFile.getAbsolutePath() + " not found";
- log.debug(errorMessage);
- throw new IOException(errorMessage);
- }
-
- // classpath handling:
- // 1) keep order:
- // jar for this artifact if it exists,
- // followed by user-specified,
- // followed by jars in lib
- // 2) remove duplicates
- // 3) paths that are generated are in form $main_root/lib/jar-name
-
- classpathsInOrder = new ArrayList<>();
- classpathsDefined = new HashSet<>();
-
- String pathToLib = String.format("$main_root/%s", InstallationController.PACKAGE_LIB_DIR);
- log.debug("pear pathToLib = " + pathToLib);
- String mainJar = String.format("%s/%s.jar", pathToLib, this.project.getBuild().getFinalName());
-
- maybeAddClasspath(mainJar);
-
- if (classpath != null && !classpath.equals("")) {
- if (classpath.indexOf(':') != -1) {
- throw new MojoExecutionException(
- "classpath: " + classpath + " must use semicolons as separators.");
- }
- String[] userClasspath = classpath.split(";");
- for (String ucp : userClasspath) {
- maybeAddClasspath(ucp);
- }
- }
-
- File libDir = new File(this.pearPackagingDir, InstallationController.PACKAGE_LIB_DIR);
- if (libDir.isDirectory()) {
- FileFilter jarFilter = new FileFilter() {
- @Override
- public boolean accept(File pathname) {
- return pathname.isFile() && pathname.getAbsolutePath().toLowerCase().endsWith(".jar");
- }
- };
- File[] jars = libDir.listFiles(jarFilter);
- if (null != jars) {
- for (File jar : jars) {
- maybeAddClasspath(String.format("%s/%s", pathToLib, jar.getName()));
- }
- }
- }
-
- StringBuffer buffer = new StringBuffer();
- for (String cp : classpathsInOrder) {
- buffer.append(cp).append(";");
- }
-
- // add compiled jar to the PEAR classpath
- // not done here - done as part of next step
-// buffer.append(";$main_root/");
-// buffer.append(InstallationController.PACKAGE_LIB_DIR);
-// buffer.append("/");
-// buffer.append(this.project.getBuild().getFinalName());
-// buffer.append(".jar");
-
- // add lib jars to the PEAR classpath
-
- classpath = buffer.substring(0, buffer.length()-1);
-
-// if (this.classpath != null) {
-// this.classpath = this.classpath + ";" + classpathExtension;
-// } else {
-// this.classpath = classpathExtension.substring(1,classpathExtension.length());
-// }
-
- // create the PEAR package
- createPear();
-
- // log success message
- log.info("PEAR package for component " + this.componentId
- + " successfully created at: "
- + finalPearFileName.getAbsolutePath());
-
- // set UIMA logger back to the original log level
- UIMAFramework.getLogger().setLevel(level);
-
- } catch (PackageCreatorException e) {
- log.debug(e.getMessage());
- throw new MojoExecutionException(e.getMessage());
- } catch (IOException e) {
- log.debug(e.getMessage());
- throw new MojoExecutionException(e.getMessage());
+ File libDir = new File(this.pearPackagingDir, InstallationController.PACKAGE_LIB_DIR);
+ if (libDir.isDirectory()) {
+ FileFilter jarFilter = new FileFilter() {
+ @Override
+ public boolean accept(File pathname) {
+ return pathname.isFile() && pathname.getAbsolutePath().toLowerCase().endsWith(".jar");
+ }
+ };
+ File[] jars = libDir.listFiles(jarFilter);
+ if (null != jars) {
+ for (File jar : jars) {
+ maybeAddClasspath(String.format("%s/%s", pathToLib, jar.getName()));
+ }
+ }
}
- }
+ StringBuffer buffer = new StringBuffer();
+ for (String cp : classpathsInOrder) {
+ buffer.append(cp).append(";");
+ }
+
+ // add compiled jar to the PEAR classpath
+ // not done here - done as part of next step
+ // buffer.append(";$main_root/");
+ // buffer.append(InstallationController.PACKAGE_LIB_DIR);
+ // buffer.append("/");
+ // buffer.append(this.project.getBuild().getFinalName());
+ // buffer.append(".jar");
+
+ // add lib jars to the PEAR classpath
+
+ classpath = buffer.substring(0, buffer.length() - 1);
+
+ // if (this.classpath != null) {
+ // this.classpath = this.classpath + ";" + classpathExtension;
+ // } else {
+ // this.classpath = classpathExtension.substring(1,classpathExtension.length());
+ // }
+
+ // create the PEAR package
+ createPear();
+
+ // log success message
+ log.info("PEAR package for component " + this.componentId + " successfully created at: "
+ + finalPearFileName.getAbsolutePath());
+
+ // set UIMA logger back to the original log level
+ UIMAFramework.getLogger().setLevel(level);
+
+ } catch (PackageCreatorException e) {
+ log.debug(e.getMessage());
+ throw new MojoExecutionException(e.getMessage());
+ } catch (IOException e) {
+ log.debug(e.getMessage());
+ throw new MojoExecutionException(e.getMessage());
+ }
+
+ }
private void maybeAddClasspath(String acp) {
-// System.out.println("TEST maybeAddClasspath: " + acp);
+ // System.out.println("TEST maybeAddClasspath: " + acp);
log.debug("pear maybe add classpath: " + acp);
if (!classpathsDefined.contains(acp)) {
classpathsInOrder.add(acp);
classpathsDefined.add(acp);
} else {
-// System.out.println("TEST duplicate found");
+ // System.out.println("TEST duplicate found");
log.debug("pear maybe add classpath: duplicate found");
}
}
- /**
- * Returns the current UIMA log level for the UIMA root logger
- *
- * @return the current UIMA log level
- */
- private Level getCurrentUIMALogLevel() {
- if (UIMAFramework.getLogger().isLoggable(Level.ALL)) {
- return Level.ALL;
- } else if (UIMAFramework.getLogger().isLoggable(Level.FINEST)) {
- return Level.FINEST;
- } else if (UIMAFramework.getLogger().isLoggable(Level.FINER)) {
- return Level.FINER;
- } else if (UIMAFramework.getLogger().isLoggable(Level.FINE)) {
- return Level.FINE;
- } else if (UIMAFramework.getLogger().isLoggable(Level.CONFIG)) {
- return Level.CONFIG;
- } else if (UIMAFramework.getLogger().isLoggable(Level.INFO)) {
- return Level.INFO;
- } else if (UIMAFramework.getLogger().isLoggable(Level.WARNING)) {
- return Level.WARNING;
- } else if (UIMAFramework.getLogger().isLoggable(Level.SEVERE)) {
- return Level.SEVERE;
+ /**
+ * Returns the current UIMA log level for the UIMA root logger
+ *
+ * @return the current UIMA log level
+ */
+ private Level getCurrentUIMALogLevel() {
+ if (UIMAFramework.getLogger().isLoggable(Level.ALL)) {
+ return Level.ALL;
+ } else if (UIMAFramework.getLogger().isLoggable(Level.FINEST)) {
+ return Level.FINEST;
+ } else if (UIMAFramework.getLogger().isLoggable(Level.FINER)) {
+ return Level.FINER;
+ } else if (UIMAFramework.getLogger().isLoggable(Level.FINE)) {
+ return Level.FINE;
+ } else if (UIMAFramework.getLogger().isLoggable(Level.CONFIG)) {
+ return Level.CONFIG;
+ } else if (UIMAFramework.getLogger().isLoggable(Level.INFO)) {
+ return Level.INFO;
+ } else if (UIMAFramework.getLogger().isLoggable(Level.WARNING)) {
+ return Level.WARNING;
+ } else if (UIMAFramework.getLogger().isLoggable(Level.SEVERE)) {
+ return Level.SEVERE;
+ } else {
+ return Level.OFF;
+ }
+ }
+
+ /**
+ * Copies the given directory when available to the PEAR packaging directory
+ *
+ * @param directory
+ * directory to copy
+ *
+ * @throws IOException
+ * passthru
+ */
+ private void copyDirIfAvailable(String directory) throws IOException {
+
+ // check if directory exist
+ File dirToCopy = new File(this.mainComponentDir, directory);
+ if (dirToCopy.exists()) {
+ File target = new File(this.pearPackagingDir, directory);
+ FileUtils.copyDirectory(dirToCopy, target);
+ // remove directories that begins with a "." -> e.g. .SVN
+ removeDotDirectories(target);
+ }
+ }
+
+ /**
+ * Removes recursively all directories that begins with a "." e.g. ".SVN"
+ *
+ * @param dir
+ * directory to check for Dot-directories
+ *
+ * @throws IOException
+ * passthru
+ */
+ private void removeDotDirectories(File dir) throws IOException {
+ ArrayList<File> subdirs = org.apache.uima.util.FileUtils.getSubDirs(dir);
+
+ for (int i = 0; i < subdirs.size(); i++) {
+ File current = subdirs.get(i);
+ if (current.getName().startsWith(".")) {
+ org.apache.uima.util.FileUtils.deleteRecursive(current);
} else {
- return Level.OFF;
- }
- }
-
- /**
- * Copies the given directory when available to the PEAR packaging directory
- *
- * @param directory
- * directory to copy
- *
- * @throws IOException passthru
- */
- private void copyDirIfAvailable(String directory) throws IOException {
-
- // check if directory exist
- File dirToCopy = new File(this.mainComponentDir, directory);
- if (dirToCopy.exists()) {
- File target = new File(this.pearPackagingDir, directory);
- FileUtils.copyDirectory(dirToCopy, target);
- // remove directories that begins with a "." -> e.g. .SVN
- removeDotDirectories(target);
- }
- }
-
- /**
- * Removes recursively all directories that begins with a "." e.g. ".SVN"
- *
- * @param dir
- * directory to check for Dot-directories
- *
- * @throws IOException passthru
- */
- private void removeDotDirectories(File dir) throws IOException {
- ArrayList<File> subdirs = org.apache.uima.util.FileUtils.getSubDirs(dir);
-
- for (int i = 0; i < subdirs.size(); i++) {
- File current = subdirs.get(i);
- if (current.getName().startsWith(".")) {
- org.apache.uima.util.FileUtils.deleteRecursive(current);
- } else {
- removeDotDirectories(current);
- }
- }
- }
-
- /**
- * Copies all the necessary PEAR directories (UIMA nature) to the PEAR
- * packaging directory
- *
- * @throws IOException passthru
- */
- private void copyPearData() throws IOException {
-
- // select all necessary PEAR package directories that have to be copied
- String[] dirsToCopy = new String[] {
- InstallationController.PACKAGE_CONF_DIR,
- InstallationController.PACKAGE_DATA_DIR,
- InstallationController.PACKAGE_DESC_DIR,
- InstallationController.PACKAGE_DOC_DIR,
- InstallationController.PACKAGE_LIB_DIR,
- InstallationController.PACKAGE_METADATA_DIR,
- InstallationController.PACKAGE_RESOURCES_DIR,
- /* InstallationController.PACKAGE_SOURCES_DIR , */InstallationController.PACKAGE_BIN_DIR, };
-
- // copies the selected directories if they exists
- for (int i = 0; i < dirsToCopy.length; i++) {
- copyDirIfAvailable(dirsToCopy[i]);
+ removeDotDirectories(current);
}
- }
-
- /**
- * create a PEAR package with
- *
- * @throws PackageCreatorException passthru
- */
- private void createPear() throws PackageCreatorException {
- //generates the PEAR packages with the given information
- PackageCreator
- .generatePearPackage(this.componentId, this.mainComponentDesc,
- this.classpath, this.datapath, this.pearPackagingDir
- .getAbsolutePath(), this.targetDir, this.props);
- }
+ }
+ }
+
+ /**
+ * Copies all the necessary PEAR directories (UIMA nature) to the PEAR packaging directory
+ *
+ * @throws IOException
+ * passthru
+ */
+ private void copyPearData() throws IOException {
+
+ // select all necessary PEAR package directories that have to be copied
+ String[] dirsToCopy = new String[] { InstallationController.PACKAGE_CONF_DIR,
+ InstallationController.PACKAGE_DATA_DIR, InstallationController.PACKAGE_DESC_DIR,
+ InstallationController.PACKAGE_DOC_DIR, InstallationController.PACKAGE_LIB_DIR,
+ InstallationController.PACKAGE_METADATA_DIR, InstallationController.PACKAGE_RESOURCES_DIR,
+ /* InstallationController.PACKAGE_SOURCES_DIR , */InstallationController.PACKAGE_BIN_DIR, };
+
+ // copies the selected directories if they exists
+ for (int i = 0; i < dirsToCopy.length; i++) {
+ copyDirIfAvailable(dirsToCopy[i]);
+ }
+ }
+
+ /**
+ * create a PEAR package with
+ *
+ * @throws PackageCreatorException
+ * passthru
+ */
+ private void createPear() throws PackageCreatorException {
+ // generates the PEAR packages with the given information
+ PackageCreator.generatePearPackage(this.componentId, this.mainComponentDesc, this.classpath,
+ this.datapath, this.pearPackagingDir.getAbsolutePath(), this.targetDir, this.props);
+ }
}
[uima-uimaj] 14/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit ce516fb1c612727d092901e0bb7c65acaed3b305
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:28:14 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../apache/uima/migratev3/jcas/MigrateJCas.java | 3404 +++++++++++---------
1 file changed, 1808 insertions(+), 1596 deletions(-)
diff --git a/uimaj-v3migration-jcas/src/main/java/org/apache/uima/migratev3/jcas/MigrateJCas.java b/uimaj-v3migration-jcas/src/main/java/org/apache/uima/migratev3/jcas/MigrateJCas.java
index ba3561e..99d5ae4 100644
--- a/uimaj-v3migration-jcas/src/main/java/org/apache/uima/migratev3/jcas/MigrateJCas.java
+++ b/uimaj-v3migration-jcas/src/main/java/org/apache/uima/migratev3/jcas/MigrateJCas.java
@@ -120,34 +120,47 @@ import com.github.javaparser.printer.PrettyPrinter;
import com.github.javaparser.printer.PrettyPrinterConfiguration;
/**
- * <p>A driver that scans given roots for source and/or class Java files that contain JCas classes
+ * <p>
+ * A driver that scans given roots for source and/or class Java files that contain JCas classes
*
- * <ul><li>identifies which ones appear to be JCas classes (heuristic)
- * <ul><li>of these, identifies which ones appear to be v2
- * <ul><li>converts these to v3</li></ul></li></ul>
+ * <ul>
+ * <li>identifies which ones appear to be JCas classes (heuristic)
+ * <ul>
+ * <li>of these, identifies which ones appear to be v2
+ * <ul>
+ * <li>converts these to v3</li>
+ * </ul>
+ * </li>
+ * </ul>
*
- * <li>also can receive a list of individual class names</li>
- * <li>also can do a single source file</li>
+ * <li>also can receive a list of individual class names</li>
+ * <li>also can do a single source file</li>
* </ul>
- *
- * <p>Creates summary and detailed reports of its actions.
*
- * <p>Files representing JCas classes to convert are discovered by walking file system
- * directories from various roots, specified as input. The tool operates in 1 of two exclusive
- * "modes": migrating from sources (e.g., .java files) and migrating using compiled classes.
+ * <p>
+ * Creates summary and detailed reports of its actions.
+ *
+ * <p>
+ * Files representing JCas classes to convert are discovered by walking file system directories from
+ * various roots, specified as input. The tool operates in 1 of two exclusive "modes": migrating
+ * from sources (e.g., .java files) and migrating using compiled classes.
+ *
+ * <p>
+ * Compiled classes are decompiled and then migrated. This decompilation step usually requires a
+ * java classpath, which is supplied using the -migrateClasspath parameter. Exception: migrating
+ * PEAR files, which contain their own specification for a classpath.
*
- * <p>Compiled classes are decompiled and then migrated. This decompilation step usually
- * requires a java classpath, which is supplied using the -migrateClasspath parameter.
- * Exception: migrating PEAR files, which contain their own specification for a classpath.
+ * <p>
+ * The same JCas class may be encountered multiple times while walking the directory tree from the
+ * roots, with the same or different definition. All of these definitions are migrated.
*
- * <p>The same JCas class may be encountered multiple
- * times while walking the directory tree from the roots,
- * with the same or different definition. All of these definitions are migrated.
+ * <p>
+ * Copies of the original and the converted files are put into the output file tree.
+ *
+ * <p>
+ * Directory structure, starting at -outputDirectory (which if not specified, is a new temp
+ * directory). The "a0", "a1" represent non-identical alternative definitions for the same class.
*
- * <p>Copies of the original and the converted files are put into the output file tree.
- *
- * <p>Directory structure, starting at -outputDirectory (which if not specified, is a new temp directory).
- * The "a0", "a1" represent non-identical alternative definitions for the same class.
* <pre>
* converted/
* v2/ these are the decompiled or "found" source files
@@ -194,8 +207,10 @@ import com.github.javaparser.printer.PrettyPrinterConfiguration;
* jarFileUpdates.txt
* ...
* </pre>
- *
- * <p>Operates in one of two modes:
+ *
+ * <p>
+ * Operates in one of two modes:
+ *
* <pre>
* Mode 1: Given classes-roots and/or individual class names, and a migrateClasspath,
* scans the classes-routes looking for classes candidates
@@ -212,14 +227,39 @@ import com.github.javaparser.printer.PrettyPrinterConfiguration;
* - migrates that decompiled source.
* </pre>
*
- * <p>Note: Each run clears the output directory before starting the migration.
+ * <p>
+ * Note: Each run clears the output directory before starting the migration.
*
- * <p>Note: classpath may be specified using -migrateClassPath or as the class path used to run this tool.
+ * <p>
+ * Note: classpath may be specified using -migrateClassPath or as the class path used to run this
+ * tool.
*/
public class MigrateJCas extends VoidVisitorAdapter<Object> {
-
- /* *****************************************************
- * Internals
+
+ // @formatter:off
+ /*
+ * ***************************************************** Internals
+ *
+ * Unique IDs of v2 and v3 artifacts: RootId + classname
+ *
+ * RootIdContainers (Set<RootId>) hold all discovered rootIds, at each Jar/Pear nesting level
+ * including outer level (no Jar/Pear). These are kept in a push-down stack
+ *
+ *
+ * Processing roots collection: done for source or class - iterate, for all roots --
+ * processCollection for candidates rooted at that root --- candidate is .java or .class, with
+ * path, with pearClasspath string ---- migrate called on each candidate ----- check to see if
+ * already done, and if so, skip. ------ means: same byte or source code associated with same fqcn
+ *
+ * Root-ids: created for each unique pathpart in front of fully-qualified class name created for
+ * each unique path to Jar or PEAR
+ *
+ * Caching to speed up duplicate processing: - decompiling: if the byte[] is already done, use
+ * other value (if augmented migrateClasspath is the same) - source-migrating: if the source
+ * strings are the same.
+ *
+ * Multiple sources for single class: classname2multiSources: TreeMap from fqcn to CommonConverted
+ * (string or bytes) CommonConverted: supports multiple paths having identical string/bytes.
*
* Unique IDs of v2 and v3 artifacts:
* RootId + classname
@@ -254,75 +294,83 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* - set when visiting top-level compilation unit non-built-in type
*
*/
-
+ // @formatter:on
/** manange the indention of printing routines */
private static final int[] indent = new int[1];
-
- private static StringBuilder si(StringBuilder sb) { return Misc.indent(sb, indent); }
-
+
+ private static StringBuilder si(StringBuilder sb) {
+ return Misc.indent(sb, indent);
+ }
+
private static StringBuilder flush(StringBuilder sb) {
System.out.print(sb);
sb.setLength(0);
return sb;
}
-
+
private static final Integer INTEGER0 = 0;
-
+
private static int nextContainerId = 0;
+
+ // @formatter:off
/******************************************************************
* Container - exists in tree structure, has super, sub containers
* -- subcontainers: has path to it
* - holds set of rootIds in that container
* - topmost one has null parent, and null pathToJarOrPear
******************************************************************/
+ // @formatter:on
private static class Container implements Comparable<Container> {
final int id = nextContainerId++;
- final Container parent; // null if at top level
+ final Container parent; // null if at top level
+ // @formatter:off
/** root to scan from.
* Pears: is the loc in temp space of installed pear
* Jars: is the file system mounted on the Jar
* -- for inner Jars, the Jar is copied out into temp space. */
- Path root;
+ // @formatter:on
+ Path root;
final Path rootOrig; // for Jars and Pears, the original path ending in jar or pear
- final Set<Container> subContainers = new TreeSet<>(); // tree set for better ordering
+ final Set<Container> subContainers = new TreeSet<>(); // tree set for better ordering
final List<Path> candidates = new ArrayList<>();
final List<CommonConverted> convertedItems = new ArrayList<>();
final List<V3CompiledPathAndContainerItemPath> v3CompiledPathAndContainerItemPath = new ArrayList<>();
- final boolean isPear;
+ final boolean isPear;
final boolean isJar;
final boolean isSingleJavaSource;
/** can't use Path as the type, because the equals for Path is object == */
final Set<String> _Types = new HashSet<>(); // has the non_Type path only if the _Type is found
boolean haveDifferentCapitalizedNamesCollidingOnWindows = false;
- String pearClasspath; // not final - set by subroutine after defaulting
-
- /** Cache of already done compiled classes, to avoid redoing them
- * Kept by container, because the classpath could change the decompile */
+ String pearClasspath; // not final - set by subroutine after defaulting
+
+ /**
+ * Cache of already done compiled classes, to avoid redoing them Kept by container, because the
+ * classpath could change the decompile
+ */
private Map<byte[], CommonConverted> origBytesToCommonConverted = new HashMap<>();
-
+
Container(Container parent, Path root) {
this.parent = parent;
if (parent != null) {
parent.subContainers.add(this);
- this.pearClasspath = parent.pearClasspath; // default, when expanding Jars.
+ this.pearClasspath = parent.pearClasspath; // default, when expanding Jars.
}
this.rootOrig = root;
String s = root.toString().toLowerCase();
isJar = s.endsWith(".jar");
isPear = s.endsWith(".pear");
isSingleJavaSource = s.endsWith(".java");
- this.root = (isPear || isJar)
- ? installJarOrPear()
- : root;
-// // debug
-// if (!isPear && isJar) {
-// System.out.println("debug prepare jar: " + this);
-// }
- }
-
+ this.root = (isPear || isJar) ? installJarOrPear() : root;
+ // // debug
+ // if (!isPear && isJar) {
+ // System.out.println("debug prepare jar: " + this);
+ // }
+ }
+
/**
* Called when a new container is created
+ *
* @param container
* @param path
* @return install directory
@@ -331,22 +379,24 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
try {
Path theJarOrPear = rootOrig;
if (!theJarOrPear.getFileSystem().equals(FileSystems.getDefault())) {
- // pear is embedded in another pear or jar, so copy the Jar (intact) to a temp spot so it's no longer embedded
+ // pear is embedded in another pear or jar, so copy the Jar (intact) to a temp spot so
+ // it's no longer embedded
theJarOrPear = getTempOutputPathForJarOrPear(theJarOrPear);
Files.copy(rootOrig, theJarOrPear, StandardCopyOption.REPLACE_EXISTING);
}
-
+
if (isPear) {
- // extract the pear just to get the classpath
+ // extract the pear just to get the classpath
File pearInstallDir = Files.createTempDirectory(getTempDir(), "installedPear").toFile();
- PackageBrowser ip = PackageInstaller.installPackage(pearInstallDir, rootOrig.toFile(), false);
+ PackageBrowser ip = PackageInstaller.installPackage(pearInstallDir, rootOrig.toFile(),
+ false);
String newClasspath = ip.buildComponentClassPath();
String parentClasspath = parent.pearClasspath;
- this.pearClasspath = (null == parentClasspath || 0 == parentClasspath.length())
- ? newClasspath
- : newClasspath + File.pathSeparator + parentClasspath;
- }
-
+ this.pearClasspath = (null == parentClasspath || 0 == parentClasspath.length())
+ ? newClasspath
+ : newClasspath + File.pathSeparator + parentClasspath;
+ }
+
FileSystem pfs = FileSystems.newFileSystem(theJarOrPear, (ClassLoader) null);
return pfs.getPath("/");
} catch (IOException e) {
@@ -354,7 +404,9 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#toString()
*/
@Override
@@ -362,31 +414,36 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
StringBuilder sb = toString1();
indent[0] += 2;
try {
- si(sb); // new line + indent
- sb.append("subContainers=");
- Misc.addElementsToStringBuilder(indent, sb, Misc.setAsList(subContainers), -1, (sbx, i) -> sbx.append(i.id)).append(',');
- si(sb).append("paths migrated="); // new line + indent
- Misc.addElementsToStringBuilder(indent, sb, candidates, -1, StringBuilder::append).append(',');
-// si(sb).append("v3CompilePath="); // new line + indent
-// Misc.addElementsToStringBuilder(indent, sb, v3CompiledPathAndContainerItemPath, 100, StringBuilder::append);
+ si(sb); // new line + indent
+ sb.append("subContainers=");
+ Misc.addElementsToStringBuilder(indent, sb, Misc.setAsList(subContainers), -1,
+ (sbx, i) -> sbx.append(i.id)).append(',');
+ si(sb).append("paths migrated="); // new line + indent
+ Misc.addElementsToStringBuilder(indent, sb, candidates, -1, StringBuilder::append)
+ .append(',');
+ // si(sb).append("v3CompilePath="); // new line + indent
+ // Misc.addElementsToStringBuilder(indent, sb, v3CompiledPathAndContainerItemPath, 100,
+ // StringBuilder::append);
} finally {
- indent[0] -=2;
+ indent[0] -= 2;
si(sb).append(']');
}
return sb.toString();
}
-
+
public StringBuilder toString1() {
StringBuilder sb = new StringBuilder();
si(sb); // initial nl and indentation
sb.append(isJar ? "Jar " : isPear ? "PEAR " : "");
- sb.append("container [id=").append(id)
- .append(", parent.id=").append((null == parent) ? "null" : parent.id)
- .append(", root or pathToJarOrPear=").append(rootOrig).append(',');
+ sb.append("container [id=").append(id).append(", parent.id=")
+ .append((null == parent) ? "null" : parent.id).append(", root or pathToJarOrPear=")
+ .append(rootOrig).append(',');
return sb;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#hashCode()
*/
@Override
@@ -394,7 +451,9 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
return 31 * id;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
@@ -411,27 +470,28 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
return true;
}
-
@Override
public int compareTo(Container o) {
- return Integer.compare(id, o.id);
- }
+ return Integer.compare(id, o.id);
+ }
}
-
+
/**
- * A path to a .java or .class file in some container, for the v2 version
- * For Jars and Pears, the path is relative to the zip "/" dir
+ * A path to a .java or .class file in some container, for the v2 version For Jars and Pears, the
+ * path is relative to the zip "/" dir
*/
private static class ContainerAndPath implements Comparable<ContainerAndPath> {
final Path path;
final Container container;
-
+
ContainerAndPath(Path path, Container container) {
this.path = path;
- this.container = container;
+ this.container = container;
}
-
- /* (non-Javadoc)
+
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
@Override
@@ -443,19 +503,21 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
return Integer.compare(container.id, o.container.id);
}
-
-
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
- sb.append("ContainerAndPath [path=").append(path).append(", container=").append(container.id).append("]");
+ sb.append("ContainerAndPath [path=").append(path).append(", container=").append(container.id)
+ .append("]");
return sb.toString();
}
}
-
+
+ // @formatter:off
/**
* This class holds information used to replace compiled items in Jars and Pears.
*
@@ -465,16 +527,19 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* - Note: if a Jar has the same compiled class at multiple nesting levels, each one will have
* an instance of this class
*/
+ // @formatter:on
private static class V3CompiledPathAndContainerItemPath {
final Path v3CompiledPath;
- final String pathInContainer;
-
+ final String pathInContainer;
+
public V3CompiledPathAndContainerItemPath(Path v3CompiledPath, String pathInContainer) {
this.v3CompiledPath = v3CompiledPath;
this.pathInContainer = pathInContainer;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#toString()
*/
@Override
@@ -491,12 +556,11 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
return sb.toString();
}
-
-
+
}
-
+
private static final JavaCompiler javaCompiler = ToolProvider.getSystemJavaCompiler();
-
+
/****************************************************************
* Command line parameters
****************************************************************/
@@ -505,52 +569,54 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
private static final String CLASS_FILE_ROOTS = "-classesRoots";
private static final String OUTPUT_DIRECTORY = "-outputDirectory";
-
-// private static final String SKIP_TYPE_CHECK = "-skipTypeCheck";
-
- private static final String MIGRATE_CLASSPATH = "-migrateClasspath";
-
-// private static final String CLASSES = "-classes"; // individual classes to migrate, get from supplied classpath
-
+
+ // private static final String SKIP_TYPE_CHECK = "-skipTypeCheck";
+
+ private static final String MIGRATE_CLASSPATH = "-migrateClasspath";
+
+ // private static final String CLASSES = "-classes"; // individual classes to migrate, get from
+ // supplied classpath
private static final Type intType = PrimitiveType.intType();
-
+
private static final Type callSiteType = JavaParser.parseType("CallSite");
-
+
private static final Type methodHandleType = JavaParser.parseType("MethodHandle");
-
+
private static final Type stringType = JavaParser.parseType("String");
-
- private static final EnumSet<Modifier> public_static_final =
- EnumSet.of(Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL);
- private static final EnumSet<Modifier> private_static_final =
- EnumSet.of(Modifier.PRIVATE, Modifier.STATIC, Modifier.FINAL);
-
- private static final PrettyPrinterConfiguration printWithoutComments =
- new PrettyPrinterConfiguration();
- static { printWithoutComments.setPrintComments(false); }
-
- private static final PrettyPrinterConfiguration printCu =
- new PrettyPrinterConfiguration();
- static { printCu.setIndent(" "); }
-
+
+ private static final EnumSet<Modifier> public_static_final = EnumSet.of(Modifier.PUBLIC,
+ Modifier.STATIC, Modifier.FINAL);
+ private static final EnumSet<Modifier> private_static_final = EnumSet.of(Modifier.PRIVATE,
+ Modifier.STATIC, Modifier.FINAL);
+
+ private static final PrettyPrinterConfiguration printWithoutComments = new PrettyPrinterConfiguration();
+ static {
+ printWithoutComments.setPrintComments(false);
+ }
+
+ private static final PrettyPrinterConfiguration printCu = new PrettyPrinterConfiguration();
+ static {
+ printCu.setIndent(" ");
+ }
+
private static final String ERROR_DECOMPILING = "!!! ERROR:";
-
+
static private boolean isSource = false;
static private Path tempDir = null;
-/***************************************************************************************************/
-
- private String packageName; // with dots?
- private String className; // (omitting package)
- private String packageAndClassNameSlash;
-
+ /***************************************************************************************************/
+
+ private String packageName; // with dots?
+ private String className; // (omitting package)
+ private String packageAndClassNameSlash;
+
// next 3 set at start of migrate for item being migrated
- private CommonConverted current_cc;
+ private CommonConverted current_cc;
private Path current_path;
private Container current_container;
-
+
/** includes trailing / */
private String outputDirectory;
/** includes trailing / */
@@ -559,24 +625,25 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
private String outDirSkipped;
/** includes trailing / */
private String outDirLog;
-
+
private Container[] sourcesRoots = null; // only one of these has 1 or more Container instances
private Container[] classesRoots = null;
-
+
private CompilationUnit cu;
-
+
// save this value in the class instance to avoid recomputing it
private ClassLoader cachedMigrateClassLoader = null;
-
+
private String migrateClasspath = null;
-
-// private String individualClasses = null; // to decompile
+
+ // private String individualClasses = null; // to decompile
/**
- * CommonConverted next id, by fqcn
- * key: fqcn_slashes value: next id
+ * CommonConverted next id, by fqcn key: fqcn_slashes value: next id
*/
- private Map<String, Integer> nextCcId = new HashMap<>();
+ private Map<String, Integer> nextCcId = new HashMap<>();
+
+ // @formatter:off
/**
* Common info about a particular source-code instance of a class
* Used to avoid duplicate work for the same JCas definition
@@ -590,27 +657,30 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* use map: origBytesToCommonConverted key = byte[], kept by container in container
* if found, use previous converted results
*/
+ // @formatter:on
private class CommonConverted {
/**
- * starts at 0, incr for each new instance for a particular fqcn_slash
- * can't be assigned until fqcn known
+ * starts at 0, incr for each new instance for a particular fqcn_slash can't be assigned until
+ * fqcn known
+ */
+ int id = -1; // temp value
+ final String v2Source; // remembered original source
+ final byte[] v2ByteCode; // remembered original bytes
+
+ /**
+ * all paths + their containers having the same converted result Need container because might
+ * change classpath for compiling - path is to v2 source or compiled class
*/
- int id = -1; // temp value
- final String v2Source; // remembered original source
- final byte[] v2ByteCode; // remembered original bytes
-
- /** all paths + their containers having the same converted result
- * Need container because might change classpath for compiling
- * - path is to v2 source or compiled class*/
- final Set<ContainerAndPath> containersAndV2Paths = new HashSet<>();
-
- String v3Source; // if converted, the result
+ final Set<ContainerAndPath> containersAndV2Paths = new HashSet<>();
+
+ String v3Source; // if converted, the result
/** converted/v3/id-of-cc/pkg/name/classname.java */
- Path v3SourcePath; // path to converted source or null
-
- String fqcn_slash; // full name of the class e.g. java/util/Foo. unknown for sources at first
-
- CommonConverted(String origSource, byte[] v2ByteCode, Path path, Container container, String fqcn_slash) {
+ Path v3SourcePath; // path to converted source or null
+
+ String fqcn_slash; // full name of the class e.g. java/util/Foo. unknown for sources at first
+
+ CommonConverted(String origSource, byte[] v2ByteCode, Path path, Container container,
+ String fqcn_slash) {
this.v2Source = origSource;
this.v2ByteCode = v2ByteCode;
containersAndV2Paths.add(new ContainerAndPath(path, container));
@@ -619,9 +689,10 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
/**
*
- * @param container having this commonConverted instance
- * @return the path to .java or .class file.
- * If the container is a Jar or PEAR, it is the path within that Jar or Pear FileSystem
+ * @param container
+ * having this commonConverted instance
+ * @return the path to .java or .class file. If the container is a Jar or PEAR, it is the path
+ * within that Jar or Pear FileSystem
*/
Path getV2SourcePath(Container container) {
for (ContainerAndPath cp : containersAndV2Paths) {
@@ -631,7 +702,7 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
throw new RuntimeException("internalError");
}
-
+
int getId() {
if (id < 0) {
Integer nextId = nextCcId.computeIfAbsent(fqcn_slash, s -> INTEGER0);
@@ -640,8 +711,10 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
return id;
}
-
- /* (non-Javadoc)
+
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#hashCode()
*/
@Override
@@ -649,16 +722,18 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
return v2Source == null ? 0 : v2Source.hashCode();
}
- /* equal if the v2source is equal
+ /*
+ * equal if the v2source is equal
*/
@Override
public boolean equals(Object obj) {
- return obj instanceof CommonConverted &&
- v2Source != null &&
- v2Source.equals(((CommonConverted)obj).v2Source);
+ return obj instanceof CommonConverted && v2Source != null
+ && v2Source.equals(((CommonConverted) obj).v2Source);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.lang.Object#toString()
*/
@Override
@@ -668,78 +743,87 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
si(sb).append("CommonConverted [v2Source=").append(Misc.elide(v2Source, 100));
indent[0] += 2;
try {
- si(sb).append("v2ByteCode=");
- sb.append(v2ByteCode != null
- ? Arrays.toString(Arrays.copyOf(v2ByteCode, Math.min(v2ByteCode.length, maxLen))) :
- "null").append(',');
- si(sb).append("containersAndPaths=")
- .append(containersAndV2Paths != null
- ? Misc.ppList(indent, Misc.setAsList(containersAndV2Paths), -1, StringBuilder::append)
- : "null").append(',');
- si(sb).append("v3SourcePath=").append(v3SourcePath).append(',');
- si(sb).append("fqcn_slash=").append(fqcn_slash).append("]").append('\n');
+ si(sb).append("v2ByteCode=");
+ sb.append(v2ByteCode != null
+ ? Arrays.toString(Arrays.copyOf(v2ByteCode, Math.min(v2ByteCode.length, maxLen)))
+ : "null").append(',');
+ si(sb).append("containersAndPaths=")
+ .append(containersAndV2Paths != null ? Misc.ppList(indent,
+ Misc.setAsList(containersAndV2Paths), -1, StringBuilder::append) : "null")
+ .append(',');
+ si(sb).append("v3SourcePath=").append(v3SourcePath).append(',');
+ si(sb).append("fqcn_slash=").append(fqcn_slash).append("]").append('\n');
} finally {
indent[0] -= 2;
}
return sb.toString();
}
- }
+ }
+
+ // @formatter:off
/** Cache of already converted source classes, to avoid redoing them;
* - key is the actual source
* - value is CommonConverted
* This cache is over all containers
- * */
+ */
+ // @formatter:on
private Map<String, CommonConverted> sourceToCommonConverted = new HashMap<>();
-
+
/**
- * A map from fqcn_slash to a list of converted sources
- * one per non-duplicated source
+ * A map from fqcn_slash to a list of converted sources one per non-duplicated source
*/
private Map<String, List<CommonConverted>> classname2multiSources = new TreeMap<>();
-
+
/************************************
* Reporting
************************************/
-// private final List<Path> v2JCasFiles = new ArrayList<>(); // unused
-// private final List<Path> v3JCasFiles = new ArrayList<>(); // unused
-
- private final List<PathContainerAndReason> nonJCasFiles = new ArrayList<>(); // path, reason
+ // private final List<Path> v2JCasFiles = new ArrayList<>(); // unused
+ // private final List<Path> v3JCasFiles = new ArrayList<>(); // unused
+
+ private final List<PathContainerAndReason> nonJCasFiles = new ArrayList<>(); // path, reason
private final List<PathContainerAndReason> failedMigration = new ArrayList<>(); // path, reason
- private final List<PathContainerAndReason> skippedBuiltins = new ArrayList<>(); // path, "built-in"
- private final List<PathContainerAndReason> deletedCheckModified = new ArrayList<>(); // path, deleted check string
+ private final List<PathContainerAndReason> skippedBuiltins = new ArrayList<>(); // path,
+ // "built-in"
+ private final List<PathContainerAndReason> deletedCheckModified = new ArrayList<>(); // path,
+ // deleted
+ // check
+ // string
private final List<String1AndString2> pathWorkaround = new ArrayList<>(); // original, workaround
private final List<String1AndString2> pearClassReplace = new ArrayList<>(); // pear, classname
- private final List<String1AndString2> jarClassReplace = new ArrayList<>(); // jar, classname
-
+ private final List<String1AndString2> jarClassReplace = new ArrayList<>(); // jar, classname
+
private final List<PathContainerAndReason> manualInspection = new ArrayList<>(); // path, reason
-// private final List<PathAndPath> embeddedJars = new ArrayList<>(); // source, temp
-
- private boolean isV2JCas; // false at start of migrate, set to true if a v2 class candidate is discovered
- private boolean isConvert2v3; // true at start of migrate, set to false if conversion fails, left true if already a v3
- private boolean isBuiltinJCas; // false at start of migrate, set to true if a built-in class is discovered
-
- /************************************
- * Context for visits
+ // private final List<PathAndPath> embeddedJars = new ArrayList<>(); // source, temp
+
+ private boolean isV2JCas; // false at start of migrate, set to true if a v2 class candidate is
+ // discovered
+ private boolean isConvert2v3; // true at start of migrate, set to false if conversion fails, left
+ // true if already a v3
+ private boolean isBuiltinJCas; // false at start of migrate, set to true if a built-in class is
+ // discovered
+
+ /************************************
+ * Context for visits
************************************/
/**
* if non-null, we're inside the ast for a likely JCas getter or setter method
*/
- private MethodDeclaration get_set_method;
+ private MethodDeclaration get_set_method;
private String featName;
private boolean isGetter;
- private boolean isArraySetter;
+ private boolean isArraySetter;
/**
* the range name part for _getXXXValue.. calls
*/
private Object rangeNamePart;
-
+
/**
* the range name part for _getXXXValue.. calls without converting Ref to Feature
*/
private String rangeNameV2Part;
-
+
/**
* temp place to insert static final int feature declarations
*/
@@ -759,9 +843,8 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* set if getAndProcessCasndidatesInContainer encounters a class where it cannot do the compile
*/
private boolean unableToCompile;
-
- final private StringBuilder psb = new StringBuilder();
+ final private StringBuilder psb = new StringBuilder();
public MigrateJCas() {
}
@@ -769,16 +852,18 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
public static void main(String[] args) {
(new MigrateJCas()).run(args);
}
-
+
/***********************************
* Main
- * @param args -
+ *
+ * @param args
+ * -
***********************************/
void run(String[] args) {
CommandLineParser clp = parseCommandArgs(args);
-
+
System.out.format("Output top directory: %s%n", outputDirectory);
-
+
// clear output dir
FileUtils.deleteRecursive(new File(outputDirectory));
@@ -789,111 +874,107 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
} else {
if (javaCompiler == null) {
System.out.println("The migration tool cannot compile the migrated files, \n"
- + " because no Java compiler is available.\n"
- + " To make one available, run this tool using a Java JDK, not JRE");
- }
+ + " because no Java compiler is available.\n"
+ + " To make one available, run this tool using a Java JDK, not JRE");
+ }
isOk = processRootsCollection("classes", classesRoots, clp);
}
-
-// if (individualClasses != null) {
-// processCollection("individual classes: ", new Iterator<String>() {
-// Iterator<String> it = Arrays.asList(individualClasses.split(File.pathSeparator)).iterator();
-// public boolean hasNext() {return it.hasNext();}
-// public String next() {
-// return prepareIndividual(it.next());}
-// });
-// }
-
- if (error_decompiling) {
+
+ // if (individualClasses != null) {
+ // processCollection("individual classes: ", new Iterator<String>() {
+ // Iterator<String> it = Arrays.asList(individualClasses.split(File.pathSeparator)).iterator();
+ // public boolean hasNext() {return it.hasNext();}
+ // public String next() {
+ // return prepareIndividual(it.next());}
+ // });
+ // }
+
+ if (error_decompiling) {
isOk = false;
}
-
+
isOk = report() && isOk;
-
- System.out.println("Migration finished " +
- (isOk
- ? "with no unusual conditions."
- : "with 1 or more unusual conditions that need manual checking."));
- }
-
-
+
+ System.out.println("Migration finished " + (isOk ? "with no unusual conditions."
+ : "with 1 or more unusual conditions that need manual checking."));
+ }
+
/**
- * called for compiled input when a compiler is available and don't have name collision
- * if the container is a PEAR or a Jar
- * Updates a copy of the Pear or Jar
+ * called for compiled input when a compiler is available and don't have name collision if the
+ * container is a PEAR or a Jar Updates a copy of the Pear or Jar
+ *
* @param container
*/
private void postProcessPearOrJar(Container container) {
- Path outDir = Paths.get(outputDirectory,
- container.isJar ? "jars" : "pears",
- Integer.toString(container.id));
+ Path outDir = Paths.get(outputDirectory, container.isJar ? "jars" : "pears",
+ Integer.toString(container.id));
withIOX(() -> Files.createDirectories(outDir));
si(psb).append("Replacing .class files in copy of ").append(container.rootOrig);
flush(psb);
try {
// copy the pear or jar so we don't change the original
Path lastPartOfPath = container.rootOrig.getFileName();
- if (null == lastPartOfPath) throw new RuntimeException("Internal Error");
- Path pearOrJarCopy = Paths.get(outputDirectory,
- container.isJar ? "jars" : "pears",
- Integer.toString(container.id),
- lastPartOfPath.toString());
-
- Files.copy(container.rootOrig, pearOrJarCopy);
+ if (null == lastPartOfPath)
+ throw new RuntimeException("Internal Error");
+ Path pearOrJarCopy = Paths.get(outputDirectory, container.isJar ? "jars" : "pears",
+ Integer.toString(container.id), lastPartOfPath.toString());
+
+ Files.copy(container.rootOrig, pearOrJarCopy);
// put up a file system on the pear or jar
FileSystem pfs = FileSystems.newFileSystem(pearOrJarCopy, (ClassLoader) null);
-
+
// replace the .class files in this PEAR or Jar with corresponding v3 ones
indent[0] += 2;
- String[] previousSkip = {""};
+ String[] previousSkip = { "" };
container.v3CompiledPathAndContainerItemPath.forEach(c_p -> {
- if (Files.exists(c_p.v3CompiledPath)) {
- withIOX(() -> Files.copy(c_p.v3CompiledPath, pfs.getPath(c_p.pathInContainer), StandardCopyOption.REPLACE_EXISTING));
- reportPearOrJarClassReplace(pearOrJarCopy.toString(), c_p.v3CompiledPath.toString(), container);
- } else {
- String pstr = c_p.v3CompiledPath.toString();
- String pstr2 = pstr;
- if (previousSkip[0] != "") {
- int cmn = findFirstCharDifferent(previousSkip[0], pstr);
- pstr2 = cmn > 5
- ? ("..." + pstr.substring(cmn))
- : pstr;
- }
- previousSkip[0] = pstr;
- si(psb).append("Skipping replacing ").append(pstr2)
- .append(" because it could not be found, perhaps due to compile errors.");
- flush(psb);
- }
- });
+ if (Files.exists(c_p.v3CompiledPath)) {
+ withIOX(() -> Files.copy(c_p.v3CompiledPath, pfs.getPath(c_p.pathInContainer),
+ StandardCopyOption.REPLACE_EXISTING));
+ reportPearOrJarClassReplace(pearOrJarCopy.toString(), c_p.v3CompiledPath.toString(),
+ container);
+ } else {
+ String pstr = c_p.v3CompiledPath.toString();
+ String pstr2 = pstr;
+ if (previousSkip[0] != "") {
+ int cmn = findFirstCharDifferent(previousSkip[0], pstr);
+ pstr2 = cmn > 5 ? ("..." + pstr.substring(cmn)) : pstr;
+ }
+ previousSkip[0] = pstr;
+ si(psb).append("Skipping replacing ").append(pstr2)
+ .append(" because it could not be found, perhaps due to compile errors.");
+ flush(psb);
+ }
+ });
indent[0] -= 2;
-// for (CommonConverted cc : container.convertedItems) {
-// Map<Container, Path> v3ccs = cc.v3CompiledResultPaths;
-// v3ccs.forEach((v3ccc, v3cc_path) ->
-// {
-// if (v3ccc == container) {
-// String path_in_v3_classes = cc.v3CompiledResultPaths.get(container).toString();
-//
-// withIOX(() -> Files.copy(v3cc_path, pfs.getPath(path_in_v3_classes)));
-// reportPearOrJarClassReplace(pearOrJarCopy.toString(), path_in_v3_classes, container);
-// }
-// });
-// }
-
- pfs.close();
-
+ // for (CommonConverted cc : container.convertedItems) {
+ // Map<Container, Path> v3ccs = cc.v3CompiledResultPaths;
+ // v3ccs.forEach((v3ccc, v3cc_path) ->
+ // {
+ // if (v3ccc == container) {
+ // String path_in_v3_classes = cc.v3CompiledResultPaths.get(container).toString();
+ //
+ // withIOX(() -> Files.copy(v3cc_path, pfs.getPath(path_in_v3_classes)));
+ // reportPearOrJarClassReplace(pearOrJarCopy.toString(), path_in_v3_classes, container);
+ // }
+ // });
+ // }
+
+ pfs.close();
+
} catch (IOException e) {
throw new RuntimeException(e);
}
}
-
+
+ // @formatter:off
/**
- * Compile all the migrated JCas classes in this container, adjusting the classpath
- * if the container is a Jar or Pear to include the Jar or PEAR.
+ * Compile all the migrated JCas classes in this container, adjusting the classpath if the
+ * container is a Jar or Pear to include the Jar or PEAR.
+ *
+ * As a side effect, it saves in the container, a list of all the compiled things together with
+ * the path in container part, for use by a subsequent step to update copies of the jars/pears.
*
- * As a side effect, it saves in the container, a list of all the compiled things together
- * with the path in container part, for use by a subsequent step to update copies of the jars/pears.
- *
* The items in the container are broken into batches of multiple classes to be compiled together.
* - The grouping is to group by alternative number. This insures that multiple
* definitions of the same class are done separately (otherwise the compiler complains
@@ -905,26 +986,27 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* @param container -
* @return true if compiled 1 or more sources, false if nothing was compiled
*/
+ // @formatter:on
private boolean compileV3SourcesCommon2(Container container) {
-
+
String classesBaseDir = outDirConverted + "v3-classes/" + container.id;
-
- // specify the classpath. For PEARs use a class loader that loads first.
+
+ // specify the classpath. For PEARs use a class loader that loads first.
String classpath = getCompileClassPath(container);
-
-// // debug
-// String[] cpa = classpath.split(File.pathSeparator);
-// System.out.println("debug - compilation classpath");
-// int j = 0;
-// for (String s : cpa) System.out.println("debug classpath: " + (++j) + " " + s);
-
+
+ // // debug
+ // String[] cpa = classpath.split(File.pathSeparator);
+ // System.out.println("debug - compilation classpath");
+ // int j = 0;
+ // for (String s : cpa) System.out.println("debug classpath: " + (++j) + " " + s);
+
// get a list of compilation unit path strings to the converted/v3/nnn/path
/**
- * containerRoot is
- * rootOrig or for Jars/Pears the Path to "/" in the zip file system
+ * containerRoot is rootOrig or for Jars/Pears the Path to "/" in the zip file system
*/
Path containerRoot = null;
-
+
+ // @formatter:off
/**
* The Cu Path Strings for one container might have multiple instances of the class.
* These might be for identical or different sources.
@@ -938,94 +1020,102 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* different paths saying "duplicate class definition".
* - Fix: do compilation in batches, one for each different commonConverted id.
*/
-
- Map<Integer, ArrayList<String>> cu_path_strings_by_ccId = new TreeMap<>(); // tree map to have nice order of keys
-
+ // @formatter:on
+ Map<Integer, ArrayList<String>> cu_path_strings_by_ccId = new TreeMap<>(); // tree map to have
+ // nice order of keys
+
indent[0] += 2;
boolean isEmpty = true;
for (CommonConverted cc : container.convertedItems) {
- if (cc.v3SourcePath == null) continue; // skip items that failed migration
+ if (cc.v3SourcePath == null)
+ continue; // skip items that failed migration
isEmpty = false;
- // relativePathInContainer = the whole path with the first part (up to the end of the container root) stripped off
+ // relativePathInContainer = the whole path with the first part (up to the end of the
+ // container root) stripped off
/**
- * itemPath is the original path in the container to where the source or class file is
- * For Jars and PEARs, it is relative to the Jar or PEAR
+ * itemPath is the original path in the container to where the source or class file is For
+ * Jars and PEARs, it is relative to the Jar or PEAR
*/
Path itemPath = cc.getV2SourcePath(container);
if (null == containerRoot) {
// lazy setup on first call
// for Pears, must use the == filesystem, otherwise get
- // ProviderMismatchException
- containerRoot = (container.isJar || container.isPear)
- ? itemPath.getFileSystem().getPath("/")
- : container.rootOrig;
+ // ProviderMismatchException
+ containerRoot = (container.isJar || container.isPear)
+ ? itemPath.getFileSystem().getPath("/")
+ : container.rootOrig;
}
/**
- * relativePathInContainer might be x/y/z/a/b/c/name.class
- * (ends in .class because we only get here when the input is class files)
+ * relativePathInContainer might be x/y/z/a/b/c/name.class (ends in .class because we only get
+ * here when the input is class files)
*/
String relativePathInContainer = containerRoot.relativize(itemPath).toString();
-
- container.v3CompiledPathAndContainerItemPath.add(
- new V3CompiledPathAndContainerItemPath(
- Paths.get(classesBaseDir, "a" + cc.id, cc.fqcn_slash + ".class" /*relativePathInContainer*/),
+
+ container.v3CompiledPathAndContainerItemPath.add(new V3CompiledPathAndContainerItemPath(
+ Paths.get(classesBaseDir, "a" + cc.id,
+ cc.fqcn_slash + ".class" /* relativePathInContainer */),
relativePathInContainer));
- ArrayList<String> items = cu_path_strings_by_ccId.computeIfAbsent(cc.id, x -> new ArrayList<>());
+ ArrayList<String> items = cu_path_strings_by_ccId.computeIfAbsent(cc.id,
+ x -> new ArrayList<>());
items.add(cc.v3SourcePath.toString());
}
-
+
if (isEmpty) {
- si(psb).append("Skipping compiling for container ").append(container.id).append(" ").append(container.rootOrig);
+ si(psb).append("Skipping compiling for container ").append(container.id).append(" ")
+ .append(container.rootOrig);
si(psb).append(" because non of the v2 classes were migrated (might have been built-ins)");
flush(psb);
return false;
- }
- else {
- si(psb).append("Compiling for container ").append(container.id).append(" ").append(container.rootOrig);
+ } else {
+ si(psb).append("Compiling for container ").append(container.id).append(" ")
+ .append(container.rootOrig);
flush(psb);
}
-
-// List<String> cu_path_strings = container.convertedItems.stream()
-// .filter(cc -> cc.v3SourcePath != null)
-// .peek(cc -> container.v3CompiledPathAndContainerItemPath.add(
-// new V3CompiledPathAndContainerItemPath(
-// Paths.get(classesBaseDir, cc.v3SourcePath.toString()),
-// getPathInContainer(container, cc).toString())))
-// .map(cc -> cc.v3SourcePath.toString())
-// .collect(Collectors.toList());
-
+
+ // List<String> cu_path_strings = container.convertedItems.stream()
+ // .filter(cc -> cc.v3SourcePath != null)
+ // .peek(cc -> container.v3CompiledPathAndContainerItemPath.add(
+ // new V3CompiledPathAndContainerItemPath(
+ // Paths.get(classesBaseDir, cc.v3SourcePath.toString()),
+ // getPathInContainer(container, cc).toString())))
+ // .map(cc -> cc.v3SourcePath.toString())
+ // .collect(Collectors.toList());
+
boolean resultOk = true;
-
- for (int ccId = 0;; ccId++) { // do each version of classes separately
+
+ for (int ccId = 0;; ccId++) { // do each version of classes separately
List<String> cups = cu_path_strings_by_ccId.get(ccId);
if (cups == null) {
break;
}
-
- StandardJavaFileManager fileManager = javaCompiler.getStandardFileManager(null, null, Charset.forName("UTF-8"));
-
- Iterable<? extends JavaFileObject> compilationUnits =
- fileManager.getJavaFileObjectsFromStrings(cups);
-
-// //debug
-// System.out.println("Debug: list of compilation unit strings for iteration " + i);
-// int[] k = new int[] {0};
-// cups.forEach(s -> System.out.println(Integer.toString(++(k[0])) + " " + s));
-// System.out.println("debug end");
-
+
+ StandardJavaFileManager fileManager = javaCompiler.getStandardFileManager(null, null,
+ Charset.forName("UTF-8"));
+
+ Iterable<? extends JavaFileObject> compilationUnits = fileManager
+ .getJavaFileObjectsFromStrings(cups);
+
+ // //debug
+ // System.out.println("Debug: list of compilation unit strings for iteration " + i);
+ // int[] k = new int[] {0};
+ // cups.forEach(s -> System.out.println(Integer.toString(++(k[0])) + " " + s));
+ // System.out.println("debug end");
+
String classesBaseDirN = classesBaseDir + "/a" + ccId;
withIOX(() -> Files.createDirectories(Paths.get(classesBaseDirN)));
Iterable<String> options = Arrays.asList("-d", classesBaseDirN, "-classpath", classpath);
-
- si(psb).append("Compiling for commonConverted version ").append(ccId)
- .append(", ").append(cups.size()).append(" classes");
+
+ si(psb).append("Compiling for commonConverted version ").append(ccId).append(", ")
+ .append(cups.size()).append(" classes");
flush(psb);
DiagnosticCollector<JavaFileObject> diagnostics = new DiagnosticCollector<>();
- /*********** Compile ***********/
- resultOk = javaCompiler.getTask(null, fileManager, diagnostics, options, null, compilationUnits).call() && resultOk;
+ /*********** Compile ***********/
+ resultOk = javaCompiler
+ .getTask(null, fileManager, diagnostics, options, null, compilationUnits).call()
+ && resultOk;
/********************************/
-
+
indent[0] += 2;
for (Diagnostic<? extends JavaFileObject> diagnostic : diagnostics.getDiagnostics()) {
JavaFileObject s = diagnostic.getSource();
@@ -1044,19 +1134,18 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
si(psb).append(" ").append(diagnostic.getMessage(null));
flush(psb);
}
- withIOX( () -> fileManager.close());
+ withIOX(() -> fileManager.close());
indent[0] -= 2;
- si(psb).append("Compilation finished").append(
- resultOk ? " with no errors." : "with some errors.");
+ si(psb).append("Compilation finished")
+ .append(resultOk ? " with no errors." : "with some errors.");
flush(psb);
}
indent[0] -= 2;
unableToCompile = !resultOk;
return true;
}
-
-
-
+
+ // @formatter:off
/**
* The classpath used to compile is (in precedence order)
* - the classpath for this migration app (first in order to pick up v3 support, overriding others)
@@ -1065,23 +1154,24 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* - passed in migrate classpath
* @return the classpath to use in compiling the jcasgen'd sources
*/
+ // @formatter:on
private String getCompileClassPath(Container container) {
-
+
// start with this (the v3migration tool) app's classpath to a cp string
URLClassLoader systemClassLoader = (URLClassLoader) ClassLoader.getSystemClassLoader();
URL[] urls = systemClassLoader.getURLs();
StringBuilder cp = new StringBuilder();
-
+
boolean firstTime = true;
for (URL url : urls) {
- if (! firstTime) {
+ if (!firstTime) {
cp.append(File.pathSeparatorChar);
} else {
firstTime = false;
}
cp.append(url.getPath());
}
-
+
// pears up the classpath, closest first
Container c = container;
while (c != null) {
@@ -1090,13 +1180,13 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
c = c.parent;
}
-
+
// add the migrateClasspath, expanded
-
+
if (null != migrateClasspath) {
cp.append(File.pathSeparator).append(Misc.expandClasspath(migrateClasspath));
}
-
+
// add the Jars, closest last
c = container;
List<String> ss = new ArrayList<>();
@@ -1108,45 +1198,44 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
Collections.reverse(ss);
ss.forEach(s -> cp.append(File.pathSeparator).append(s));
-
-// System.out.println("debug: compile classpath = " + cp.toString());
+
+ // System.out.println("debug: compile classpath = " + cp.toString());
return cp.toString();
}
-
- /**
- * iterate to process collections from all roots
- * Called once, to process either sources or classes
+
+ /**
+ * iterate to process collections from all roots Called once, to process either sources or classes
+ *
* @return false if unable to compile, true otherwise
*/
private boolean processRootsCollection(String kind, Container[] roots, CommandLineParser clp) {
unableToCompile = false; // preinit
-
+
psb.setLength(0);
indent[0] = 0;
itemCount = 1;
-
- for (Container rootContainer : roots) {
- showWorkStart(rootContainer);
-
+ for (Container rootContainer : roots) {
+ showWorkStart(rootContainer);
+
// adds candidates to root containers, and adds sub containers for Jars and Pears
getAndProcessCandidatesInContainer(rootContainer);
-
-// for (Path path : rootContainer.candidates) {
-//
-// CommonConverted cc = getSource(path, rootContainer);
-// migrate(cc, rootContainer, path);
-//
-// if ((i % 50) == 0) System.out.format("%4d%n ", Integer.valueOf(i));
-// i++;
-// }
+
+ // for (Path path : rootContainer.candidates) {
+ //
+ // CommonConverted cc = getSource(path, rootContainer);
+ // migrate(cc, rootContainer, path);
+ //
+ // if ((i % 50) == 0) System.out.format("%4d%n ", Integer.valueOf(i));
+ // i++;
+ // }
}
si(psb).append("Total number of candidates processed: ").append(itemCount - 1);
flush(psb);
indent[0] = 0;
return !unableToCompile;
}
-
+
private void showWorkStart(Container rootContainer) {
si(psb).append("Migrating " + rootContainer.rootOrig.toString());
indent[0] += 2;
@@ -1158,10 +1247,12 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
si(psb).append(" nnn at the end of the line is the number of classes migrated\n");
flush(psb);
}
-
+
/**
* parse command line args
- * @param args -
+ *
+ * @param args
+ * -
* @return the CommandLineParser instance
*/
private CommandLineParser parseCommandArgs(String[] args) {
@@ -1175,18 +1266,18 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
printUsage();
System.exit(2);
}
-
+
if (clp.isInArgsList(CLASS_FILE_ROOTS)) {
classesRoots = getRoots(clp, CLASS_FILE_ROOTS);
}
-
+
if (clp.isInArgsList(SOURCE_FILE_ROOTS)) {
sourcesRoots = getRoots(clp, SOURCE_FILE_ROOTS);
}
-
+
return clp;
}
-
+
private Container[] getRoots(CommandLineParser clp, String kind) {
String[] paths = clp.getParamArgument(kind).split("\\" + File.pathSeparator);
Container[] cs = new Container[paths.length];
@@ -1196,23 +1287,25 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
return cs;
}
-
+
/**
- * @param p the path to the compiled or non-compiled source
- * @param container the container
- * @return the instance of the CommonConverted object,
- * and update the container's convertedItems list if needed to include it
- */
+ * @param p
+ * the path to the compiled or non-compiled source
+ * @param container
+ * the container
+ * @return the instance of the CommonConverted object, and update the container's convertedItems
+ * list if needed to include it
+ */
private CommonConverted getSource(Path p, Container container) {
try {
byte[] localV2ByteCode = null;
-
+
CommonConverted cc;
String v2Source;
-
+
if (!isSource) {
localV2ByteCode = Files.readAllBytes(p);
-
+
// only use prev decompiled if same container
cc = container.origBytesToCommonConverted.get(localV2ByteCode);
if (null != cc) {
@@ -1230,37 +1323,40 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
System.err.println("Candidate with bad Class Name is: " + p.toString());
return null;
}
- final byte[] finalbc = localV2ByteCode;
- cc = sourceToCommonConverted.computeIfAbsent(v2Source,
+ final byte[] finalbc = localV2ByteCode;
+ cc = sourceToCommonConverted.computeIfAbsent(v2Source,
src -> new CommonConverted(src, finalbc, p, container, packageAndClassNameSlash));
-// cc = new CommonConverted(v2Source, localV2ByteCode, p, container, packageAndClassNameSlash);
+ // cc = new CommonConverted(v2Source, localV2ByteCode, p, container,
+ // packageAndClassNameSlash);
container.origBytesToCommonConverted.put(localV2ByteCode, cc);
} else {
-
+
v2Source = FileUtils.reader2String(Files.newBufferedReader(p));
cc = sourceToCommonConverted.get(v2Source);
if (null == cc) {
cc = new CommonConverted(v2Source, null, p, container, "unknown");
- sourceToCommonConverted.put(v2Source, cc);
+ sourceToCommonConverted.put(v2Source, cc);
} else {
- // add this new path + container to set of pathsAndContainers kept by this CommonConverted object
- cc.containersAndV2Paths.add(new ContainerAndPath(p, container));
+ // add this new path + container to set of pathsAndContainers kept by this CommonConverted
+ // object
+ cc.containersAndV2Paths.add(new ContainerAndPath(p, container));
}
}
- //Containers have list of CommonConverted, which, in turn
- // have Set of ContainerAndPath elements.
- // (the same JCas class might appear in two different paths in a container)
+ // Containers have list of CommonConverted, which, in turn
+ // have Set of ContainerAndPath elements.
+ // (the same JCas class might appear in two different paths in a container)
if (!container.convertedItems.contains(cc)) {
container.convertedItems.add(cc);
}
-
- return cc;
+
+ return cc;
} catch (IOException e) {
throw new RuntimeException(e);
}
}
-
+
+ // @formatter:off
/**
* Migrate one JCas definition, writes to Sysem.out 1 char to indicate progress.
*
@@ -1291,16 +1387,17 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
*
* @param source - the source, either directly from a .java file, or a decompiled .class file
*/
+ // @formatter:on
private void migrate(CommonConverted cc, Container container, Path path) {
-
+
if (null == cc) {
System.err.println("Skipping this component due to decompile failure: " + path.toString());
System.err.println(" in container: " + container);
- isConvert2v3 = false;
- error_decompiling = true;
+ isConvert2v3 = false;
+ error_decompiling = true;
return;
}
-
+
if (cc.v3Source != null) {
// next updates classname2multiSources for tracking non-identical defs
boolean identical = collectInfoForReports(cc);
@@ -1310,38 +1407,42 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
cc.containersAndV2Paths.add(new ContainerAndPath(path, container));
return;
}
-
+
assert cc.v2Source != null;
packageName = null;
className = null;
packageAndClassNameSlash = null;
cu = null;
-
+
String source = cc.v2Source;
- isConvert2v3 = true; // preinit, set false if convert fails
- isV2JCas = false; // preinit, set true by reportV2Class, called by visit to ClassOrInterfaceDeclaration,
- // when it has v2 constructors, and the right type and type_index_id field declares
+ isConvert2v3 = true; // preinit, set false if convert fails
+ isV2JCas = false; // preinit, set true by reportV2Class, called by visit to
+ // ClassOrInterfaceDeclaration,
+ // when it has v2 constructors, and the right type and type_index_id field
+ // declares
isBuiltinJCas = false;
featNames.clear();
fi_fields.clear();
-
- try { // to reset the next 3 items
+
+ try { // to reset the next 3 items
current_cc = cc;
current_container = container;
current_path = path;
-
- // System.out.println("Migrating source before migration:\n");
- // System.out.println(source);
- // System.out.println("\n\n\n");
+
+ // System.out.println("Migrating source before migration:\n");
+ // System.out.println(source);
+ // System.out.println("\n\n\n");
if (source.startsWith(ERROR_DECOMPILING)) {
- System.err.println("Decompiling failed for class: " + cc.toString() + "\n got: " + Misc.elide(source, 300, false));
+ System.err.println("Decompiling failed for class: " + cc.toString() + "\n got: "
+ + Misc.elide(source, 300, false));
System.err.println("Please check the migrateClasspath");
if (null == migrateClasspath) {
System.err.println("classpath of this app is");
System.err.println(System.getProperty("java.class.path"));
} else {
- System.err.println(" first part of migrateClasspath argument was: " + Misc.elide(migrateClasspath, 300, false));
+ System.err.println(" first part of migrateClasspath argument was: "
+ + Misc.elide(migrateClasspath, 300, false));
System.err.println(" Value used was:");
URL[] urls = Misc.classpath2urls(migrateClasspath);
for (URL url : urls) {
@@ -1349,28 +1450,29 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
}
System.err.println("Skipping this component");
- isConvert2v3 = false;
- error_decompiling = true;
+ isConvert2v3 = false;
+ error_decompiling = true;
return;
}
-
+
StringReader sr = new StringReader(source);
try {
- cu = JavaParser.parse(sr);
-
+ cu = JavaParser.parse(sr);
+
addImport("java.lang.invoke.CallSite");
addImport("java.lang.invoke.MethodHandle");
addImport("org.apache.uima.cas.impl.CASImpl");
addImport("org.apache.uima.cas.impl.TypeImpl");
addImport("org.apache.uima.cas.impl.TypeSystemImpl");
-
- this.visit(cu, null); // side effect: sets the className, packageAndClassNameSlash, packageName
-
+
+ this.visit(cu, null); // side effect: sets the className, packageAndClassNameSlash,
+ // packageName
+
new removeEmptyStmts().visit(cu, null);
if (isConvert2v3) {
removeImport("org.apache.uima.jcas.cas.TOP_Type");
}
-
+
if (isConvert2v3 && fi_fields.size() > 0) {
NodeList<BodyDeclaration<?>> classMembers = cu.getTypes().get(0).getMembers();
int positionOfFirstConstructor = findConstructor(classMembers);
@@ -1379,15 +1481,13 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
classMembers.addAll(positionOfFirstConstructor, fi_fields);
}
-
+
ImportDeclaration firstImport = cu.getImports().get(0);
- String transformedMessage = String.format(" Migrated by uimaj-v3-migration-jcas, %s%n" +
- " Container: %s%n" +
- " Path in container: %s%n",
- new Date(),
- container.toString1(),
- path.toString()).replace('\\','/');
-
+ String transformedMessage = String.format(
+ " Migrated by uimaj-v3-migration-jcas, %s%n" + " Container: %s%n"
+ + " Path in container: %s%n",
+ new Date(), container.toString1(), path.toString()).replace('\\', '/');
+
Optional<Comment> existingComment = firstImport.getComment();
if (existingComment.isPresent()) {
Comment comment = existingComment.get();
@@ -1395,27 +1495,26 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
} else {
firstImport.setBlockComment(transformedMessage);
}
-
+
if (isSource) {
sourceToCommonConverted.put(source, cc);
- }
-
+ }
+
boolean identicalFound = collectInfoForReports(cc);
- assert ! identicalFound;
-
- if (isV2JCas) {
+ assert !identicalFound;
+
+ if (isV2JCas) {
writeV2Orig(cc, isConvert2v3);
}
if (isConvert2v3) {
cc.v3Source = new PrettyPrinter(printCu).print(cu);
- writeV3(cc);
+ writeV3(cc);
}
-
- psb.append(isBuiltinJCas
- ? "b"
- : (classname2multiSources.get(cc.fqcn_slash).size() == 1)
- ? "."
- : "d"); // means non-identical duplicate
+
+ psb.append(isBuiltinJCas ? "b"
+ : (classname2multiSources.get(cc.fqcn_slash).size() == 1) ? "." : "d"); // means
+ // non-identical
+ // duplicate
flush(psb);
} catch (IOException e) {
e.printStackTrace();
@@ -1432,60 +1531,61 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
/**
- * Called when have already converted this exact source or
- * when we just finished converting this source.
- * Add this instance to the tracking information for multiple versions (identical or not) of a class
+ * Called when have already converted this exact source or when we just finished converting this
+ * source. Add this instance to the tracking information for multiple versions (identical or not)
+ * of a class
+ *
* @return true if this is an identical duplicate of one already done
*/
-
+
private boolean collectInfoForReports(CommonConverted cc) {
String fqcn_slash = cc.fqcn_slash;
-
+
// track, by fqcn, all duplicates (identical or not)
-
-// // for a given fully qualified class name (slashified),
-// // find the list of CommonConverteds - one per each different version
-// // create it if null
- List<CommonConverted> commonConverteds = classname2multiSources
- .computeIfAbsent(fqcn_slash, k -> new ArrayList<>());
+
+ // // for a given fully qualified class name (slashified),
+ // // find the list of CommonConverteds - one per each different version
+ // // create it if null
+ List<CommonConverted> commonConverteds = classname2multiSources.computeIfAbsent(fqcn_slash,
+ k -> new ArrayList<>());
// search to see if this instance already in the set
- // if so, add the path to the set of identicals
+ // if so, add the path to the set of identicals
// For class sources case, we compare the decompiled version
boolean found = commonConverteds.contains(cc);
if (!found) {
commonConverteds.add(cc);
- }
-
+ }
+
return found;
}
-
+
/******************
- * Visitors
+ * Visitors
******************/
/**
- * Capture the type name from all top-level types
- * AnnotationDeclaration, Empty, and Enum
+ * Capture the type name from all top-level types AnnotationDeclaration, Empty, and Enum
*/
-
+
@Override
public void visit(AnnotationDeclaration n, Object ignore) {
updateClassName(n);
- super.visit(n, ignore);
+ super.visit(n, ignore);
}
-// @Override
-// public void visit(EmptyTypeDeclaration n, Object ignore) {
-// updateClassName(n);
-// super.visit(n, ignore);
-// }
+ // @Override
+ // public void visit(EmptyTypeDeclaration n, Object ignore) {
+ // updateClassName(n);
+ // super.visit(n, ignore);
+ // }
@Override
public void visit(EnumDeclaration n, Object ignore) {
updateClassName(n);
- super.visit(n, ignore);
+ super.visit(n, ignore);
}
+ // @formatter:off
/**
* Check if the top level class looks like a JCas class, and report if not:
* has 0, 1, and 2 element constructors
@@ -1499,10 +1599,11 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* @param n -
* @param ignore -
*/
+ // @formatter:on
@Override
public void visit(ClassOrInterfaceDeclaration n, Object ignore) {
// do checks to see if this is a JCas class; if not report skipped
-
+
Optional<Node> maybeParent = n.getParentNode();
if (maybeParent.isPresent()) {
Node parent = maybeParent.get();
@@ -1517,14 +1618,14 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
if (supers == null || supers.size() == 0) {
reportNotJCasClass("class doesn't extend a superclass");
super.visit(n, ignore);
- return;
+ return;
}
-
+
NodeList<BodyDeclaration<?>> members = n.getMembers();
setHasJCasConstructors(members);
if (hasV2Constructors && hasTypeFields(members)) {
reportV2Class();
- super.visit(n, ignore);
+ super.visit(n, ignore);
return;
}
if (hasV2Constructors) {
@@ -1536,63 +1637,68 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
return;
}
reportNotJCasClass("missing v2 constructors");
- return;
+ return;
}
}
-
- super.visit(n, ignore);
+
+ super.visit(n, ignore);
return;
-
+
}
-
+
@Override
public void visit(PackageDeclaration n, Object ignored) {
packageName = n.getNameAsString();
super.visit(n, ignored);
}
-
+
/***************
- * Constructors
- * - modify the 2 arg constructor - changing the args and the body
- * @param n - the constructor node
- * @param ignored -
+ * Constructors - modify the 2 arg constructor - changing the args and the body
+ *
+ * @param n
+ * - the constructor node
+ * @param ignored
+ * -
*/
@Override
public void visit(ConstructorDeclaration n, Object ignored) {
- super.visit(n, ignored); // processes the params
- if (!isConvert2v3) { // for enums, annotations
+ super.visit(n, ignored); // processes the params
+ if (!isConvert2v3) { // for enums, annotations
return;
}
List<Parameter> ps = n.getParameters();
-
- if (ps.size() == 2 &&
- getParmTypeName(ps, 0).equals("int") &&
- getParmTypeName(ps, 1).equals("TOP_Type")) {
-
- /** public Foo(TypeImpl type, CASImpl casImpl) {
- * super(type, casImpl);
- * readObject();
+
+ if (ps.size() == 2 && getParmTypeName(ps, 0).equals("int")
+ && getParmTypeName(ps, 1).equals("TOP_Type")) {
+
+ /**
+ * public Foo(TypeImpl type, CASImpl casImpl) { super(type, casImpl); readObject();
*/
setParameter(ps, 0, "TypeImpl", "type");
setParameter(ps, 1, "CASImpl", "casImpl");
-
+
// Body: change the 1st statement (must be super)
NodeList<Statement> stmts = n.getBody().getStatements();
if (!(stmts.get(0) instanceof ExplicitConstructorInvocationStmt)) {
recordBadConstructor("missing super call");
return;
}
- NodeList<Expression> args = ((ExplicitConstructorInvocationStmt)(stmts.get(0))).getArguments();
+ NodeList<Expression> args = ((ExplicitConstructorInvocationStmt) (stmts.get(0)))
+ .getArguments();
args.set(0, new NameExpr("type"));
- args.set(1, new NameExpr("casImpl"));
-
+ args.set(1, new NameExpr("casImpl"));
+
// leave the rest unchanged.
- }
+ }
}
- private final static Pattern refGetter = Pattern.compile("(ll_getRef(Array)?Value)|"
- + "(ll_getFSForRef)");
- private final static Pattern word1 = Pattern.compile("\\A(\\w*)"); // word chars starting at beginning \\A means beginning
+ private final static Pattern refGetter = Pattern
+ .compile("(ll_getRef(Array)?Value)|" + "(ll_getFSForRef)");
+ private final static Pattern word1 = Pattern.compile("\\A(\\w*)"); // word chars starting at
+ // beginning \\A means
+ // beginning
+
+ // @formatter:off
/*****************************
* Method Declaration Visitor
* Heuristic to determine if a feature getter or setter:
@@ -1606,45 +1712,53 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* Workaround for decompiler - getters which return FSs might be missing the cast to the return value type
*
*****************************/
+ // @formatter:on
@Override
public void visit(MethodDeclaration n, Object ignore) {
String name = n.getNameAsString();
isGetter = isArraySetter = false;
- do { // to provide break exit
-
- if (name.length() >= 4 &&
- ((isGetter = name.startsWith("get")) || name.startsWith("set")) &&
- Character.isUpperCase(name.charAt(3)) &&
- !name.equals("getTypeIndexID")) {
+ do { // to provide break exit
+
+ if (name.length() >= 4 && ((isGetter = name.startsWith("get")) || name.startsWith("set"))
+ && Character.isUpperCase(name.charAt(3)) && !name.equals("getTypeIndexID")) {
List<Parameter> ps = n.getParameters();
if (isGetter) {
- if (ps.size() > 1) break;
+ if (ps.size() > 1)
+ break;
} else { // is setter
- if (ps.size() > 2 ||
- ps.size() == 0) break;
+ if (ps.size() > 2 || ps.size() == 0)
+ break;
if (ps.size() == 2) {
- if (!getParmTypeName(ps, 0).equals("int")) break;
+ if (!getParmTypeName(ps, 0).equals("int"))
+ break;
isArraySetter = true;
- }
+ }
}
-
+
// get the range-part-name and convert to v3 range ("Ref" changes to "Feature")
String bodyString = n.getBody().get().toString(printWithoutComments);
int i = bodyString.indexOf("jcasType.ll_cas.ll_");
- if (i < 0) break;
- String s = bodyString.substring(i + "jcasType.ll_cas.ll_get".length()); // also for ...ll_set - same length!
+ if (i < 0)
+ break;
+ String s = bodyString.substring(i + "jcasType.ll_cas.ll_get".length()); // also for
+ // ...ll_set - same
+ // length!
if (s.startsWith("FSForRef(")) { // then it's the wrapper and the wrong instance.
i = s.indexOf("jcasType.ll_cas.ll_");
if (i < 0) {
- reportUnrecognizedV2Code("Found \"jcasType.ll_cas.ll_[set or get]...FSForRef(\" but didn't find following \"jcasType.ll_cas_ll_\"\n" + n.toString());
+ reportUnrecognizedV2Code(
+ "Found \"jcasType.ll_cas.ll_[set or get]...FSForRef(\" but didn't find following \"jcasType.ll_cas_ll_\"\n"
+ + n.toString());
break;
}
s = s.substring(i + "jcasType.ll_cas.ll_get".length());
}
i = s.indexOf("Value");
if (i < 0) {
- reportUnrecognizedV2Code("Found \"jcasType.ll_cas.ll_[set or get]\" but didn't find following \"Value\"\n" + n.toString());
- break; // give up
+ reportUnrecognizedV2Code(
+ "Found \"jcasType.ll_cas.ll_[set or get]\" but didn't find following \"Value\"\n"
+ + n.toString());
+ break; // give up
}
s = Character.toUpperCase(s.charAt(0)) + s.substring(1, i);
rangeNameV2Part = s;
@@ -1656,69 +1770,78 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
reportUnrecognizedV2Code("Didn't find \"...jcasType).casFeatCode_\"\n" + n.toString());
break;
}
- Matcher m = word1.matcher(bodyString.substring(i + "jcasType).casFeatCode_".length() ));
+ Matcher m = word1.matcher(bodyString.substring(i + "jcasType).casFeatCode_".length()));
if (!m.find()) {
- reportUnrecognizedV2Code("Found \"...jcasType).casFeatCode_\" but didn't find subsequent word\n" + n.toString());
+ reportUnrecognizedV2Code(
+ "Found \"...jcasType).casFeatCode_\" but didn't find subsequent word\n"
+ + n.toString());
break;
}
featName = m.group(1);
String fromMethod = Character.toLowerCase(name.charAt(3)) + name.substring(4);
if (!featName.equals(fromMethod)) {
// don't report if the only difference is the first letter captialization
- if (!(Character.toLowerCase(featName.charAt(0)) + featName.substring(1)).equals(fromMethod)) {
+ if (!(Character.toLowerCase(featName.charAt(0)) + featName.substring(1))
+ .equals(fromMethod)) {
reportMismatchedFeatureName(String.format("%-25s %s", featName, name));
}
}
// add _FI_xxx = TypeSystemImpl.getAdjustedFeatureOffset("xxx");
// replaced Sept 2017
-// NodeList<Expression> args = new NodeList<>();
-// args.add(new StringLiteralExpr(featName));
-// VariableDeclarator vd = new VariableDeclarator(
-// intType,
-// "_FI_" + featName,
-// new MethodCallExpr(new NameExpr("TypeSystemImpl"), new SimpleName("getAdjustedFeatureOffset"), args));
-// if (featNames.add(featName)) { // returns true if it was added, false if already in the set of featNames
-// fi_fields.add(new FieldDeclaration(public_static_final, vd));
-// }
-
+ // NodeList<Expression> args = new NodeList<>();
+ // args.add(new StringLiteralExpr(featName));
+ // VariableDeclarator vd = new VariableDeclarator(
+ // intType,
+ // "_FI_" + featName,
+ // new MethodCallExpr(new NameExpr("TypeSystemImpl"), new
+ // SimpleName("getAdjustedFeatureOffset"), args));
+ // if (featNames.add(featName)) { // returns true if it was added, false if already in the
+ // set of featNames
+ // fi_fields.add(new FieldDeclaration(public_static_final, vd));
+ // }
+
// add _FC_xxx = TypeSystemImpl.createCallSite(ccc.class, "xxx");
// add _FH_xxx = _FC_xxx.dynamicInvoker();
- // add _FeatName_xxx = "xxx" // https://issues.apache.org/jira/browse/UIMA-5575
-
- if (featNames.add(featName)) { // returns true if it was added, false if already in the set of featNames
+ // add _FeatName_xxx = "xxx" // https://issues.apache.org/jira/browse/UIMA-5575
+
+ if (featNames.add(featName)) { // returns true if it was added, false if already in the set
+ // of featNames
// _FC_xxx = TypeSystemImpl.createCallSite(ccc.class, "xxx");
- MethodCallExpr initCallSite = new MethodCallExpr(new NameExpr("TypeSystemImpl"), "createCallSite");
+ MethodCallExpr initCallSite = new MethodCallExpr(new NameExpr("TypeSystemImpl"),
+ "createCallSite");
initCallSite.addArgument(new FieldAccessExpr(new NameExpr(className), "class"));
initCallSite.addArgument(new StringLiteralExpr(featName));
- VariableDeclarator vd_FC = new VariableDeclarator(callSiteType, "_FC_" + featName, initCallSite);
+ VariableDeclarator vd_FC = new VariableDeclarator(callSiteType, "_FC_" + featName,
+ initCallSite);
fi_fields.add(new FieldDeclaration(private_static_final, vd_FC));
-
+
// _FH_xxx = _FC_xxx.dynamicInvoker();
- MethodCallExpr initInvoker = new MethodCallExpr(new NameExpr(vd_FC.getName()), "dynamicInvoker");
- VariableDeclarator vd_FH = new VariableDeclarator(methodHandleType, "_FH_" + featName, initInvoker);
+ MethodCallExpr initInvoker = new MethodCallExpr(new NameExpr(vd_FC.getName()),
+ "dynamicInvoker");
+ VariableDeclarator vd_FH = new VariableDeclarator(methodHandleType, "_FH_" + featName,
+ initInvoker);
fi_fields.add(new FieldDeclaration(private_static_final, vd_FH));
-
- // _FeatName_xxx = "xxx" // https://issues.apache.org/jira/browse/UIMA-5575
- VariableDeclarator vd_fn = new VariableDeclarator(stringType, "_FeatName_" + featName, new StringLiteralExpr(featName));
+
+ // _FeatName_xxx = "xxx" // https://issues.apache.org/jira/browse/UIMA-5575
+ VariableDeclarator vd_fn = new VariableDeclarator(stringType, "_FeatName_" + featName,
+ new StringLiteralExpr(featName));
fi_fields.add(new FieldDeclaration(public_static_final, vd_fn));
-
+
}
-
+
/**
- * add missing cast stmt for
- * return stmts where the value being returned:
- * - doesn't have a cast already
- * - has the expression be a methodCallExpr with a name which looks like:
- * ll_getRefValue or
- * ll_getRefArrayValue
+ * add missing cast stmt for return stmts where the value being returned: - doesn't have a
+ * cast already - has the expression be a methodCallExpr with a name which looks like:
+ * ll_getRefValue or ll_getRefArrayValue
*/
if (isGetter && "Feature".equals(rangeNamePart)) {
for (Statement stmt : n.getBody().get().getStatements()) {
if (stmt instanceof ReturnStmt) {
- Expression e = getUnenclosedExpr(((ReturnStmt)stmt).getExpression().get());
+ Expression e = getUnenclosedExpr(((ReturnStmt) stmt).getExpression().get());
if ((e instanceof MethodCallExpr)) {
- String methodName = ((MethodCallExpr)e).getNameAsString();
- if (refGetter.matcher(methodName).matches()) { // ll_getRefValue or ll_getRefArrayValue
+ String methodName = ((MethodCallExpr) e).getNameAsString();
+ if (refGetter.matcher(methodName).matches()) { // ll_getRefValue or
+ // ll_getRefArrayValue
addCastExpr(stmt, n.getType());
}
}
@@ -1726,176 +1849,183 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
}
- get_set_method = n; // used as a flag during inner "visits" to signal
+ get_set_method = n; // used as a flag during inner "visits" to signal
// we're inside a likely feature setter/getter
} // end of test for getter or setter method
- } while (false); // do once, provide break exit
-
+ } while (false); // do once, provide break exit
+
super.visit(n, ignore);
get_set_method = null; // after visiting, reset the get_set_method to null
}
-
+
/**
- * Visitor for if stmts
- * - removes feature missing test
+ * Visitor for if stmts - removes feature missing test
*/
@Override
public void visit(IfStmt n, Object ignore) {
do {
- // if (get_set_method == null) break; // sometimes, these occur outside of recogn. getters/setters
-
+ // if (get_set_method == null) break; // sometimes, these occur outside of recogn.
+ // getters/setters
+
Expression c = n.getCondition(), e;
- BinaryExpr be, be2;
+ BinaryExpr be, be2;
List<Statement> stmts;
- if ((c instanceof BinaryExpr) &&
- ((be = (BinaryExpr)c).getLeft() instanceof FieldAccessExpr) &&
- ((FieldAccessExpr)be.getLeft()).getNameAsString().equals("featOkTst")) {
+ if ((c instanceof BinaryExpr) && ((be = (BinaryExpr) c).getLeft() instanceof FieldAccessExpr)
+ && ((FieldAccessExpr) be.getLeft()).getNameAsString().equals("featOkTst")) {
// remove the feature missing if statement
-
- // verify the remaining form
- if (! (be.getRight() instanceof BinaryExpr)
- || ! ((be2 = (BinaryExpr)be.getRight()).getRight() instanceof NullLiteralExpr)
- || ! (be2.getLeft() instanceof FieldAccessExpr)
-
- || ! ((e = getExpressionFromStmt(n.getThenStmt())) instanceof MethodCallExpr)
- || ! (((MethodCallExpr)e).getNameAsString()).equals("throwFeatMissing")) {
+
+ // verify the remaining form
+ if (!(be.getRight() instanceof BinaryExpr)
+ || !((be2 = (BinaryExpr) be.getRight()).getRight() instanceof NullLiteralExpr)
+ || !(be2.getLeft() instanceof FieldAccessExpr)
+
+ || !((e = getExpressionFromStmt(n.getThenStmt())) instanceof MethodCallExpr)
+ || !(((MethodCallExpr) e).getNameAsString()).equals("throwFeatMissing")) {
reportDeletedCheckModified("The featOkTst was modified:\n" + n.toString() + '\n');
}
-
+
BlockStmt parent = (BlockStmt) n.getParentNode().get();
stmts = parent.getStatements();
- stmts.set(stmts.indexOf(n), new EmptyStmt()); //dont remove
- // otherwise iterators fail
-// parent.getStmts().remove(n);
+ stmts.set(stmts.indexOf(n), new EmptyStmt()); // dont remove
+ // otherwise iterators fail
+ // parent.getStmts().remove(n);
return;
}
} while (false);
-
- super.visit(n, ignore);
+
+ super.visit(n, ignore);
}
- /**
+
+ /**
* visitor for method calls
*/
@Override
public void visit(MethodCallExpr n, Object ignore) {
- Optional<Node> p1, p2, p3 = null;
+ Optional<Node> p1, p2, p3 = null;
Node updatedNode = null;
NodeList<Expression> args;
-
+
do {
- if (get_set_method == null) break;
-
+ if (get_set_method == null)
+ break;
+
/** remove checkArraybounds statement **/
- if (n.getNameAsString().equals("checkArrayBounds") &&
- ((p1 = n.getParentNode()).isPresent() && p1.get() instanceof ExpressionStmt) &&
- ((p2 = p1.get().getParentNode()).isPresent() && p2.get() instanceof BlockStmt) &&
- ((p3 = p2.get().getParentNode()).isPresent() && p3.get() == get_set_method)) {
- NodeList<Statement> stmts = ((BlockStmt)p2.get()).getStatements();
+ if (n.getNameAsString().equals("checkArrayBounds")
+ && ((p1 = n.getParentNode()).isPresent() && p1.get() instanceof ExpressionStmt)
+ && ((p2 = p1.get().getParentNode()).isPresent() && p2.get() instanceof BlockStmt)
+ && ((p3 = p2.get().getParentNode()).isPresent() && p3.get() == get_set_method)) {
+ NodeList<Statement> stmts = ((BlockStmt) p2.get()).getStatements();
stmts.set(stmts.indexOf(p1.get()), new EmptyStmt());
return;
}
-
+
// convert simpleCore expression ll_get/setRangeValue
boolean useGetter = isGetter || isArraySetter;
- if (n.getNameAsString().startsWith("ll_" + (useGetter ? "get" : "set") + rangeNameV2Part + "Value")) {
+ if (n.getNameAsString()
+ .startsWith("ll_" + (useGetter ? "get" : "set") + rangeNameV2Part + "Value")) {
args = n.getArguments();
- if (args.size() != (useGetter ? 2 : 3)) break;
+ if (args.size() != (useGetter ? 2 : 3))
+ break;
String suffix = useGetter ? "Nc" : rangeNamePart.equals("Feature") ? "NcWj" : "Nfc";
- String methodName = "_" + (useGetter ? "get" : "set") + rangeNamePart + "Value" + suffix;
- args.remove(0); // remove the old addr arg
- // arg 0 converted when visiting args FieldAccessExpr
+ String methodName = "_" + (useGetter ? "get" : "set") + rangeNamePart + "Value" + suffix;
+ args.remove(0); // remove the old addr arg
+ // arg 0 converted when visiting args FieldAccessExpr
n.setScope(null);
n.setName(methodName);
}
-
+
// convert array sets/gets
String z = "ll_" + (isGetter ? "get" : "set");
String nname = n.getNameAsString();
- if (nname.startsWith(z) &&
- nname.endsWith("ArrayValue")) {
-
+ if (nname.startsWith(z) && nname.endsWith("ArrayValue")) {
+
String s = nname.substring(z.length());
- s = s.substring(0, s.length() - "Value".length()); // s = "ShortArray", etc.
- if (s.equals("RefArray")) s = "FSArray";
- if (s.equals("IntArray")) s = "IntegerArray";
+ s = s.substring(0, s.length() - "Value".length()); // s = "ShortArray", etc.
+ if (s.equals("RefArray"))
+ s = "FSArray";
+ if (s.equals("IntArray"))
+ s = "IntegerArray";
EnclosedExpr ee = new EnclosedExpr(
- new CastExpr(new ClassOrInterfaceType(s), n.getArguments().get(0)));
-
- n.setScope(ee); // the getter for the array fs
+ new CastExpr(new ClassOrInterfaceType(s), n.getArguments().get(0)));
+
+ n.setScope(ee); // the getter for the array fs
n.setName(isGetter ? "get" : "set");
n.getArguments().remove(0);
}
-
+
/** remove ll_getFSForRef **/
/** remove ll_getFSRef **/
- if (n.getNameAsString().equals("ll_getFSForRef") ||
- n.getNameAsString().equals("ll_getFSRef")) {
- updatedNode = replaceInParent(n, n.getArguments().get(0));
+ if (n.getNameAsString().equals("ll_getFSForRef")
+ || n.getNameAsString().equals("ll_getFSRef")) {
+ updatedNode = replaceInParent(n, n.getArguments().get(0));
}
-
-
-
+
} while (false);
-
+
if (updatedNode != null) {
- updatedNode.accept(this, null);
+ updatedNode.accept(this, null);
} else {
super.visit(n, null);
}
}
/**
- * visitor for field access expressions
- * - convert ((...type_Type)jcasType).casFeatCode_XXXX to _FI_xxx
- * @param n -
- * @param ignore -
+ * visitor for field access expressions - convert ((...type_Type)jcasType).casFeatCode_XXXX to
+ * _FI_xxx
+ *
+ * @param n
+ * -
+ * @param ignore
+ * -
*/
@Override
public void visit(FieldAccessExpr n, Object ignore) {
Expression e;
Optional<Expression> oe;
String nname = n.getNameAsString();
-
- if (get_set_method != null) {
- if (nname.startsWith("casFeatCode_") &&
- ((oe = n.getScope()).isPresent()) &&
- ((e = getUnenclosedExpr(oe.get())) instanceof CastExpr) &&
- ("jcasType".equals(getName(((CastExpr)e).getExpression())))) {
+
+ if (get_set_method != null) {
+ if (nname.startsWith("casFeatCode_") && ((oe = n.getScope()).isPresent())
+ && ((e = getUnenclosedExpr(oe.get())) instanceof CastExpr)
+ && ("jcasType".equals(getName(((CastExpr) e).getExpression())))) {
String featureName = nname.substring("casFeatCode_".length());
-// replaceInParent(n, new NameExpr("_FI_" + featureName)); // repl last in List<Expression> (args)
-
+ // replaceInParent(n, new NameExpr("_FI_" + featureName)); // repl last in List<Expression>
+ // (args)
+
MethodCallExpr getint = new MethodCallExpr(null, "wrapGetIntCatchException");
getint.addArgument(new NameExpr("_FH_" + featureName));
replaceInParent(n, getint);
-
+
return;
} else if (nname.startsWith("casFeatCode_")) {
- reportMigrateFailed("Found field casFeatCode_ ... without a previous cast expr using jcasType");
+ reportMigrateFailed(
+ "Found field casFeatCode_ ... without a previous cast expr using jcasType");
}
}
- super.visit(n, ignore);
+ super.visit(n, ignore);
}
-
+
private class removeEmptyStmts extends VoidVisitorAdapter<Object> {
@Override
public void visit(BlockStmt n, Object ignore) {
n.getStatements().removeIf(statement -> statement instanceof EmptyStmt);
- super.visit(n, ignore);
- }
-
-// @Override
-// public void visit(MethodDeclaration n, Object ignore) {
-// if (n.getNameAsString().equals("getModifiablePrimitiveNodes")) {
-// System.out.println("debug");
-// }
-// super.visit(n, ignore);
-// if (n.getNameAsString().equals("getModifiablePrimitiveNodes")) {
-// System.out.println("debug");
-// }
-// }
- }
-
+ super.visit(n, ignore);
+ }
+
+ // @Override
+ // public void visit(MethodDeclaration n, Object ignore) {
+ // if (n.getNameAsString().equals("getModifiablePrimitiveNodes")) {
+ // System.out.println("debug");
+ // }
+ // super.visit(n, ignore);
+ // if (n.getNameAsString().equals("getModifiablePrimitiveNodes")) {
+ // System.out.println("debug");
+ // }
+ // }
+ }
+
+ // @formatter:off
/**
* converted files:
* java name, path (sorted by java name, v3 name only)
@@ -1905,6 +2035,7 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* java name, path (sorted by java name)
* @return true if it's likely everything converted OK.
*/
+ // @formatter:on
private boolean report() {
System.out.println("\n\nMigration Summary");
System.out.format("Output top directory: %s%n", outputDirectory);
@@ -1916,22 +2047,28 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
try {
// these reports, if non-empty items, imply something needs manual checking, so reset isOk2
isOk2 = reportPaths("Workaround Directories", "workaroundDir.txt", pathWorkaround) && isOk2;
- isOk2 = reportPaths("Reports of converted files where a deleted check was customized", "deletedCheckModified.txt", deletedCheckModified) && isOk2;
- isOk2 = reportPaths("Reports of converted files needing manual inspection", "manualInspection.txt", manualInspection) && isOk2;
- isOk2 = reportPaths("Reports of files which failed migration", "failed.txt", failedMigration) && isOk2;
+ isOk2 = reportPaths("Reports of converted files where a deleted check was customized",
+ "deletedCheckModified.txt", deletedCheckModified) && isOk2;
+ isOk2 = reportPaths("Reports of converted files needing manual inspection",
+ "manualInspection.txt", manualInspection) && isOk2;
+ isOk2 = reportPaths("Reports of files which failed migration", "failed.txt", failedMigration)
+ && isOk2;
isOk2 = reportPaths("Reports of non-JCas files", "NonJCasFiles.txt", nonJCasFiles) && isOk2;
- isOk2 = reportPaths("Builtin JCas classes - skipped - need manual checking to see if they are modified",
- "skippedBuiltins.txt", skippedBuiltins) && isOk2;
+ isOk2 = reportPaths(
+ "Builtin JCas classes - skipped - need manual checking to see if they are modified",
+ "skippedBuiltins.txt", skippedBuiltins) && isOk2;
// these reports, if non-empty, do not imply OK issues
reportPaths("Reports of updated Jars", "jarFileUpdates.txt", jarClassReplace);
reportPaths("Reports of updated PEARs", "pearFileUpdates.txt", pearClassReplace);
-
-// computeDuplicates();
-// reportPaths("Report of duplicates - not identical", "nonIdenticalDuplicates.txt", nonIdenticalDuplicates);
-// reportPaths("Report of duplicates - identical", "identicalDuplicates.txt", identicalDuplicates);
-// isOk2 = reportDuplicates() && isOk2; // false if non-identical duplicates
-
+
+ // computeDuplicates();
+ // reportPaths("Report of duplicates - not identical", "nonIdenticalDuplicates.txt",
+ // nonIdenticalDuplicates);
+ // reportPaths("Report of duplicates - identical", "identicalDuplicates.txt",
+ // identicalDuplicates);
+ // isOk2 = reportDuplicates() && isOk2; // false if non-identical duplicates
+
return isOk2;
} catch (IOException e) {
throw new RuntimeException(e);
@@ -1941,14 +2078,15 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
private void pprintRoots(String kind, Container[] roots) {
if (roots != null && roots.length > 0) {
try {
- try (BufferedWriter bw = Files.newBufferedWriter(makePath(outDirLog + "ItemsProcessed"), StandardOpenOption.CREATE)) {
+ try (BufferedWriter bw = Files.newBufferedWriter(makePath(outDirLog + "ItemsProcessed"),
+ StandardOpenOption.CREATE)) {
logPrintNl(kind + " Roots:", bw);
indent[0] += 2;
try {
- for (Container container : roots) {
- pprintContainer(container, bw);
- }
- logPrintNl("", bw);
+ for (Container container : roots) {
+ pprintContainer(container, bw);
+ }
+ logPrintNl("", bw);
} finally {
indent[0] -= 2;
}
@@ -1958,7 +2096,7 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
}
}
-
+
private void pprintContainer(Container container, BufferedWriter bw) throws IOException {
logPrintNl(container.toString(), bw);
if (container.subContainers.size() > 1) {
@@ -1968,66 +2106,65 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
pprintContainer(subc, bw);
}
}
-
-
- }
-
-// private void computeDuplicates() {
-// List<ClassnameAndPath> toCheck = new ArrayList<>(c2ps);
-// toCheck.addAll(extendableBuiltins);
-// sortReport2(toCheck);
-// ClassnameAndPath prevP = new ClassnameAndPath(null, null);
-// List<ClassnameAndPath> sameList = new ArrayList<>();
-// boolean areAllEqual = true;
-//
-// for (ClassnameAndPath p : toCheck) {
-// if (!p.getFirst().equals(prevP.getFirst())) {
-//
-// addToIdenticals(sameList, areAllEqual);
-// sameList.clear();
-// areAllEqual = true;
-//
-// prevP = p;
-// continue;
-// }
-//
-// // have 2nd or subsequent same class
-// if (sameList.size() == 0) {
-// sameList.add(prevP);
-// }
-// sameList.add(p);
-// if (areAllEqual) {
-// if (isFilesMiscompare(p.path, prevP.path)) {
-// areAllEqual = false;
-// }
-// }
-// }
-//
-// addToIdenticals(sameList, areAllEqual);
-// }
-
-// /**
-// * Compare two java source or class files
-// * @param p1
-// * @param p2
-// * @return
-// */
-// private boolean isFilesMiscompare(Path p1, Path p2) {
-// String s1 = (p1);
-// String s2 = (p2);
-// return !s1.equals(s2);
-// }
-
-// private void addToIdenticals(List<ClassnameAndPath> sameList, boolean areAllEqual) {
-// if (sameList.size() > 0) {
-// if (areAllEqual) {
-// identicalDuplicates.addAll(sameList);
-// } else {
-// nonIdenticalDuplicates.addAll(sameList);
-// }
-// }
-// }
-
+
+ }
+
+ // private void computeDuplicates() {
+ // List<ClassnameAndPath> toCheck = new ArrayList<>(c2ps);
+ // toCheck.addAll(extendableBuiltins);
+ // sortReport2(toCheck);
+ // ClassnameAndPath prevP = new ClassnameAndPath(null, null);
+ // List<ClassnameAndPath> sameList = new ArrayList<>();
+ // boolean areAllEqual = true;
+ //
+ // for (ClassnameAndPath p : toCheck) {
+ // if (!p.getFirst().equals(prevP.getFirst())) {
+ //
+ // addToIdenticals(sameList, areAllEqual);
+ // sameList.clear();
+ // areAllEqual = true;
+ //
+ // prevP = p;
+ // continue;
+ // }
+ //
+ // // have 2nd or subsequent same class
+ // if (sameList.size() == 0) {
+ // sameList.add(prevP);
+ // }
+ // sameList.add(p);
+ // if (areAllEqual) {
+ // if (isFilesMiscompare(p.path, prevP.path)) {
+ // areAllEqual = false;
+ // }
+ // }
+ // }
+ //
+ // addToIdenticals(sameList, areAllEqual);
+ // }
+
+ // /**
+ // * Compare two java source or class files
+ // * @param p1
+ // * @param p2
+ // * @return
+ // */
+ // private boolean isFilesMiscompare(Path p1, Path p2) {
+ // String s1 = (p1);
+ // String s2 = (p2);
+ // return !s1.equals(s2);
+ // }
+
+ // private void addToIdenticals(List<ClassnameAndPath> sameList, boolean areAllEqual) {
+ // if (sameList.size() > 0) {
+ // if (areAllEqual) {
+ // identicalDuplicates.addAll(sameList);
+ // } else {
+ // nonIdenticalDuplicates.addAll(sameList);
+ // }
+ // }
+ // }
+
/**
*
* @param name
@@ -2036,7 +2173,7 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
*/
private Path makePath(String name) throws IOException {
Path p = Paths.get(name);
- Path parent = p.getParent(); // all the parts of the path up to the final segment
+ Path parent = p.getParent(); // all the parts of the path up to the final segment
if (parent == null) {
return p;
}
@@ -2044,8 +2181,8 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
Files.createDirectories(parent);
} catch (FileAlreadyExistsException e) { // parent already exists but is not a directory!
// caused by running on Windows system which ignores "case"
- // there's a file at /x/y/ named "z", but the path wants to be /x/y/Z/
- // Workaround: change "z" to "z_c" c for capitalization issue
+ // there's a file at /x/y/ named "z", but the path wants to be /x/y/Z/
+ // Workaround: change "z" to "z_c" c for capitalization issue
current_container.haveDifferentCapitalizedNamesCollidingOnWindows = true;
Path fn = parent.getFileName();
if (fn == null) {
@@ -2053,58 +2190,65 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
String newDir = fn.toString() + "_c";
Path parent2 = parent.getParent();
-
+
Path p2 = parent2 == null ? Paths.get(newDir) : Paths.get(parent2.toString(), newDir);
try {
Files.createDirectories(p2);
} catch (FileAlreadyExistsException e2) { // parent already exists but is not a directory!
throw new RuntimeException(e2);
}
-
+
reportPathWorkaround(parent.toString(), p2.toString());
Path lastPartOfPath = p.getFileName();
- if (null == lastPartOfPath) throw new RuntimeException();
+ if (null == lastPartOfPath)
+ throw new RuntimeException();
return Paths.get(p2.toString(), lastPartOfPath.toString());
}
return p;
}
-
-
+
private void logPrint(String msg, Writer bw) throws IOException {
System.out.print(msg);
bw.write(msg);
}
-
+
private void logPrintNl(String msg, Writer bw) throws IOException {
logPrint(msg, bw);
logPrint("\n", bw);
}
-
+
/**
- * prints "There were no xxx" if there are no items.
- * prints a title, followed by a ================== underneath it
+ * prints "There were no xxx" if there are no items. prints a title, followed by a
+ * ================== underneath it
*
* prints a sorted report of two fields.
*
- * @param title title of report
- * @param fileName file name to save the report in (as well as print to sysout
- * @param items the set of items to report on-
+ * @param title
+ * title of report
+ * @param fileName
+ * file name to save the report in (as well as print to sysout
+ * @param items
+ * the set of items to report on-
* @return true if items were empty
- * @throws IOException -
+ * @throws IOException
+ * -
*/
- private <T, U> boolean reportPaths(String title, String fileName, List<? extends Report2<T, U>> items) throws IOException {
+ private <T, U> boolean reportPaths(String title, String fileName,
+ List<? extends Report2<T, U>> items) throws IOException {
if (items.size() == 0) {
System.out.println("There were no " + title);
return true;
}
System.out.println("\n" + title);
- for (int i = 0; i < title.length(); i++) System.out.print('=');
+ for (int i = 0; i < title.length(); i++)
+ System.out.print('=');
System.out.println("");
-
- try (BufferedWriter bw = Files.newBufferedWriter(makePath(outDirLog + fileName), StandardOpenOption.CREATE)) {
+
+ try (BufferedWriter bw = Files.newBufferedWriter(makePath(outDirLog + fileName),
+ StandardOpenOption.CREATE)) {
List<Report2<T, U>> sorted = new ArrayList<>(items);
- sortReport2(sorted);
+ sortReport2(sorted);
int max = 0;
int nbrFirsts = 0;
Object prevFirst = null;
@@ -2113,28 +2257,27 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
Comparable<T> first = p.getFirst();
if (first != prevFirst) {
prevFirst = first;
- nbrFirsts ++;
+ nbrFirsts++;
}
}
-
- /**
- * Two styles.
- * Style 1: where nbrFirst <= 25% nbr: first on separate line, seconds indented
- * Style 2: firsts and seconds on same line.
+
+ /**
+ * Two styles. Style 1: where nbrFirst <= 25% nbr: first on separate line, seconds indented
+ * Style 2: firsts and seconds on same line.
*/
int i = 1;
boolean style1 = nbrFirsts <= sorted.size() / 4;
prevFirst = null;
for (Report2<T, U> p : sorted) {
if (style1) {
-
+
if (prevFirst != p.getFirst()) {
prevFirst = p.getFirst();
logPrintNl(String.format("\n For: %s", p.getFirst()), bw);
- }
+ }
logPrintNl(String.format(" %5d %s", i, p.getSecond()), bw);
} else {
- logPrintNl(String.format("%5d %-" +max+ "s %s", i, p.getFirst(), p.getSecond()), bw);
+ logPrintNl(String.format("%5d %-" + max + "s %s", i, p.getFirst(), p.getSecond()), bw);
}
i++;
}
@@ -2142,14 +2285,15 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
} // end of try-with-resources
return false;
}
-
+
private boolean isZipFs(Object o) {
// Surprise! sometimes the o is not an instance of FileSystem but is the zipfs anyways
- return o.getClass().getName().contains("zipfs"); // java 8 and 9
+ return o.getClass().getName().contains("zipfs"); // java 8 and 9
}
-
+
/**
* Sort the items on first, then second
+ *
* @param items
*/
private <T, U> void sortReport2(List<? extends Report2<T, U>> items) {
@@ -2161,17 +2305,19 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
return r;
});
}
-
+
/**
- * protect against comparing zip fs with non-zip fs - these are not comparable to each other in IBM Java 8
+ * protect against comparing zip fs with non-zip fs - these are not comparable to each other in
+ * IBM Java 8
+ *
* @return -
*/
private <T> int protectedCompare(Comparable<T> comparable, Comparable<T> comparable2) {
- //debug
+ // debug
try {
if (isZipFs(comparable)) {
if (isZipFs(comparable2)) {
- return comparable.compareTo((T) comparable2); // both zip
+ return comparable.compareTo((T) comparable2); // both zip
} else {
return 1;
}
@@ -2179,16 +2325,19 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
if (isZipFs(comparable2)) {
return -1;
} else {
- return comparable.compareTo((T) comparable2); // both not zip
+ return comparable.compareTo((T) comparable2); // both not zip
}
}
} catch (ClassCastException e) {
- //debug
- System.out.format("Internal error: c1: %b c2: %b%n c1: %s%n c2: %s%n", isZipFs(comparable), isZipFs(comparable2), comparable.getClass().getName(), comparable2.getClass().getName());
+ // debug
+ System.out.format("Internal error: c1: %b c2: %b%n c1: %s%n c2: %s%n", isZipFs(comparable),
+ isZipFs(comparable2), comparable.getClass().getName(),
+ comparable2.getClass().getName());
throw e;
}
}
+ // @formatter:off
/**
* Called only for top level roots. Sub containers recurse getCandidates_processFile2.
*
@@ -2205,16 +2354,21 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* @param root
* @throws IOException
*/
+ // @formatter:on
private void getAndProcessCandidatesInContainer(Container container) {
-
-// current_paths2RootIds = top_paths2RootIds; // don't do lower, that's called within Jars etc.
+
+ // current_paths2RootIds = top_paths2RootIds; // don't do lower, that's called within Jars etc.
if (container.isSingleJavaSource) {
getCandidates_processFile2(container.root, container);
} else {
- try (Stream<Path> stream = Files.walk(container.root, FileVisitOption.FOLLOW_LINKS)) { // needed to release file handles
- stream.forEachOrdered(
- // only puts into the RootIds possible Fqcn (ending in either .class or .java)
- p -> getCandidates_processFile2(p, container));
+ try (Stream<Path> stream = Files.walk(container.root, FileVisitOption.FOLLOW_LINKS)) { // needed
+ // to
+ // release
+ // file
+ // handles
+ stream.forEachOrdered(
+ // only puts into the RootIds possible Fqcn (ending in either .class or .java)
+ p -> getCandidates_processFile2(p, container));
} catch (IOException e) {
throw new RuntimeException(e);
}
@@ -2224,38 +2378,35 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
// prunes empty rootIds and subContainer nodes
removeNonJCas(container);
- if (container.candidates.size() == 0 &&
- container.subContainers.size() == 0) { // above call might remove all candidates
+ if (container.candidates.size() == 0 && container.subContainers.size() == 0) { // above call
+ // might remove
+ // all candidates
Container parent = container.parent;
if (parent != null) {
-// System.out.println("No Candidates found, removing container: " + container.toString() );
-// // debug
-// System.out.println("debug: " + container.rootOrig.toString());
+ // System.out.println("No Candidates found, removing container: " + container.toString() );
+ // // debug
+ // System.out.println("debug: " + container.rootOrig.toString());
parent.subContainers.remove(container);
}
return;
}
-
+
si(psb).append("Migrating JCas files ");
- psb.append( container.isJar
- ? "in Jar: "
- : container.isPear
- ? "in Pear: "
- : "from root: ");
+ psb.append(container.isJar ? "in Jar: " : container.isPear ? "in Pear: " : "from root: ");
psb.append(container.rootOrig);
-
+
indent[0] += 2;
si(psb);
flush(psb);
try {
for (Path path : container.candidates) {
-
+
CommonConverted cc = getSource(path, container);
// migrate checks to see if already done, outputs a "." or some other char for the candidate
migrate(cc, container, path);
-
- //defer any compilation to container level
-
+
+ // defer any compilation to container level
+
if ((itemCount % 50) == 0) {
psb.append(" ").append(itemCount);
si(psb);
@@ -2263,18 +2414,16 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
itemCount++;
}
-
+
psb.append(" ").append(itemCount - 1);
flush(psb);
-
-
+
if (isSource) {
- return; // done
+ return; // done
}
-
- if (!isSource &&
- !container.haveDifferentCapitalizedNamesCollidingOnWindows &&
- javaCompiler != null) {
+
+ if (!isSource && !container.haveDifferentCapitalizedNamesCollidingOnWindows
+ && javaCompiler != null) {
boolean somethingCompiled = compileV3SourcesCommon2(container);
if (container.isPear || container.isJar) {
if (somethingCompiled) {
@@ -2283,9 +2432,9 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
return;
}
-
+
unableToCompile = true;
- return; // unable to do post processing or compiling
+ return; // unable to do post processing or compiling
} finally {
indent[0] -= 2;
}
@@ -2297,31 +2446,33 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
while (it.hasNext()) {
String candidate = it.next().toString();
// remove non JCas classes
-// //debug
-// System.out.println("debug, testing to remove: " + candidate);
-// if (candidate.indexOf("Corrected") >= 0) {
-// if (!container._Types.contains(candidate)) {
-// System.out.println("debug dumping _Types map keys to see why ... Corrected.class not there");
-// System.out.println("debug key is=" + candidate);
-// System.out.println("keys are:");
-// int i = 0;
-// for (String k : container._Types) {
-// if (i == 4) {
-// i = 0;
-// System.out.println("");
-// }
-// System.out.print(k + ", ");
-// }
-// } else {
-// System.out.println("debug container._Types did contain " + candidate);
-// }
-// }
+ // //debug
+ // System.out.println("debug, testing to remove: " + candidate);
+ // if (candidate.indexOf("Corrected") >= 0) {
+ // if (!container._Types.contains(candidate)) {
+ // System.out.println("debug dumping _Types map keys to see why ... Corrected.class not
+ // there");
+ // System.out.println("debug key is=" + candidate);
+ // System.out.println("keys are:");
+ // int i = 0;
+ // for (String k : container._Types) {
+ // if (i == 4) {
+ // i = 0;
+ // System.out.println("");
+ // }
+ // System.out.print(k + ", ");
+ // }
+ // } else {
+ // System.out.println("debug container._Types did contain " + candidate);
+ // }
+ // }
if (!container.isSingleJavaSource && !container._Types.contains(candidate)) {
- it.remove();
+ it.remove();
}
- }
+ }
}
-
+
+ // @formatter:off
/**
* Called from Stream walker starting at a root or starting at an imbedded Jar or Pear.
*
@@ -2346,24 +2497,26 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* - rootIds (which have the JCas candidates) and
* - subContainers for imbedded Pears and Jars
*/
+ // @formatter:on
private void getCandidates_processFile2(Path path, Container container) {
-
+
String pathString = path.toString();
final boolean isPear = pathString.endsWith(".pear"); // path.endsWith does not mean this !!
final boolean isJar = pathString.endsWith(".jar");
-
+
if (isPear || isJar) {
- Container subc = new Container(container, path);
+ Container subc = new Container(container, path);
getAndProcessCandidatesInContainer(subc);
return;
}
-
+
if (pathString.endsWith(isSource ? ".java" : ".class")) {
// Skip candidates except .java or .class
addToCandidates(path, container);
- }
+ }
}
-
+
+ // @formatter:off
/**
* if _Type kind, add artifactId to set kept in current rootIdContainer
* If currently scanning within a PEAR,
@@ -2379,70 +2532,74 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* @param path
* @param pearClassPath
*/
+ // @formatter:on
private void addToCandidates(Path path, Container container) {
String ps = path.toString();
-
+
if (ps.endsWith(isSource ? "_Type.java" : "_Type.class")) {
- container._Types.add(isSource
- ? (ps.substring(0, ps.length() - 10) + ".java")
- : (ps.substring(0, ps.length() - 11) + ".class"));
-// if (container.isJar) {
-// System.out.println("debug add container._Types " + Paths.get(ps.substring(0, ps.length() - 11)).toString() + ".class".toString() + " for Jar " + container.rootOrig.getFileName().toString());
-// }
+ container._Types.add(isSource ? (ps.substring(0, ps.length() - 10) + ".java")
+ : (ps.substring(0, ps.length() - 11) + ".class"));
+ // if (container.isJar) {
+ // System.out.println("debug add container._Types " + Paths.get(ps.substring(0, ps.length() -
+ // 11)).toString() + ".class".toString() + " for Jar " +
+ // container.rootOrig.getFileName().toString());
+ // }
return;
}
-
+
if (ps.contains("$")) {
return; // don't add these kinds of things, they're not JCas classes
}
-
- //debug
-// if (container.isJar) {
-// System.out.println("debug add candidate " + path.toString() + " for Jar " + container.rootOrig.getFileName().toString());
-// }
+
+ // debug
+ // if (container.isJar) {
+ // System.out.println("debug add candidate " + path.toString() + " for Jar " +
+ // container.rootOrig.getFileName().toString());
+ // }
container.candidates.add(path);
}
-
-
+
/**
- * For Jars inside other Jars, we copy the Jar to a temp spot in the default file system
- * Extracted Jar is marked delete-on-exit
+ * For Jars inside other Jars, we copy the Jar to a temp spot in the default file system Extracted
+ * Jar is marked delete-on-exit
*
- * @param path embedded Jar to copy (only the last name is used, in constructing the temp dir)
+ * @param path
+ * embedded Jar to copy (only the last name is used, in constructing the temp dir)
* @return a temporary file in the local temp directory that is a copy of the Jar
- * @throws IOException -
+ * @throws IOException
+ * -
*/
private static Path getTempOutputPathForJarOrPear(Path path) throws IOException {
Path localTempDir = getTempDir();
- if (path == null ) {
+ if (path == null) {
throw new IllegalArgumentException();
}
Path fn = path.getFileName();
if (fn == null) {
throw new IllegalArgumentException();
}
- Path tempPath = Files.createTempFile(localTempDir, fn.toString(), "");
+ Path tempPath = Files.createTempFile(localTempDir, fn.toString(), "");
tempPath.toFile().deleteOnExit();
return tempPath;
}
-
+
private static Path getTempDir() throws IOException {
if (tempDir == null) {
tempDir = Files.createTempDirectory("migrateJCas");
tempDir.toFile().deleteOnExit();
}
return tempDir;
- }
-
+ }
+
private static final CommandLineParser createCmdLineParser() {
CommandLineParser parser = new CommandLineParser();
parser.addParameter(SOURCE_FILE_ROOTS, true);
parser.addParameter(CLASS_FILE_ROOTS, true);
parser.addParameter(OUTPUT_DIRECTORY, true);
-// parser.addParameter(SKIP_TYPE_CHECK, false);
+ // parser.addParameter(SKIP_TYPE_CHECK, false);
parser.addParameter(MIGRATE_CLASSPATH, true);
-// parser.addParameter(CLASSES, true);
+ // parser.addParameter(CLASSES, true);
return parser;
}
@@ -2457,17 +2614,19 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
System.err.println();
return false;
}
-
+
if (!clp.isInArgsList(SOURCE_FILE_ROOTS) && !clp.isInArgsList(CLASS_FILE_ROOTS)) {
- System.err.println("Neither sources file roots nor classes file roots parameters specified; please specify just one.");
+ System.err.println(
+ "Neither sources file roots nor classes file roots parameters specified; please specify just one.");
return false;
}
-
+
if (clp.isInArgsList(SOURCE_FILE_ROOTS) && clp.isInArgsList(CLASS_FILE_ROOTS)) {
- System.err.println("both sources file roots and classes file roots parameters specified; please specify just one.");
+ System.err.println(
+ "both sources file roots and classes file roots parameters specified; please specify just one.");
return false;
}
-
+
if (clp.isInArgsList(OUTPUT_DIRECTORY)) {
outputDirectory = Paths.get(clp.getParamArgument(OUTPUT_DIRECTORY)).toString();
if (!outputDirectory.endsWith("/")) {
@@ -2485,33 +2644,34 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
outDirSkipped = outputDirectory + "not-converted/";
outDirLog = outputDirectory + "logs/";
-
if (clp.isInArgsList(MIGRATE_CLASSPATH)) {
migrateClasspath = clp.getParamArgument(MIGRATE_CLASSPATH);
} else {
if (clp.isInArgsList(CLASS_FILE_ROOTS)) {
System.err.println("WARNING: classes file roots is specified, but the\n"
- + " migrateClasspath parameter is missing\n");
+ + " migrateClasspath parameter is missing\n");
}
}
-
-// if (clp.isInArgsList(CLASSES)) {
-// individualClasses = clp.getParamArgument(CLASSES);
-// }
+
+ // if (clp.isInArgsList(CLASSES)) {
+ // individualClasses = clp.getParamArgument(CLASSES);
+ // }
return true;
}
-
+
// called to decompile a string of bytes.
- // - first get the class name (fully qualified)
- // and skip decompiling if already decompiled this class
- // for this pearClasspath
- // - this handles multiple class definitions, insuring
- // only one decompile happens per pearClasspath (including null)
+ // - first get the class name (fully qualified)
+ // and skip decompiling if already decompiled this class
+ // for this pearClasspath
+ // - this handles multiple class definitions, insuring
+ // only one decompile happens per pearClasspath (including null)
/**
* Caller does any caching to avoid this method.
*
- * @param b bytecode to decompile
- * @param pearClasspath to prepend to the classpath
+ * @param b
+ * bytecode to decompile
+ * @param pearClasspath
+ * to prepend to the classpath
* @return
*/
private String decompile(byte[] b, String pearClasspath) {
@@ -2519,112 +2679,116 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
String classNameWithSlashes = Misc.classNameFromByteCode(b);
packageAndClassNameSlash = classNameWithSlashes;
ClassLoader cl = getClassLoader(pearClasspath);
-
+
UimaDecompiler ud = new UimaDecompiler(cl, null);
if (classNameWithSlashes == null || classNameWithSlashes.length() < 2) {
- System.err.println("Failed to extract class name from binary code, "
- + "name found was \"" + ((classNameWithSlashes == null) ? "null" : classNameWithSlashes)
- + "\"\n byte array was:");
+ System.err.println("Failed to extract class name from binary code, " + "name found was \""
+ + ((classNameWithSlashes == null) ? "null" : classNameWithSlashes)
+ + "\"\n byte array was:");
System.err.println(Misc.dumpByteArray(b, 2000));
badClassName = true;
}
return ud.decompileToString(classNameWithSlashes, b);
}
-
+
/**
- * The classloader to use in decompiling, if it is provided, is one that delegates first
- * to the parent. This may need fixing for PEARs
+ * The classloader to use in decompiling, if it is provided, is one that delegates first to the
+ * parent. This may need fixing for PEARs
+ *
* @return classloader to use for migrate decompiling
*/
private ClassLoader getClassLoader(String pearClasspath) {
if (null == pearClasspath) {
if (null == cachedMigrateClassLoader) {
- cachedMigrateClassLoader = (null == migrateClasspath)
- ? this.getClass().getClassLoader()
- : new UIMAClassLoader(Misc.classpath2urls(migrateClasspath));
+ cachedMigrateClassLoader = (null == migrateClasspath) ? this.getClass().getClassLoader()
+ : new UIMAClassLoader(Misc.classpath2urls(migrateClasspath));
}
return cachedMigrateClassLoader;
} else {
try {
- return new UIMAClassLoader((null == migrateClasspath)
- ? pearClasspath
- : (pearClasspath + File.pathSeparator + migrateClasspath));
+ return new UIMAClassLoader((null == migrateClasspath) ? pearClasspath
+ : (pearClasspath + File.pathSeparator + migrateClasspath));
} catch (MalformedURLException e) {
throw new UIMARuntimeException(e);
}
}
}
-
+
private void addImport(String s) {
cu.getImports().add(new ImportDeclaration(new Name(s), false, false));
}
-
+
private void removeImport(String s) {
Iterator<ImportDeclaration> it = cu.getImports().iterator();
- while (it.hasNext()) {
+ while (it.hasNext()) {
ImportDeclaration impDcl = it.next();
if (impDcl.getNameAsString().equals(s)) {
it.remove();
break;
}
- }
+ }
}
/******************
* AST Utilities
******************/
-
+
private Node replaceInParent(Node n, Expression v) {
Optional<Node> maybeParent = n.getParentNode();
if (maybeParent.isPresent()) {
Node parent = n.getParentNode().get();
if (parent instanceof EnclosedExpr) {
- ((EnclosedExpr)parent).setInner(v);
+ ((EnclosedExpr) parent).setInner(v);
} else if (parent instanceof MethodCallExpr) { // args in the arg list
- List<Expression> args = ((MethodCallExpr)parent).getArguments();
+ List<Expression> args = ((MethodCallExpr) parent).getArguments();
args.set(args.indexOf(n), v);
v.setParentNode(parent);
- } else if (parent instanceof ExpressionStmt) {
- ((ExpressionStmt)parent).setExpression(v);
- } else if (parent instanceof CastExpr) {
- ((CastExpr)parent).setExpression(v);
- } else if (parent instanceof ReturnStmt) {
- ((ReturnStmt)parent).setExpression(v);
+ } else if (parent instanceof ExpressionStmt) {
+ ((ExpressionStmt) parent).setExpression(v);
+ } else if (parent instanceof CastExpr) {
+ ((CastExpr) parent).setExpression(v);
+ } else if (parent instanceof ReturnStmt) {
+ ((ReturnStmt) parent).setExpression(v);
} else if (parent instanceof AssignExpr) {
- ((AssignExpr)parent).setValue(v);
+ ((AssignExpr) parent).setValue(v);
} else if (parent instanceof VariableDeclarator) {
- ((VariableDeclarator)parent).setInitializer(v);
+ ((VariableDeclarator) parent).setInitializer(v);
} else if (parent instanceof ObjectCreationExpr) {
- List<Expression> args = ((ObjectCreationExpr)parent).getArguments();
+ List<Expression> args = ((ObjectCreationExpr) parent).getArguments();
int i = args.indexOf(n);
- if (i < 0) throw new RuntimeException();
- args.set(i, v);
+ if (i < 0)
+ throw new RuntimeException();
+ args.set(i, v);
} else {
System.out.println(parent.getClass().getName());
throw new RuntimeException();
}
return v;
}
- System.out.println("internal error replacing in parent: no parent for node: " + n.getClass().getName());
+ System.out.println(
+ "internal error replacing in parent: no parent for node: " + n.getClass().getName());
System.out.println(" node: " + n.toString());
System.out.println(" expression replacing: " + v.toString());
throw new RuntimeException();
}
-
+
/**
*
- * @param p the parameter to modify
- * @param t the name of class or interface
- * @param name the name of the variable
+ * @param p
+ * the parameter to modify
+ * @param t
+ * the name of class or interface
+ * @param name
+ * the name of the variable
*/
private void setParameter(List<Parameter> ps, int i, String t, String name) {
Parameter p = ps.get(i);
p.setType(new ClassOrInterfaceType(t));
p.setName(new SimpleName(name));
}
-
+
private int findConstructor(NodeList<BodyDeclaration<?>> classMembers) {
int i = 0;
for (BodyDeclaration<?> bd : classMembers) {
@@ -2635,26 +2799,26 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
return -1;
}
-
+
private boolean hasTypeFields(NodeList<BodyDeclaration<?>> members) {
boolean hasType = false;
boolean hasTypeId = false;
for (BodyDeclaration<?> bd : members) {
if (bd instanceof FieldDeclaration) {
- FieldDeclaration f = (FieldDeclaration)bd;
+ FieldDeclaration f = (FieldDeclaration) bd;
EnumSet<Modifier> m = f.getModifiers();
- if (m.contains(Modifier.PUBLIC) &&
- m.contains(Modifier.STATIC) &&
- m.contains(Modifier.FINAL)
-// &&
-// getTypeName(f.getType()).equals("int")
- ) {
+ if (m.contains(Modifier.PUBLIC) && m.contains(Modifier.STATIC) && m.contains(Modifier.FINAL)
+ // &&
+ // getTypeName(f.getType()).equals("int")
+ ) {
List<VariableDeclarator> vds = f.getVariables();
for (VariableDeclarator vd : vds) {
if (vd.getType().equals(intType)) {
String n = vd.getNameAsString();
- if (n.equals("type")) hasType = true;
- if (n.equals("typeIndexID")) hasTypeId = true;
+ if (n.equals("type"))
+ hasType = true;
+ if (n.equals("typeIndexID"))
+ hasTypeId = true;
if (hasTypeId && hasType) {
return true;
}
@@ -2665,7 +2829,8 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
} // end of for
return false;
}
-
+
+ // @formatter:off
/**
* Heuristic:
* JCas classes have 0, 1, and 2 arg constructors with particular arg types
@@ -2676,110 +2841,117 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
* Additional 1 and 2 arg constructors are permitted.
*
* Sets fields hasV2Constructors, hasV3Constructors
+ *
* @param members
*/
+ // @formatter:on
private void setHasJCasConstructors(NodeList<BodyDeclaration<?>> members) {
boolean has0ArgConstructor = false;
boolean has1ArgJCasConstructor = false;
boolean has2ArgJCasConstructorV2 = false;
boolean has2ArgJCasConstructorV3 = false;
-
+
for (BodyDeclaration<?> bd : members) {
if (bd instanceof ConstructorDeclaration) {
- List<Parameter> ps = ((ConstructorDeclaration)bd).getParameters();
- if (ps.size() == 0) has0ArgConstructor = true;
+ List<Parameter> ps = ((ConstructorDeclaration) bd).getParameters();
+ if (ps.size() == 0)
+ has0ArgConstructor = true;
if (ps.size() == 1 && getParmTypeName(ps, 0).equals("JCas")) {
has1ArgJCasConstructor = true;
}
if (ps.size() == 2) {
- if (getParmTypeName(ps, 0).equals("int") &&
- getParmTypeName(ps, 1).equals("TOP_Type")) {
+ if (getParmTypeName(ps, 0).equals("int") && getParmTypeName(ps, 1).equals("TOP_Type")) {
has2ArgJCasConstructorV2 = true;
- } else if (getParmTypeName(ps, 0).equals("TypeImpl") &&
- getParmTypeName(ps, 1).equals("CASImpl")) {
+ } else if (getParmTypeName(ps, 0).equals("TypeImpl")
+ && getParmTypeName(ps, 1).equals("CASImpl")) {
has2ArgJCasConstructorV3 = true;
}
} // end of 2 arg constructor
} // end of is-constructor
} // end of for loop
-
+
hasV2Constructors = has0ArgConstructor && has1ArgJCasConstructor && has2ArgJCasConstructorV2;
hasV3Constructors = has0ArgConstructor && has1ArgJCasConstructor && has2ArgJCasConstructorV3;
}
-
+
private String getParmTypeName(List<Parameter> p, int i) {
return getTypeName(p.get(i).getType());
}
-
+
private String getTypeName(Type t) {
-// if (t instanceof ReferenceType) {
-// t = ((ReferenceType<?>)t).getType();
-// }
-
+ // if (t instanceof ReferenceType) {
+ // t = ((ReferenceType<?>)t).getType();
+ // }
+
if (t instanceof PrimitiveType) {
- return ((PrimitiveType)t).toString();
+ return ((PrimitiveType) t).toString();
}
if (t instanceof ClassOrInterfaceType) {
- return ((ClassOrInterfaceType)t).getNameAsString();
+ return ((ClassOrInterfaceType) t).getNameAsString();
}
- Misc.internalError(); return null;
+ Misc.internalError();
+ return null;
}
-
+
/**
* Get the name of a field
- * @param e -
+ *
+ * @param e
+ * -
* @return the field name or null
*/
private String getName(Expression e) {
e = getUnenclosedExpr(e);
if (e instanceof NameExpr) {
- return ((NameExpr)e).getNameAsString();
+ return ((NameExpr) e).getNameAsString();
}
if (e instanceof FieldAccessExpr) {
- return ((FieldAccessExpr)e).getNameAsString();
+ return ((FieldAccessExpr) e).getNameAsString();
}
return null;
}
-
+
/**
- * Called on Annotation Decl, Class/intfc decl, empty type decl, enum decl
- * Does nothing unless at top level of compilation unit
+ * Called on Annotation Decl, Class/intfc decl, empty type decl, enum decl Does nothing unless at
+ * top level of compilation unit
*
* Otherwise, adds an entry to c2ps for the classname and package, plus full path
*
- * @param n type being declared
+ * @param n
+ * type being declared
*/
private void updateClassName(TypeDeclaration<?> n) {
Optional<Node> pnode = n.getParentNode();
Node node;
- if (pnode.isPresent() &&
- (node = pnode.get()) instanceof CompilationUnit) {
+ if (pnode.isPresent() && (node = pnode.get()) instanceof CompilationUnit) {
CompilationUnit cu2 = (CompilationUnit) node;
className = cu2.getType(0).getNameAsString();
- String packageAndClassName =
- (className.contains("."))
- ? className
- : packageName + '.' + className;
+ String packageAndClassName = (className.contains(".")) ? className
+ : packageName + '.' + className;
packageAndClassNameSlash = packageAndClassName.replace('.', '/');
-// assert current_cc.fqcn_slash == null; // for decompiling, already set
- assert (current_cc.fqcn_slash != null) ? current_cc.fqcn_slash.equals(packageAndClassNameSlash) : true;
+ // assert current_cc.fqcn_slash == null; // for decompiling, already set
+ assert (current_cc.fqcn_slash != null)
+ ? current_cc.fqcn_slash.equals(packageAndClassNameSlash)
+ : true;
current_cc.fqcn_slash = packageAndClassNameSlash;
-
- TypeImpl ti = TypeSystemImpl.staticTsi.getType(Misc.javaClassName2UimaTypeName(packageAndClassName));
+
+ TypeImpl ti = TypeSystemImpl.staticTsi
+ .getType(Misc.javaClassName2UimaTypeName(packageAndClassName));
if (null != ti) {
// is a built-in type
-// ContainerAndPath p = new ContainerAndPath(
-// current_path,
-// current_container,packageAndClassNameSlash,
-// current_cc.,
-// current_cc.pearClasspath);
- skippedBuiltins.add(new PathContainerAndReason(current_path, current_container, "built-in"));
+ // ContainerAndPath p = new ContainerAndPath(
+ // current_path,
+ // current_container,packageAndClassNameSlash,
+ // current_cc.,
+ // current_cc.pearClasspath);
+ skippedBuiltins
+ .add(new PathContainerAndReason(current_path, current_container, "built-in"));
isBuiltinJCas = true;
isConvert2v3 = false;
- return;
+ return;
} else {
- VariableDeclarator vd_typename = new VariableDeclarator(
- stringType, "_TypeName", new StringLiteralExpr(packageAndClassName));
+ VariableDeclarator vd_typename = new VariableDeclarator(stringType, "_TypeName",
+ new StringLiteralExpr(packageAndClassName));
fi_fields.add(new FieldDeclaration(public_static_final, vd_typename));
}
@@ -2791,21 +2963,23 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
private Expression getExpressionFromStmt(Statement stmt) {
stmt = getStmtFromStmt(stmt);
if (stmt instanceof ExpressionStmt) {
- return getUnenclosedExpr(((ExpressionStmt)stmt).getExpression());
+ return getUnenclosedExpr(((ExpressionStmt) stmt).getExpression());
}
return null;
}
-
+
private Expression getUnenclosedExpr(Expression e) {
while (e instanceof EnclosedExpr) {
- e = ((EnclosedExpr)e).getInner().get();
+ e = ((EnclosedExpr) e).getInner().get();
}
return e;
}
-
+
/**
* Unwrap (possibly nested) 1 statement blocks
- * @param stmt -
+ *
+ * @param stmt
+ * -
* @return unwrapped (non- block) statement
*/
private Statement getStmtFromStmt(Statement stmt) {
@@ -2819,18 +2993,18 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
return stmt;
}
-
+
private void addCastExpr(Statement stmt, Type castType) {
ReturnStmt rstmt = (ReturnStmt) stmt;
- Optional<Expression> o_expr = rstmt.getExpression();
+ Optional<Expression> o_expr = rstmt.getExpression();
Expression expr = o_expr.isPresent() ? o_expr.get() : null;
CastExpr ce = new CastExpr(castType, expr);
- rstmt.setExpression(ce); // removes the parent link from expr
+ rstmt.setExpression(ce); // removes the parent link from expr
if (expr != null) {
expr.setParentNode(ce); // restore it
}
}
-
+
/********************
* Recording results
********************/
@@ -2838,73 +3012,79 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
private void recordBadConstructor(String msg) {
reportMigrateFailed("Constructor is incorrect, " + msg);
}
-
-// private void reportParseException() {
-// reportMigrateFailed("Unparsable Java");
-// }
-
+
+ // private void reportParseException() {
+ // reportMigrateFailed("Unparsable Java");
+ // }
+
private void migrationFailed(String reason) {
failedMigration.add(new PathContainerAndReason(current_path, current_container, reason));
- isConvert2v3 = false;
+ isConvert2v3 = false;
}
-
+
private void reportMigrateFailed(String m) {
System.out.format("Skipping this file due to error: %s, path: %s%n", m, current_path);
migrationFailed(m);
}
-
+
private void reportV2Class() {
-// v2JCasFiles.add(current_path);
+ // v2JCasFiles.add(current_path);
isV2JCas = true;
}
-
+
private void reportV3Class() {
-// v3JCasFiles.add(current_path);
+ // v3JCasFiles.add(current_path);
isConvert2v3 = true;
}
-
+
private void reportNotJCasClass(String reason) {
nonJCasFiles.add(new PathContainerAndReason(current_path, current_container, reason));
isConvert2v3 = false;
}
-
+
private void reportNotJCasClassMissingTypeFields() {
reportNotJCasClass("missing required type and/or typeIndexID static fields");
}
-
+
private void reportDeletedCheckModified(String m) {
deletedCheckModified.add(new PathContainerAndReason(current_path, current_container, m));
}
-
+
private void reportMismatchedFeatureName(String m) {
- manualInspection.add(new PathContainerAndReason(current_path, current_container,
- "This getter/setter name doesn't match internal feature name: " + m));
+ manualInspection.add(new PathContainerAndReason(current_path, current_container,
+ "This getter/setter name doesn't match internal feature name: " + m));
}
-
+
private void reportUnrecognizedV2Code(String m) {
migrationFailed("V2 code not recognized:\n" + m);
}
-
+
private void reportPathWorkaround(String orig, String modified) {
pathWorkaround.add(new String1AndString2(orig, modified));
}
-
- private void reportPearOrJarClassReplace(String pearOrJar, String classname, Container kind) { // pears or jars
+
+ private void reportPearOrJarClassReplace(String pearOrJar, String classname, Container kind) { // pears
+ // or
+ // jars
if (kind.isPear) {
pearClassReplace.add(new String1AndString2(pearOrJar, classname));
} else {
jarClassReplace.add(new String1AndString2(pearOrJar, classname));
}
- }
-
+ }
+
/***********************************************/
/**
- * Output directory for source and migrated files
- * Consisting of converted/skipped, v2/v3, a+cc.id, slashified classname
- * @param cc -
- * @param isV2 -
- * @param wasConverted -
- * @return converted/skipped, v2/v3, a+cc.id, slashified classname
+ * Output directory for source and migrated files Consisting of converted/skipped, v2/v3, a+cc.id,
+ * slashified classname
+ *
+ * @param cc
+ * -
+ * @param isV2
+ * -
+ * @param wasConverted
+ * -
+ * @return converted/skipped, v2/v3, a+cc.id, slashified classname
*/
private String getBaseOutputPath(CommonConverted cc, boolean isV2, boolean wasConverted) {
StringBuilder sb = new StringBuilder();
@@ -2913,85 +3093,106 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
sb.append("a").append(cc.getId()).append('/');
sb.append(cc.fqcn_slash).append(".java");
return sb.toString();
- }
-
+ }
+
private void writeV2Orig(CommonConverted cc, boolean wasConverted) throws IOException {
- String base = getBaseOutputPath(cc, true, wasConverted); // adds numeric suffix if dupls
+ String base = getBaseOutputPath(cc, true, wasConverted); // adds numeric suffix if dupls
FileUtils.writeToFile(makePath(base), cc.v2Source);
}
-
+
private void writeV3(CommonConverted cc) throws IOException {
- String base = getBaseOutputPath(cc, false, true);
+ String base = getBaseOutputPath(cc, false, true);
cc.v3SourcePath = makePath(base);
String data = fixImplementsBug(cc.v3Source);
FileUtils.writeToFile(cc.v3SourcePath, data);
}
-
+
private void printUsage() {
- System.out.println(
- "Usage: java org.apache.uima.migratev3.jcas.MigrateJCas \n"
- + " [-sourcesRoots <One-or-more-directories-or-jars-separated-by-Path-separator, or a path to a single JCas source class>]\n"
- + " [-classesRoots <One-or-more-directories-or-jars-or-pears-separated-by-Path-separator>]\n"
- + " [-outputDirectory a-writable-directory-path (optional)\n"
- + " if omitted, a temporary directory is used\n"
- + " if not omitted, the directory contents WILL BE ERASED at the start.\n"
- + " [-migrateClasspath a-class-path to use in decompiling, when -classesRoots is specified\n"
- + " also used when compiling the migrated classes.\n"
- + " NOTE: either -sourcesRoots or -classesRoots is required, but only one may be specified.\n"
- + " NOTE: classesRoots are scanned for JCas classes, which are then decompiled, and the results processed like sourcesRoots\n"
- );
+ System.out.println("Usage: java org.apache.uima.migratev3.jcas.MigrateJCas \n"
+ + " [-sourcesRoots <One-or-more-directories-or-jars-separated-by-Path-separator, or a path to a single JCas source class>]\n"
+ + " [-classesRoots <One-or-more-directories-or-jars-or-pears-separated-by-Path-separator>]\n"
+ + " [-outputDirectory a-writable-directory-path (optional)\n"
+ + " if omitted, a temporary directory is used\n"
+ + " if not omitted, the directory contents WILL BE ERASED at the start.\n"
+ + " [-migrateClasspath a-class-path to use in decompiling, when -classesRoots is specified\n"
+ + " also used when compiling the migrated classes.\n"
+ + " NOTE: either -sourcesRoots or -classesRoots is required, but only one may be specified.\n"
+ + " NOTE: classesRoots are scanned for JCas classes, which are then decompiled, and the results processed like sourcesRoots\n");
}
private static final Pattern implementsEmpty = Pattern.compile("implements \\{");
+
private String fixImplementsBug(String data) {
return implementsEmpty.matcher(data).replaceAll("{");
}
-
+
/*********************************************************************
* Reporting classes
*********************************************************************/
-
+
private static abstract class Report2<T, U> {
- public abstract Comparable<T> getFirst(); // Eclipse on linux complained if not public, was OK on windows
- public abstract Comparable<U> getSecond();
+ public abstract Comparable<T> getFirst(); // Eclipse on linux complained if not public, was OK
+ // on windows
+
+ public abstract Comparable<U> getSecond();
+
abstract int getFirstLength();
}
-
+
private static class PathContainerAndReason extends Report2<ContainerAndPath, String> {
final ContainerAndPath cap;
final String reason;
+
PathContainerAndReason(ContainerAndPath cap, String reason) {
this.cap = cap;
this.reason = reason;
}
-
+
PathContainerAndReason(Path path, Container container, String reason) {
this(new ContainerAndPath(path, container), reason);
}
-
+
@Override
- public Comparable<ContainerAndPath> getFirst() { return cap; }
+ public Comparable<ContainerAndPath> getFirst() {
+ return cap;
+ }
+
@Override
- public Comparable<String> getSecond() { return reason; }
+ public Comparable<String> getSecond() {
+ return reason;
+ }
+
@Override
- int getFirstLength() { return cap.toString().length(); }
+ int getFirstLength() {
+ return cap.toString().length();
+ }
}
-
+
private static class String1AndString2 extends Report2<String, String> {
String s1;
String s2;
+
String1AndString2(String s1, String s2) {
this.s1 = s1;
this.s2 = s2;
}
+
@Override
- public Comparable<String> getFirst() { return s1; }
+ public Comparable<String> getFirst() {
+ return s1;
+ }
+
@Override
- public Comparable<String> getSecond() { return s2; }
+ public Comparable<String> getSecond() {
+ return s2;
+ }
+
@Override
- int getFirstLength() { return s1.toString().length(); }
+ int getFirstLength() {
+ return s1.toString().length();
+ }
}
-
+
private static void withIOX(Runnable_withException r) {
try {
r.run();
@@ -2999,11 +3200,11 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
throw new UIMARuntimeException(e);
}
}
-
+
private int findFirstCharDifferent(String s1, String s2) {
int s1l = s1.length();
int s2l = s2.length();
- for (int i = 0;;i++) {
+ for (int i = 0;; i++) {
if (i == s1l || i == s2l) {
return i;
}
@@ -3012,549 +3213,560 @@ public class MigrateJCas extends VoidVisitorAdapter<Object> {
}
}
}
-// private String drop_Type(String s) {
-// return s.substring(0, isSource ? "_Type.java".length()
-// : "_Type.class".length()) +
-// (isSource ? ".java" : ".class");
-// }
-
-///*****************
-//* Root-id
-//*****************/
-//private static int nextRootId = 1;
-//
-///***********************************************************************
-//* Root-id - this is the path part up to the start of the package name.
-//* - it is relative to container
-//* - has the collection of artifacts that might be candidates, having this rootId
-//* - has the collection of _Type things having this rootId
-//* - "null" path is OK - means package name starts immediately
-//* There is no Root-id for path ending in Jar or PEAR - these created containers instead
-//***********************************************************************/
-//private static class RootId {
-// final int id = nextRootId++;
-// /**
-// * The path relative to the the container (if any) (= Jar or Pear)
-// * - for Pears, the path is as if it was not installed, but within the PEAR file
-// */
-// final Path path;
-//
-// /** The container holding this RootId */
-// final Container container;
-// /**
-// * For this rootId, all of the fully qualified classnames that are migration eligible.
-// * - not all might be migrated, if upon further inspection they are not JCas class files.
-// */
-// final Set<Fqcn> fqcns = new HashSet<>();
-// final Set<String> fqcns_ignore_case = new HashSet<>();
-// boolean haveDifferentCapitalizedNamesCollidingOnWindows = false;
-//
-// RootId(Path path, Container container) {
-// this.path = path;
-// this.container = container;
-// }
-//
-// /* (non-Javadoc)
-// * @see java.lang.Object#toString()
-// */
-// @Override
-// public String toString() {
-// return "RootId [id="
-// + id
-// + ", path="
-// + path
-// + ", container="
-// + container.id
-// + ", fqcns="
-// + Misc.ppList(Misc.setAsList(fqcns))
-// + ", fqcns_Type="
-// + Misc.ppList(Misc.setAsList(fqcns_Type))
-// + "]";
-// }
-//
-// void add(Fqcn fqcn) {
-// boolean wasNotPresent = fqcns.add(fqcn);
-// boolean lc = fqcns_ignore_case.add(fqcn.fqcn_dots.toLowerCase());
-// if (!lc && wasNotPresent) {
-// haveDifferentCapitalizedNamesCollidingOnWindows = true;
-// }
-// }
-//
-// boolean hasMatching_Type(Fqcn fqcn) {
-//
-// }
-//}
-///**
-//* Called from Stream walker starting at a root or starting at an imbedded Jar or Pear.
-//*
-//* adds all the .java or .class files to the candidates, including _Type if not skipping the _Type check
-//* Handling embedded jar files
-//* - single level Jar (at the top level of the default file system)
-//* -- handle using an overlayed file system
-//* - embedded Jars within Jars:
-//* - not supported by Zip File System Provider (it only supports one level)
-//* - handle by extracting to a temp dir, and then using the Zip File System Provider
-//* @param path the path to a .java or .class or .jar or .pear
-//* @param pearClasspath - a string representing a path to the pear's classpath if there is one, or null
-//*/
-//private void getCandidates_processFile(Path path, String pearClasspath) {
-//// if (path.toString().contains("commons-httpclient-3.1.jar"))
-//// System.out.println("Debug: " + path.toString());
-//// System.out.println("debug processing " + path);
-// try {
-//// URI pathUri = path.toUri();
-// String pathString = path.toString();
-// final boolean isPear = pathString.endsWith(".pear"); // path.endsWith does not mean this !!
-// final boolean isJar = pathString.endsWith(".jar");
-//
-// if (isJar || isPear) {
-// if (!path.getFileSystem().equals(FileSystems.getDefault())) {
-// // embedded Pear or Jar: extract to temp
-// Path out = getTempOutputPathForJar(path);
-// Files.copy(path, out, StandardCopyOption.REPLACE_EXISTING);
-//// embeddedJars.add(new PathAndPath(path, out));
-// path = out; // path points to pear or jar
-// }
-//
-// Path start;
-// final String localPearClasspath;
-// if (isPear) {
-// if (pearClasspath != null) {
-// throw new UIMARuntimeException("Nested PEAR files not supported");
-// }
-//
-//// pear_current = new PearOrJar(path);
-//// pears.add(pear_current);
-// // add pear classpath info
-// File pearInstallDir = Files.createTempDirectory(getTempDir(), "installedPear").toFile();
-// PackageBrowser ip = PackageInstaller.installPackage(pearInstallDir, path.toFile(), false);
-// localPearClasspath = ip.buildComponentClassPath();
-// String[] children = pearInstallDir.list();
-// if (children == null || children.length != 1) {
-// Misc.internalError();
-// }
-// pearResolveStart = Paths.get(pearInstallDir.getAbsolutePath(), children[0]);
-//
-// start = pearInstallDir.toPath();
-// } else {
-// if (isJar) {
-// PearOrJar jarInfo = new PearOrJar(path);
-// pear_or_jar_current_stack.push(jarInfo);
-// jars.add(jarInfo);
-// }
-//
-// localPearClasspath = pearClasspath;
-// FileSystem jfs = FileSystems.newFileSystem(Paths.get(path.toUri()), null);
-// start = jfs.getPath("/");
-// }
-//
-// try (Stream<Path> stream = Files.walk(start)) { // needed to release file handles
-// stream.forEachOrdered(
-// p -> getCandidates_processFile(p, localPearClasspath));
-// }
-// if (isJar) {
-// pear_or_jar_current_stack.pop();
-// }
-// if (isPear) {
-// pear_current = null;
-// }
-// } else {
-// // is not a .jar or .pear file. add .java or .class files to initial candidate set
-// // will be filtered additionally later
-//// System.out.println("debug path ends with java or class " + pathString.endsWith(isSource ? ".java" : ".class") + " " + pathString);
-// if (pathString.endsWith(isSource ? ".java" : ".class")) {
-// candidates.add(new Candidate(path, pearClasspath));
-// if (!isSource && null != pear_current) {
-// // inside a pear, which has been unzipped into pearInstallDir;
-// path2InsidePearOrJarPath.put(path.toString(), pearResolveStart.relativize(path).toString());
-// pear_current.pathsToCandidateFiles.add(path.toString());
-// }
-//
-// if (!isSource && pear_or_jar_current_stack.size() > 0) {
-// // inside a jar, not contained in a pear
-// pear_or_jar_current_stack.getFirst().pathsToCandidateFiles.add(path.toString());
-// }
-// }
-// }
-// } catch (IOException e) {
-// throw new RuntimeException(e);
-// }
-//}
-//private void postProcessPearsOrJars(String kind, List<PearOrJar> pearsOrJars, List<String1AndString2> classReplace) { // pears or jars
-//try {
-// Path outDir = Paths.get(outputDirectory, kind);
-// FileUtils.deleteRecursive(outDir.toFile());
-// Files.createDirectories(outDir);
-//} catch (IOException e) {
-// throw new RuntimeException(e);
-//}
-//
-//// pearsOrJars may have entries with 0 candidate paths. This happens when we scan them
-//// but find nothing to convert.
-//// eliminate these.
-//
-//Iterator<PearOrJar> it = pearsOrJars.iterator();
-//while (it.hasNext()) {
-// PearOrJar poj = it.next();
-// if (poj.pathsToCandidateFiles.size() == 0) {
-// it.remove();
-// } else {
-//// //debug
-//// if (poj.pathToPearOrJar.toString().contains("commons-httpclient-3.1")) {
-//// System.err.println("debug found converted things inside commons-httpclient");;
-//// for (String x : poj.pathsToCandidateFiles) {
-//// System.err.println(x);
-//// }
-//// System.err.println("");
-//// }
-// }
-//}
-//
-//it = pearsOrJars.iterator();
-//while (it.hasNext()) {
-// PearOrJar poj = it.next();
-// if (poj.pathsToCandidateFiles.size() == 0) {
-// System.err.print("debug failed to remove unconverted Jar");
-// }
-//}
-//
-//if (pearsOrJars.size() == 0) {
-// System.out.format("No .class files were replaced in %s.%n", kind);
-//} else {
-// System.out.format("replacing .class files in %,d %s%n", pearsOrJars.size(), kind);
-// for (PearOrJar p : pearsOrJars) {
-// pearOrJarPostProcessing(p, kind);
-// }
-// try {
-// reportPaths("Reports of updated " + kind, kind + "FileUpdates.txt", classReplace);
-//
-// } catch (IOException e) {
-// throw new RuntimeException(e);
-// }
-//}
-//
-//}
-///**
-//* When running the compiler to compile v3 sources, we need a classpath that at a minimum
-//* includes uimaj-core. The strategy is to use the invoker of this tool's classpath as
-//* specified from the application class loader
-//* @return true if no errors
-//*/
-//private boolean compileV3SourcesCommon(List<ClassnameAndPath> items, String msg, String pearClasspath) {
-//
-// if (items.size() == 0) {
-// return true;
-// }
-// System.out.format("Compiling %,d classes %s -- This may take a while!%n", c2ps.size(), msg);
-// StandardJavaFileManager fileManager = javaCompiler.getStandardFileManager(null, null, Charset.forName("UTF-8"));
-//
-// List<String> cus = items.stream()
-// .map(c -> outDirConverted + "v3/" + c.classname + ".java")
-// .collect(Collectors.toList());
-//
-// Iterable<String> compilationUnitStrings = cus;
-//
-// Iterable<? extends JavaFileObject> compilationUnits =
-// fileManager.getJavaFileObjectsFromStrings(compilationUnitStrings);
-//
-// // specify where the output classes go
-// String classesBaseDir = outDirConverted + "v3-classes";
-// try {
-// Files.createDirectories(Paths.get(classesBaseDir));
-// } catch (IOException e) {
-// throw new UIMARuntimeException(e);
-// }
-// // specify the classpath
-// String classpath = getCompileClassPath(pearClasspath);
-// Iterable<String> options = Arrays.asList("-d", classesBaseDir,
-// "-classpath", classpath);
-// return javaCompiler.getTask(null, fileManager, null, options, null, compilationUnits).call();
-//}
-///**
-//* Called after class is migrated
-//* Given a path to a class (source or class file),
-//* return the URL to the class as found in the classpath.
-//* This returns the "first" one found in the classpath, in the case of duplicates.
-//* @param path
-//* @return the location of the class in the class path
-//*/
-//private URL getPathForClass(Path path) {
-// return (null == packageAndClassNameSlash)
-// ? null
-// : migrateClassLoader.getResource(packageAndClassNameSlash + ".class");
-//}
-//private void getBaseOutputPath() {
-//String s = packageAndClassNameSlash;
-//int i = 0;
-//while (!usedPackageAndClassNames.add(s)) {
-// i = i + 1;
-// s = packageAndClassNameSlash + "_dupid_" + i;
-//}
-//packageAndClassNameSlash_i = i;
-//}
-//private String prepareIndividual(String classname) {
-//candidate = new Candidate(Paths.get(classname)); // a pseudo path
-//packageName = null;
-//className = null;
-//packageAndClassNameSlash = null;
-//cu = null;
-//return decompile(classname); // always look up in classpath
-// // to decompile individual source - put in sourcesRoots
-//}
-//if (!isSource) { // skip this recording if source
-//if (null != pear_current) {
-// // inside a pear, which has been unzipped into a temporary pearInstallDir;
-// // we don't want that temporary dir to be part of the path.
-// path2InsidePearOrJarPath.put(path.toString(), pearResolveStart.relativize(path).toString());
-// pear_current.pathsToCandidateFiles.add(path.toString());
-//}
-//
-//if (!isSource && pear_or_jar_current_stack.size() > 0) {
-// // inside a jar, not contained in a pear
-// pear_or_jar_current_stack.getFirst().pathsToCandidateFiles.add(path.toString());
-//}
-//}
-//}
-///**
-//* For a given candidate, use its path:
-//* switch the ...java to ..._Type.java, or ...class to ..._Type.class
-//* look thru all the candidates
-//* @param cand
-//* @param start
-//* @return
-//*/
-//private boolean has_Type(Candidate cand, int start) {
-// if (start >= candidates.size()) {
-// return false;
-// }
-//
-// String sc = cand.p.toString();
-// String sc_minus_suffix = sc.substring(0, sc.length() - ( isSource ? ".java".length() : ".class".length()));
-// String sc_Type = sc_minus_suffix + ( isSource ? "_Type.java" : "_Type.class");
-// // a string which sorts beyond the candidate + a suffix of "_"
-// String s_end = sc_minus_suffix + (char) (((int)'_') + 1);
-// for (Candidate c : candidates.subList(start, candidates.size())) {
-// String s = c.p.toString();
-// if (s_end.compareTo(s) < 0) {
-// return false; // not found, we're already beyond where it would be found
-// }
-// if (s.equals(sc_Type)) {
-// return true;
-// }
-// }
-// return false;
-//}
-//private final static Comparator<Candidate> pathComparator = new Comparator<Candidate>() {
-//@Override
-//public int compare(Candidate o1, Candidate o2) {
-// return o1.p.toString().compareTo(o2.p.toString());
-//}
-//};
-
-//// there may be several same-name roots not quite right
-//// xxx_Type$1.class
-//
-//private void addIfPreviousIsSameName(List<Path> c, int i) {
-//if (i == 0) return;
-//String _Type = candidates.get(i).toString();
-////String prev = r.get(i-1).getPath();
-//String prefix = _Type.substring(0, _Type.length() - ("_Type." + (isSource ? "java" : "class")).length());
-//i--;
-//while (i >= 0) {
-// String s = candidates.get(i).toString();
-// if ( ! s.startsWith(prefix)) {
-// break;
-// }
-// if (s.substring(prefix.length()).equals((isSource ? ".java" : ".class"))) {
-// c.add(candidates.get(i));
-// break;
-// }
-// i--;
-//}
-//}
-
-
-//
-//for (int i = 0; i < pearOrJar.pathsToCandidateFiles.size(); i++) {
-// String candidatePath = pearOrJar.pathsToCandidateFiles.get(i);
-// String path_in_v3_classes = isPear
-// ? getPath_in_v3_classes(candidatePath)
-// : candidatePath;
-//
-// Path src = Paths.get(outputDirectory, "converted/v3-classes", path_in_v3_classes
-// + (isPear ? ".class" : ""));
-// Path tgt = pfs.getPath(
-// "/",
-// isPear
-// ? path2InsidePearOrJarPath.get(candidatePath) // needs to be bin/org/... etc
-// : candidatePath); // needs to be org/... etc
-// if (Files.exists(src)) {
-// Files.copy(src, tgt, StandardCopyOption.REPLACE_EXISTING);
-// reportPearOrJarClassReplace(pearOrJarCopy.toString(), path_in_v3_classes, kind);
-// }
-//}
-
-///** for compiled mode, do recompiling and reassembly of Jars and Pears */
-//
-//private boolean compileAndReassemble(CommonConverted cc, Container container, Path path) {
-// boolean noErrors = true;
-// if (javaCompiler != null) {
-// if (container.haveDifferentCapitalizedNamesCollidingOnWindows) {
-// System.out.println("Skipping compiling / reassembly because class " + container.toString() + " has multiple names differing only in capitalization, please resolve first.");
-// } else {
-//
-//
-// noErrors = compileV3PearSources(container, path);
-// noErrors = noErrors && compileV3NonPearSources(container, path);
-//
-// postProcessPearsOrJars("jars" , jars , jarClassReplace);
-// postProcessPearsOrJars("pears", pears, pearClassReplace);
-//
-////
-//// try {
-//// Path pearOutDir = Paths.get(outputDirectory, "pears");
-//// FileUtils.deleteRecursive(pearOutDir.toFile());
-//// Files.createDirectories(pearOutDir);
-//// } catch (IOException e) {
-//// throw new RuntimeException(e);
-//// }
-////
-//// System.out.format("replacing .class files in %,d PEARs%n", pears.size());
-//// for (PearOrJar p : pears) {
-//// pearOrJarPostProcessing(p);
-//// }
-//// try {
-//// reportPaths("Reports of updated Pears", "pearFileUpdates.txt", pearClassReplace);
-//// } catch (IOException e) {
-//// throw new RuntimeException(e);
-//// }
-// }
-// }
-//
-// return noErrors;
-//}
-
-///**
-//* @return true if no errors
-//*/
-//private boolean compileV3PearSources() {
-// boolean noError = true;
-// Map<String, List<ClassnameAndPath>> p2c = c2ps.stream()
-// .filter(c -> c.pearClasspath != null)
-// .collect(Collectors.groupingBy(c -> c.pearClasspath));
-//
-// List<Entry<String, List<ClassnameAndPath>>> ea = p2c.entrySet().stream()
-// .sorted(Comparator.comparing(Entry::getKey)) //(e1, e2) -> e1.getKey().compareTo(e2.getKey())
-// .collect(Collectors.toList());
-//
-// for (Entry<String, List<ClassnameAndPath>> e : ea) {
-// noError = noError && compileV3SourcesCommon(e.getValue(), "for Pear " + e.getKey(), e.getKey() );
-// }
-// return noError;
-//}
-//
-///**
-//* @return true if no errors
-//*/
-//private boolean compileV3NonPearSources() {
-//
-// List<ClassnameAndPath> cnps = c2ps.stream()
-// .filter(c -> c.pearClasspath == null)
-// .collect(Collectors.toList());
-//
-// return compileV3SourcesCommon(cnps, "(non PEAR)", null);
-//}
-
-///**
-//* @param pathInPear a complete path to a class inside an (installed) pear
-//* @return the part starting after the top node of the install dir
-//*/
-//private String getPath_in_v3_classes(String pathInPear) {
-// return path2classname.get(pathInPear);
-//}
-
-//private boolean reportDuplicates() throws IOException {
-//List<List<CommonConverted>> nonIdenticals = new ArrayList<>();
-//List<CommonConverted> onlyIdenticals = new ArrayList<>();
-//
-//classname2multiSources.forEach(
-// (classname, ccs) -> {
-// if (ccs.size() > 1) {
-// nonIdenticals.add(ccs);
-// } else {
-// CommonConverted cc = ccs.get(0);
-// if (cc.containersAndV2Paths.size() > 1)
-// onlyIdenticals.add(cc); // the same item in multiple containers and/or paths
-// }
-// }
-// );
-//
-//if (nonIdenticals.size() == 0) {
-// if (onlyIdenticals.size() == 0) {
-// System.out.println("There were no duplicates found.");
-// } else {
-// // report identical duplicates
-// try (BufferedWriter bw = Files.newBufferedWriter(makePath(outDirLog + "identical_duplicates.txt"), StandardOpenOption.CREATE)) {
-// logPrintNl("Report of Identical duplicates:", bw);
-// for (CommonConverted cc : onlyIdenticals) {
-// int i = 0;
-// logPrintNl("Class: " + cc.fqcn_slash, bw);
-// for (ContainerAndPath cp : cc.containersAndV2Paths) {
-// logPrintNl(" " + (++i) + " " + cp, bw);
-// }
-// logPrintNl("", bw);
-// }
-// }
-// }
-// return true;
-//}
-//
-//// non-identicals, print out all of them
-//try (BufferedWriter bw = Files.newBufferedWriter(makePath(outDirLog + "nonIdentical_duplicates.txt"), StandardOpenOption.CREATE)) {
-// logPrintNl("Report of non-identical duplicates", bw);
-// for (List<CommonConverted> nonIdentical : nonIdenticals) {
-// String fqcn = nonIdentical.get(0).fqcn_slash;
-// logPrintNl(" classname: " + fqcn, bw);
-// int i = 1;
-// // for each cc, and within each cc, for each containerAndPath
-// for (CommonConverted cc : nonIdentical) {
-//// logPrintNl(" version " + i, bw);
-// assert fqcn.equals(cc.fqcn_slash);
-// int j = 1;
-// boolean isSame = cc.containersAndV2Paths.size() > 1;
-// boolean isFirstTime = true;
-// for (ContainerAndPath cp : cc.containersAndV2Paths) {
-// String first = isSame && isFirstTime
-// ? " same: "
-// : isSame
-// ? " "
-// : " ";
-// isFirstTime = false;
-// logPrintNl(first + i + "." + (j++) + " " + cp, bw);
-// }
-// indent[0] -= 6;
-//// logPrintNl("", bw);
-// i++;
-// }
-//// logPrintNl("", bw);
-// }
-//}
-//return false;
-//}
-
-//private static class PathAndReason extends Report2<Path, String> {
-//Path path;
-//String reason;
-//PathAndReason(Path path, String reason) {
-// this.path = path;
-// this.reason = reason;
-//}
-//@Override
-//public Comparable<Path> getFirst() { return path; }
-//@Override
-//public Comparable<String> getSecond() { return reason; }
-//@Override
-//int getFirstLength() { return path.toString().length(); }
-//}
+ // private String drop_Type(String s) {
+ // return s.substring(0, isSource ? "_Type.java".length()
+ // : "_Type.class".length()) +
+ // (isSource ? ".java" : ".class");
+ // }
+
+ /// *****************
+ // * Root-id
+ // *****************/
+ // private static int nextRootId = 1;
+ //
+ /// ***********************************************************************
+ // * Root-id - this is the path part up to the start of the package name.
+ // * - it is relative to container
+ // * - has the collection of artifacts that might be candidates, having this rootId
+ // * - has the collection of _Type things having this rootId
+ // * - "null" path is OK - means package name starts immediately
+ // * There is no Root-id for path ending in Jar or PEAR - these created containers instead
+ // ***********************************************************************/
+ // private static class RootId {
+ // final int id = nextRootId++;
+ // /**
+ // * The path relative to the the container (if any) (= Jar or Pear)
+ // * - for Pears, the path is as if it was not installed, but within the PEAR file
+ // */
+ // final Path path;
+ //
+ // /** The container holding this RootId */
+ // final Container container;
+ // /**
+ // * For this rootId, all of the fully qualified classnames that are migration eligible.
+ // * - not all might be migrated, if upon further inspection they are not JCas class files.
+ // */
+ // final Set<Fqcn> fqcns = new HashSet<>();
+ // final Set<String> fqcns_ignore_case = new HashSet<>();
+ // boolean haveDifferentCapitalizedNamesCollidingOnWindows = false;
+ //
+ // RootId(Path path, Container container) {
+ // this.path = path;
+ // this.container = container;
+ // }
+ //
+ // /* (non-Javadoc)
+ // * @see java.lang.Object#toString()
+ // */
+ // @Override
+ // public String toString() {
+ // return "RootId [id="
+ // + id
+ // + ", path="
+ // + path
+ // + ", container="
+ // + container.id
+ // + ", fqcns="
+ // + Misc.ppList(Misc.setAsList(fqcns))
+ // + ", fqcns_Type="
+ // + Misc.ppList(Misc.setAsList(fqcns_Type))
+ // + "]";
+ // }
+ //
+ // void add(Fqcn fqcn) {
+ // boolean wasNotPresent = fqcns.add(fqcn);
+ // boolean lc = fqcns_ignore_case.add(fqcn.fqcn_dots.toLowerCase());
+ // if (!lc && wasNotPresent) {
+ // haveDifferentCapitalizedNamesCollidingOnWindows = true;
+ // }
+ // }
+ //
+ // boolean hasMatching_Type(Fqcn fqcn) {
+ //
+ // }
+ // }
+ /// **
+ // * Called from Stream walker starting at a root or starting at an imbedded Jar or Pear.
+ // *
+ // * adds all the .java or .class files to the candidates, including _Type if not skipping the
+ /// _Type check
+ // * Handling embedded jar files
+ // * - single level Jar (at the top level of the default file system)
+ // * -- handle using an overlayed file system
+ // * - embedded Jars within Jars:
+ // * - not supported by Zip File System Provider (it only supports one level)
+ // * - handle by extracting to a temp dir, and then using the Zip File System Provider
+ // * @param path the path to a .java or .class or .jar or .pear
+ // * @param pearClasspath - a string representing a path to the pear's classpath if there is one,
+ /// or null
+ // */
+ // private void getCandidates_processFile(Path path, String pearClasspath) {
+ //// if (path.toString().contains("commons-httpclient-3.1.jar"))
+ //// System.out.println("Debug: " + path.toString());
+ //// System.out.println("debug processing " + path);
+ // try {
+ //// URI pathUri = path.toUri();
+ // String pathString = path.toString();
+ // final boolean isPear = pathString.endsWith(".pear"); // path.endsWith does not mean this !!
+ // final boolean isJar = pathString.endsWith(".jar");
+ //
+ // if (isJar || isPear) {
+ // if (!path.getFileSystem().equals(FileSystems.getDefault())) {
+ // // embedded Pear or Jar: extract to temp
+ // Path out = getTempOutputPathForJar(path);
+ // Files.copy(path, out, StandardCopyOption.REPLACE_EXISTING);
+ //// embeddedJars.add(new PathAndPath(path, out));
+ // path = out; // path points to pear or jar
+ // }
+ //
+ // Path start;
+ // final String localPearClasspath;
+ // if (isPear) {
+ // if (pearClasspath != null) {
+ // throw new UIMARuntimeException("Nested PEAR files not supported");
+ // }
+ //
+ //// pear_current = new PearOrJar(path);
+ //// pears.add(pear_current);
+ // // add pear classpath info
+ // File pearInstallDir = Files.createTempDirectory(getTempDir(), "installedPear").toFile();
+ // PackageBrowser ip = PackageInstaller.installPackage(pearInstallDir, path.toFile(), false);
+ // localPearClasspath = ip.buildComponentClassPath();
+ // String[] children = pearInstallDir.list();
+ // if (children == null || children.length != 1) {
+ // Misc.internalError();
+ // }
+ // pearResolveStart = Paths.get(pearInstallDir.getAbsolutePath(), children[0]);
+ //
+ // start = pearInstallDir.toPath();
+ // } else {
+ // if (isJar) {
+ // PearOrJar jarInfo = new PearOrJar(path);
+ // pear_or_jar_current_stack.push(jarInfo);
+ // jars.add(jarInfo);
+ // }
+ //
+ // localPearClasspath = pearClasspath;
+ // FileSystem jfs = FileSystems.newFileSystem(Paths.get(path.toUri()), null);
+ // start = jfs.getPath("/");
+ // }
+ //
+ // try (Stream<Path> stream = Files.walk(start)) { // needed to release file handles
+ // stream.forEachOrdered(
+ // p -> getCandidates_processFile(p, localPearClasspath));
+ // }
+ // if (isJar) {
+ // pear_or_jar_current_stack.pop();
+ // }
+ // if (isPear) {
+ // pear_current = null;
+ // }
+ // } else {
+ // // is not a .jar or .pear file. add .java or .class files to initial candidate set
+ // // will be filtered additionally later
+ //// System.out.println("debug path ends with java or class " + pathString.endsWith(isSource ?
+ /// ".java" : ".class") + " " + pathString);
+ // if (pathString.endsWith(isSource ? ".java" : ".class")) {
+ // candidates.add(new Candidate(path, pearClasspath));
+ // if (!isSource && null != pear_current) {
+ // // inside a pear, which has been unzipped into pearInstallDir;
+ // path2InsidePearOrJarPath.put(path.toString(), pearResolveStart.relativize(path).toString());
+ // pear_current.pathsToCandidateFiles.add(path.toString());
+ // }
+ //
+ // if (!isSource && pear_or_jar_current_stack.size() > 0) {
+ // // inside a jar, not contained in a pear
+ // pear_or_jar_current_stack.getFirst().pathsToCandidateFiles.add(path.toString());
+ // }
+ // }
+ // }
+ // } catch (IOException e) {
+ // throw new RuntimeException(e);
+ // }
+ // }
+ // private void postProcessPearsOrJars(String kind, List<PearOrJar> pearsOrJars,
+ /// List<String1AndString2> classReplace) { // pears or jars
+ // try {
+ // Path outDir = Paths.get(outputDirectory, kind);
+ // FileUtils.deleteRecursive(outDir.toFile());
+ // Files.createDirectories(outDir);
+ // } catch (IOException e) {
+ // throw new RuntimeException(e);
+ // }
+ //
+ //// pearsOrJars may have entries with 0 candidate paths. This happens when we scan them
+ //// but find nothing to convert.
+ //// eliminate these.
+ //
+ // Iterator<PearOrJar> it = pearsOrJars.iterator();
+ // while (it.hasNext()) {
+ // PearOrJar poj = it.next();
+ // if (poj.pathsToCandidateFiles.size() == 0) {
+ // it.remove();
+ // } else {
+ //// //debug
+ //// if (poj.pathToPearOrJar.toString().contains("commons-httpclient-3.1")) {
+ //// System.err.println("debug found converted things inside commons-httpclient");;
+ //// for (String x : poj.pathsToCandidateFiles) {
+ //// System.err.println(x);
+ //// }
+ //// System.err.println("");
+ //// }
+ // }
+ // }
+ //
+ // it = pearsOrJars.iterator();
+ // while (it.hasNext()) {
+ // PearOrJar poj = it.next();
+ // if (poj.pathsToCandidateFiles.size() == 0) {
+ // System.err.print("debug failed to remove unconverted Jar");
+ // }
+ // }
+ //
+ // if (pearsOrJars.size() == 0) {
+ // System.out.format("No .class files were replaced in %s.%n", kind);
+ // } else {
+ // System.out.format("replacing .class files in %,d %s%n", pearsOrJars.size(), kind);
+ // for (PearOrJar p : pearsOrJars) {
+ // pearOrJarPostProcessing(p, kind);
+ // }
+ // try {
+ // reportPaths("Reports of updated " + kind, kind + "FileUpdates.txt", classReplace);
+ //
+ // } catch (IOException e) {
+ // throw new RuntimeException(e);
+ // }
+ // }
+ //
+ // }
+ /// **
+ // * When running the compiler to compile v3 sources, we need a classpath that at a minimum
+ // * includes uimaj-core. The strategy is to use the invoker of this tool's classpath as
+ // * specified from the application class loader
+ // * @return true if no errors
+ // */
+ // private boolean compileV3SourcesCommon(List<ClassnameAndPath> items, String msg, String
+ /// pearClasspath) {
+ //
+ // if (items.size() == 0) {
+ // return true;
+ // }
+ // System.out.format("Compiling %,d classes %s -- This may take a while!%n", c2ps.size(), msg);
+ // StandardJavaFileManager fileManager = javaCompiler.getStandardFileManager(null, null,
+ /// Charset.forName("UTF-8"));
+ //
+ // List<String> cus = items.stream()
+ // .map(c -> outDirConverted + "v3/" + c.classname + ".java")
+ // .collect(Collectors.toList());
+ //
+ // Iterable<String> compilationUnitStrings = cus;
+ //
+ // Iterable<? extends JavaFileObject> compilationUnits =
+ // fileManager.getJavaFileObjectsFromStrings(compilationUnitStrings);
+ //
+ // // specify where the output classes go
+ // String classesBaseDir = outDirConverted + "v3-classes";
+ // try {
+ // Files.createDirectories(Paths.get(classesBaseDir));
+ // } catch (IOException e) {
+ // throw new UIMARuntimeException(e);
+ // }
+ // // specify the classpath
+ // String classpath = getCompileClassPath(pearClasspath);
+ // Iterable<String> options = Arrays.asList("-d", classesBaseDir,
+ // "-classpath", classpath);
+ // return javaCompiler.getTask(null, fileManager, null, options, null, compilationUnits).call();
+ // }
+ /// **
+ // * Called after class is migrated
+ // * Given a path to a class (source or class file),
+ // * return the URL to the class as found in the classpath.
+ // * This returns the "first" one found in the classpath, in the case of duplicates.
+ // * @param path
+ // * @return the location of the class in the class path
+ // */
+ // private URL getPathForClass(Path path) {
+ // return (null == packageAndClassNameSlash)
+ // ? null
+ // : migrateClassLoader.getResource(packageAndClassNameSlash + ".class");
+ // }
+ // private void getBaseOutputPath() {
+ // String s = packageAndClassNameSlash;
+ // int i = 0;
+ // while (!usedPackageAndClassNames.add(s)) {
+ // i = i + 1;
+ // s = packageAndClassNameSlash + "_dupid_" + i;
+ // }
+ // packageAndClassNameSlash_i = i;
+ // }
+ // private String prepareIndividual(String classname) {
+ // candidate = new Candidate(Paths.get(classname)); // a pseudo path
+ // packageName = null;
+ // className = null;
+ // packageAndClassNameSlash = null;
+ // cu = null;
+ // return decompile(classname); // always look up in classpath
+ // // to decompile individual source - put in sourcesRoots
+ // }
+ // if (!isSource) { // skip this recording if source
+ // if (null != pear_current) {
+ // // inside a pear, which has been unzipped into a temporary pearInstallDir;
+ // // we don't want that temporary dir to be part of the path.
+ // path2InsidePearOrJarPath.put(path.toString(), pearResolveStart.relativize(path).toString());
+ // pear_current.pathsToCandidateFiles.add(path.toString());
+ // }
+ //
+ // if (!isSource && pear_or_jar_current_stack.size() > 0) {
+ // // inside a jar, not contained in a pear
+ // pear_or_jar_current_stack.getFirst().pathsToCandidateFiles.add(path.toString());
+ // }
+ // }
+ // }
+ /// **
+ // * For a given candidate, use its path:
+ // * switch the ...java to ..._Type.java, or ...class to ..._Type.class
+ // * look thru all the candidates
+ // * @param cand
+ // * @param start
+ // * @return
+ // */
+ // private boolean has_Type(Candidate cand, int start) {
+ // if (start >= candidates.size()) {
+ // return false;
+ // }
+ //
+ // String sc = cand.p.toString();
+ // String sc_minus_suffix = sc.substring(0, sc.length() - ( isSource ? ".java".length() :
+ /// ".class".length()));
+ // String sc_Type = sc_minus_suffix + ( isSource ? "_Type.java" : "_Type.class");
+ // // a string which sorts beyond the candidate + a suffix of "_"
+ // String s_end = sc_minus_suffix + (char) (((int)'_') + 1);
+ // for (Candidate c : candidates.subList(start, candidates.size())) {
+ // String s = c.p.toString();
+ // if (s_end.compareTo(s) < 0) {
+ // return false; // not found, we're already beyond where it would be found
+ // }
+ // if (s.equals(sc_Type)) {
+ // return true;
+ // }
+ // }
+ // return false;
+ // }
+ // private final static Comparator<Candidate> pathComparator = new Comparator<Candidate>() {
+ // @Override
+ // public int compare(Candidate o1, Candidate o2) {
+ // return o1.p.toString().compareTo(o2.p.toString());
+ // }
+ // };
+
+ //// there may be several same-name roots not quite right
+ //// xxx_Type$1.class
+ //
+ // private void addIfPreviousIsSameName(List<Path> c, int i) {
+ // if (i == 0) return;
+ // String _Type = candidates.get(i).toString();
+ //// String prev = r.get(i-1).getPath();
+ // String prefix = _Type.substring(0, _Type.length() - ("_Type." + (isSource ? "java" :
+ //// "class")).length());
+ // i--;
+ // while (i >= 0) {
+ // String s = candidates.get(i).toString();
+ // if ( ! s.startsWith(prefix)) {
+ // break;
+ // }
+ // if (s.substring(prefix.length()).equals((isSource ? ".java" : ".class"))) {
+ // c.add(candidates.get(i));
+ // break;
+ // }
+ // i--;
+ // }
+ // }
+
+ //
+ // for (int i = 0; i < pearOrJar.pathsToCandidateFiles.size(); i++) {
+ // String candidatePath = pearOrJar.pathsToCandidateFiles.get(i);
+ // String path_in_v3_classes = isPear
+ // ? getPath_in_v3_classes(candidatePath)
+ // : candidatePath;
+ //
+ // Path src = Paths.get(outputDirectory, "converted/v3-classes", path_in_v3_classes
+ // + (isPear ? ".class" : ""));
+ // Path tgt = pfs.getPath(
+ // "/",
+ // isPear
+ // ? path2InsidePearOrJarPath.get(candidatePath) // needs to be bin/org/... etc
+ // : candidatePath); // needs to be org/... etc
+ // if (Files.exists(src)) {
+ // Files.copy(src, tgt, StandardCopyOption.REPLACE_EXISTING);
+ // reportPearOrJarClassReplace(pearOrJarCopy.toString(), path_in_v3_classes, kind);
+ // }
+ // }
+
+ /// ** for compiled mode, do recompiling and reassembly of Jars and Pears */
+ //
+ // private boolean compileAndReassemble(CommonConverted cc, Container container, Path path) {
+ // boolean noErrors = true;
+ // if (javaCompiler != null) {
+ // if (container.haveDifferentCapitalizedNamesCollidingOnWindows) {
+ // System.out.println("Skipping compiling / reassembly because class " + container.toString() + "
+ /// has multiple names differing only in capitalization, please resolve first.");
+ // } else {
+ //
+ //
+ // noErrors = compileV3PearSources(container, path);
+ // noErrors = noErrors && compileV3NonPearSources(container, path);
+ //
+ // postProcessPearsOrJars("jars" , jars , jarClassReplace);
+ // postProcessPearsOrJars("pears", pears, pearClassReplace);
+ //
+ ////
+ //// try {
+ //// Path pearOutDir = Paths.get(outputDirectory, "pears");
+ //// FileUtils.deleteRecursive(pearOutDir.toFile());
+ //// Files.createDirectories(pearOutDir);
+ //// } catch (IOException e) {
+ //// throw new RuntimeException(e);
+ //// }
+ ////
+ //// System.out.format("replacing .class files in %,d PEARs%n", pears.size());
+ //// for (PearOrJar p : pears) {
+ //// pearOrJarPostProcessing(p);
+ //// }
+ //// try {
+ //// reportPaths("Reports of updated Pears", "pearFileUpdates.txt", pearClassReplace);
+ //// } catch (IOException e) {
+ //// throw new RuntimeException(e);
+ //// }
+ // }
+ // }
+ //
+ // return noErrors;
+ // }
+
+ /// **
+ // * @return true if no errors
+ // */
+ // private boolean compileV3PearSources() {
+ // boolean noError = true;
+ // Map<String, List<ClassnameAndPath>> p2c = c2ps.stream()
+ // .filter(c -> c.pearClasspath != null)
+ // .collect(Collectors.groupingBy(c -> c.pearClasspath));
+ //
+ // List<Entry<String, List<ClassnameAndPath>>> ea = p2c.entrySet().stream()
+ // .sorted(Comparator.comparing(Entry::getKey)) //(e1, e2) -> e1.getKey().compareTo(e2.getKey())
+ // .collect(Collectors.toList());
+ //
+ // for (Entry<String, List<ClassnameAndPath>> e : ea) {
+ // noError = noError && compileV3SourcesCommon(e.getValue(), "for Pear " + e.getKey(), e.getKey()
+ /// );
+ // }
+ // return noError;
+ // }
+ //
+ /// **
+ // * @return true if no errors
+ // */
+ // private boolean compileV3NonPearSources() {
+ //
+ // List<ClassnameAndPath> cnps = c2ps.stream()
+ // .filter(c -> c.pearClasspath == null)
+ // .collect(Collectors.toList());
+ //
+ // return compileV3SourcesCommon(cnps, "(non PEAR)", null);
+ // }
+
+ /// **
+ // * @param pathInPear a complete path to a class inside an (installed) pear
+ // * @return the part starting after the top node of the install dir
+ // */
+ // private String getPath_in_v3_classes(String pathInPear) {
+ // return path2classname.get(pathInPear);
+ // }
+
+ // private boolean reportDuplicates() throws IOException {
+ // List<List<CommonConverted>> nonIdenticals = new ArrayList<>();
+ // List<CommonConverted> onlyIdenticals = new ArrayList<>();
+ //
+ // classname2multiSources.forEach(
+ // (classname, ccs) -> {
+ // if (ccs.size() > 1) {
+ // nonIdenticals.add(ccs);
+ // } else {
+ // CommonConverted cc = ccs.get(0);
+ // if (cc.containersAndV2Paths.size() > 1)
+ // onlyIdenticals.add(cc); // the same item in multiple containers and/or paths
+ // }
+ // }
+ // );
+ //
+ // if (nonIdenticals.size() == 0) {
+ // if (onlyIdenticals.size() == 0) {
+ // System.out.println("There were no duplicates found.");
+ // } else {
+ // // report identical duplicates
+ // try (BufferedWriter bw = Files.newBufferedWriter(makePath(outDirLog +
+ // "identical_duplicates.txt"), StandardOpenOption.CREATE)) {
+ // logPrintNl("Report of Identical duplicates:", bw);
+ // for (CommonConverted cc : onlyIdenticals) {
+ // int i = 0;
+ // logPrintNl("Class: " + cc.fqcn_slash, bw);
+ // for (ContainerAndPath cp : cc.containersAndV2Paths) {
+ // logPrintNl(" " + (++i) + " " + cp, bw);
+ // }
+ // logPrintNl("", bw);
+ // }
+ // }
+ // }
+ // return true;
+ // }
+ //
+ //// non-identicals, print out all of them
+ // try (BufferedWriter bw = Files.newBufferedWriter(makePath(outDirLog +
+ // "nonIdentical_duplicates.txt"), StandardOpenOption.CREATE)) {
+ // logPrintNl("Report of non-identical duplicates", bw);
+ // for (List<CommonConverted> nonIdentical : nonIdenticals) {
+ // String fqcn = nonIdentical.get(0).fqcn_slash;
+ // logPrintNl(" classname: " + fqcn, bw);
+ // int i = 1;
+ // // for each cc, and within each cc, for each containerAndPath
+ // for (CommonConverted cc : nonIdentical) {
+ //// logPrintNl(" version " + i, bw);
+ // assert fqcn.equals(cc.fqcn_slash);
+ // int j = 1;
+ // boolean isSame = cc.containersAndV2Paths.size() > 1;
+ // boolean isFirstTime = true;
+ // for (ContainerAndPath cp : cc.containersAndV2Paths) {
+ // String first = isSame && isFirstTime
+ // ? " same: "
+ // : isSame
+ // ? " "
+ // : " ";
+ // isFirstTime = false;
+ // logPrintNl(first + i + "." + (j++) + " " + cp, bw);
+ // }
+ // indent[0] -= 6;
+ //// logPrintNl("", bw);
+ // i++;
+ // }
+ //// logPrintNl("", bw);
+ // }
+ // }
+ // return false;
+ // }
+
+ // private static class PathAndReason extends Report2<Path, String> {
+ // Path path;
+ // String reason;
+ // PathAndReason(Path path, String reason) {
+ // this.path = path;
+ // this.reason = reason;
+ // }
+ // @Override
+ // public Comparable<Path> getFirst() { return path; }
+ // @Override
+ // public Comparable<String> getSecond() { return reason; }
+ // @Override
+ // int getFirstLength() { return path.toString().length(); }
+ // }
}
[uima-uimaj] 05/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit 2950fa0edf18310b2a2566fdd1ee06422a5574ff
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:01:09 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../test/junit_extension/AnnotationWriter.java | 678 ++++++++++-----------
.../AnnotatorPerformanceTester.java | 41 +-
.../uima/test/junit_extension/AnnotatorTester.java | 676 ++++++++++----------
.../junit_extension/PerformanceTestResult.java | 20 +-
.../junit_extension/PerformanceTestResultImpl.java | 148 +++--
5 files changed, 795 insertions(+), 768 deletions(-)
diff --git a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotationWriter.java b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotationWriter.java
index ba8a58c..1f83888 100644
--- a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotationWriter.java
+++ b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotationWriter.java
@@ -43,363 +43,331 @@ import org.apache.uima.resource.ResourceInitializationException;
import org.apache.uima.resource.ResourceProcessException;
import org.apache.uima.util.ProcessTrace;
-
/**
- * The AnnotationWriter class writes specified annotations to an output file.
- * The encoding of the output file is UTF-8
+ * The AnnotationWriter class writes specified annotations to an output file. The encoding of the
+ * output file is UTF-8
*/
-public class AnnotationWriter extends CasConsumer_ImplBase implements CasConsumer
-{
-
- /** The out file. */
- //output file
- private File outFile;
-
- /** The file writer. */
- //output file writer
- private OutputStreamWriter fileWriter;
-
- /** The tofs. */
- //respected annotations
- private String[] tofs;
-
- /** The reconfig. */
- //check if reconfigure must be called
- private boolean reconfig = false;
-
- /** The Constant featureOnlyKey. */
- private final static String featureOnlyKey = "feature";
-
- /**
- * Initializes this CAS Consumer with the parameters specified in the
- * descriptor.
- *
- * @throws ResourceInitializationException if there is error in
- * initializing the resources
- */
- @Override
- public void initialize() throws ResourceInitializationException
- {
-
- // extract configuration parameter settings
- String oPath = (String) getUimaContext().getConfigParameterValue("outputFile");
-
- //Output file should be specified in the descriptor
- if (oPath == null)
- {
- //set reconfiguration - reconfig() must be called
- this.reconfig = true;
- }
- else
- {
- // If specified output directory does not exist, try to create it
- this.outFile = new File(oPath);
- if (this.outFile.getParentFile() != null && !this.outFile.getParentFile().exists())
- {
- if (!this.outFile.getParentFile().mkdirs())
- throw new ResourceInitializationException(
- ResourceInitializationException.RESOURCE_DATA_NOT_VALID,
- new Object[] { oPath, "outputFile" });
- }
- try
- {
- this.fileWriter = new OutputStreamWriter(new FileOutputStream(this.outFile, false),
- StandardCharsets.UTF_8);
- }
- catch (IOException e)
- {
- throw new ResourceInitializationException(e);
- }
- }
-
- //extract annotation types
- this.tofs = (String[]) getUimaContext().getConfigParameterValue("AnnotationTypes");
- //sort array
- if (this.tofs != null)
- Arrays.sort(this.tofs);
-
- }
-
- /**
- * processTofs() writes als specified types an features to a HashMap.
- *
- * @param aCAS a CAS with a TypeSystem
- * @param someTofs the some tofs
- * @return HashMap - Map with all types an features.
- */
- private HashMap processTofs(CAS aCAS, String[] someTofs)
- {
- HashMap types = new HashMap(10);
-
- for (int i = 0; i < someTofs.length; i++)
- {
- Type type = aCAS.getTypeSystem().getType(someTofs[i]);
-
- if (type == null) //maybe a feature
- {
- int index = someTofs[i].indexOf(":");
-
- if (index != -1)
- {
- String typename = someTofs[i].substring(0, index);
- Type typeKey = aCAS.getTypeSystem().getType(typename);
-
- //get feature object (Vector) for the current type
- Object obj = types.get(typeKey);
-
- //if type is not included in the typelist create type and add feature
- if (obj == null)
- {
- ArrayList list = new ArrayList(10);
- Feature fs = aCAS.getTypeSystem().getFeatureByFullName(someTofs[i]);
- list.add(0, featureOnlyKey);
- list.add(fs);
- types.put(typeKey, list);
- }
- else //add feature to type
- {
- //cast feature vector for the current type
- ArrayList vec = (ArrayList) obj;
- Feature fs = aCAS.getTypeSystem().getFeatureByFullName(someTofs[i]);
- vec.add(fs);
- }
-
- }
- }
- else
- {
- //add type as key and a Vector as Feature container
- if(types.containsKey(type)){
- ArrayList featureList = (ArrayList) types.get(type);
- if(featureList.size() >0 && featureList.get(0).equals(featureOnlyKey)){
- featureList.remove(0);
- }
- // type is already in the list do not overwrite it!
- }else{
- types.put(type, new ArrayList(10));
- }
- }
- }
-
- return types;
- }
-
- /* (non-Javadoc)
- * @see org.apache.uima.collection.base_cpm.CasObjectProcessor#processCas(org.apache.uima.cas.CAS)
- */
- @Override
- public synchronized void processCas(CAS aCAS) throws ResourceProcessException
- {
- if (this.reconfig == true)
- {
- throw new ResourceProcessException(
- ResourceInitializationException.CONFIG_SETTING_ABSENT,
- new Object[] { "outputFile" });
- }
-
- //get low level CAS
- LowLevelCAS ll_cas = aCAS.getLowLevelCAS();
-
- //get low level TypeSystem
- LowLevelTypeSystem ll_typeSystem = ll_cas.ll_getTypeSystem();
-
- //get types and feature interessted in
- HashMap types = processTofs(aCAS, this.tofs);
-
- try
- {
- //iterate and print annotations
- FSIterator typeIterator = aCAS.getAnnotationIndex().iterator();
-
- for (typeIterator.moveToFirst(); typeIterator.isValid(); typeIterator.moveToNext())
- {
- Iterator it = types.keySet().iterator();
-
- while (it.hasNext())
- {
- //get current type and features
- Type currentType = (Type) it.next();
- boolean isFeatureOnly = false;
-
- ArrayList featureList = (ArrayList) types.get(currentType);
- if(featureList.size() >0 && featureList.get(0).equals(featureOnlyKey)){
- featureList.remove(0);
- isFeatureOnly = true;
- }
- Feature[] features = (Feature[]) featureList.toArray(new Feature[] {
- });
-
- AnnotationFS annot = (AnnotationFS) typeIterator.get();
-
- if (annot.getType().getName() == currentType.getName())
- {
- //only for formatting necessary
- boolean firstFeature = true;
-
- String span = annot.getCoveredText();
- if(!isFeatureOnly){
- this.fileWriter.write(
- annot.getType().getShortName()
- + "(" + annot.getBegin() + "," + annot.getEnd() + "): " + span);
- }else{
- this.fileWriter.write(
- annot.getType().getShortName()
- + ": ");
- }
-
- for (int f = 0; f < features.length; f++)
- {
- if (firstFeature)
- {
- this.fileWriter.write(" { ");
- firstFeature = false;
- }
- else
- {
- this.fileWriter.write(", ");
- }
-
- Feature fs = features[f];
- int typeClass = ll_cas.ll_getTypeClass(ll_typeSystem.ll_getCodeForType(fs.getRange()));
- this.fileWriter.write(fs.getShortName() + "=");
-
- switch (typeClass)
- {
- case LowLevelCAS.TYPE_CLASS_FLOAT :
- this.fileWriter.write(Float.toString(annot.getFloatValue(fs)));
- break;
-
- case LowLevelCAS.TYPE_CLASS_INT :
- this.fileWriter.write(Integer.toString(annot.getIntValue(fs)));
- break;
-
- case LowLevelCAS.TYPE_CLASS_STRING :
- String value = annot.getStringValue(fs);
- if(value != null) {
- this.fileWriter.write(value);
- } else {
- this.fileWriter.write("null");
- }
- break;
-
- case LowLevelCAS.TYPE_CLASS_FS:
-
- FeatureStructure fStruct = annot.getFeatureValue(fs);
- if(fStruct != null) {
- this.fileWriter.write(fStruct.toString());
- } else {
- this.fileWriter.write("null");
- }
- break;
- }
- }
-
- if (firstFeature == false)
- {
- this.fileWriter.write(" }");
- }
-
- this.fileWriter.write(System.getProperty("line.separator"));
- }
-
- }
- }
-
- this.fileWriter.flush();
- }
- catch (Exception ex)
- {
- throw new ResourceProcessException(ex);
- }
-
- }
-
- /* (non-Javadoc)
- * @see org.apache.uima.collection.CasConsumer_ImplBase#batchProcessComplete(org.apache.uima.util.ProcessTrace)
- */
- @Override
- public void batchProcessComplete(ProcessTrace aTrace) throws ResourceProcessException, IOException
- {
- // nothing to do here
- }
-
- /* (non-Javadoc)
- * @see org.apache.uima.collection.CasConsumer_ImplBase#collectionProcessComplete(org.apache.uima.util.ProcessTrace)
- */
- @Override
- public void collectionProcessComplete(ProcessTrace aTrace) throws ResourceProcessException, IOException
- {
- if (this.fileWriter != null)
- {
- this.fileWriter.close();
- }
- }
-
- /* (non-Javadoc)
- * @see org.apache.uima.collection.CasConsumer_ImplBase#reconfigure()
- */
- @Override
- public void reconfigure() throws ResourceConfigurationException
- {
- //reset reconfiguration - is done
- this.reconfig = false;
-
- super.reconfigure();
- // extract configuration parameter settings
- String oPath = (String) getUimaContext().getConfigParameterValue("outputFile");
- File oFile = new File(oPath);
- //if output file has changed, close exiting file and open new
- if (!oFile.equals(this.outFile))
- {
- this.outFile = oFile;
- try
- {
- if (this.fileWriter != null)
- this.fileWriter.close();
-
- // If specified output directory does not exist, try to create it
- if (oFile.getParentFile() != null && !oFile.getParentFile().exists())
- {
- if (!oFile.getParentFile().mkdirs())
- throw new ResourceConfigurationException(
- ResourceInitializationException.RESOURCE_DATA_NOT_VALID,
- new Object[] { oPath, "outputFile" });
- }
- //write result specification to the output file
- this.fileWriter = new OutputStreamWriter(new FileOutputStream(oFile, false), StandardCharsets.UTF_8);
- }
- catch (IOException e)
- {
- throw new ResourceConfigurationException();
- }
- }
-
- //extract annotation types
- this.tofs = (String[]) getUimaContext().getConfigParameterValue("AnnotationTypes");
- //sort array
- if (this.tofs != null)
- Arrays.sort(this.tofs);
-
- }
-
- /* (non-Javadoc)
- * @see org.apache.uima.collection.CasConsumer_ImplBase#destroy()
- */
- @Override
- public void destroy()
- {
- if (this.fileWriter != null)
- {
- try
- {
- this.fileWriter.close();
- }
- catch (IOException e)
- {
- // ignore IOException on destroy
- }
- }
- }
+public class AnnotationWriter extends CasConsumer_ImplBase implements CasConsumer {
+
+ /** The out file. */
+ // output file
+ private File outFile;
+
+ /** The file writer. */
+ // output file writer
+ private OutputStreamWriter fileWriter;
+
+ /** The tofs. */
+ // respected annotations
+ private String[] tofs;
+
+ /** The reconfig. */
+ // check if reconfigure must be called
+ private boolean reconfig = false;
+
+ /** The Constant featureOnlyKey. */
+ private final static String featureOnlyKey = "feature";
+
+ /**
+ * Initializes this CAS Consumer with the parameters specified in the descriptor.
+ *
+ * @throws ResourceInitializationException
+ * if there is error in initializing the resources
+ */
+ @Override
+ public void initialize() throws ResourceInitializationException {
+
+ // extract configuration parameter settings
+ String oPath = (String) getUimaContext().getConfigParameterValue("outputFile");
+
+ // Output file should be specified in the descriptor
+ if (oPath == null) {
+ // set reconfiguration - reconfig() must be called
+ this.reconfig = true;
+ } else {
+ // If specified output directory does not exist, try to create it
+ this.outFile = new File(oPath);
+ if (this.outFile.getParentFile() != null && !this.outFile.getParentFile().exists()) {
+ if (!this.outFile.getParentFile().mkdirs())
+ throw new ResourceInitializationException(
+ ResourceInitializationException.RESOURCE_DATA_NOT_VALID,
+ new Object[] { oPath, "outputFile" });
+ }
+ try {
+ this.fileWriter = new OutputStreamWriter(new FileOutputStream(this.outFile, false),
+ StandardCharsets.UTF_8);
+ } catch (IOException e) {
+ throw new ResourceInitializationException(e);
+ }
+ }
+
+ // extract annotation types
+ this.tofs = (String[]) getUimaContext().getConfigParameterValue("AnnotationTypes");
+ // sort array
+ if (this.tofs != null)
+ Arrays.sort(this.tofs);
+
+ }
+
+ /**
+ * processTofs() writes als specified types an features to a HashMap.
+ *
+ * @param aCAS
+ * a CAS with a TypeSystem
+ * @param someTofs
+ * the some tofs
+ * @return HashMap - Map with all types an features.
+ */
+ private HashMap processTofs(CAS aCAS, String[] someTofs) {
+ HashMap types = new HashMap(10);
+
+ for (int i = 0; i < someTofs.length; i++) {
+ Type type = aCAS.getTypeSystem().getType(someTofs[i]);
+
+ if (type == null) // maybe a feature
+ {
+ int index = someTofs[i].indexOf(":");
+
+ if (index != -1) {
+ String typename = someTofs[i].substring(0, index);
+ Type typeKey = aCAS.getTypeSystem().getType(typename);
+
+ // get feature object (Vector) for the current type
+ Object obj = types.get(typeKey);
+
+ // if type is not included in the typelist create type and add feature
+ if (obj == null) {
+ ArrayList list = new ArrayList(10);
+ Feature fs = aCAS.getTypeSystem().getFeatureByFullName(someTofs[i]);
+ list.add(0, featureOnlyKey);
+ list.add(fs);
+ types.put(typeKey, list);
+ } else // add feature to type
+ {
+ // cast feature vector for the current type
+ ArrayList vec = (ArrayList) obj;
+ Feature fs = aCAS.getTypeSystem().getFeatureByFullName(someTofs[i]);
+ vec.add(fs);
+ }
+
+ }
+ } else {
+ // add type as key and a Vector as Feature container
+ if (types.containsKey(type)) {
+ ArrayList featureList = (ArrayList) types.get(type);
+ if (featureList.size() > 0 && featureList.get(0).equals(featureOnlyKey)) {
+ featureList.remove(0);
+ }
+ // type is already in the list do not overwrite it!
+ } else {
+ types.put(type, new ArrayList(10));
+ }
+ }
+ }
+
+ return types;
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.collection.base_cpm.CasObjectProcessor#processCas(org.apache.uima.cas.CAS)
+ */
+ @Override
+ public synchronized void processCas(CAS aCAS) throws ResourceProcessException {
+ if (this.reconfig == true) {
+ throw new ResourceProcessException(ResourceInitializationException.CONFIG_SETTING_ABSENT,
+ new Object[] { "outputFile" });
+ }
+
+ // get low level CAS
+ LowLevelCAS ll_cas = aCAS.getLowLevelCAS();
+
+ // get low level TypeSystem
+ LowLevelTypeSystem ll_typeSystem = ll_cas.ll_getTypeSystem();
+
+ // get types and feature interessted in
+ HashMap types = processTofs(aCAS, this.tofs);
+
+ try {
+ // iterate and print annotations
+ FSIterator typeIterator = aCAS.getAnnotationIndex().iterator();
+
+ for (typeIterator.moveToFirst(); typeIterator.isValid(); typeIterator.moveToNext()) {
+ Iterator it = types.keySet().iterator();
+
+ while (it.hasNext()) {
+ // get current type and features
+ Type currentType = (Type) it.next();
+ boolean isFeatureOnly = false;
+
+ ArrayList featureList = (ArrayList) types.get(currentType);
+ if (featureList.size() > 0 && featureList.get(0).equals(featureOnlyKey)) {
+ featureList.remove(0);
+ isFeatureOnly = true;
+ }
+ Feature[] features = (Feature[]) featureList.toArray(new Feature[] {});
+
+ AnnotationFS annot = (AnnotationFS) typeIterator.get();
+
+ if (annot.getType().getName() == currentType.getName()) {
+ // only for formatting necessary
+ boolean firstFeature = true;
+
+ String span = annot.getCoveredText();
+ if (!isFeatureOnly) {
+ this.fileWriter.write(annot.getType().getShortName() + "(" + annot.getBegin() + ","
+ + annot.getEnd() + "): " + span);
+ } else {
+ this.fileWriter.write(annot.getType().getShortName() + ": ");
+ }
+
+ for (int f = 0; f < features.length; f++) {
+ if (firstFeature) {
+ this.fileWriter.write(" { ");
+ firstFeature = false;
+ } else {
+ this.fileWriter.write(", ");
+ }
+
+ Feature fs = features[f];
+ int typeClass = ll_cas
+ .ll_getTypeClass(ll_typeSystem.ll_getCodeForType(fs.getRange()));
+ this.fileWriter.write(fs.getShortName() + "=");
+
+ switch (typeClass) {
+ case LowLevelCAS.TYPE_CLASS_FLOAT:
+ this.fileWriter.write(Float.toString(annot.getFloatValue(fs)));
+ break;
+
+ case LowLevelCAS.TYPE_CLASS_INT:
+ this.fileWriter.write(Integer.toString(annot.getIntValue(fs)));
+ break;
+
+ case LowLevelCAS.TYPE_CLASS_STRING:
+ String value = annot.getStringValue(fs);
+ if (value != null) {
+ this.fileWriter.write(value);
+ } else {
+ this.fileWriter.write("null");
+ }
+ break;
+
+ case LowLevelCAS.TYPE_CLASS_FS:
+
+ FeatureStructure fStruct = annot.getFeatureValue(fs);
+ if (fStruct != null) {
+ this.fileWriter.write(fStruct.toString());
+ } else {
+ this.fileWriter.write("null");
+ }
+ break;
+ }
+ }
+
+ if (firstFeature == false) {
+ this.fileWriter.write(" }");
+ }
+
+ this.fileWriter.write(System.getProperty("line.separator"));
+ }
+
+ }
+ }
+
+ this.fileWriter.flush();
+ } catch (Exception ex) {
+ throw new ResourceProcessException(ex);
+ }
+
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.collection.CasConsumer_ImplBase#batchProcessComplete(org.apache.uima.util.
+ * ProcessTrace)
+ */
+ @Override
+ public void batchProcessComplete(ProcessTrace aTrace)
+ throws ResourceProcessException, IOException {
+ // nothing to do here
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.collection.CasConsumer_ImplBase#collectionProcessComplete(org.apache.uima.util.
+ * ProcessTrace)
+ */
+ @Override
+ public void collectionProcessComplete(ProcessTrace aTrace)
+ throws ResourceProcessException, IOException {
+ if (this.fileWriter != null) {
+ this.fileWriter.close();
+ }
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.collection.CasConsumer_ImplBase#reconfigure()
+ */
+ @Override
+ public void reconfigure() throws ResourceConfigurationException {
+ // reset reconfiguration - is done
+ this.reconfig = false;
+
+ super.reconfigure();
+ // extract configuration parameter settings
+ String oPath = (String) getUimaContext().getConfigParameterValue("outputFile");
+ File oFile = new File(oPath);
+ // if output file has changed, close exiting file and open new
+ if (!oFile.equals(this.outFile)) {
+ this.outFile = oFile;
+ try {
+ if (this.fileWriter != null)
+ this.fileWriter.close();
+
+ // If specified output directory does not exist, try to create it
+ if (oFile.getParentFile() != null && !oFile.getParentFile().exists()) {
+ if (!oFile.getParentFile().mkdirs())
+ throw new ResourceConfigurationException(
+ ResourceInitializationException.RESOURCE_DATA_NOT_VALID,
+ new Object[] { oPath, "outputFile" });
+ }
+ // write result specification to the output file
+ this.fileWriter = new OutputStreamWriter(new FileOutputStream(oFile, false),
+ StandardCharsets.UTF_8);
+ } catch (IOException e) {
+ throw new ResourceConfigurationException();
+ }
+ }
+
+ // extract annotation types
+ this.tofs = (String[]) getUimaContext().getConfigParameterValue("AnnotationTypes");
+ // sort array
+ if (this.tofs != null)
+ Arrays.sort(this.tofs);
+
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.uima.collection.CasConsumer_ImplBase#destroy()
+ */
+ @Override
+ public void destroy() {
+ if (this.fileWriter != null) {
+ try {
+ this.fileWriter.close();
+ } catch (IOException e) {
+ // ignore IOException on destroy
+ }
+ }
+ }
}
diff --git a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorPerformanceTester.java b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorPerformanceTester.java
index 1b3ceef..f79c7fc 100644
--- a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorPerformanceTester.java
+++ b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorPerformanceTester.java
@@ -36,7 +36,6 @@ import org.apache.uima.util.Logger;
import org.apache.uima.util.XMLInputSource;
import org.junit.Assert;
-
/**
* AnnotatorPerfTester is a helper class to execute annotator performance tests. The performance
* test results are returned as {@link PerformanceTestResultImpl} object.
@@ -55,7 +54,9 @@ public class AnnotatorPerformanceTester {
private FileFileFilter() {
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see java.io.FileFilter#accept(java.io.File)
*/
@Override
@@ -82,16 +83,23 @@ public class AnnotatorPerformanceTester {
/**
* runs an annotator performance test.
*
- * @param repeatSingle if true, every document is process "numsToRun" times before the next document is
+ * @param repeatSingle
+ * if true, every document is process "numsToRun" times before the next document is
* processed. If false, all documents are processed and this is repeated "numsToRun"
* times.
- * @param numsToRun repeat count for the input documents
- * @param taeDescFilePath ae descriptor - absolute file path
- * @param testFileDir test file directory
- * @param dataPath ae datapath
- * @param doWarmup do warum for analysis engine - runs an short english sample document
+ * @param numsToRun
+ * repeat count for the input documents
+ * @param taeDescFilePath
+ * ae descriptor - absolute file path
+ * @param testFileDir
+ * test file directory
+ * @param dataPath
+ * ae datapath
+ * @param doWarmup
+ * do warum for analysis engine - runs an short english sample document
* @return PerformanceTestResult - returns the performance test results
- * @throws Exception passthru
+ * @throws Exception
+ * passthru
*/
public static PerformanceTestResult runPerformanceTest(boolean repeatSingle, int numsToRun,
File taeDescFilePath, File testFileDir, String dataPath, boolean doWarmup)
@@ -118,8 +126,7 @@ public class AnnotatorPerformanceTester {
}
// get current log level setting
- Level defaultLogLevel = (Level) logLevels.get(LogManager.getLogManager()
- .getProperty(".level"));
+ Level defaultLogLevel = (Level) logLevels.get(LogManager.getLogManager().getProperty(".level"));
if (defaultLogLevel == null) {
// no log level was specified, use default log level settings "INFO" that is also
@@ -130,7 +137,7 @@ public class AnnotatorPerformanceTester {
Logger logger = UIMAFramework.getLogger();
logger.setLevel(Level.OFF);
- //create timer
+ // create timer
Timer globalTimer = new Timer();
Timer initTimer = new Timer();
Timer warmupTimer = new Timer();
@@ -138,16 +145,16 @@ public class AnnotatorPerformanceTester {
Timer processResetTimer = new Timer();
Timer cleanupTimer = new Timer();
Timer documentPreparationTimer = new Timer();
-
- //start timer for global time
+
+ // start timer for global time
globalTimer.start();
// init analysis engine
try {
- // start initialization timer
+ // start initialization timer
initTimer.start();
-
+
// set datapath
ResourceManager resMgr = UIMAFramework.newDefaultResourceManager();
if (dataPath != null) {
@@ -178,7 +185,7 @@ public class AnnotatorPerformanceTester {
result.setInitTime(initTimer.getTimeSpan());
if (doWarmup) {
- // start warmup timer
+ // start warmup timer
warmupTimer.start();
// process dummy document
diff --git a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java
index 99b6627..4dd448a 100644
--- a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java
+++ b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/AnnotatorTester.java
@@ -43,352 +43,350 @@ import org.apache.uima.util.InvalidXMLException;
import org.apache.uima.util.XMLInputSource;
import org.junit.Assert;
-
/**
* AnnotatorTester is the helper class to test annotators.
*/
public class AnnotatorTester {
-
- /** The desc file. */
- // annotator descriptor
- private File descFile;
-
- /** The ae. */
- // analysis engine instance
- private AnalysisEngine ae;
-
- /** The mgr. */
- // Resource Manager
- private ResourceManager mgr;
-
- /**
- * Constructor save the specified descriptor file path and initialize the
- * analysis engine.
- *
- * @param descFilePath
- * descriptor file path
- * @throws Exception passthru
- * if an analysis engine initialize error occurs.
- */
- public AnnotatorTester(String descFilePath) throws Exception {
- this.descFile = new File(descFilePath);
- this.mgr = UIMAFramework.newDefaultResourceManager();
- setup();
- }
-
- /**
- * Constructor save the specified descriptor file path and initialize the
- * analysis engine.
- *
- * @param descFile
- * descriptor file
- * @throws Exception passthru
- * if an analysis engine initialize error occurs.
- */
- public AnnotatorTester(File descFile) throws Exception {
- this.descFile = descFile;
- this.mgr = UIMAFramework.newDefaultResourceManager();
- setup();
- }
-
- /**
- * Constructor save the specified descriptor file path and initialize the
- * analysis engine.
- *
- * @param descFilePath
- * descriptor file path
- * @param mgr
- * a ResourceManager
- * @throws Exception
- * if an analysis engine initialize error occurs.
- */
- public AnnotatorTester(String descFilePath, ResourceManager mgr)
- throws Exception {
- this.descFile = new File(descFilePath);
- this.mgr = mgr;
- setup();
- }
-
- /**
- * initialize the analysis engine with the specified specifier.
- *
- * @throws Exception passthru
- */
- private void setup() throws Exception {
- this.ae = null;
- // Create an XML input source from the specifier file.
- XMLInputSource in = new XMLInputSource(this.descFile);
- // Parse the specifier.
- ResourceSpecifier specifier = UIMAFramework.getXMLParser()
- .parseResourceSpecifier(in);
- // Create the Text Analysis Engine.
- this.ae = UIMAFramework.produceAnalysisEngine(specifier, this.mgr,
- null);
- }
-
- /**
- * change the parameter name for the given analysis engine.
- *
- * @param groupName group name, if no group is available, pass null
- * @param paramName parameter name
- * @param paramValue parameter value
- * @throws ResourceConfigurationException passthru
- */
- public void changeParameterSetting(String groupName, String paramName,
- Object paramValue) throws ResourceConfigurationException {
- if (groupName == null) {
- this.ae.setConfigParameterValue(paramName, paramValue);
- } else {
- this.ae.setConfigParameterValue(groupName, paramName, paramValue);
- }
- // call reconfigure to activate the change
- this.ae.reconfigure();
- }
-
- /**
- * change the parameter name for the given delegate analysis engine key.
- *
- * @param delegeteKey analysis engine key
- * @param groupName group name
- * @param paramName parameter name
- * @param paramValue parameter value
- * @throws InvalidXMLException passthru
- * @throws ResourceInitializationException passthru
- * @throws IOException passthru
- */
- public void changeDelegateParameterSetting(String delegeteKey,
- String groupName, String paramName, Object paramValue)
- throws InvalidXMLException, ResourceInitializationException,
- IOException {
- // create CasConsumer description
- AnalysisEngineDescription aeSpecifier = UIMAFramework.getXMLParser()
+
+ /** The desc file. */
+ // annotator descriptor
+ private File descFile;
+
+ /** The ae. */
+ // analysis engine instance
+ private AnalysisEngine ae;
+
+ /** The mgr. */
+ // Resource Manager
+ private ResourceManager mgr;
+
+ /**
+ * Constructor save the specified descriptor file path and initialize the analysis engine.
+ *
+ * @param descFilePath
+ * descriptor file path
+ * @throws Exception
+ * passthru if an analysis engine initialize error occurs.
+ */
+ public AnnotatorTester(String descFilePath) throws Exception {
+ this.descFile = new File(descFilePath);
+ this.mgr = UIMAFramework.newDefaultResourceManager();
+ setup();
+ }
+
+ /**
+ * Constructor save the specified descriptor file path and initialize the analysis engine.
+ *
+ * @param descFile
+ * descriptor file
+ * @throws Exception
+ * passthru if an analysis engine initialize error occurs.
+ */
+ public AnnotatorTester(File descFile) throws Exception {
+ this.descFile = descFile;
+ this.mgr = UIMAFramework.newDefaultResourceManager();
+ setup();
+ }
+
+ /**
+ * Constructor save the specified descriptor file path and initialize the analysis engine.
+ *
+ * @param descFilePath
+ * descriptor file path
+ * @param mgr
+ * a ResourceManager
+ * @throws Exception
+ * if an analysis engine initialize error occurs.
+ */
+ public AnnotatorTester(String descFilePath, ResourceManager mgr) throws Exception {
+ this.descFile = new File(descFilePath);
+ this.mgr = mgr;
+ setup();
+ }
+
+ /**
+ * initialize the analysis engine with the specified specifier.
+ *
+ * @throws Exception
+ * passthru
+ */
+ private void setup() throws Exception {
+ this.ae = null;
+ // Create an XML input source from the specifier file.
+ XMLInputSource in = new XMLInputSource(this.descFile);
+ // Parse the specifier.
+ ResourceSpecifier specifier = UIMAFramework.getXMLParser().parseResourceSpecifier(in);
+ // Create the Text Analysis Engine.
+ this.ae = UIMAFramework.produceAnalysisEngine(specifier, this.mgr, null);
+ }
+
+ /**
+ * change the parameter name for the given analysis engine.
+ *
+ * @param groupName
+ * group name, if no group is available, pass null
+ * @param paramName
+ * parameter name
+ * @param paramValue
+ * parameter value
+ * @throws ResourceConfigurationException
+ * passthru
+ */
+ public void changeParameterSetting(String groupName, String paramName, Object paramValue)
+ throws ResourceConfigurationException {
+ if (groupName == null) {
+ this.ae.setConfigParameterValue(paramName, paramValue);
+ } else {
+ this.ae.setConfigParameterValue(groupName, paramName, paramValue);
+ }
+ // call reconfigure to activate the change
+ this.ae.reconfigure();
+ }
+
+ /**
+ * change the parameter name for the given delegate analysis engine key.
+ *
+ * @param delegeteKey
+ * analysis engine key
+ * @param groupName
+ * group name
+ * @param paramName
+ * parameter name
+ * @param paramValue
+ * parameter value
+ * @throws InvalidXMLException
+ * passthru
+ * @throws ResourceInitializationException
+ * passthru
+ * @throws IOException
+ * passthru
+ */
+ public void changeDelegateParameterSetting(String delegeteKey, String groupName, String paramName,
+ Object paramValue)
+ throws InvalidXMLException, ResourceInitializationException, IOException {
+ // create CasConsumer description
+ AnalysisEngineDescription aeSpecifier = UIMAFramework.getXMLParser()
.parseAnalysisEngineDescription(new XMLInputSource(this.descFile));
- // get delegates
- Map delegates = aeSpecifier.getDelegateAnalysisEngineSpecifiers();
-
- // check if delegeteKey is available
- if (delegates.containsKey(delegeteKey)) {
- // create new import
- AnalysisEngineDescription delegate = (AnalysisEngineDescription) delegates
- .get(delegeteKey);
-
- if (groupName == null) {
- delegate.getMetaData().getConfigurationParameterSettings()
- .setParameterValue(paramName, paramValue);
- } else {
- delegate.getMetaData().getConfigurationParameterSettings()
- .setParameterValue(groupName, paramName, paramValue);
- }
+ // get delegates
+ Map delegates = aeSpecifier.getDelegateAnalysisEngineSpecifiers();
+
+ // check if delegeteKey is available
+ if (delegates.containsKey(delegeteKey)) {
+ // create new import
+ AnalysisEngineDescription delegate = (AnalysisEngineDescription) delegates.get(delegeteKey);
+
+ if (groupName == null) {
+ delegate.getMetaData().getConfigurationParameterSettings().setParameterValue(paramName,
+ paramValue);
+ } else {
+ delegate.getMetaData().getConfigurationParameterSettings().setParameterValue(groupName,
+ paramName, paramValue);
}
+ }
- // produce new AE
- this.ae = UIMAFramework
- .produceAnalysisEngine(aeSpecifier, this.mgr, null);
-
- }
-
- /**
- * does configuration parameter test.
- *
- * @param configDescFilePath the config desc file path
- * @return AnalysisEngine
- * @throws Exception passthru
- */
- public static AnalysisEngine doConfigurationTest(String configDescFilePath)
- throws Exception {
- AnalysisEngine ae = null;
- // Create an XML input source from the specifier file.
- XMLInputSource in = new XMLInputSource(configDescFilePath);
- // Parse the specifier.
- ResourceSpecifier specifier = UIMAFramework.getXMLParser()
- .parseResourceSpecifier(in);
- // Create the Text Analysis Engine.
- ae = UIMAFramework.produceAnalysisEngine(specifier, null, null);
-
- // Create a new CAS.
- CAS cas = ae.newCAS();
- // Set the document text on the CAS.
- cas
- .setDocumentText("This is a simple text to check if the configuration works");
- cas.setDocumentLanguage("en");
- // Process the sample document.
- ae.process(cas);
-
- return ae;
- }
-
- /**
- * Creates a new fresh CAS instance which can be used for testing.
- * @return a new fresh CAS instance which can be used for testing
- * @throws Exception passthru
- */
- public CAS createCAS() throws Exception {
- return ae.newCAS();
+ // produce new AE
+ this.ae = UIMAFramework.produceAnalysisEngine(aeSpecifier, this.mgr, null);
+
+ }
+
+ /**
+ * does configuration parameter test.
+ *
+ * @param configDescFilePath
+ * the config desc file path
+ * @return AnalysisEngine
+ * @throws Exception
+ * passthru
+ */
+ public static AnalysisEngine doConfigurationTest(String configDescFilePath) throws Exception {
+ AnalysisEngine ae = null;
+ // Create an XML input source from the specifier file.
+ XMLInputSource in = new XMLInputSource(configDescFilePath);
+ // Parse the specifier.
+ ResourceSpecifier specifier = UIMAFramework.getXMLParser().parseResourceSpecifier(in);
+ // Create the Text Analysis Engine.
+ ae = UIMAFramework.produceAnalysisEngine(specifier, null, null);
+
+ // Create a new CAS.
+ CAS cas = ae.newCAS();
+ // Set the document text on the CAS.
+ cas.setDocumentText("This is a simple text to check if the configuration works");
+ cas.setDocumentLanguage("en");
+ // Process the sample document.
+ ae.process(cas);
+
+ return ae;
+ }
+
+ /**
+ * Creates a new fresh CAS instance which can be used for testing.
+ *
+ * @return a new fresh CAS instance which can be used for testing
+ * @throws Exception
+ * passthru
+ */
+ public CAS createCAS() throws Exception {
+ return ae.newCAS();
+ }
+
+ /**
+ * performs a test on the initialized annotator. The specified document is processed with the
+ * given language.
+ *
+ * @param text
+ * a document text
+ * @param language
+ * the document text language
+ * @return CAS - results of the analysis
+ * @throws Exception
+ * passthru
+ */
+ public CAS performTest(String text, String language) throws Exception {
+ // Create a new CAS.
+ CAS cas = this.ae.newCAS();
+ // Set the document text on the CAS.
+ cas.setDocumentText(text);
+ cas.setDocumentLanguage(language);
+ // Process the sample document.
+ this.ae.process(cas);
+
+ return cas;
+ }
+
+ /**
+ * performs a test on the initialized annotator. The specified CAS is processed and the results
+ * are returned.
+ *
+ * @param cas
+ * a CAS for processing
+ * @return CAS - results of the analysis
+ * @throws Exception
+ * passthru
+ */
+ public CAS performTest(CAS cas) throws Exception {
+ // Process the sample document.
+ this.ae.process(cas);
+
+ return cas;
+ }
+
+ /**
+ * performs a test with a special annotator configuration. For this a new AE is created and used
+ * to process the specified document for the specified language.
+ *
+ * @param descFilePath
+ * Descriptor file path
+ * @param text
+ * a document text
+ * @param language
+ * the document text language
+ * @return CAS - results of the analysis
+ * @throws Exception
+ * passthru
+ */
+ public static CAS performTest(String descFilePath, String text, String language)
+ throws Exception {
+ AnalysisEngine ae = null;
+ // Create an XML input source from the specifier file.
+ XMLInputSource in = new XMLInputSource(descFilePath);
+ // Parse the specifier.
+ ResourceSpecifier specifier = UIMAFramework.getXMLParser().parseResourceSpecifier(in);
+ // Create the Text Analysis Engine.
+ ae = UIMAFramework.produceAnalysisEngine(specifier, null, null);
+
+ // Create a new CAS.
+ CAS cas = ae.newCAS();
+ // Set the document text on the CAS.
+ cas.setDocumentText(text);
+ cas.setDocumentLanguage(language);
+ // Process the sample document.
+ ae.process(cas);
+
+ return cas;
+ }
+
+ /**
+ * create a CAS object from the given XCAS and typesystem files.
+ *
+ * @param tsFile
+ * - a typesystem file
+ * @param xcasFile
+ * - a xcas file
+ * @return CAS - CAS object created from the given input data
+ * @throws Exception
+ * passthru
+ */
+ public static CAS getCASfromXCAS(File tsFile, File xcasFile) throws Exception {
+ Object tsDescriptor = UIMAFramework.getXMLParser().parse(new XMLInputSource(tsFile));
+ TypeSystemDescription tsDesc = (TypeSystemDescription) tsDescriptor;
+ CAS cas = CasCreationUtils.createCas(tsDesc, null, new FsIndexDescription[0]);
+
+ SAXParser parser = XMLUtils.createSAXParserFactory().newSAXParser();
+ XCASDeserializer xcasDeserializer = new XCASDeserializer(cas.getTypeSystem());
+ parser.parse(xcasFile, xcasDeserializer.getXCASHandler(cas));
+
+ return cas;
+ }
+
+ /**
+ * Reads the content form a file to a String with respect to the file encoding.
+ *
+ * @param file
+ * a file with the source
+ * @param encoding
+ * file encoding
+ * @return String - file content
+ * @throws Exception
+ * passthru
+ */
+ public static String readFileContent(File file, String encoding) throws Exception {
+ return FileUtils.file2String(file, encoding);
+ }
+
+ /**
+ * checkResult compares the analyzed document with the reference output.
+ *
+ * @param cas
+ * a cas with the analyzed data
+ * @param AnnotationTypes
+ * respected annotation types
+ * @param refFile
+ * reference output
+ * @param testFile
+ * test file for the current output
+ * @throws Exception
+ * passthru
+ */
+ public static void checkResult(CAS cas, String[] AnnotationTypes, File refFile, File testFile)
+ throws Exception {
+
+ testFile.delete(); // delete file if exist
+ testFile.createNewFile(); // create new file
+
+ // Create an XML input source from the specifier file.
+ XMLInputSource in = new XMLInputSource(JUnitExtension.getURL("AnnotationWriter.xml"));
+ // Parse the specifier.
+ ResourceSpecifier specifier = UIMAFramework.getXMLParser().parseResourceSpecifier(in);
+
+ CasConsumer consumer = UIMAFramework.produceCasConsumer(specifier);
+
+ consumer.setConfigParameterValue("AnnotationTypes", AnnotationTypes);
+
+ consumer.setConfigParameterValue("outputFile", testFile.getAbsolutePath());
+
+ consumer.reconfigure();
+
+ consumer.processCas(cas);
+ consumer.destroy();
+
+ // check file output
+ boolean isIdentical = FileCompare.compare(refFile, testFile);
+
+ if (isIdentical) {
+ testFile.delete();
}
-
- /**
- * performs a test on the initialized annotator. The specified document is
- * processed with the given language.
- *
- * @param text
- * a document text
- * @param language
- * the document text language
- * @return CAS - results of the analysis
- * @throws Exception passthru
- */
- public CAS performTest(String text, String language) throws Exception {
- // Create a new CAS.
- CAS cas = this.ae.newCAS();
- // Set the document text on the CAS.
- cas.setDocumentText(text);
- cas.setDocumentLanguage(language);
- // Process the sample document.
- this.ae.process(cas);
-
- return cas;
- }
-
- /**
- * performs a test on the initialized annotator. The specified CAS is
- * processed and the results are returned.
- *
- * @param cas
- * a CAS for processing
- * @return CAS - results of the analysis
- * @throws Exception passthru
- */
- public CAS performTest(CAS cas) throws Exception {
- // Process the sample document.
- this.ae.process(cas);
-
- return cas;
- }
-
- /**
- * performs a test with a special annotator configuration. For this a new AE
- * is created and used to process the specified document for the specified
- * language.
- *
- * @param descFilePath
- * Descriptor file path
- * @param text
- * a document text
- * @param language
- * the document text language
- * @return CAS - results of the analysis
- * @throws Exception passthru
- */
- public static CAS performTest(String descFilePath, String text,
- String language) throws Exception {
- AnalysisEngine ae = null;
- // Create an XML input source from the specifier file.
- XMLInputSource in = new XMLInputSource(descFilePath);
- // Parse the specifier.
- ResourceSpecifier specifier = UIMAFramework.getXMLParser()
- .parseResourceSpecifier(in);
- // Create the Text Analysis Engine.
- ae = UIMAFramework.produceAnalysisEngine(specifier, null, null);
-
- // Create a new CAS.
- CAS cas = ae.newCAS();
- // Set the document text on the CAS.
- cas.setDocumentText(text);
- cas.setDocumentLanguage(language);
- // Process the sample document.
- ae.process(cas);
-
- return cas;
- }
-
- /**
- * create a CAS object from the given XCAS and typesystem files.
- *
- * @param tsFile -
- * a typesystem file
- * @param xcasFile -
- * a xcas file
- * @return CAS - CAS object created from the given input data
- * @throws Exception passthru
- */
- public static CAS getCASfromXCAS(File tsFile, File xcasFile)
- throws Exception {
- Object tsDescriptor = UIMAFramework.getXMLParser().parse(
- new XMLInputSource(tsFile));
- TypeSystemDescription tsDesc = (TypeSystemDescription) tsDescriptor;
- CAS cas = CasCreationUtils.createCas(tsDesc, null,
- new FsIndexDescription[0]);
-
- SAXParser parser = XMLUtils.createSAXParserFactory().newSAXParser();
- XCASDeserializer xcasDeserializer = new XCASDeserializer(cas
- .getTypeSystem());
- parser.parse(xcasFile, xcasDeserializer.getXCASHandler(cas));
-
- return cas;
- }
-
- /**
- * Reads the content form a file to a String with respect to the file
- * encoding.
- *
- * @param file
- * a file with the source
- * @param encoding
- * file encoding
- * @return String - file content
- * @throws Exception passthru
- */
- public static String readFileContent(File file, String encoding)
- throws Exception {
- return FileUtils.file2String(file, encoding);
- }
-
- /**
- * checkResult compares the analyzed document with the reference output.
- *
- * @param cas
- * a cas with the analyzed data
- * @param AnnotationTypes
- * respected annotation types
- * @param refFile
- * reference output
- * @param testFile
- * test file for the current output
- * @throws Exception passthru
- */
- public static void checkResult(CAS cas, String[] AnnotationTypes,
- File refFile, File testFile) throws Exception {
-
- testFile.delete(); // delete file if exist
- testFile.createNewFile(); // create new file
-
- // Create an XML input source from the specifier file.
- XMLInputSource in = new XMLInputSource(JUnitExtension
- .getURL("AnnotationWriter.xml"));
- // Parse the specifier.
- ResourceSpecifier specifier = UIMAFramework.getXMLParser()
- .parseResourceSpecifier(in);
-
- CasConsumer consumer = UIMAFramework.produceCasConsumer(specifier);
-
- consumer.setConfigParameterValue("AnnotationTypes", AnnotationTypes);
-
- consumer.setConfigParameterValue("outputFile", testFile
- .getAbsolutePath());
-
- consumer.reconfigure();
-
- consumer.processCas(cas);
- consumer.destroy();
-
- // check file output
- boolean isIdentical = FileCompare.compare(refFile, testFile);
-
- if (isIdentical) {
- testFile.delete();
- }
-
- Assert.assertTrue(isIdentical);
- }
+
+ Assert.assertTrue(isIdentical);
+ }
}
diff --git a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/PerformanceTestResult.java b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/PerformanceTestResult.java
index d0da3db..511b0e8 100644
--- a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/PerformanceTestResult.java
+++ b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/PerformanceTestResult.java
@@ -23,20 +23,19 @@ import java.io.File;
import org.apache.uima.internal.util.TimeSpan;
-
/**
* PerformanceTestResult interfance contains all the methods to access the performance test results.
*
*/
public interface PerformanceTestResult {
- /**
- * Gets the number of processed characters.
- *
- * @return Returns the number of processed characters.
- */
+ /**
+ * Gets the number of processed characters.
+ *
+ * @return Returns the number of processed characters.
+ */
int getNumberOfProcessedCharacters();
-
+
/**
* Gets the number of processed files.
*
@@ -50,7 +49,7 @@ public interface PerformanceTestResult {
* @return Returns the UIMA datapath setting used for the performance test.
*/
String getUIMADatapath();
-
+
/**
* Gets the ae init time.
*
@@ -136,10 +135,11 @@ public interface PerformanceTestResult {
* @param file
* Output file where the results are written to
*
- * @throws Exception passthru
+ * @throws Exception
+ * passthru
*/
void writePerfResultsAsColumn(String level, File file) throws Exception;
-
+
/**
* Gets the ae cleanup time.
*
diff --git a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/PerformanceTestResultImpl.java b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/PerformanceTestResultImpl.java
index 8f6a15f..d741da5 100644
--- a/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/PerformanceTestResultImpl.java
+++ b/uimaj-component-test-util/src/main/java/org/apache/uima/test/junit_extension/PerformanceTestResultImpl.java
@@ -26,10 +26,9 @@ import java.util.GregorianCalendar;
import org.apache.uima.internal.util.TimeSpan;
-
/**
- * PerformanceTestResultImpl implements the PerformanceTestResult interface and provides the results of a performance
- * test run.
+ * PerformanceTestResultImpl implements the PerformanceTestResult interface and provides the results
+ * of a performance test run.
*
*/
public class PerformanceTestResultImpl implements PerformanceTestResult {
@@ -88,8 +87,11 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/** The document preparation time. */
private TimeSpan documentPreparationTime = null;
- /* (non-Javadoc)
- * @see org.apache.uima.test.junit_extension.PerformanceTestResult#getNumberOfProcessedCharacters()
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.apache.uima.test.junit_extension.PerformanceTestResult#getNumberOfProcessedCharacters()
*/
@Override
public int getNumberOfProcessedCharacters() {
@@ -99,13 +101,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the number of characters.
*
- * @param numberOfCharacters The number of characters.
+ * @param numberOfCharacters
+ * The number of characters.
*/
public void setNumberOfCharacters(int numberOfCharacters) {
this.numberOfCharacters = numberOfCharacters;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getNumberOfProcessedFiles()
*/
@Override
@@ -116,13 +121,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the number of files.
*
- * @param numberOfFiles The number of files.
+ * @param numberOfFiles
+ * The number of files.
*/
public void setNumberOfFiles(int numberOfFiles) {
this.numberOfFiles = numberOfFiles;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getUIMADatapath()
*/
@Override
@@ -133,13 +141,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the datapath.
*
- * @param datapath The UIMA datapath.
+ * @param datapath
+ * The UIMA datapath.
*/
public void setDatapath(String datapath) {
this.datapath = datapath;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getAeInitTime()
*/
@Override
@@ -150,13 +161,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the inits the time.
*
- * @param initTime The analysis engine init time.
+ * @param initTime
+ * The analysis engine init time.
*/
public void setInitTime(TimeSpan initTime) {
this.initTime = initTime;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getFileIoTime()
*/
@Override
@@ -167,13 +181,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the io time.
*
- * @param ioTime The file io time to set.
+ * @param ioTime
+ * The file io time to set.
*/
public void setIoTime(TimeSpan ioTime) {
this.ioTime = ioTime;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getNumberOfCreatedAnnotations()
*/
@Override
@@ -184,13 +201,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the number of created annotations.
*
- * @param numberOfCreatedAnnotations The number of created annotations to set.
+ * @param numberOfCreatedAnnotations
+ * The number of created annotations to set.
*/
public void setNumberOfCreatedAnnotations(int numberOfCreatedAnnotations) {
this.numberOfCreatedAnnotations = numberOfCreatedAnnotations;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getNumberOfRepeatedRuns()
*/
@Override
@@ -201,13 +221,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the nums to run.
*
- * @param numsToRun The number of repeated runs.
+ * @param numsToRun
+ * The number of repeated runs.
*/
public void setNumsToRun(int numsToRun) {
this.numsToRun = numsToRun;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getOverallTime()
*/
@Override
@@ -218,13 +241,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the overall time.
*
- * @param overallTime The overall processing time.
+ * @param overallTime
+ * The overall processing time.
*/
public void setOverallTime(TimeSpan overallTime) {
this.overallTime = overallTime;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getAeProcessingTime()
*/
@Override
@@ -235,13 +261,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the processing time.
*
- * @param processingTime The analysis engine processing time.
+ * @param processingTime
+ * The analysis engine processing time.
*/
public void setProcessingTime(TimeSpan processingTime) {
this.processingTime = processingTime;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#isRepeatSingleMode()
*/
@Override
@@ -252,13 +281,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the repeat single mode.
*
- * @param repeatSingleMode The repeat single mode setting
+ * @param repeatSingleMode
+ * The repeat single mode setting
*/
public void setRepeatSingleMode(boolean repeatSingleMode) {
this.repeatSingleMode = repeatSingleMode;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getAeDescFilePath()
*/
@Override
@@ -269,13 +301,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the ae desc file path.
*
- * @param aeDescFile The analysis engine descriptor file.
+ * @param aeDescFile
+ * The analysis engine descriptor file.
*/
public void setAeDescFilePath(File aeDescFile) {
this.aeDescFile = aeDescFile;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getTestFileDirectoryPath()
*/
@Override
@@ -286,13 +321,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the test file dir.
*
- * @param testFileDir The test file directory.
+ * @param testFileDir
+ * The test file directory.
*/
public void setTestFileDir(File testFileDir) {
this.testFileDir = testFileDir;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getAeWarmupTime()
*/
@Override
@@ -303,13 +341,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the warmup time.
*
- * @param warmupTime The analysis engine warmup time.
+ * @param warmupTime
+ * The analysis engine warmup time.
*/
public void setWarmupTime(TimeSpan warmupTime) {
this.warmupTime = warmupTime;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#isDoAeWarmup()
*/
@Override
@@ -320,7 +361,8 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the do warmup.
*
- * @param doWarmup the doWarmup setting
+ * @param doWarmup
+ * the doWarmup setting
*/
public void setDoWarmup(boolean doWarmup) {
this.doWarmup = doWarmup;
@@ -344,9 +386,10 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
resultString.append("Use " + this.aeDescFile.getAbsolutePath() + " descriptor" + NEWLINE);
resultString.append("Fileset " + this.testFileDir + " is used" + NEWLINE);
resultString.append("Datapath setting is: " + this.datapath + NEWLINE);
- resultString.append("Number of documents (overall): " + this.getNumberOfProcessedFiles() + NEWLINE);
resultString
- .append("Number of characters (overall): " + this.getNumberOfProcessedCharacters() + NEWLINE);
+ .append("Number of documents (overall): " + this.getNumberOfProcessedFiles() + NEWLINE);
+ resultString.append(
+ "Number of characters (overall): " + this.getNumberOfProcessedCharacters() + NEWLINE);
resultString.append("Total document size (overall): "
+ (float) (this.getProcessedFileSize() / 1024) + " KB" + NEWLINE);
resultString.append(NEWLINE + "Initialize: " + NEWLINE);
@@ -361,10 +404,11 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
resultString.append("Analysis Engine processing time: " + this.processingTime + NEWLINE);
if (this.processingTime.getFullMilliseconds() > 0 && this.getProcessedFileSize() > 0) {
resultString.append("Processing throughput: "
- + (long) ((this.getProcessedFileSize() / 1024) / ((float) this.processingTime
- .getFullMilliseconds() / 1000)) + " KB/s" + NEWLINE);
- long mbPerSecond = (long) ((this.getProcessedFileSize() / 1024 / 1024) / ((float) this.processingTime
- .getFullMilliseconds() / 1000 / 60 / 60));
+ + (long) ((this.getProcessedFileSize() / 1024)
+ / ((float) this.processingTime.getFullMilliseconds() / 1000))
+ + " KB/s" + NEWLINE);
+ long mbPerSecond = (long) ((this.getProcessedFileSize() / 1024 / 1024)
+ / ((float) this.processingTime.getFullMilliseconds() / 1000 / 60 / 60));
resultString.append("Processing throughput: " + mbPerSecond + " MB/h" + NEWLINE);
}
@@ -385,7 +429,8 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
* @param file
* Output file where the results are written to
*
- * @throws Exception passthru
+ * @throws Exception
+ * passthru
*/
@Override
public void writePerfResultsAsColumn(String level, File file) throws Exception {
@@ -441,8 +486,8 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
FileWriter fileWriter = new FileWriter(file, true);
if (writeHeader) {
- fileWriter
- .write("Timestamp ; Levelname ; singleMode ; warmup; Docs ; Annotations ; Processing time ; init time ; io time");
+ fileWriter.write(
+ "Timestamp ; Levelname ; singleMode ; warmup; Docs ; Annotations ; Processing time ; init time ; io time");
fileWriter.write(System.getProperty("line.separator"));
}
@@ -454,7 +499,9 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
fileWriter.close();
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getAeCleanupTime()
*/
@Override
@@ -465,13 +512,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the cleanup time.
*
- * @param cleanupTime the analysis engine cleanup time
+ * @param cleanupTime
+ * the analysis engine cleanup time
*/
public void setCleanupTime(TimeSpan cleanupTime) {
this.cleanupTime = cleanupTime;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getDocumentPreparationTime()
*/
@Override
@@ -482,13 +532,16 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the document preparation time.
*
- * @param documentPreparationTime the document preparation time
+ * @param documentPreparationTime
+ * the document preparation time
*/
public void setDocumentPreparationTime(TimeSpan documentPreparationTime) {
this.documentPreparationTime = documentPreparationTime;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.apache.uima.test.junit_extension.PerformanceTestResult#getProcessedFileSize()
*/
@Override
@@ -499,7 +552,8 @@ public class PerformanceTestResultImpl implements PerformanceTestResult {
/**
* Sets the total file size.
*
- * @param collectionFileSize the collection file size
+ * @param collectionFileSize
+ * the collection file size
*/
public void setTotalFileSize(long collectionFileSize) {
this.collectionFileSize = collectionFileSize;
[uima-uimaj] 09/15: [UIMA-6373] Format UIMA Core Java SDK codebase
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rec pushed a commit to branch refactoring/UIMA-6373-Format-UIMA-Core-Java-SDK-codebase
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git
commit 154a0bff692a2a00e43ab09b78bf80b465ed6634
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Feb 10 15:14:17 2022 +0100
[UIMA-6373] Format UIMA Core Java SDK codebase
- Auto-format
---
.../java/org/apache/uima/ep_debug/DebugPlugin.java | 70 +++++++++++-----------
.../apache/uima/ep_debug/DebugPluginStartup.java | 24 ++++----
2 files changed, 49 insertions(+), 45 deletions(-)
diff --git a/uimaj-ep-debug/src/main/java/org/apache/uima/ep_debug/DebugPlugin.java b/uimaj-ep-debug/src/main/java/org/apache/uima/ep_debug/DebugPlugin.java
index f391903..4744144 100644
--- a/uimaj-ep-debug/src/main/java/org/apache/uima/ep_debug/DebugPlugin.java
+++ b/uimaj-ep-debug/src/main/java/org/apache/uima/ep_debug/DebugPlugin.java
@@ -38,44 +38,46 @@ public class DebugPlugin extends Plugin {
public DebugPlugin() {
plugin = this;
}
-
-// next moved to DebugPluginStartup class, per change in Eclipse Platform Design
-// /**
-// * This method is called upon plug-in activation.
-// *
-// * @param context the context
-// * @throws Exception the exception
-// */
-// @Override
-// public void start(BundleContext context) throws Exception {
-// super.start(context);
-// // Intent of next code
-// // For users installing this plugin for the first time, set the pref-show-details preference,
-// // but only once (per fresh workspace) - to allow it to be set to the value which makes
-// // debugging
-// // display work, initially, but allowing the user to set it to something else without having
-// // this
-// // be overridden every time the pluging starts.
-// String doneOnce = JDIDebugUIPlugin.getDefault().getPreferenceStore().getString(
-// PREF_ALREADY_SET_PREF_SHOW_DETAILS);
-// if (ALREADY_SET_PREF_SHOW_DETAILS.equals(doneOnce))
-// return;
-// JDIDebugUIPlugin.getDefault().getPreferenceStore().setValue(PREF_ALREADY_SET_PREF_SHOW_DETAILS,
-// ALREADY_SET_PREF_SHOW_DETAILS);
-//
-// String preference = JDIDebugUIPlugin.getDefault().getPreferenceStore().getString(
-// IJDIPreferencesConstants.PREF_SHOW_DETAILS);
-// if (IJDIPreferencesConstants.INLINE_ALL.equals(preference))
-// return;
-// JDIDebugUIPlugin.getDefault().getPreferenceStore().setValue(
-// IJDIPreferencesConstants.PREF_SHOW_DETAILS, IJDIPreferencesConstants.INLINE_ALL);
-// }
+
+ // next moved to DebugPluginStartup class, per change in Eclipse Platform Design
+ // /**
+ // * This method is called upon plug-in activation.
+ // *
+ // * @param context the context
+ // * @throws Exception the exception
+ // */
+ // @Override
+ // public void start(BundleContext context) throws Exception {
+ // super.start(context);
+ // // Intent of next code
+ // // For users installing this plugin for the first time, set the pref-show-details preference,
+ // // but only once (per fresh workspace) - to allow it to be set to the value which makes
+ // // debugging
+ // // display work, initially, but allowing the user to set it to something else without having
+ // // this
+ // // be overridden every time the pluging starts.
+ // String doneOnce = JDIDebugUIPlugin.getDefault().getPreferenceStore().getString(
+ // PREF_ALREADY_SET_PREF_SHOW_DETAILS);
+ // if (ALREADY_SET_PREF_SHOW_DETAILS.equals(doneOnce))
+ // return;
+ // JDIDebugUIPlugin.getDefault().getPreferenceStore().setValue(PREF_ALREADY_SET_PREF_SHOW_DETAILS,
+ // ALREADY_SET_PREF_SHOW_DETAILS);
+ //
+ // String preference = JDIDebugUIPlugin.getDefault().getPreferenceStore().getString(
+ // IJDIPreferencesConstants.PREF_SHOW_DETAILS);
+ // if (IJDIPreferencesConstants.INLINE_ALL.equals(preference))
+ // return;
+ // JDIDebugUIPlugin.getDefault().getPreferenceStore().setValue(
+ // IJDIPreferencesConstants.PREF_SHOW_DETAILS, IJDIPreferencesConstants.INLINE_ALL);
+ // }
/**
* This method is called when the plug-in is stopped.
*
- * @param context the context
- * @throws Exception the exception
+ * @param context
+ * the context
+ * @throws Exception
+ * the exception
*/
@Override
public void stop(BundleContext context) throws Exception {
diff --git a/uimaj-ep-debug/src/main/java/org/apache/uima/ep_debug/DebugPluginStartup.java b/uimaj-ep-debug/src/main/java/org/apache/uima/ep_debug/DebugPluginStartup.java
index 30de1e7..ed47779 100644
--- a/uimaj-ep-debug/src/main/java/org/apache/uima/ep_debug/DebugPluginStartup.java
+++ b/uimaj-ep-debug/src/main/java/org/apache/uima/ep_debug/DebugPluginStartup.java
@@ -24,8 +24,8 @@ import org.eclipse.jdt.internal.debug.ui.JDIDebugUIPlugin;
import org.eclipse.ui.IStartup;
/**
- * The class that has the startup code.
- * Per Eclipse platform design, it must be in a different class than the main plugin code.
+ * The class that has the startup code. Per Eclipse platform design, it must be in a different class
+ * than the main plugin code.
*/
public class DebugPluginStartup implements IStartup {
@@ -34,10 +34,12 @@ public class DebugPluginStartup implements IStartup {
/** The Constant ALREADY_SET_PREF_SHOW_DETAILS. */
public static final String ALREADY_SET_PREF_SHOW_DETAILS = "already_set_pref_show_details";
-
- /* (non-Javadoc)
- * @see org.eclipse.ui.IStartup#earlyStartup()
- * This method will be called on a different thread after the workbench initializes.
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.eclipse.ui.IStartup#earlyStartup() This method will be called on a different thread
+ * after the workbench initializes.
*/
@Override
public void earlyStartup() {
@@ -48,19 +50,19 @@ public class DebugPluginStartup implements IStartup {
// display work, initially, but allowing the user to set it to something else without having
// this
// be overridden every time the pluging starts.
- String doneOnce = JDIDebugUIPlugin.getDefault().getPreferenceStore().getString(
- PREF_ALREADY_SET_PREF_SHOW_DETAILS);
+ String doneOnce = JDIDebugUIPlugin.getDefault().getPreferenceStore()
+ .getString(PREF_ALREADY_SET_PREF_SHOW_DETAILS);
if (ALREADY_SET_PREF_SHOW_DETAILS.equals(doneOnce))
return;
JDIDebugUIPlugin.getDefault().getPreferenceStore().setValue(PREF_ALREADY_SET_PREF_SHOW_DETAILS,
ALREADY_SET_PREF_SHOW_DETAILS);
- String preference = JDIDebugUIPlugin.getDefault().getPreferenceStore().getString(
- IJDIPreferencesConstants.PREF_SHOW_DETAILS);
+ String preference = JDIDebugUIPlugin.getDefault().getPreferenceStore()
+ .getString(IJDIPreferencesConstants.PREF_SHOW_DETAILS);
if (IJDIPreferencesConstants.INLINE_ALL.equals(preference))
return;
JDIDebugUIPlugin.getDefault().getPreferenceStore().setValue(
- IJDIPreferencesConstants.PREF_SHOW_DETAILS, IJDIPreferencesConstants.INLINE_ALL);
+ IJDIPreferencesConstants.PREF_SHOW_DETAILS, IJDIPreferencesConstants.INLINE_ALL);
}
}