public class ScaffoldingImpl extends java.lang.Object implements Scaffolding
Modifier and Type | Class and Description |
---|---|
class |
ScaffoldingImpl.ContentPlugin |
Modifier and Type | Field and Description |
---|---|
protected org.slf4j.Logger |
logger |
Constructor and Description |
---|
ScaffoldingImpl(java.lang.String projectDir,
com.marklogic.client.DatabaseClient databaseClient) |
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
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
public ScaffoldingImpl(java.lang.String projectDir, com.marklogic.client.DatabaseClient databaseClient)
public static java.lang.String getAbsolutePath(java.lang.String first, java.lang.String... more)
public java.nio.file.Path getFlowDir(java.lang.String entityName, java.lang.String flowName, FlowType flowType)
Scaffolding
getFlowDir
in interface Scaffolding
entityName
- - the entity nameflowName
- - the name of the flowflowType
- - FlowType (sjs or xqy)public void createEntity(java.lang.String entityName)
Scaffolding
createEntity
in interface Scaffolding
entityName
- - the name of the entity as stringpublic void createFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType, CodeFormat codeFormat, DataFormat dataFormat)
Scaffolding
createFlow
in interface Scaffolding
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)public void createFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType, CodeFormat codeFormat, DataFormat dataFormat, boolean useEsModel)
Scaffolding
createFlow
in interface Scaffolding
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 topublic java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion, java.lang.String entityName)
Scaffolding
updateLegacyFlows
in interface Scaffolding
fromVersion
- - string version number of DHFentityName
- - the entity which the flow is attachedpublic void updateLegacyEntity(java.lang.String entityName)
Scaffolding
updateLegacyEntity
in interface Scaffolding
entityName
- - name of the entitypublic boolean updateLegacyFlow(java.lang.String fromVersion, java.lang.String entityName, java.lang.String flowName, FlowType flowType)
Scaffolding
updateLegacyFlow
in interface Scaffolding
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 ingestpublic boolean update2xFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType)
public void createRestExtension(java.lang.String entityName, java.lang.String extensionName, FlowType flowType, CodeFormat codeFormat) throws ScaffoldingValidationException
Scaffolding
createRestExtension
in interface Scaffolding
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
public void createRestTransform(java.lang.String entityName, java.lang.String transformName, FlowType flowType, CodeFormat codeFormat) throws ScaffoldingValidationException
Scaffolding
createRestTransform
in interface Scaffolding
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
public java.nio.file.Path getEntityDir(java.lang.String entityName)