com.github.cafdataprocessing.utilities.initialization

Class WorkflowInitializationParams

java.lang.Object

com.github.cafdataprocessing.utilities.initialization.WorkflowInitializationParams

public class WorkflowInitializationParams
extends Object

Parameters to use for method calls to the WorkflowInitializer class.

Constructor Summary

Constructors

Constructor and Description
WorkflowInitializationParams(InputStream workflowBaseDataStream, InputStream workflowOverlayStream, String projectId) Create the parameter object with required properties.
WorkflowInitializationParams(InputStream workflowBaseDataStream, String projectId) Create the parameter object with required properties.
WorkflowInitializationParams(String workflowBaseDataFileName, String projectId) Create the parameter object with required properties.
WorkflowInitializationParams(String workflowBaseDataFileName, String workflowOverlayFileName, String projectId) Create the parameter object with required properties.

Method Summary

Modifier and Type	Method and Description
boolean	getOverwriteExisting() Get whether existing workflows under the projectId with the same name as the provided workflow should be removed.
String	getProjectId()
String	getWorkflowBaseDataFileName()
WorkflowJson	getWorkflowBaseDataJson() Builds a WorkflowJson object using the workflowBaseDataStream if set or the workflowBaseDataFileName.
InputStream	getWorkflowBaseDataStream()
String	getWorkflowOverlayFileName()
WorkflowJson	getWorkflowOverlayJson() Builds a WorkflowJson object using the workflowOverlayStream if set or the workflowOverlayFileName.
InputStream	getWorkflowOverlayStream() Get InputStream containing extensions / overrides to merge with the base workflow.
void	setOverwriteExisting(boolean overwriteExisting) Set whether existing workflows under the projectId with the same name as the provided workflow should be removed.
void	setWorkflowOverlayFileName(String workflowOverlayFileName) Set Path to file containing extensions / overrides to merge with the base workflow.
void	setWorkflowOverlayStream(InputStream workflowOverlayStream) Set InputStream containing extensions / overrides to merge with the base workflow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowInitializationParams

public WorkflowInitializationParams(String workflowBaseDataFileName,
                                    String projectId)

Create the parameter object with required properties.

Parameters:

workflowBaseDataFileName - Path to file containing workflow in JSON format that should be created.

projectId - ProjectId to create workflow under.

WorkflowInitializationParams

public WorkflowInitializationParams(String workflowBaseDataFileName,
                                    String workflowOverlayFileName,
                                    String projectId)

Create the parameter object with required properties.

Parameters:

workflowBaseDataFileName - Path to file containing workflow in JSON format that should be created.

workflowOverlayFileName - Path to file containing extensions / overrides to merge with the base.

projectId - ProjectId to create workflow under.

WorkflowInitializationParams

public WorkflowInitializationParams(InputStream workflowBaseDataStream,
                                    String projectId)

Create the parameter object with required properties.

Parameters:

workflowBaseDataStream - Input stream containing workflow in JSON format that should be created.

projectId - ProjectId to create workflow under.

WorkflowInitializationParams

public WorkflowInitializationParams(InputStream workflowBaseDataStream,
                                    InputStream workflowOverlayStream,
                                    String projectId)

Create the parameter object with required properties.

Parameters:

workflowBaseDataStream - Input stream containing workflow in JSON format that should be created.

workflowOverlayStream - InputStream containing extensions / overrides to merge with the base workflow

projectId - ProjectId to create workflow under.

Method Detail

getOverwriteExisting

public boolean getOverwriteExisting()

Get whether existing workflows under the projectId with the same name as the provided workflow should be removed.

getProjectId

public String getProjectId()

getWorkflowBaseDataFileName

public String getWorkflowBaseDataFileName()

getWorkflowBaseDataJson

public WorkflowJson getWorkflowBaseDataJson()
                                     throws IOException

Builds a WorkflowJson object using the workflowBaseDataStream if set or the workflowBaseDataFileName. Returns null if neither is set.

Returns:

Constructed WorkflowJson form overlay settings or null if neither workflowBaseDataStream or workflowBaseDataFileName have been set.

Throws:

IOException - IOException If unable to convert Input Stream or file contents to WorkflowJson object.

getWorkflowBaseDataStream

public InputStream getWorkflowBaseDataStream()

getWorkflowOverlayFileName

public String getWorkflowOverlayFileName()

getWorkflowOverlayJson

public WorkflowJson getWorkflowOverlayJson()
                                    throws IOException

Builds a WorkflowJson object using the workflowOverlayStream if set or the workflowOverlayFileName. Returns null if neither is set.

Returns:

Constructed WorkflowJson form overlay settings or null if neither workflowOverlayStream or workflowOverlayFileName have been set.

Throws:

IOException - IOException If unable to convert Input Stream or file contents to WorkflowJson object.

getWorkflowOverlayStream

public InputStream getWorkflowOverlayStream()

Get InputStream containing extensions / overrides to merge with the base workflow.

setOverwriteExisting

public void setOverwriteExisting(boolean overwriteExisting)

Set whether existing workflows under the projectId with the same name as the provided workflow should be removed.

Parameters:

overwriteExisting - Value to set overwriteExisting to.

setWorkflowOverlayFileName

public void setWorkflowOverlayFileName(String workflowOverlayFileName)

Set Path to file containing extensions / overrides to merge with the base workflow.

Parameters:

workflowOverlayFileName - Path to file containing extensions / overrides to merge with the base workflow

setWorkflowOverlayStream

public void setWorkflowOverlayStream(InputStream workflowOverlayStream)

Set InputStream containing extensions / overrides to merge with the base workflow.

Parameters:

workflowOverlayStream - InputStream containing extensions / overrides to merge with the base workflow