AbstractStepDefinition (marklogic-data-hub 5.2.6 API)

java.lang.Object
- com.marklogic.hub.step.AbstractStepDefinition

All Implemented Interfaces:

StepDefinition

Direct Known Subclasses:

CustomStepDefinitionImpl, IngestionStepDefinitionImpl, MappingStepDefinitionImpl, MasteringStepDefinitionImpl, MatchingStepDefinitionImpl, MergingStepDefinitionImpl
```
public abstract class AbstractStepDefinition
extends java.lang.Object
implements StepDefinition
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.marklogic.hub.step.StepDefinition
  StepDefinition.StepDefinitionType

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractStepDefinition()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractStepDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.marklogic.hub.step.StepDefinition
create

- Constructor Detail
  - AbstractStepDefinition
```
protected AbstractStepDefinition()
```
- Method Detail
  - getLanguage
```
@Deprecated
public java.lang.String getLanguage()
```
    Deprecated.
    
    Description copied from interface: StepDefinition
    
    Returns the language setting of the step
    
    Specified by:
    
    getLanguage in interface StepDefinition
    
    Returns:
    
    'zxx', the default setting
  - getLang
```
public java.lang.String getLang()
```
    Description copied from interface: StepDefinition
    
    Returns the language setting of the step
    
    Specified by:
    
    getLang in interface StepDefinition
    
    Returns:
    
    'zxx', the default setting
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: StepDefinition
    
    Returns the name of the step
    
    Specified by:
    
    getName in interface StepDefinition
    
    Returns:
    
    a step name
  - setName
```
public void setName(java.lang.String name)
```
    Description copied from interface: StepDefinition
    
    Sets the name of the step
    
    Specified by:
    
    setName in interface StepDefinition
    
    Parameters:
    
    name - - a step name
  - getType
```
public StepDefinition.StepDefinitionType getType()
```
    Description copied from interface: StepDefinition
    
    Returns the type of the Step
    
    Specified by:
    
    getType in interface StepDefinition
    
    Returns:
    
    - a step type
  - setType
```
public void setType(StepDefinition.StepDefinitionType type)
```
    Description copied from interface: StepDefinition
    
    Sets the type of the step
    
    Specified by:
    
    setType in interface StepDefinition
    
    Parameters:
    
    type - - a step type
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: StepDefinition
    
    Returns the description of the Step
    
    Specified by:
    
    getDescription in interface StepDefinition
    
    Returns:
    
    - a step description
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description copied from interface: StepDefinition
    
    Sets the description for the step
    
    Specified by:
    
    setDescription in interface StepDefinition
    
    Parameters:
    
    description - - a string description
  - getVersion
```
public java.lang.Integer getVersion()
```
    Description copied from interface: StepDefinition
    
    Return the step version
    
    Specified by:
    
    getVersion in interface StepDefinition
    
    Returns:
    
    - a step version
  - setVersion
```
public void setVersion(java.lang.Integer version)
```
    Description copied from interface: StepDefinition
    
    Sets the step version number
    
    Specified by:
    
    setVersion in interface StepDefinition
    
    Parameters:
    
    version - - a step version
  - getOptions
```
public java.util.Map<java.lang.String,java.lang.Object> getOptions()
```
    Description copied from interface: StepDefinition
    
    Returns the step options as a map
    
    Specified by:
    
    getOptions in interface StepDefinition
    
    Returns:
    
    - options map
  - setOptions
```
public void setOptions(java.util.Map<java.lang.String,java.lang.Object> options)
```
    Description copied from interface: StepDefinition
    
    Sets the step options
    
    Specified by:
    
    setOptions in interface StepDefinition
    
    Parameters:
    
    options - - a options map
  - getModulePath
```
public java.lang.String getModulePath()
```
    Description copied from interface: StepDefinition
    
    Returns path to the module
    
    Specified by:
    
    getModulePath in interface StepDefinition
    
    Returns:
    
    - a string path to the module
  - setModulePath
```
public void setModulePath(java.lang.String path)
```
    Description copied from interface: StepDefinition
    
    Sets the module path
    
    Specified by:
    
    setModulePath in interface StepDefinition
    
    Parameters:
    
    path - - a string path to the module
  - getCustomHook
```
public com.fasterxml.jackson.databind.JsonNode getCustomHook()
```
    Description copied from interface: StepDefinition
    
    Returns the customHook
    
    Specified by:
    
    getCustomHook in interface StepDefinition
    
    Returns:
    
    - a customHook node
  - setCustomHook
```
public void setCustomHook(com.fasterxml.jackson.databind.JsonNode hookObj)
```
    Description copied from interface: StepDefinition
    
    Sets the customHook
    
    Specified by:
    
    setCustomHook in interface StepDefinition
    
    Parameters:
    
    hookObj - - a customHook node
  - getSourceQuery
```
public java.lang.String getSourceQuery()
```
    Description copied from interface: StepDefinition
    
    Returns the step sourceQuery
    
    Specified by:
    
    getSourceQuery in interface StepDefinition
    
    Returns:
    
    - a string sourceQuery
  - setSourceQuery
```
public void setSourceQuery(java.lang.String sourceQuery)
```
    Description copied from interface: StepDefinition
    
    Sets the sourceQuery for the step
    
    Specified by:
    
    setSourceQuery in interface StepDefinition
    
    Parameters:
    
    sourceQuery - - a string sourceQuery
  - getRetryLimit
```
public int getRetryLimit()
```
    Description copied from interface: StepDefinition
    
    Returns the retry limit for the step
    
    Specified by:
    
    getRetryLimit in interface StepDefinition
    
    Returns:
    
    - an integer retry limit
  - setRetryLimit
```
public void setRetryLimit(int retryLimit)
```
    Description copied from interface: StepDefinition
    
    Sets the retry limit for the step
    
    Specified by:
    
    setRetryLimit in interface StepDefinition
    
    Parameters:
    
    retryLimit - - an integer retry limit
  - getBatchSize
```
public java.lang.Integer getBatchSize()
```
    Description copied from interface: StepDefinition
    
    Returns the batch size
    
    Specified by:
    
    getBatchSize in interface StepDefinition
    
    Returns:
    
    - an integer batch size
  - setBatchSize
```
public void setBatchSize(java.lang.Integer batchSize)
```
    Description copied from interface: StepDefinition
    
    Sets the batch size for running this step
    
    Specified by:
    
    setBatchSize in interface StepDefinition
    
    Parameters:
    
    batchSize - - an integer
  - getThreadCount
```
public java.lang.Integer getThreadCount()
```
    Description copied from interface: StepDefinition
    
    Returns the thread count
    
    Specified by:
    
    getThreadCount in interface StepDefinition
    
    Returns:
    
    - thread count as integer
  - setThreadCount
```
public void setThreadCount(java.lang.Integer threadCount)
```
    Description copied from interface: StepDefinition
    
    Sets the thread count for running this step
    
    Specified by:
    
    setThreadCount in interface StepDefinition
    
    Parameters:
    
    threadCount - - an integer
  - incrementVersion
```
public void incrementVersion()
```
    Description copied from interface: StepDefinition
    
    Automatically increments the version of the mapping by 1
    
    Specified by:
    
    incrementVersion in interface StepDefinition
  - deserialize
```
public void deserialize(com.fasterxml.jackson.databind.JsonNode json)
```
    Description copied from interface: StepDefinition
    
    Deserialize a json response and applies it to this mapping
    
    Specified by:
    
    deserialize in interface StepDefinition
    
    Parameters:
    
    json - - the JsonNode you want deserialize
  - transformToStep
```
public Step transformToStep(java.lang.String stepName,
                            StepDefinition stepDefinition,
                            Step step)
```
    Specified by:
    
    transformToStep in interface StepDefinition
    
    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
```
public StepDefinition transformFromStep(StepDefinition stepDefinition,
                                        Step step)
```
    Specified by:
    
    transformFromStep in interface StepDefinition
    
    Parameters:
    
    stepDefinition - step definition to be transformed
    
    step - step object to transform from
    
    Returns:
    
    a transformed step definition object

Class AbstractStepDefinition

Nested Class Summary

Nested classes/interfaces inherited from interface com.marklogic.hub.step.StepDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.marklogic.hub.step.StepDefinition

Constructor Detail

AbstractStepDefinition

Method Detail

getLanguage

getLang

getName

setName

getType

setType

getDescription

setDescription

getVersion

setVersion

getOptions

setOptions

getModulePath

setModulePath

getCustomHook

setCustomHook

getSourceQuery

setSourceQuery

getRetryLimit

setRetryLimit

getBatchSize

setBatchSize

getThreadCount

setThreadCount

incrementVersion

deserialize

transformToStep

transformFromStep