Making magic numbers into enums

paxtonhare · paxtonhare · commit 560650be136f · 2016-02-25T14:16:58.000-05:00
diff --git a/data-hub/src/main/java/com/marklogic/hub/collector/AbstractCollector.java b/data-hub/src/main/java/com/marklogic/hub/collector/AbstractCollector.java
@@ -20,16 +20,18 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 
+import com.marklogic.hub.plugin.PluginType;
+
 public abstract class AbstractCollector implements Collector {
 
-    private String type;
+    private PluginType type;
 
-    public AbstractCollector(String type) {
+    public AbstractCollector(PluginType type) {
         this.type = type;
     }
 
     @Override
-    public String getType() {
+    public PluginType getType() {
         return this.type;
     }
 
diff --git a/data-hub/src/main/java/com/marklogic/hub/collector/Collector.java b/data-hub/src/main/java/com/marklogic/hub/collector/Collector.java
@@ -20,9 +20,11 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 
+import com.marklogic.hub.plugin.PluginType;
+
 public interface Collector {
 
-    String getType();
+    PluginType getType();
     List<String> run();
     void serialize(XMLStreamWriter serializer) throws XMLStreamException;
 }
diff --git a/data-hub/src/main/java/com/marklogic/hub/collector/QueryCollector.java b/data-hub/src/main/java/com/marklogic/hub/collector/QueryCollector.java
@@ -17,12 +17,14 @@
 
 import java.util.List;
 
+import com.marklogic.hub.plugin.PluginType;
+
 public class QueryCollector extends ServerCollector {
 
     public static final String MODULE = "/com.marklogic.hub/collectors/query.xqy";
 
     public QueryCollector() {
-        super("xquery", MODULE);
+        super(PluginType.XQUERY, MODULE);
     }
 
     @Override
diff --git a/data-hub/src/main/java/com/marklogic/hub/collector/ServerCollector.java b/data-hub/src/main/java/com/marklogic/hub/collector/ServerCollector.java
@@ -27,13 +27,14 @@
 import com.marklogic.client.extensions.ResourceServices.ServiceResultIterator;
 import com.marklogic.client.io.JacksonDatabindHandle;
 import com.marklogic.client.util.RequestParameters;
+import com.marklogic.hub.plugin.PluginType;
 
 public class ServerCollector extends AbstractCollector {
 
     private DatabaseClient client = null;
     private String module;
 
-    public ServerCollector(String type, String module) {
+    public ServerCollector(PluginType type, String module) {
         super(type);
         this.module = module;
     }
@@ -53,7 +54,7 @@ public String getModule() {
     @Override
     public void serialize(XMLStreamWriter serializer) throws XMLStreamException {
         serializer.writeStartElement("collector");
-        serializer.writeAttribute("type", getType());
+        serializer.writeAttribute("type", getType().toString());
         serializer.writeAttribute("module", this.module);
         serializer.writeEndElement();
 
diff --git a/data-hub/src/main/java/com/marklogic/hub/flow/AbstractFlow.java b/data-hub/src/main/java/com/marklogic/hub/flow/AbstractFlow.java
@@ -36,6 +36,7 @@
 import com.marklogic.hub.plugin.ContentPlugin;
 import com.marklogic.hub.plugin.HeadersPlugin;
 import com.marklogic.hub.plugin.Plugin;
+import com.marklogic.hub.plugin.PluginType;
 import com.marklogic.hub.plugin.TriplesPlugin;
 import com.marklogic.hub.plugin.ServerPlugin;
 import com.marklogic.hub.writer.DefaultWriter;
@@ -96,8 +97,8 @@ private void deserialize(Node xml) {
                 this.domainName = node.getTextContent();
                 break;
             case "collector":
-                String colType = node.getAttributes().getNamedItem("type").getNodeValue();
-                if (colType.equals("xquery") || colType.equals("sjs") || colType.equals("xslt")) {
+                PluginType colType = PluginType.getPluginType(node.getAttributes().getNamedItem("type").getNodeValue());
+                if (colType.equals(PluginType.XQUERY) || colType.equals(PluginType.JAVASCRIPT) || colType.equals(PluginType.XSLT)) {
                     String module = node.getAttributes().getNamedItem("module").getNodeValue();
                     Collector collector = null;
                     if (module.equals(QueryCollector.MODULE)) {
@@ -115,13 +116,13 @@ private void deserialize(Node xml) {
             case "plugin":
                 String pluginDest = null;
                 String module = null;
-                String pluginType = node.getAttributes().getNamedItem("type").getNodeValue();
-                if (!pluginType.equals("null")) {
+                PluginType pluginType = PluginType.getPluginType(node.getAttributes().getNamedItem("type").getNodeValue());
+                if (!pluginType.equals(PluginType.NULL)) {
                     pluginDest = node.getAttributes().getNamedItem("dest").getNodeValue();
                     module = node.getAttributes().getNamedItem("module").getNodeValue();
                 }
 
-                if (pluginType.equals("xquery") || pluginType.equals("sjs") || pluginType.equals("xslt")) {
+                if (pluginType.equals(PluginType.XQUERY) || pluginType.equals(PluginType.JAVASCRIPT) || pluginType.equals(PluginType.XSLT)) {
                     if (pluginDest.equals(ContentPlugin.MODULE)) {
                         ContentPlugin t = new ContentPlugin();
                         this.plugins.add(t);
@@ -139,14 +140,14 @@ else if (pluginDest.equals(TriplesPlugin.MODULE)) {
                         this.plugins.add(t);
                     }
                 }
-                else if (pluginType.equals("null")) {
+                else if (pluginType.equals(PluginType.NULL)) {
                     this.plugins.add(null);
                 }
                 break;
             case "writer":
                 module = null;
-                pluginType = node.getAttributes().getNamedItem("type").getNodeValue();
-                if (pluginType.equals("xquery") || pluginType.equals("sjs") || pluginType.equals("xslt")) {
+                pluginType = PluginType.getPluginType(node.getAttributes().getNamedItem("type").getNodeValue());
+                if (pluginType.equals(PluginType.XQUERY) || pluginType.equals(PluginType.JAVASCRIPT) || pluginType.equals(PluginType.XSLT)) {
                     module = node.getAttributes().getNamedItem("module").getNodeValue();
                     Writer w = null;
                     if (module.equals(DefaultWriter.MODULE)) {
diff --git a/data-hub/src/main/java/com/marklogic/hub/plugin/ContentPlugin.java b/data-hub/src/main/java/com/marklogic/hub/plugin/ContentPlugin.java
@@ -19,7 +19,7 @@ public class ContentPlugin extends ServerPlugin {
     public static final String MODULE = "/com.marklogic.hub/plugins/content.xqy";
 
     public ContentPlugin() {
-        super("xquery", MODULE, "content");
+        super(PluginType.XQUERY, MODULE, "content");
     }
 
     @Override
diff --git a/data-hub/src/main/java/com/marklogic/hub/plugin/HeadersPlugin.java b/data-hub/src/main/java/com/marklogic/hub/plugin/HeadersPlugin.java
@@ -19,7 +19,7 @@ public class HeadersPlugin extends ServerPlugin {
     public static final String MODULE = "/com.marklogic.hub/plugins/header.xqy";
 
     public HeadersPlugin() {
-        super("xquery", MODULE, "header");
+        super(PluginType.XQUERY, MODULE, "header");
     }
 
     @Override
diff --git a/data-hub/src/main/java/com/marklogic/hub/plugin/Plugin.java b/data-hub/src/main/java/com/marklogic/hub/plugin/Plugin.java
@@ -19,7 +19,7 @@
 import javax.xml.stream.XMLStreamWriter;
 
 public interface Plugin {
-    String getType();
+    PluginType getType();
     String getDest();
     void run(String identifier);
     void serialize(XMLStreamWriter serializer) throws XMLStreamException;
diff --git a/data-hub/src/main/java/com/marklogic/hub/plugin/PluginType.java b/data-hub/src/main/java/com/marklogic/hub/plugin/PluginType.java
@@ -0,0 +1,24 @@
+package com.marklogic.hub.plugin;
+
+public enum PluginType {
+
+    XQUERY("xquery"), JAVASCRIPT("javascript"), XSLT("xslt"), XML("xml"), JSON("json"), NULL("null");
+
+    private String type;
+    PluginType(String type) {
+        this.type = type;
+    }
+
+    public static PluginType getPluginType(String type) {
+        for (PluginType pluginType : PluginType.values()) {
+            if (pluginType.toString().equals(type)) {
+                return pluginType;
+            }
+        }
+        return null;
+    }
+
+    public String toString() {
+        return type;
+    }
+}
diff --git a/data-hub/src/main/java/com/marklogic/hub/plugin/ServerPlugin.java b/data-hub/src/main/java/com/marklogic/hub/plugin/ServerPlugin.java
@@ -23,12 +23,12 @@
 import com.marklogic.client.util.RequestParameters;
 
 public class ServerPlugin extends AbstractPlugin {
-    private String type;
+    private PluginType type;
     private String module;
     private String destination;
     private DatabaseClient client;
 
-    public ServerPlugin(String type, String module, String destination) {
+    public ServerPlugin(PluginType type, String module, String destination) {
         this.type = type;
         this.module = module;
         this.destination = destination;
@@ -46,7 +46,7 @@ public String getDest() {
     }
 
     @Override
-    public String getType() {
+    public PluginType getType() {
         return this.type;
     }
 
@@ -60,7 +60,7 @@ public void setClient(DatabaseClient client) {
 
     public void serialize(XMLStreamWriter serializer) throws XMLStreamException {
         serializer.writeStartElement("plugin");
-        serializer.writeAttribute("type", this.type);
+        serializer.writeAttribute("type", this.type.toString());
         serializer.writeAttribute("module", this.module);
         serializer.writeAttribute("dest", this.destination);
         serializer.writeEndElement();
diff --git a/data-hub/src/main/java/com/marklogic/hub/plugin/TriplesPlugin.java b/data-hub/src/main/java/com/marklogic/hub/plugin/TriplesPlugin.java
@@ -20,7 +20,7 @@ public class TriplesPlugin extends ServerPlugin {
     public static final String MODULE = "/com.marklogic.hub/plugins/triples.xqy";
 
     public TriplesPlugin() {
-        super("xquery", MODULE, "triples");
+        super(PluginType.XQUERY, MODULE, "triples");
     }
 
     @Override
diff --git a/data-hub/src/main/java/com/marklogic/hub/writer/AbstractWriter.java b/data-hub/src/main/java/com/marklogic/hub/writer/AbstractWriter.java
@@ -18,10 +18,12 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 
+import com.marklogic.hub.plugin.PluginType;
+
 public abstract class AbstractWriter implements Writer {
 
     @Override
-    public abstract String getType();
+    public abstract PluginType getType();
 
     @Override
     public abstract void write(String identifier);
diff --git a/data-hub/src/main/java/com/marklogic/hub/writer/DefaultWriter.java b/data-hub/src/main/java/com/marklogic/hub/writer/DefaultWriter.java
@@ -15,11 +15,13 @@
  */
 package com.marklogic.hub.writer;
 
+import com.marklogic.hub.plugin.PluginType;
+
 public class DefaultWriter extends ServerWriter {
 
     public static final String MODULE = "/com.marklogic.hub/writers/default.xqy";
 
     public DefaultWriter() {
-        super("xquery", MODULE);
+        super(PluginType.XQUERY, MODULE);
     }
 }
diff --git a/data-hub/src/main/java/com/marklogic/hub/writer/ServerWriter.java b/data-hub/src/main/java/com/marklogic/hub/writer/ServerWriter.java
@@ -21,20 +21,21 @@
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.extensions.ResourceManager;
 import com.marklogic.client.util.RequestParameters;
+import com.marklogic.hub.plugin.PluginType;
 
 public class ServerWriter extends AbstractWriter {
 
-    private String type;
+    private PluginType type;
     private String module;
     private DatabaseClient client;
 
-    public ServerWriter(String type, String module) {
+    public ServerWriter(PluginType type, String module) {
         this.type = type;
         this.module = module;
     }
 
     @Override
-    public String getType() {
+    public PluginType getType() {
         return this.type;
     }
 
@@ -55,7 +56,7 @@ public void setClient(DatabaseClient client) {
     @Override
     public void serialize(XMLStreamWriter serializer) throws XMLStreamException {
         serializer.writeStartElement("writer");
-        serializer.writeAttribute("type", this.type);
+        serializer.writeAttribute("type", this.type.toString());
         serializer.writeAttribute("module", this.module);
         serializer.writeEndElement();
     }
diff --git a/data-hub/src/main/java/com/marklogic/hub/writer/Writer.java b/data-hub/src/main/java/com/marklogic/hub/writer/Writer.java
@@ -18,8 +18,10 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 
+import com.marklogic.hub.plugin.PluginType;
+
 public interface Writer {
-    String getType();
+    PluginType getType();
 
     void write(String identifier);
     void serialize(XMLStreamWriter serializer) throws XMLStreamException;
diff --git a/data-hub/src/main/resources/ml-modules/root/com.marklogic.hub/lib/flow-lib.xqy b/data-hub/src/main/resources/ml-modules/root/com.marklogic.hub/lib/flow-lib.xqy
@@ -58,6 +58,16 @@ declare variable $DOMAINS-DIR := "/ext/domains/";
 
 declare variable $PLUGIN-NS := "http://marklogic.com/hub-in-a-box/plugins/";
 
+declare variable $TYPE-XQUERY := "xquery";
+
+declare variable $TYPE-JAVASCRIPT := "javascript";
+
+declare variable $TYPE-XSLT := "xslt";
+
+declare variable $TYPE-XML := "xml";
+
+declare variable $TYPE-JSON := "json";
+
 (:
  : Determines the type of flow given a filename
  :
@@ -69,15 +79,15 @@ declare %private function flow:get-type($filename) as xs:string?
   let $ext as xs:string := hul:get-file-extension($filename)
   return
     if ($ext = hul:get-xqy-extensions()) then
-      "xquery"
+      $TYPE-XQUERY
     else if ($ext = hul:get-sjs-extensions()) then
-      "sjs"
+      $TYPE-JAVASCRIPT
     else if ($ext = hul:get-xslt-extensions()) then
-      "xslt"
+      $TYPE-XSLT
     else if ($ext = "xml") then
-      "xml"
+      $TYPE-XML
     else if ($ext = "json") then
-      "json"
+      $TYPE-JSON
     else
       fn:error(xs:QName("INVALID_PLUGIN"), $filename)
 };
@@ -386,7 +396,7 @@ declare function flow:run-collector(
   let $filename as xs:string := hul:get-file-from-uri($module-uri)
   let $type := flow:get-type($filename)
   let $ns :=
-    if ($type eq "sjs") then ()
+    if ($type eq $TYPE-JAVASCRIPT) then ()
     else
       $PLUGIN-NS || fn:lower-case($module-name)
   let $func := xdmp:function(fn:QName($ns, "collect"), $module-uri)
@@ -513,11 +523,11 @@ declare function flow:run-plugin(
       let $filename as xs:string := hul:get-file-from-uri($module-uri)
       let $type := flow:get-type($filename)
       let $ns :=
-        if ($type eq "sjs") then ()
+        if ($type eq $TYPE-JAVASCRIPT) then ()
         else
           $PLUGIN-NS || fn:lower-case($module-name)
       let $func-name :=
-        if ($type eq "sjs") then
+        if ($type eq $TYPE-JAVASCRIPT) then
           "create" || functx:capitalize-first($destination)
         else
           "create-" || $destination
diff --git a/data-hub/src/test/java/com/marklogic/hub/DomainManagerTest.java b/data-hub/src/test/java/com/marklogic/hub/DomainManagerTest.java
diff --git a/data-hub/src/test/java/com/marklogic/hub/FlowManagerTest.java b/data-hub/src/test/java/com/marklogic/hub/FlowManagerTest.java
diff --git a/quick-start/src/main/java/com/marklogic/hub/web/controller/CollectorManagerController.java b/quick-start/src/main/java/com/marklogic/hub/web/controller/CollectorManagerController.java

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public class ContentPlugin extends ServerPlugin {`
`19`	`19`	`public static final String MODULE = "/com.marklogic.hub/plugins/content.xqy";`
`20`	`20`
`21`	`21`	`public ContentPlugin() {`
`22`		`- super("xquery", MODULE, "content");`
	`22`	`+ super(PluginType.XQUERY, MODULE, "content");`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public class HeadersPlugin extends ServerPlugin {`
`19`	`19`	`public static final String MODULE = "/com.marklogic.hub/plugins/header.xqy";`
`20`	`20`
`21`	`21`	`public HeadersPlugin() {`
`22`		`- super("xquery", MODULE, "header");`
	`22`	`+ super(PluginType.XQUERY, MODULE, "header");`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`@Override`