com.marklogic.hub.legacy

Interface LegacyFlowManager

All Known Implementing Classes:

LegacyFlowManagerImpl

public interface LegacyFlowManager

Manages existing flows and creates flow runners to execute flows.

Method Summary

Modifier and Type	Method and Description
static LegacyFlow	flowFromXml(org.w3c.dom.Element doc) Turns an XML document into a flow
LegacyFlow	getFlow(java.lang.String entityName, java.lang.String flowName) Retrieves a named flow from a given entity
LegacyFlow	getFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType) Retrieves a named flow from a given entity
LegacyFlow	getFlowFromProperties(java.nio.file.Path propertiesFile) Obtains a flow from a property file
java.util.List<LegacyFlow>	getFlows(java.lang.String entityName) Retrieves a list of flows installed on the MarkLogic server
java.util.List<LegacyFlow>	getLocalFlows() retrieves a list of all the flows on the local files systems
java.util.List<LegacyFlow>	getLocalFlowsForEntity(java.lang.String entityName) retrieves a list of all the flows on the local files systems
java.util.List<LegacyFlow>	getLocalFlowsForEntity(java.lang.String entityName, FlowType flowType) retrieves a list of all the flows on the local files systems
LegacyFlowRunner	newFlowRunner() Creates and returns a new LegacyFlowRunner object using the FlowManager's hubconfig
void	setHubConfig(HubConfig hubConfig) Set HubConfig

Method Detail

setHubConfig

void setHubConfig(HubConfig hubConfig)

Set HubConfig

Parameters:

hubConfig - a hubConfig object

flowFromXml

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

Turns an XML document into a flow

Parameters:

doc - - the xml document representing a flow

Returns:

a LegacyFlow instance

getLocalFlows

java.util.List<LegacyFlow> getLocalFlows()

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

Returns:

a list of Flows

getLocalFlowsForEntity

java.util.List<LegacyFlow> 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<LegacyFlow> 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

LegacyFlow 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<LegacyFlow> 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

LegacyFlow 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

LegacyFlow 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

newFlowRunner

LegacyFlowRunner newFlowRunner()

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

Returns:

LegacyFlowRunner object with current hubconfig already set