Merge pull request #4031 from inception-project/refactoring/4030-Move…

…-AnnotatorJS-code-to-different-package #4030 - Move AnnotatorJS code to different package
inception-project · May 29, 2023 · 9ab916a · 9ab916a
2 parents 118cb69 + 777d906
commit 9ab916a
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 19 deletions.
diff --git a/...orjs/AnnotatorJsHtmlAnnotationEditor.java → ...orjs/AnnotatorJsHtmlAnnotationEditor.java b/...orjs/AnnotatorJsHtmlAnnotationEditor.java → ...orjs/AnnotatorJsHtmlAnnotationEditor.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package de.tudarmstadt.ukp.inception.htmleditor.annotatorjs;
+package de.tudarmstadt.ukp.inception.annotatorjs;
 
 import static de.tudarmstadt.ukp.clarin.webanno.support.wicket.ServletContextUtils.referenceToUrl;
 import static java.util.Arrays.asList;
@@ -29,13 +29,13 @@
 
 import de.tudarmstadt.ukp.clarin.webanno.api.CasProvider;
 import de.tudarmstadt.ukp.clarin.webanno.api.DocumentService;
+import de.tudarmstadt.ukp.inception.annotatorjs.resources.AnnotatorJsCssResourceReference;
+import de.tudarmstadt.ukp.inception.annotatorjs.resources.AnnotatorJsJavascriptResourceReference;
 import de.tudarmstadt.ukp.inception.editor.AnnotationEditorFactory;
 import de.tudarmstadt.ukp.inception.editor.action.AnnotationActionHandler;
 import de.tudarmstadt.ukp.inception.editor.view.DocumentViewFactory;
 import de.tudarmstadt.ukp.inception.externaleditor.ExternalAnnotationEditorBase;
 import de.tudarmstadt.ukp.inception.externaleditor.model.AnnotationEditorProperties;
-import de.tudarmstadt.ukp.inception.htmleditor.annotatorjs.resources.AnnotatorJsCssResourceReference;
-import de.tudarmstadt.ukp.inception.htmleditor.annotatorjs.resources.AnnotatorJsJavascriptResourceReference;
 import de.tudarmstadt.ukp.inception.rendering.editorstate.AnnotatorState;
 
 public class AnnotatorJsHtmlAnnotationEditor

diff --git a/...notatorJsHtmlAnnotationEditorFactory.java → ...notatorJsHtmlAnnotationEditorFactory.java b/...notatorJsHtmlAnnotationEditorFactory.java → ...notatorJsHtmlAnnotationEditorFactory.java
@@ -15,17 +15,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package de.tudarmstadt.ukp.inception.htmleditor.annotatorjs;
+package de.tudarmstadt.ukp.inception.annotatorjs;
 
 import org.apache.wicket.model.IModel;
 
 import de.tudarmstadt.ukp.clarin.webanno.api.CasProvider;
 import de.tudarmstadt.ukp.clarin.webanno.api.annotation.paging.NoPagingStrategy;
 import de.tudarmstadt.ukp.clarin.webanno.model.Project;
+import de.tudarmstadt.ukp.inception.annotatorjs.config.AnnotatorJsAnnotationEditorSupportAutoConfiguration;
 import de.tudarmstadt.ukp.inception.editor.AnnotationEditorBase;
 import de.tudarmstadt.ukp.inception.editor.AnnotationEditorFactoryImplBase;
 import de.tudarmstadt.ukp.inception.editor.action.AnnotationActionHandler;
-import de.tudarmstadt.ukp.inception.htmleditor.config.HtmlAnnotationEditorSupportAutoConfiguration;
 import de.tudarmstadt.ukp.inception.io.html.HtmlFormatSupport;
 import de.tudarmstadt.ukp.inception.io.html.LegacyHtmlFormatSupport;
 import de.tudarmstadt.ukp.inception.rendering.editorstate.AnnotatorState;
@@ -34,7 +34,7 @@
  * Support for HTML-oriented editor component.
  * <p>
  * This class is exposed as a Spring Component via
- * {@link HtmlAnnotationEditorSupportAutoConfiguration#htmlAnnotationEditorFactory()}.
+ * {@link AnnotatorJsAnnotationEditorSupportAutoConfiguration#annotatorJsHtmlAnnotationEditorFactory()}.
  * </p>
  */
 public class AnnotatorJsHtmlAnnotationEditorFactory

diff --git a/...ukp/inception/annotatorjs/config/AnnotatorJsAnnotationEditorSupportAutoConfiguration.java b/...ukp/inception/annotatorjs/config/AnnotatorJsAnnotationEditorSupportAutoConfiguration.java
@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Technische Universität Darmstadt under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The Technische Universität Darmstadt 
+ * licenses this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.
+ *  
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package de.tudarmstadt.ukp.inception.annotatorjs.config;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import de.tudarmstadt.ukp.inception.annotatorjs.AnnotatorJsHtmlAnnotationEditorFactory;
+
+/**
+ * Provides support for an AnnotatorJS-based HTML-oriented annotation editor.
+ */
+@ConditionalOnWebApplication
+@Configuration
+public class AnnotatorJsAnnotationEditorSupportAutoConfiguration
+{
+    @ConditionalOnProperty(prefix = "ui.html-annotatorjs", name = "enabled", //
+            havingValue = "true", matchIfMissing = false)
+    @Bean
+    public AnnotatorJsHtmlAnnotationEditorFactory annotatorJsHtmlAnnotationEditorFactory()
+    {
+        return new AnnotatorJsHtmlAnnotationEditorFactory();
+    }
+}
diff --git a/...rces/AnnotatorJsCssResourceReference.java → ...rces/AnnotatorJsCssResourceReference.java b/...rces/AnnotatorJsCssResourceReference.java → ...rces/AnnotatorJsCssResourceReference.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package de.tudarmstadt.ukp.inception.htmleditor.annotatorjs.resources;
+package de.tudarmstadt.ukp.inception.annotatorjs.resources;
 
 import org.apache.wicket.request.resource.CssResourceReference;
 

diff --git a/...notatorJsJavascriptResourceReference.java → ...notatorJsJavascriptResourceReference.java b/...notatorJsJavascriptResourceReference.java → ...notatorJsJavascriptResourceReference.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package de.tudarmstadt.ukp.inception.htmleditor.annotatorjs.resources;
+package de.tudarmstadt.ukp.inception.annotatorjs.resources;
 
 import org.apache.wicket.request.resource.JavaScriptResourceReference;
 

diff --git a/...rmstadt/ukp/inception/htmleditor/config/HtmlAnnotationEditorSupportAutoConfiguration.java b/...rmstadt/ukp/inception/htmleditor/config/HtmlAnnotationEditorSupportAutoConfiguration.java
@@ -22,7 +22,6 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-import de.tudarmstadt.ukp.inception.htmleditor.annotatorjs.AnnotatorJsHtmlAnnotationEditorFactory;
 import de.tudarmstadt.ukp.inception.htmleditor.docview.HtmlDocumentIFrameViewFactory;
 
 /**
@@ -32,14 +31,6 @@
 @Configuration
 public class HtmlAnnotationEditorSupportAutoConfiguration
 {
-    @ConditionalOnProperty(prefix = "ui.html-annotatorjs", name = "enabled", //
-            havingValue = "true", matchIfMissing = false)
-    @Bean
-    public AnnotatorJsHtmlAnnotationEditorFactory htmlAnnotationEditorFactory()
-    {
-        return new AnnotatorJsHtmlAnnotationEditorFactory();
-    }
-
     @ConditionalOnProperty(prefix = "ui.html.legacy-iframe-view", name = "enabled", //
             havingValue = "true", matchIfMissing = false)
     @Bean

diff --git a/inception/inception-html-editor/src/main/resources/META-INF/spring.factories b/inception/inception-html-editor/src/main/resources/META-INF/spring.factories
diff --git a/...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
@@ -0,0 +1,2 @@
+de.tudarmstadt.ukp.inception.htmleditor.config.HtmlAnnotationEditorSupportAutoConfiguration
+de.tudarmstadt.ukp.inception.annotatorjs.config.AnnotatorJsAnnotationEditorSupportAutoConfiguration
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		de.tudarmstadt.ukp.inception.htmleditor.config.HtmlAnnotationEditorSupportAutoConfiguration
		de.tudarmstadt.ukp.inception.annotatorjs.config.AnnotatorJsAnnotationEditorSupportAutoConfiguration