Creating FlowRunner Class

marklogic-data-hub/src/main/java/com/marklogic/hub/collector/Collector.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2012-2019 MarkLogic Corporation
+ *
+ * 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 com.marklogic.hub.collector;
+
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.hub.HubConfig;
+
+
+
+import java.util.Map;
+
+/**
+ * Manages config and client for the collector, as well as runs the collector for the associated entity and flow
+ */
+public interface Collector {
+
+
+    /**
+     * Set's the hub config for the collector
+     * @param config takes in a HubConfig object
+     */
+    void setHubConfig(HubConfig config);
+
+    /**
+     * Returns the current hubConfig ont he collector object
+     * @return current hub config in use by collector
+     */
+    HubConfig getHubConfig();
+
+    /**
+     * Sets the client to be used to communicate with the database
+     * @param client - a databaseclient to use
+     */
+    void setClient(DatabaseClient client);
+
+    /**
+     * Gets the client in use currently by the collector object
+     * @return a database client object
+     */
+    DatabaseClient getClient();
+
+    /**
+     * Obtains and grabs a list of uris that match the collector code
+     * @param flow - name of which flow
+     * @param step - step of the flow
+     * @return a list of uris as strings in a diskqueue object
+     */
+    DiskQueue<String> run(String flow, String step);
+}