com.marklogic.hub.impl

Class ScaffoldingImpl

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.hub.impl.ScaffoldingImpl

All Implemented Interfaces:

Scaffolding

@Component
public class ScaffoldingImpl
extends com.marklogic.client.ext.helper.LoggingObject
implements Scaffolding

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScaffoldingImpl.ContentPlugin

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
ScaffoldingImpl()
ScaffoldingImpl(HubConfig hubConfig)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	buildFlowFromDefaultFlow(java.util.Map<java.lang.String,java.lang.String> customTokens)
void	createCustomModule(java.lang.String stepName, java.lang.String stepType) Creates a custom module given a string stepName
void	createCustomModule(java.lang.String stepName, java.lang.String stepType, java.lang.String format) Creates a custom module given a string stepName
java.io.File	createDefaultFlow(java.lang.String flowName) Create default flow with all the default steps
void	createEntity(java.lang.String entityName) Creates an entity given a string name
void	createLegacyFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType, CodeFormat codeFormat, DataFormat dataFormat) Creates a flow for an entity with Entity Services model as default
void	createLegacyFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType, CodeFormat codeFormat, DataFormat dataFormat, boolean useEsModel) Creates a flow for an entity with an additional option for using Entity Services
void	createLegacyFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType, CodeFormat codeFormat, DataFormat dataFormat, boolean useEsModel, java.lang.String mappingNameWithVersion) Creates a flow for an entity with an additional option for using Entity Services
void	createLegacyMappingDir(java.lang.String mappingName) Creates a legacy mapping given a string name
void	createMappingDir(java.lang.String mappingName) Creates a mapping given a string name
StepDefinition	createStepDefinition(java.lang.String name, java.lang.String type, java.lang.String format)
org.apache.commons.lang3.tuple.Pair<java.io.File,java.lang.String>	createStepFile(java.lang.String stepName, java.lang.String stepType, java.lang.String stepDefName, java.lang.String entityType) Create a step file based on the given stepName, stepType, entityType (for non ingestion steps), and stepDefName.
static java.lang.String	getAbsolutePath(java.lang.String first, java.lang.String... more)
java.nio.file.Path	getLegacyFlowDir(java.lang.String entityName, java.lang.String flowName, FlowType flowType) Returns the directory of the flow
void	updateLegacyEntity(java.lang.String entityName) Update a specific entity that's legacy

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

ScaffoldingImpl

public ScaffoldingImpl()

ScaffoldingImpl

public ScaffoldingImpl(HubConfig hubConfig)

Method Detail

getAbsolutePath

public static java.lang.String getAbsolutePath(java.lang.String first,
                                               java.lang.String... more)

createStepDefinition

public StepDefinition createStepDefinition(java.lang.String name,
                                           java.lang.String type,
                                           java.lang.String format)

Parameters:

name -

type -

format -

Returns:

the new step definition

createStepFile

public org.apache.commons.lang3.tuple.Pair<java.io.File,java.lang.String> createStepFile(java.lang.String stepName,
                                                                                         java.lang.String stepType,
                                                                                         java.lang.String stepDefName,
                                                                                         java.lang.String entityType)

Create a step file based on the given stepName, stepType, entityType (for non ingestion steps), and stepDefName.

Parameters:

stepName -

stepType -

stepDefName -

entityType -

Returns:

a Pair with a File representing the created file, and a String representing an optional message that, if not null, should likely be presented to the caller

getLegacyFlowDir

public java.nio.file.Path getLegacyFlowDir(java.lang.String entityName,
                                           java.lang.String flowName,
                                           FlowType flowType)

Description copied from interface: Scaffolding

Returns the directory of the flow

Specified by:

getLegacyFlowDir in interface Scaffolding

Parameters:

entityName - - the entity name

flowName - - the name of the flow

flowType - - FlowType (sjs or xqy)

Returns:

the directory path as a Path type

createEntity

public void createEntity(java.lang.String entityName)

Description copied from interface: Scaffolding

Creates an entity given a string name

Specified by:

createEntity in interface Scaffolding

Parameters:

entityName - - the name of the entity as string

createLegacyMappingDir

public void createLegacyMappingDir(java.lang.String mappingName)

Description copied from interface: Scaffolding

Creates a legacy mapping given a string name

Specified by:

createLegacyMappingDir in interface Scaffolding

Parameters:

mappingName - - the name of the mapping as string

createMappingDir

public void createMappingDir(java.lang.String mappingName)

Description copied from interface: Scaffolding

Creates a mapping given a string name

Specified by:

createMappingDir in interface Scaffolding

Parameters:

mappingName - - the name of the mapping as string

createCustomModule

public void createCustomModule(java.lang.String stepName,
                               java.lang.String stepType)

Description copied from interface: Scaffolding

Creates a custom module given a string stepName

Specified by:

createCustomModule in interface Scaffolding

Parameters:

stepName - - the name of the step as string

stepType - - the type of the step as string

createCustomModule

public void createCustomModule(java.lang.String stepName,
                               java.lang.String stepType,
                               java.lang.String format)

Description copied from interface: Scaffolding

Creates a custom module given a string stepName

Specified by:

createCustomModule in interface Scaffolding

Parameters:

stepName - - the name of the step as string

stepType - - the type of the step as string

format - - the format of the custom module (allowed values are xqy, sjs)

createDefaultFlow

public java.io.File createDefaultFlow(java.lang.String flowName)

Description copied from interface: Scaffolding

Create default flow with all the default steps

Specified by:

createDefaultFlow in interface Scaffolding

Parameters:

flowName - - the name of the flow

Returns:

the File that the flow was written to

buildFlowFromDefaultFlow

protected java.lang.String buildFlowFromDefaultFlow(java.util.Map<java.lang.String,java.lang.String> customTokens)
                                             throws java.io.IOException

Throws:

java.io.IOException

createLegacyFlow

public void createLegacyFlow(java.lang.String entityName,
                             java.lang.String flowName,
                             FlowType flowType,
                             CodeFormat codeFormat,
                             DataFormat dataFormat)

Description copied from interface: Scaffolding

Creates a flow for an entity with Entity Services model as default

Specified by:

createLegacyFlow in interface Scaffolding

Parameters:

entityName - - name of the entity to associate the flow with

flowName - - the name of the flow as a string

flowType - - the type of flow as TypeFlow, eg: harmonize or ingest

codeFormat - - the format of the code as CodeFormat enum

dataFormat - - the format of the data (json or xml)

createLegacyFlow

public void createLegacyFlow(java.lang.String entityName,
                             java.lang.String flowName,
                             FlowType flowType,
                             CodeFormat codeFormat,
                             DataFormat dataFormat,
                             boolean useEsModel)

Description copied from interface: Scaffolding

Creates a flow for an entity with an additional option for using Entity Services

Specified by:

createLegacyFlow in interface Scaffolding

Parameters:

entityName - - name of the entity to associate the flow with

flowName - - the name of the flow as a string

flowType - - the type of flow as TypeFlow, eg: harmonize or ingest

codeFormat - - the format of the code as CodeFormat enum

dataFormat - - the format of the data (json or xml)

useEsModel - - true to use Entity Services, false not to

createLegacyFlow

public void createLegacyFlow(java.lang.String entityName,
                             java.lang.String flowName,
                             FlowType flowType,
                             CodeFormat codeFormat,
                             DataFormat dataFormat,
                             boolean useEsModel,
                             java.lang.String mappingNameWithVersion)

Description copied from interface: Scaffolding

Creates a flow for an entity with an additional option for using Entity Services

Specified by:

createLegacyFlow in interface Scaffolding

Parameters:

entityName - - name of the entity to associate the flow with

flowName - - the name of the flow as a string

flowType - - the type of flow as TypeFlow, eg: harmonize or ingest

codeFormat - - the format of the code as CodeFormat enum

dataFormat - - the format of the data (json or xml)

useEsModel - - true to use Entity Services, false not to

mappingNameWithVersion - - the name of the mapping name and version together (name-version) you wish to use to generate the content plugin

updateLegacyEntity

public void updateLegacyEntity(java.lang.String entityName)

Description copied from interface: Scaffolding

Update a specific entity that's legacy

Specified by:

updateLegacyEntity in interface Scaffolding

Parameters:

entityName - - name of the entity