com.marklogic.hub

Interface FlowManager

All Known Implementing Classes:

FlowManagerImpl

public interface FlowManager

Manages existing flows and creates flow runners to execute flows.

Method Summary

Modifier and Type	Method and Description
static FlowManager	create(HubConfig hubConfig) Creates and returns the FlowManager object
static Flow	flowFromXml(org.w3c.dom.Element doc) Turns an XML document into a flow
Flow	getFlow(java.lang.String entityName, java.lang.String flowName) Retrieves a named flow from a given entity
Flow	getFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType) Retrieves a named flow from a given entity
Flow	getFlowFromProperties(java.nio.file.Path propertiesFile) Obtains a flow from a property file
java.util.List<Flow>	getFlows(java.lang.String entityName) Retrieves a list of flows installed on the MarkLogic server
java.util.List<java.lang.String>	getLegacyFlows() Updates the indexes in the database based on the project
java.util.List<Flow>	getLocalFlows() retrieves a list of all the flows on the local files systems
java.util.List<Flow>	getLocalFlowsForEntity(java.lang.String entityName) retrieves a list of all the flows on the local files systems
java.util.List<Flow>	getLocalFlowsForEntity(java.lang.String entityName, FlowType flowType) retrieves a list of all the flows on the local files systems
FlowRunner	newFlowRunner() Creates and returns a new FlowRunner object using the FlowManager's hubconfig
java.util.List<java.lang.String>	updateLegacyFlows(java.lang.String fromVersion) Sets the version that the legacy flow is to be updated from

Method Detail

create

static FlowManager create(HubConfig hubConfig)

Creates and returns the FlowManager object

Parameters:

hubConfig - - the hubConfig for the FlowManager to use

Returns:

a FlowManager object with a set hubConfig

flowFromXml

static Flow flowFromXml(org.w3c.dom.Element doc)

Turns an XML document into a flow

Parameters:

doc - - the xml document representing a flow

Returns:

a Flow instance

getLocalFlows

java.util.List<Flow> getLocalFlows()

retrieves a list of all the flows on the local files systems

Returns:

a list of Flows

getLocalFlowsForEntity

java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName)

retrieves a list of all the flows on the local files systems

Parameters:

entityName - - string name of the entity for the flow

Returns:

a list of Flows

getLocalFlowsForEntity

java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName,
                                            FlowType flowType)

retrieves a list of all the flows on the local files systems

Parameters:

entityName - - string name of the entity for the flow

flowType - - the FlowType enum, eg: ingest or harmonize

Returns:

a list of Flows

getFlowFromProperties

Flow getFlowFromProperties(java.nio.file.Path propertiesFile)

Obtains a flow from a property file

Parameters:

propertiesFile - - the Path to the property file

Returns:

- a flow object

getFlows

java.util.List<Flow> getFlows(java.lang.String entityName)

Retrieves a list of flows installed on the MarkLogic server

Parameters:

entityName - - the entity from which to fetch the flows

Returns:

- a list of flows for the given entity

getFlow

Flow getFlow(java.lang.String entityName,
             java.lang.String flowName)

Retrieves a named flow from a given entity

Parameters:

entityName - - the entity that the flow belongs to

flowName - - the name of the flow to get

Returns:

the flow

getFlow

Flow getFlow(java.lang.String entityName,
             java.lang.String flowName,
             FlowType flowType)

Retrieves a named flow from a given entity

Parameters:

entityName - - the entity that the flow belongs to

flowName - - the name of the flow to get

flowType - - the type of flow (ingest/harmonize)

Returns:

the flow

getLegacyFlows

java.util.List<java.lang.String> getLegacyFlows()

Updates the indexes in the database based on the project

updateLegacyFlows

java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion)

Sets the version that the legacy flow is to be updated from

Parameters:

fromVersion - - string representation of DHF version

Returns:

a list of updated flow names that were updated

newFlowRunner

FlowRunner newFlowRunner()

Creates and returns a new FlowRunner object using the FlowManager's hubconfig

Returns:

FlowRunner object with current hubconfig already set