com.marklogic.hub.hubcentral.conversion

Class FlowConverter

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.hub.hubcentral.conversion.FlowConverter

public class FlowConverter
extends com.marklogic.client.ext.helper.LoggingObject

Class for converting pre-5.3.0 artifacts to 5.3.0 and above versions

Field Summary

Fields inherited from class com.marklogic.client.ext.helper.LoggingObject

logger

Constructor Summary

Constructors

Constructor and Description
FlowConverter(HubConfig hubConfig)

Method Summary

Modifier and Type	Method and Description
protected void	addToCollections(com.fasterxml.jackson.databind.node.ObjectNode stepArtifact, com.fasterxml.jackson.databind.JsonNode inlineStep, java.lang.String flowName) For any step, ensure that the stepName is in the collections array.
protected com.fasterxml.jackson.databind.node.ObjectNode	buildStepArtifact(com.fasterxml.jackson.databind.JsonNode inlineStep, Mapping mapping, java.lang.String flowName) Extracted for easy unit testing; has no dependencies on anything other than the inputs.
void	convertFlows() Convert the flow files in a user's local project.
protected com.fasterxml.jackson.databind.node.ObjectNode	createStepArtifact(java.lang.String flowName, com.fasterxml.jackson.databind.JsonNode inlineStep)
void	deleteLegacyMappings() After flows have been converted, a user needs to delete any legacy mappings that exist, as these have now been converted to mapping steps.
protected java.lang.String	getEntityNameFromEntityType(java.lang.String targetEntityType) To avoid making flow conversion depend on connecting to ML, we're implementing a simple approach here to try to extract the entity name that should work most of the time.
protected Mapping	getMappingArtifact(java.lang.String flowName, com.fasterxml.jackson.databind.JsonNode inlineStep)
protected java.lang.String	getStepName(com.fasterxml.jackson.databind.node.ObjectNode stepNode)
protected void	transformMatchingOptions(com.fasterxml.jackson.databind.node.ObjectNode stepNode)
protected void	transformMergingOptions(com.fasterxml.jackson.databind.node.ObjectNode stepNode)

Methods inherited from class com.marklogic.client.ext.helper.LoggingObject

format

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowConverter

public FlowConverter(HubConfig hubConfig)

Method Detail

deleteLegacyMappings

public void deleteLegacyMappings()

After flows have been converted, a user needs to delete any legacy mappings that exist, as these have now been converted to mapping steps. Fortunately, a delete trigger exists on these to also delete the xml/xslt documents associated with them.

convertFlows

public void convertFlows()

Convert the flow files in a user's local project. Does not make any changes to what's stored in MarkLogic.

getStepName

protected java.lang.String getStepName(com.fasterxml.jackson.databind.node.ObjectNode stepNode)

getMappingArtifact

protected Mapping getMappingArtifact(java.lang.String flowName,
                                     com.fasterxml.jackson.databind.JsonNode inlineStep)

createStepArtifact

protected com.fasterxml.jackson.databind.node.ObjectNode createStepArtifact(java.lang.String flowName,
                                                                            com.fasterxml.jackson.databind.JsonNode inlineStep)

buildStepArtifact

protected com.fasterxml.jackson.databind.node.ObjectNode buildStepArtifact(com.fasterxml.jackson.databind.JsonNode inlineStep,
                                                                           Mapping mapping,
                                                                           java.lang.String flowName)

Extracted for easy unit testing; has no dependencies on anything other than the inputs.

Parameters:

inlineStep -

mapping -

flowName -

Returns:

addToCollections

protected void addToCollections(com.fasterxml.jackson.databind.node.ObjectNode stepArtifact,
                                com.fasterxml.jackson.databind.JsonNode inlineStep,
                                java.lang.String flowName)

For any step, ensure that the stepName is in the collections array. For a mapping step, also include the value of targetEntityType.

Parameters:

stepArtifact -

inlineStep -

flowName -

getEntityNameFromEntityType

protected java.lang.String getEntityNameFromEntityType(java.lang.String targetEntityType)

To avoid making flow conversion depend on connecting to ML, we're implementing a simple approach here to try to extract the entity name that should work most of the time. Since the user will be instructed to inspect the mapping collections after the flow conversion is performed, we assume that the user will verify that the collections are correct after the conversion is completed.

Parameters:

targetEntityType -

Returns:

transformMatchingOptions

protected void transformMatchingOptions(com.fasterxml.jackson.databind.node.ObjectNode stepNode)

transformMergingOptions

protected void transformMergingOptions(com.fasterxml.jackson.databind.node.ObjectNode stepNode)