public interface FlowManager
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
|
static FlowManager create(HubConfig hubConfig)
hubConfig
- - the hubConfig for the FlowManager to usestatic Flow flowFromXml(org.w3c.dom.Element doc)
doc
- - the xml document representing a flowjava.util.List<Flow> getLocalFlows()
java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName)
entityName
- - string name of the entity for the flowjava.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName, FlowType flowType)
entityName
- - string name of the entity for the flowflowType
- - the FlowType enum, eg: ingest or harmonizeFlow getFlowFromProperties(java.nio.file.Path propertiesFile)
propertiesFile
- - the Path to the property filejava.util.List<Flow> getFlows(java.lang.String entityName)
entityName
- - the entity from which to fetch the flowsFlow getFlow(java.lang.String entityName, java.lang.String flowName)
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getFlow getFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType)
entityName
- - the entity that the flow belongs toflowName
- - the name of the flow to getflowType
- - the type of flow (ingest/harmonize)java.util.List<java.lang.String> getLegacyFlows()
java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion)
fromVersion
- - string representation of DHF versionFlowRunner newFlowRunner()