com.marklogic.hub.scaffold.impl

Class ScaffoldingImpl

java.lang.Object

com.marklogic.hub.scaffold.impl.ScaffoldingImpl

All Implemented Interfaces:

Scaffolding

public class ScaffoldingImpl
extends java.lang.Object
implements Scaffolding

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ScaffoldingImpl.ContentPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
ScaffoldingImpl(java.lang.String projectDir, com.marklogic.client.DatabaseClient databaseClient)

Method Summary

Modifier and Type	Method and Description
void	createEntity(java.lang.String entityName) Creates an entity given a string name
void	createFlow(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	createFlow(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	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
static java.lang.String	getAbsolutePath(java.lang.String first, java.lang.String... more)
java.nio.file.Path	getEntityDir(java.lang.String entityName)
java.nio.file.Path	getFlowDir(java.lang.String entityName, java.lang.String flowName, FlowType flowType) Returns the directory of the flow
boolean	update2xFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType)
void	updateLegacyEntity(java.lang.String entityName) Update a specific entity that's legacy
boolean	updateLegacyFlow(java.lang.String fromVersion, java.lang.String entityName, java.lang.String flowName, FlowType flowType) Update a legacy flow
java.util.List<java.lang.String>	updateLegacyFlows(java.lang.String fromVersion, java.lang.String entityName) Updates a legacy flow on disk

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.scaffold.Scaffolding

create

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

ScaffoldingImpl

public ScaffoldingImpl(java.lang.String projectDir,
                       com.marklogic.client.DatabaseClient databaseClient)

Method Detail

getAbsolutePath

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

getFlowDir

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

Description copied from interface: Scaffolding

Returns the directory of the flow

Specified by:

getFlowDir 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

createFlow

public void createFlow(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:

createFlow 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)

createFlow

public void createFlow(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:

createFlow 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

updateLegacyFlows

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

Description copied from interface: Scaffolding

Updates a legacy flow on disk

Specified by:

updateLegacyFlows in interface Scaffolding

Parameters:

fromVersion - - string version number of DHF

entityName - - the entity which the flow is attached

Returns:

a list of updated flows by name

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

updateLegacyFlow

public boolean updateLegacyFlow(java.lang.String fromVersion,
                                java.lang.String entityName,
                                java.lang.String flowName,
                                FlowType flowType)

Description copied from interface: Scaffolding

Update a legacy flow

Specified by:

updateLegacyFlow in interface Scaffolding

Parameters:

fromVersion - - string version number of DHF

entityName - - the entity which the flow is attached

flowName - - the name of the flow as a string

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

Returns:

update2xFlow

public boolean update2xFlow(java.lang.String entityName,
                            java.lang.String flowName,
                            FlowType flowType)

createRestExtension

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

Description copied from interface: Scaffolding

Creates a rest extension on disk to be deployed to server

Specified by:

createRestExtension in interface Scaffolding

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

createRestTransform

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

Description copied from interface: Scaffolding

Creates a rest transform on disk to be deployed to server

Specified by:

createRestTransform in interface Scaffolding

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

getEntityDir

public java.nio.file.Path getEntityDir(java.lang.String entityName)