public interface Scaffolding
Modifier and Type | Method and Description |
---|---|
static Scaffolding |
create(java.lang.String projectDir,
com.marklogic.client.DatabaseClient databaseClient)
Creates and returns a Scaffolding object
|
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
|
java.nio.file.Path |
getFlowDir(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
|
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
|
static Scaffolding create(java.lang.String projectDir, com.marklogic.client.DatabaseClient databaseClient)
projectDir
- - the path to the project as a stringdatabaseClient
- - the database client that will be used to connectjava.nio.file.Path getFlowDir(java.lang.String entityName, java.lang.String flowName, FlowType flowType)
entityName
- - the entity nameflowName
- - the name of the flowflowType
- - FlowType (sjs or xqy)void createEntity(java.lang.String entityName)
entityName
- - the name of the entity as stringvoid createFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType, CodeFormat codeFormat, DataFormat dataFormat)
entityName
- - name of the entity to associate the flow withflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumdataFormat
- - the format of the data (json or xml)void createFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType, CodeFormat codeFormat, DataFormat dataFormat, boolean useEsModel)
entityName
- - name of the entity to associate the flow withflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumdataFormat
- - the format of the data (json or xml)useEsModel
- - true to use Entity Services, false not tojava.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion, java.lang.String entityName)
fromVersion
- - string version number of DHFentityName
- - the entity which the flow is attachedvoid updateLegacyEntity(java.lang.String entityName)
entityName
- - name of the entityboolean updateLegacyFlow(java.lang.String fromVersion, java.lang.String entityName, java.lang.String flowName, FlowType flowType)
fromVersion
- - string version number of DHFentityName
- - the entity which the flow is attachedflowName
- - the name of the flow as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestvoid createRestExtension(java.lang.String entityName, java.lang.String extensionName, FlowType flowType, CodeFormat codeFormat) throws ScaffoldingValidationException
entityName
- - the entity which the flow is attachedextensionName
- - the name of the extension as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumScaffoldingValidationException
void createRestTransform(java.lang.String entityName, java.lang.String transformName, FlowType flowType, CodeFormat codeFormat) throws ScaffoldingValidationException
entityName
- - the entity which the flow is attachedtransformName
- - the name of the transform as a stringflowType
- - the type of flow as TypeFlow, eg: harmonize or ingestcodeFormat
- - the format of the code as CodeFormat enumScaffoldingValidationException