com.marklogic.hub.scaffold

Interface Scaffolding

All Known Implementing Classes:

ScaffoldingImpl

public interface Scaffolding

Interface that handles the management of DHF projects on disk Includes creating entities, flows, rest extensions, and transforms for an already initialized project

See Also:

for the initialization of the project itself to disk

Method Summary

Modifier and Type	Method and Description
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
void	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
void	createRestExtension(java.lang.String entityName, java.lang.String extensionName, FlowType flowType, CodeFormat codeFormat) Creates a rest extension on disk to be deployed to server
void	createRestTransform(java.lang.String entityName, java.lang.String transformName, FlowType flowType, CodeFormat codeFormat) Creates a rest transform on disk to be deployed to server
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

Method Detail

getLegacyFlowDir

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

Returns the directory of the flow

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

void createEntity(java.lang.String entityName)

Creates an entity given a string name

Parameters:

entityName - - the name of the entity as string

createLegacyMappingDir

void createLegacyMappingDir(java.lang.String mappingName)

Creates a legacy mapping given a string name

Parameters:

mappingName - - the name of the mapping as string

createMappingDir

void createMappingDir(java.lang.String mappingName)

Creates a mapping given a string name

Parameters:

mappingName - - the name of the mapping as string

createCustomModule

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

Creates a custom module given a string stepName

Parameters:

stepName - - the name of the step as string

stepType - - the type of the step as string

createCustomModule

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

Creates a custom module given a string stepName

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

void createDefaultFlow(java.lang.String flowName)

Create default flow with all the default steps

Parameters:

flowName - - the name of the flow

createLegacyFlow

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

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

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

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

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

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

void updateLegacyEntity(java.lang.String entityName)

Update a specific entity that's legacy

Parameters:

entityName - - name of the entity

createRestExtension

void createRestExtension(java.lang.String entityName,
                         java.lang.String extensionName,
                         FlowType flowType,
                         CodeFormat codeFormat)
                  throws ScaffoldingValidationException

Creates a rest extension on disk to be deployed to server

Parameters:

entityName - - the entity which the flow is attached

extensionName - - the name of the extension as a string

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

codeFormat - - the format of the code as CodeFormat enum

Throws:

ScaffoldingValidationException - - thrown if the extension fails to pass validation

createRestTransform

void createRestTransform(java.lang.String entityName,
                         java.lang.String transformName,
                         FlowType flowType,
                         CodeFormat codeFormat)
                  throws ScaffoldingValidationException

Creates a rest transform on disk to be deployed to server

Parameters:

entityName - - the entity which the flow is attached

transformName - - the name of the transform as a string

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

codeFormat - - the format of the code as CodeFormat enum

Throws:

ScaffoldingValidationException - - thrown if the extension fails to pass validation