T - the type of the extracted source dataS - the type of the transformed documentspublic abstract class AbstractIteratorETL<T,S> extends AbstractETL<Iterator<T>,Iterator<S>>
| Modifier and Type | Field and Description |
|---|---|
protected IntegerParameter |
endIndexParameter |
protected AtomicInteger |
harvestedCount |
protected IntegerParameter |
startIndexParameter |
enabledParameter, extractor, hash, healthHistory, loader, logger, name, stateHistory, transformer| Constructor and Description |
|---|
AbstractIteratorETL()
Forwarding super class constructor.
|
AbstractIteratorETL(String name)
Forwarding super class constructor.
|
| Modifier and Type | Method and Description |
|---|---|
int |
getEndIndex()
Returns the end index 'b' of the harvesting range [a,b).
|
int |
getHarvestedCount()
Retrieves the number of documents that have been loaded.
|
int |
getMaxNumberOfDocuments()
Returns the total number of documents that are harvested,
considering the range parameters.
|
int |
getStartIndex()
Returns start index 'a' of the harvesting range [a,b).
|
void |
incrementHarvestedDocuments()
This function increments the document counter.
|
void |
loadFromJson(ETLJson json)
Loads the state from a JSON representation of this ETL.
|
protected void |
onParameterChanged(ParameterChangedEvent event)
The implementation of the parameter changed callback.
|
void |
prepareHarvest()
Checks pre-conditions required for starting a harvest and updates the data
that is to be extracted.
|
protected void |
registerParameters()
Registers all configurable parameters.
|
abortHarvest, addEventListeners, cancelHarvest, createExtractor, createLoader, createTransformer, finishHarvestExceptionally, getAsJson, getCharset, getHash, getHealth, getName, getState, harvest, init, initHash, initMaxNumberOfDocuments, isEnabled, onContextDestroyed, onHarvestFinished, onResetContext, removeEventListeners, setHealth, setName, setStatus, skipHarvest, toString, updateprotected volatile IntegerParameter startIndexParameter
protected volatile IntegerParameter endIndexParameter
protected final AtomicInteger harvestedCount
public AbstractIteratorETL()
public AbstractIteratorETL(String name)
name - the name of this ETLprotected void registerParameters()
AbstractETLregisterParameters in class AbstractETL<Iterator<T>,Iterator<S>>public void loadFromJson(ETLJson json)
AbstractETLloadFromJson in class AbstractETL<Iterator<T>,Iterator<S>>json - a simplified JSON representation of the ETLpublic void prepareHarvest()
throws ETLPreconditionException
AbstractETLprepareHarvest in class AbstractETL<Iterator<T>,Iterator<S>>ETLPreconditionException - thrown if the harvest cannot startpublic int getHarvestedCount()
AbstractETLgetHarvestedCount in class AbstractETL<Iterator<T>,Iterator<S>>public int getMaxNumberOfDocuments()
getMaxNumberOfDocuments in class AbstractETL<Iterator<T>,Iterator<S>>public int getStartIndex()
public int getEndIndex()
public void incrementHarvestedDocuments()
protected void onParameterChanged(ParameterChangedEvent event)
AbstractETLonParameterChanged in class AbstractETL<Iterator<T>,Iterator<S>>event - the event that triggered the callbackCopyright © 2017–2019. All rights reserved.