Replaced all occurrence of "domain" to "entity" (with domains becoming entities)

Author: maeisabelle08

.metadata/.plugins/org.eclipse.ui.workbench/workingsets.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<workingSetManager>
+<workingSet aggregate="true" factoryID="org.eclipse.ui.internal.WorkingSetFactory" id="1457272715817_0" label="Window Working Set" name="Aggregate for window 1457272715816"/>
+</workingSetManager>

data-hub/src/main/java/com/marklogic/hub/DomainManager.java renamed to data-hub/src/main/java/com/marklogic/hub/EntityManager.java

@@ -29,24 +29,25 @@
 import com.marklogic.client.extensions.ResourceServices.ServiceResultIterator;
 import com.marklogic.client.io.DOMHandle;
 import com.marklogic.client.util.RequestParameters;
-import com.marklogic.hub.domain.Domain;
-import com.marklogic.hub.domain.DomainImpl;
+import com.marklogic.hub.entity.Entity;
+import com.marklogic.hub.entity.EntityImpl;
 
-public class DomainManager extends ResourceManager {
-    static final public String NAME = "domain";
+public class EntityManager extends ResourceManager {
+    static final public String NAME = "entity";
     private DatabaseClient client;
 
-    public DomainManager(DatabaseClient client) {
+    public EntityManager(DatabaseClient client) {
         super();
         this.client = client;
         this.client.init(NAME, this);
     }
 
     /**
-     * Retrieves a list of domains from the Server
-     * @return a list of domains
+     * Retrieves a list of entities from the Server
+     * 
+     * @return a list of entities
      */
-    public List<Domain> getDomains() {
+    public List<Entity> getEntities() {
         RequestParameters params = new RequestParameters();
         ServiceResultIterator resultItr = this.getServices().get(params);
         if (resultItr == null || ! resultItr.hasNext()) {
@@ -57,42 +58,44 @@ public List<Domain> getDomains() {
         Document parent = res.getContent(handle).get();
         NodeList children = parent.getDocumentElement().getChildNodes();
 
-        ArrayList<Domain> domains = null;
+        ArrayList<Entity> entities = null;
         if (children.getLength() > 0) {
-            domains = new ArrayList<Domain>();
+            entities = new ArrayList<Entity>();
         }
 
         Node node;
         for (int i = 0; i < children.getLength(); i++) {
             node = children.item(i);
             if (node.getNodeType() == Node.ELEMENT_NODE) {
-                domains.add(domainFromXml((Element)children.item(i)));
+                entities.add(entityFromXml((Element) children.item(i)));
             }
         }
-        return domains;
+        return entities;
     }
 
     /**
-     * Retrieve a named domain
-     * @param domainName - the name of the domain to retrieve
-     * @return a domain
+     * Retrieve a named entity
+     * 
+     * @param entityName
+     *            - the name of the entity to retrieve
+     * @return a entity
      */
-    public Domain getDomain(String domainName) {
+    public Entity getEntity(String entityName) {
         RequestParameters params = new RequestParameters();
-        params.add("domain-name", domainName);
+        params.add("entity-name", entityName);
         ServiceResultIterator resultItr = this.getServices().get(params);
         if (resultItr == null || ! resultItr.hasNext()) {
             return null;
         }
         ServiceResult res = resultItr.next();
         DOMHandle handle = new DOMHandle();
         Document parent = res.getContent(handle).get();
-        return new DomainImpl(parent.getDocumentElement());
+        return new EntityImpl(parent.getDocumentElement());
     }
 
 
-    private Domain domainFromXml(Element doc) {
-        Domain d = new DomainImpl(doc);
+    private Entity entityFromXml(Element doc) {
+        Entity d = new EntityImpl(doc);
         return d;
     }
 }

data-hub/src/main/java/com/marklogic/hub/FlowManager.java

@@ -116,12 +116,14 @@ protected void initializeDefaultSpringBatchComponents() {
 
     /**
      * Retrieves a list of flows installed on the MarkLogic server
-     * @param domainName - the domain from which to fetch the flows
-     * @return - a list of flows for the given domain
+     * 
+     * @param entityName
+     *            - the entity from which to fetch the flows
+     * @return - a list of flows for the given entity
      */
-    public List<Flow> getFlows(String domainName) {
+    public List<Flow> getFlows(String entityName) {
         RequestParameters params = new RequestParameters();
-        params.add("domain-name", domainName);
+        params.add("entity-name", entityName);
         ServiceResultIterator resultItr = this.getServices().get(params);
         if (resultItr == null || ! resultItr.hasNext()) {
             return null;
@@ -147,18 +149,21 @@ public List<Flow> getFlows(String domainName) {
     }
 
     /**
-     * Retrieves a named flow from a given domain
-     * @param domainName - the domain that the flow belongs to
-     * @param flowName - the name of the flow to get
+     * Retrieves a named flow from a given entity
+     * 
+     * @param entityName
+     *            - the entity that the flow belongs to
+     * @param flowName
+     *            - the name of the flow to get
      * @return the flow
      */
-    public Flow getFlow(String domainName, String flowName) {
-        return getFlow(domainName, flowName, null);
+    public Flow getFlow(String entityName, String flowName) {
+        return getFlow(entityName, flowName, null);
     }
 
-    public Flow getFlow(String domainName, String flowName, FlowType flowType) {
+    public Flow getFlow(String entityName, String flowName, FlowType flowType) {
         RequestParameters params = new RequestParameters();
-        params.add("domain-name", domainName);
+        params.add("entity-name", entityName);
         params.add("flow-name", flowName);
         if (flowType != null) {
             params.add("flow-type", flowType.toString());
@@ -206,7 +211,8 @@ public void runFlow(Flow flow, int batchSize, JobExecutionListener listener) {
                 .<String, String> chunk(batchSize)
                 .reader(reader).writer(writer).build();
 
-        String jobName = flow.getDomainName() + ":" + flow.getType() + ":" + flow.getName() + "-" + System.currentTimeMillis();
+        String jobName = flow.getEntityName() + ":" + flow.getType() + ":"
+                + flow.getName() + "-" + System.currentTimeMillis();
         SimpleJobBuilder builder = jobBuilderFactory.get(jobName).start(step);
         if (listener != null) {
             builder = builder.listener(listener);
@@ -224,12 +230,16 @@ public void runFlow(Flow flow, int batchSize, JobExecutionListener listener) {
     public void runInputFlow(Flow flow, HubConfig config) {
         try {
             Mlcp mlcp = new Mlcp(config.getHost(), config.getStagingPort(), config.getAdminUsername(), config.getAdminPassword());
-            SourceOptions sourceOptions = new SourceOptions(flow.getDomainName(), flow.getName(), FlowType.INPUT.toString());
+            SourceOptions sourceOptions = new SourceOptions(
+                    flow.getEntityName(), flow.getName(),
+                    FlowType.INPUT.toString());
             mlcp.addSourceDirectory(config.getModulesPath(), sourceOptions);
             mlcp.loadContent();
         }
         catch (IOException e) {
-            LOGGER.error("Error encountered while trying to run flow:  " + flow.getDomainName() + " > " + flow.getName(), e);
+            LOGGER.error(
+                    "Error encountered while trying to run flow:  "
+                            + flow.getEntityName() + " > " + flow.getName(), e);
         }
     }
 

data-hub/src/main/java/com/marklogic/hub/Mlcp.java

@@ -152,20 +152,20 @@ public List<String> getMlcpArguments() throws IOException {
     }
 
     public static class SourceOptions {
-        private String domainName;
+        private String entityName;
         private String flowName;
         private String flowType;
         private String inputFileType;
         private String inputFilePattern;
 
-        public SourceOptions(String domainName, String flowName, String flowType) {
-            this.domainName = domainName;
+        public SourceOptions(String entityName, String flowName, String flowType) {
+            this.entityName = entityName;
             this.flowName = flowName;
             this.flowType = flowType;
         }
 
-        public String getDomainName() {
-            return domainName;
+        public String getEntityName() {
+            return entityName;
         }
 
         public String getFlowName() {
@@ -193,7 +193,9 @@ public void setInputFilePattern(String inputFilePattern) {
         }
 
         protected String getTransformParams() {
-            return String.format("<params><domain-name>%s</domain-name><flow-name>%s</flow-name><flow-type>%s</flow-type></params>", domainName, flowName, flowType);
+            return String
+                    .format("<params><entity-name>%s</entity-name><flow-name>%s</flow-name><flow-type>%s</flow-type></params>",
+                            entityName, flowName, flowType);
         }
     }
 }

data-hub/src/main/java/com/marklogic/hub/Scaffolding.java

@@ -27,35 +27,37 @@
 import org.slf4j.LoggerFactory;
 
 import com.marklogic.client.io.Format;
-import com.marklogic.hub.flow.Flow;
 import com.marklogic.hub.flow.FlowType;
 import com.marklogic.hub.flow.SimpleFlow;
 
 public class Scaffolding {
 
     static final private Logger LOGGER = LoggerFactory.getLogger(Scaffolding.class);
 
-    public static File getDomainDir(File userlandDir, String domainName) {
-        File domainsDir = new File(userlandDir, "domains");
-        File domainDir = new File(domainsDir, domainName);
-        return domainDir;
+    public static File getEntityDir(File userlandDir, String entityName) {
+        File entitiesDir = new File(userlandDir, "entities");
+        File entityDir = new File(entitiesDir, entityName);
+        return entityDir;
     }
 
-    public static File getFlowDir(File userlandDir, String domainName, String flowName, FlowType flowType) {
-        File domainDir = getDomainDir(userlandDir, domainName);
-        File typeDir = new File(domainDir, flowType.toString());
+    public static File getFlowDir(File userlandDir, String entityName,
+            String flowName, FlowType flowType) {
+        File entityDir = getEntityDir(userlandDir, entityName);
+        File typeDir = new File(entityDir, flowType.toString());
         File flowDir = new File(typeDir, flowName);
         return flowDir;
     }
 
-    public static void createDomain(String domainName, File userlandPath) {
-        File domainDir = getDomainDir(userlandPath, domainName);
-        domainDir.mkdirs();
+    public static void createEntity(String entityName, File userlandPath) {
+        File entityDir = getEntityDir(userlandPath, entityName);
+        entityDir.mkdirs();
     }
 
-    public static void createFlow(String domainName, String flowName, FlowType flowType, PluginFormat pluginFormat, Format dataFormat, File userlandDir)
+    public static void createFlow(String entityName, String flowName,
+            FlowType flowType, PluginFormat pluginFormat, Format dataFormat,
+            File userlandDir)
             throws IOException {
-        File flowDir = getFlowDir(userlandDir, domainName, flowName, flowType);
+        File flowDir = getFlowDir(userlandDir, entityName, flowName, flowType);
 
         if (flowType.equals(FlowType.CONFORMANCE)) {
             File collectorDir = new File(flowDir, "collector");
@@ -79,7 +81,8 @@ public static void createFlow(String domainName, String flowName, FlowType flowT
         writeFile("scaffolding/" + flowType + "/" + pluginFormat + "/triples." + pluginFormat,
                 Paths.get(triplesDir.getPath(), "triples." + pluginFormat));
 
-        SimpleFlow flow = new SimpleFlow(domainName, flowName, flowType, dataFormat);
+        SimpleFlow flow = new SimpleFlow(entityName, flowName, flowType,
+                dataFormat);
         flow.serialize();
         File flowFile = new File(flowDir, flowName + ".xml");
         try(PrintWriter out = new PrintWriter(flowFile)) {

data-hub/src/main/java/com/marklogic/hub/domain/AbstractDomain.java renamed to data-hub/src/main/java/com/marklogic/hub/entity/AbstractEntity.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.marklogic.hub.domain;
+package com.marklogic.hub.entity;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -26,18 +26,18 @@
 import com.marklogic.hub.flow.Flow;
 
 /**
- * Abstract Base class for Domains
+ * Abstract Base class for entities
  */
-public abstract class AbstractDomain implements Domain {
+public abstract class AbstractEntity implements Entity {
 
     private String name;
     private ArrayList<Flow> flows = new ArrayList<Flow>();
 
-    public AbstractDomain(Element xml) {
+    public AbstractEntity(Element xml) {
         deserialize(xml);
     }
 
-    public AbstractDomain(String name) {
+    public AbstractEntity(String name) {
         this.name = name;
     }
 
@@ -65,7 +65,7 @@ private void deserialize(Node xml) {
     }
 
     /**
-     * Returns the name of the Domain
+     * Returns the name of the Entity
      */
     @Override
     public String getName() {
@@ -74,7 +74,7 @@ public String getName() {
     }
 
     /**
-     * Serializes the domain to an XML string
+     * Serializes the entity to an XML string
      */
     @Override
     public String serialize() {
@@ -83,7 +83,7 @@ public String serialize() {
     }
 
     /**
-     * Returns the domain's flows
+     * Returns the entity's flows
      */
     @Override
     public List<Flow> getFlows() {

data-hub/src/main/java/com/marklogic/hub/domain/Domain.java renamed to data-hub/src/main/java/com/marklogic/hub/entity/Entity.java

@@ -13,30 +13,33 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.marklogic.hub.domain;
+package com.marklogic.hub.entity;
 
 import java.util.List;
 
 import com.marklogic.hub.flow.Flow;
 
 /**
- * A domain object. The data hub groups data by domains.
+ * A entity object. The data hub groups data by entities.
  */
-public interface Domain {
+public interface Entity {
     /**
-     * Gets the Domain name
-     * @return the domain name
+     * Gets the Entity name
+     * 
+     * @return the entity name
      */
     String getName();
 
     /**
-     * Serializes the Domain as an XML string
+     * Serializes the Entity as an XML string
+     * 
      * @return the serialized XML string
      */
     String serialize();
 
     /**
-     * Returns all flows registered to the domain
+     * Returns all flows registered to the entity
+     * 
      * @return a list of flows
      */
     List<Flow> getFlows();

data-hub/src/main/java/com/marklogic/hub/domain/DomainImpl.java renamed to data-hub/src/main/java/com/marklogic/hub/entity/EntityImpl.java

@@ -13,20 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.marklogic.hub.domain;
+package com.marklogic.hub.entity;
 
 import org.w3c.dom.Element;
 
 /**
- * An implementation of the Domain base class
+ * An implementation of the Entity base class
  */
-public class DomainImpl extends AbstractDomain {
+public class EntityImpl extends AbstractEntity {
 
-    public DomainImpl(Element xml) {
+    public EntityImpl(Element xml) {
         super(xml);
     }
 
-    public DomainImpl(String name) {
+    public EntityImpl(String name) {
         super(name);
     }