com.marklogic.hub.step

Interface StepDefinition

All Known Implementing Classes:

AbstractStepDefinition, CustomStepDefinitionImpl, IngestionStepDefinitionImpl, MappingStepDefinitionImpl, MasteringStepDefinitionImpl, MatchingStepDefinitionImpl, MergingStepDefinitionImpl

public interface StepDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StepDefinition.StepDefinitionType

Method Summary

Modifier and Type	Method and Description
static StepDefinition	create(java.lang.String name, StepDefinition.StepDefinitionType type) Creates an in-memory default instance of a Step given a name and a type
void	deserialize(com.fasterxml.jackson.databind.JsonNode json) Deserialize a json response and applies it to this mapping
java.lang.Integer	getBatchSize() Returns the batch size
com.fasterxml.jackson.databind.JsonNode	getCustomHook() Returns the customHook
java.lang.String	getDescription() Returns the description of the Step
java.lang.String	getLang() Returns the language setting of the step
java.lang.String	getLanguage() Deprecated.
java.lang.String	getModulePath() Returns path to the module
java.lang.String	getName() Returns the name of the step
java.util.Map<java.lang.String,java.lang.Object>	getOptions() Returns the step options as a map
int	getRetryLimit() Returns the retry limit for the step
java.lang.String	getSourceQuery() Returns the step sourceQuery
java.lang.Integer	getThreadCount() Returns the thread count
StepDefinition.StepDefinitionType	getType() Returns the type of the Step
java.lang.Integer	getVersion() Return the step version
void	incrementVersion() Automatically increments the version of the mapping by 1
void	setBatchSize(java.lang.Integer batchSize) Sets the batch size for running this step
void	setCustomHook(com.fasterxml.jackson.databind.JsonNode hookObj) Sets the customHook
void	setDescription(java.lang.String description) Sets the description for the step
void	setModulePath(java.lang.String path) Sets the module path
void	setName(java.lang.String name) Sets the name of the step
void	setOptions(java.util.Map<java.lang.String,java.lang.Object> options) Sets the step options
void	setRetryLimit(int retryLimit) Sets the retry limit for the step
void	setSourceQuery(java.lang.String sourceQuery) Sets the sourceQuery for the step
void	setThreadCount(java.lang.Integer threadCount) Sets the thread count for running this step
void	setType(StepDefinition.StepDefinitionType type) Sets the type of the step
void	setVersion(java.lang.Integer version) Sets the step version number
StepDefinition	transformFromStep(StepDefinition stepDefinition, Step step)
Step	transformToStep(java.lang.String stepName, StepDefinition stepDefinition, Step step)

Method Detail

create

static StepDefinition create(java.lang.String name,
                             StepDefinition.StepDefinitionType type)

Creates an in-memory default instance of a Step given a name and a type

Parameters:

name - - the name of the Step

type - - the type of the mapping

Returns:

a Step object

getName

java.lang.String getName()

Returns the name of the step

Returns:

a step name

setName

void setName(java.lang.String name)

Sets the name of the step

Parameters:

name - - a step name

getLanguage

@Deprecated
java.lang.String getLanguage()

Deprecated.

Returns the language setting of the step

Returns:

'zxx', the default setting

getLang

java.lang.String getLang()

Returns the language setting of the step

Returns:

'zxx', the default setting

getVersion

java.lang.Integer getVersion()

Return the step version

Returns:

- a step version

setVersion

void setVersion(java.lang.Integer version)

Sets the step version number

Parameters:

version - - a step version

getOptions

java.util.Map<java.lang.String,java.lang.Object> getOptions()

Returns the step options as a map

Returns:

- options map

setOptions

void setOptions(java.util.Map<java.lang.String,java.lang.Object> options)

Sets the step options

Parameters:

options - - a options map

getModulePath

java.lang.String getModulePath()

Returns path to the module

Returns:

- a string path to the module

setModulePath

void setModulePath(java.lang.String path)

Sets the module path

Parameters:

path - - a string path to the module

getCustomHook

com.fasterxml.jackson.databind.JsonNode getCustomHook()

Returns the customHook

Returns:

- a customHook node

setCustomHook

void setCustomHook(com.fasterxml.jackson.databind.JsonNode hookObj)

Sets the customHook

Parameters:

hookObj - - a customHook node

getSourceQuery

java.lang.String getSourceQuery()

Returns the step sourceQuery

Returns:

- a string sourceQuery

setSourceQuery

void setSourceQuery(java.lang.String sourceQuery)

Sets the sourceQuery for the step

Parameters:

sourceQuery - - a string sourceQuery

getRetryLimit

int getRetryLimit()

Returns the retry limit for the step

Returns:

- an integer retry limit

setRetryLimit

void setRetryLimit(int retryLimit)

Sets the retry limit for the step

Parameters:

retryLimit - - an integer retry limit

getType

StepDefinition.StepDefinitionType getType()

Returns the type of the Step

Returns:

- a step type

setType

void setType(StepDefinition.StepDefinitionType type)

Sets the type of the step

Parameters:

type - - a step type

getDescription

java.lang.String getDescription()

Returns the description of the Step

Returns:

- a step description

setDescription

void setDescription(java.lang.String description)

Sets the description for the step

Parameters:

description - - a string description

getBatchSize

java.lang.Integer getBatchSize()

Returns the batch size

Returns:

- an integer batch size

setBatchSize

void setBatchSize(java.lang.Integer batchSize)

Sets the batch size for running this step

Parameters:

batchSize - - an integer

getThreadCount

java.lang.Integer getThreadCount()

Returns the thread count

Returns:

- thread count as integer

setThreadCount

void setThreadCount(java.lang.Integer threadCount)

Sets the thread count for running this step

Parameters:

threadCount - - an integer

incrementVersion

void incrementVersion()

Automatically increments the version of the mapping by 1

deserialize

void deserialize(com.fasterxml.jackson.databind.JsonNode json)

Deserialize a json response and applies it to this mapping

Parameters:

json - - the JsonNode you want deserialize

transformToStep

Step transformToStep(java.lang.String stepName,
                     StepDefinition stepDefinition,
                     Step step)

Parameters:

stepName - name of the step

stepDefinition - step definition object to transform from

step - step object to be transformed

Returns:

a transformed step object

transformFromStep

StepDefinition transformFromStep(StepDefinition stepDefinition,
                                 Step step)

Parameters:

stepDefinition - step definition to be transformed

step - step object to transform from

Returns:

a transformed step definition object