#10 - Using WordNet as Maven Dependency

- Fixed default resource file
- Added possibility to set custom workspace via a system property, very useful in unit tests

de.tudarmstadt.ukp.dkpro.lexsemresource.api-asl/src/main/java/de/tudarmstadt/ukp/dkpro/lexsemresource/LSRFramework.java

@@ -0,0 +1,56 @@
+/*******************************************************************************
+ * Copyright 2018
+ * Ubiquitous Knowledge Processing (UKP) Lab
+ * Technische Universität Darmstadt
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   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.dkpro.lexsemresource;
+
+import java.io.File;
+
+public class LSRFramework
+{
+    public static final String ENV_DKPRO_HOME = "DKPRO_HOME";
+    public static final String SYS_LSR_WORKSPACE = "dkpro.lsr.workspace";
+
+    private static File workspace;
+
+    public static void setWorkspace(File aWorkspace)
+    {
+        workspace = aWorkspace;
+    }
+
+    /**
+     * Get the workspace directory.
+     *
+     * @return the workspace directory.
+     */
+    public static File getWorkspace()
+    {
+        if (workspace != null) {
+            return workspace;
+        }
+
+        if (System.getProperty(SYS_LSR_WORKSPACE) != null) {
+            return new File(System.getProperty(SYS_LSR_WORKSPACE));
+        }
+
+        if (System.getenv(ENV_DKPRO_HOME) != null) {
+            return new File(System.getenv(ENV_DKPRO_HOME));
+        }
+
+        throw new IllegalStateException(
+                "Environment variable or system property [" + ENV_DKPRO_HOME + "] not set");
+    }
+}

de.tudarmstadt.ukp.dkpro.lexsemresource.core-asl/src/main/java/de/tudarmstadt/ukp/dkpro/lexsemresource/core/ResourceFactory.java

@@ -27,6 +27,7 @@
 
 import org.springframework.context.support.FileSystemXmlApplicationContext;
 
+import de.tudarmstadt.ukp.dkpro.lexsemresource.LSRFramework;
 import de.tudarmstadt.ukp.dkpro.lexsemresource.LexicalSemanticResource;
 import de.tudarmstadt.ukp.dkpro.lexsemresource.exception.ResourceLoaderException;
 
@@ -38,7 +39,6 @@
  */
 public class ResourceFactory
 {
-	public static final String ENV_DKPRO_HOME = "DKPRO_HOME";
 	public final static String CONFIG_FILE = "resources.xml";
     public final static String DEFAULT_CONFIG_FILE = "/de/tudarmstadt/ukp/dkpro/lexsemresource/core/default-resources.xml";
 
@@ -152,15 +152,8 @@ public Collection<LexicalSemanticResource> getAll()
 	 * @return the workspace directory.
 	 * @throws IOException if the workspace cannot be obtained
 	 */
-	private static
-	File getWorkspace()
-	throws IOException
+    private static File getWorkspace() throws IOException
 	{
-		if (System.getenv(ENV_DKPRO_HOME) != null) {
-			File f = new File(System.getenv(ENV_DKPRO_HOME));
-			return new File(f, ResourceFactory.class.getName());
-		}
-
-		throw new IOException("Environment variable ["+ENV_DKPRO_HOME+"] not set");
+        return new File(LSRFramework.getWorkspace(), ResourceFactory.class.getName());
 	}
 }

de.tudarmstadt.ukp.dkpro.lexsemresource.core-asl/src/main/resources/de/tudarmstadt/ukp/dkpro/lexsemresource/core/default-resources.xml

@@ -2,7 +2,7 @@
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
 
-  <bean id="wordnet-en" lazy-init="true"
-    class="de.tudarmstadt.ukp.lexsemresource.resource.WordNetResource">
+  <bean id="wordnet-default-en" lazy-init="true"
+    class="de.tudarmstadt.ukp.dkpro.lexsemresource.wordnet.WordNetResource">
   </bean>
 </beans>

de.tudarmstadt.ukp.dkpro.lexsemresource.graph-asl/src/main/java/de/tudarmstadt/ukp/dkpro/lexsemresource/graph/EntityGraphJGraphT.java

@@ -43,8 +43,8 @@
 import org.jgrapht.graph.DefaultEdge;
 
 import de.tudarmstadt.ukp.dkpro.lexsemresource.Entity;
+import de.tudarmstadt.ukp.dkpro.lexsemresource.LSRFramework;
 import de.tudarmstadt.ukp.dkpro.lexsemresource.LexicalSemanticResource;
-import de.tudarmstadt.ukp.dkpro.lexsemresource.core.ResourceFactory;
 import de.tudarmstadt.ukp.dkpro.lexsemresource.core.util.LoggingUtils;
 import de.tudarmstadt.ukp.dkpro.lexsemresource.core.util.ProgressMeter;
 import de.tudarmstadt.ukp.dkpro.lexsemresource.exception.LexicalSemanticResourceException;
@@ -108,13 +108,7 @@ public EntityGraphJGraphT(File aGraphDirectory)
             graphDirectory = aGraphDirectory;
         }
         else {
-            if (System.getenv(ResourceFactory.ENV_DKPRO_HOME) == null) {
-                throw new IllegalStateException(
-                        "Environment variable [" + ResourceFactory.ENV_DKPRO_HOME + "] not set");
-            }
-
-            graphDirectory = new File(System.getenv(ResourceFactory.ENV_DKPRO_HOME)
-                    + "/" + EntityGraphJGraphT.class.getName());
+            graphDirectory = getWorkspace();
         }
 
         if (!graphDirectory.exists()) {
@@ -1619,4 +1613,14 @@ public boolean isHyponymCountMapUseLcc()
 	{
 		return hyponymCountMapUseLcc;
 	}
+
+    /**
+     * Get the workspace directory.
+     *
+     * @return the workspace directory.
+     */
+    private static File getWorkspace()
+    {
+        return new File(LSRFramework.getWorkspace(), EntityGraphJGraphT.class.getName());
+    }
 }