com.marklogic.hub

Interface StepDefinitionManager

All Known Implementing Classes:

StepDefinitionManagerImpl

public interface StepDefinitionManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STEP_DEFINITION_FILE_EXTENSION String value for the mapping file extension

Method Summary

Modifier and Type	Method and Description
StepDefinition	createStepDefinitionFromJSON(com.fasterxml.jackson.databind.JsonNode json) Creates a Step Definition from a given JsonNode
void	deleteStepDefinition(StepDefinition stepDefinition) Deletes a Step Definition from disk
StepDefinition	getStepDefinition(java.lang.String name, StepDefinition.StepDefinitionType type) Returns a single Step Definition given a name and a type
java.util.ArrayList<java.lang.String>	getStepDefinitionNamesByType(StepDefinition.StepDefinitionType type) Returns a list of Step Definition names that have the given type
java.util.ArrayList<StepDefinition>	getStepDefinitions() Returns a list of all Step Definition currently defined
java.util.ArrayList<StepDefinition>	getStepDefinitionsByType(StepDefinition.StepDefinitionType type) Returns a list of Step Definitions that have the given type
void	saveStepDefinition(StepDefinition stepDefinition) Saves a Step Definition to disk
void	saveStepDefinition(StepDefinition stepDefinition, boolean autoIncrement) Saves a Step Definition to disk

Field Detail

STEP_DEFINITION_FILE_EXTENSION

static final java.lang.String STEP_DEFINITION_FILE_EXTENSION

String value for the mapping file extension

See Also:

Constant Field Values

Method Detail

saveStepDefinition

void saveStepDefinition(StepDefinition stepDefinition)

Saves a Step Definition to disk

Parameters:

stepDefinition - - the Step Definition object to be saved

saveStepDefinition

void saveStepDefinition(StepDefinition stepDefinition,
                        boolean autoIncrement)

Saves a Step Definition to disk

Parameters:

stepDefinition - - the Step Definition object to be saved

autoIncrement - - true to increment version, false if not to

deleteStepDefinition

void deleteStepDefinition(StepDefinition stepDefinition)

Deletes a Step Definition from disk

Parameters:

stepDefinition - - the Step Definition object to be deleted

getStepDefinitions

java.util.ArrayList<StepDefinition> getStepDefinitions()

Returns a list of all Step Definition currently defined

Returns:

- an ArrayList of all Step Definition objects from disk

getStepDefinition

StepDefinition getStepDefinition(java.lang.String name,
                                 StepDefinition.StepDefinitionType type)

Returns a single Step Definition given a name and a type

Parameters:

name - - name of the Step Definition

type - - type of the Step Definition

Returns:

the Step Definition object

getStepDefinitionsByType

java.util.ArrayList<StepDefinition> getStepDefinitionsByType(StepDefinition.StepDefinitionType type)

Returns a list of Step Definitions that have the given type

Parameters:

type - - type of the Step Definition

Returns:

an ArrayList of Step Definition objects of a given type

getStepDefinitionNamesByType

java.util.ArrayList<java.lang.String> getStepDefinitionNamesByType(StepDefinition.StepDefinitionType type)

Returns a list of Step Definition names that have the given type

Parameters:

type - - type of the Step Definition

Returns:

an ArrayList of Step Definition names of a given type

createStepDefinitionFromJSON

StepDefinition createStepDefinitionFromJSON(com.fasterxml.jackson.databind.JsonNode json)

Creates a Step Definition from a given JsonNode

Parameters:

json - - a JsonNode

Returns:

a Step Definition object