com.marklogic.hub.impl

Class FlowManagerImpl

java.lang.Object

com.marklogic.client.impl.ResourceManagerImplementation

com.marklogic.client.extensions.ResourceManager

com.marklogic.hub.impl.FlowManagerImpl

All Implemented Interfaces:

FlowManager

public class FlowManagerImpl
extends com.marklogic.client.extensions.ResourceManager
implements FlowManager

Constructor Summary

Constructors

Constructor and Description
FlowManagerImpl(HubConfig hubConfig)

Method Summary

Modifier and Type	Method and Description
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

Methods inherited from class com.marklogic.client.extensions.ResourceManager

getName, startLogging, stopLogging

Methods inherited from class com.marklogic.client.impl.ResourceManagerImplementation

getServices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.marklogic.hub.FlowManager

create, flowFromXml

Constructor Detail

FlowManagerImpl

public FlowManagerImpl(HubConfig hubConfig)

Method Detail

getLocalFlows

public java.util.List<Flow> getLocalFlows()

Description copied from interface: FlowManager

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

Specified by:

getLocalFlows in interface FlowManager

Returns:

a list of Flows

getLocalFlowsForEntity

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

Description copied from interface: FlowManager

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

Specified by:

getLocalFlowsForEntity in interface FlowManager

Parameters:

entityName - - string name of the entity for the flow

Returns:

a list of Flows

getLocalFlowsForEntity

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

Description copied from interface: FlowManager

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

Specified by:

getLocalFlowsForEntity in interface FlowManager

Parameters:

entityName - - string name of the entity for the flow

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

Returns:

a list of Flows

getFlowFromProperties

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

Description copied from interface: FlowManager

Obtains a flow from a property file

Specified by:

getFlowFromProperties in interface FlowManager

Parameters:

propertiesFile - - the Path to the property file

Returns:

- a flow object

getFlows

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

Description copied from interface: FlowManager

Retrieves a list of flows installed on the MarkLogic server

Specified by:

getFlows in interface FlowManager

Parameters:

entityName - - the entity from which to fetch the flows

Returns:

- a list of flows for the given entity

getFlow

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

Description copied from interface: FlowManager

Retrieves a named flow from a given entity

Specified by:

getFlow in interface FlowManager

Parameters:

entityName - - the entity that the flow belongs to

flowName - - the name of the flow to get

Returns:

the flow

getFlow

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

Description copied from interface: FlowManager

Retrieves a named flow from a given entity

Specified by:

getFlow in interface FlowManager

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

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

Description copied from interface: FlowManager

Updates the indexes in the database based on the project

Specified by:

getLegacyFlows in interface FlowManager

updateLegacyFlows

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

Description copied from interface: FlowManager

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

Specified by:

updateLegacyFlows in interface FlowManager

Parameters:

fromVersion - - string representation of DHF version

Returns:

a list of updated flow names that were updated

newFlowRunner

public FlowRunner newFlowRunner()

Description copied from interface: FlowManager

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

Specified by:

newFlowRunner in interface FlowManager

Returns:

FlowRunner object with current hubconfig already set