com.github.cafdataprocessing.initialization.jsonobjects

Class WorkflowJson

java.lang.Object

com.github.cafdataprocessing.initialization.jsonobjects.WorkflowJson

public class WorkflowJson
extends Object

JSON representation of a data processing workflow for use with task submitter application

Field Summary

Fields

Modifier and Type	Field and Description
String	description
String	name
String	notes
List<ProcessingRuleJson>	processingRules

Constructor Summary

Constructors

Constructor and Description
WorkflowJson(String name, String description, String notes, List<ProcessingRuleJson> processingRules)

Method Summary

Modifier and Type	Method and Description
static WorkflowJson	readInputFile(String inputFilepath) Reads the contents of the file at the specified location and converts them to a WorkflowJson representation
static WorkflowJson	readInputStream(InputStream inputStream) Reads the the input stream and converts to a WorkflowJson representation
com.github.cafdataprocessing.processing.service.client.model.BaseWorkflow	toApiBaseWorkflow()

Methods inherited from class java.lang.Object

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

Field Detail

name

public final String name

description

public final String description

notes

public final String notes

processingRules

public final List<ProcessingRuleJson> processingRules

Constructor Detail

WorkflowJson

public WorkflowJson(String name,
                    String description,
                    String notes,
                    List<ProcessingRuleJson> processingRules)

Method Detail

toApiBaseWorkflow

public com.github.cafdataprocessing.processing.service.client.model.BaseWorkflow toApiBaseWorkflow()

readInputFile

public static WorkflowJson readInputFile(String inputFilepath)
                                  throws IOException,
                                         NullPointerException

Reads the contents of the file at the specified location and converts them to a WorkflowJson representation

Parameters:

inputFilepath - Path to the file with WorkflowJson definition.

Returns:

Converted WorkflowJson object.

Throws:

IOException - If unable to convert file contents.

NullPointerException - If the inputFilepath argument is null

readInputStream

public static WorkflowJson readInputStream(InputStream inputStream)
                                    throws IOException,
                                           NullPointerException

Reads the the input stream and converts to a WorkflowJson representation

Parameters:

inputStream - InputStream of a WorkflowJson definition.

Returns:

Converted WorkflowJson object.

Throws:

IOException - If unable to convert file contents.

NullPointerException - If the inputStream argument is null