Class AbstractExtractStep

java.lang.Object

com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractExtractStep

All Implemented Interfaces:

BackendStep

Direct Known Subclasses:

BulkInsertExtractStep, ExtractViaQueryStep

public abstract class AbstractExtractStep
extends Object
implements BackendStep

Base class for the Extract logic of Streamed ETL processes. These steps are invoked by both the "preview" and the "execute" steps of a StreamedETLWithFrontend process. Key here, is that subclasses here should put records that they're "Extracting" into the recordPipe member. That is to say, DO NOT use the recordList in the Step input/output objects. Ideally, they'll also stop once they've hit the "limit" number of records (though if you keep going, the pipe will get terminated and the job will be cancelled, etc...).

Constructor Summary

Constructors

Constructor	Description
AbstractExtractStep()

Method Summary

Modifier and Type	Method	Description
RecordPipe	createRecordPipe(RunBackendStepInput runBackendStepInput, Integer overrideCapacity)	Create the record pipe to be used for this process step.
Integer	doCount(RunBackendStepInput runBackendStepInput)
Integer	getLimit()	Getter for limit
RecordPipe	getRecordPipe()
void	preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput)	Allow subclasses to do an action before the run begins.
void	setLimit(Integer limit)	Setter for limit
void	setRecordPipe(RecordPipe recordPipe)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.actions.processes.BackendStep

run

Constructor Details

AbstractExtractStep

public AbstractExtractStep()

Method Details

preRun

public void preRun(RunBackendStepInput runBackendStepInput,
 RunBackendStepOutput runBackendStepOutput)
            throws QException

Allow subclasses to do an action before the run begins.

Throws:

QException

doCount

public Integer doCount(RunBackendStepInput runBackendStepInput)
                throws QException

Throws:

QException

setRecordPipe

public void setRecordPipe(RecordPipe recordPipe)

getRecordPipe

public RecordPipe getRecordPipe()

getLimit

public Integer getLimit()

Getter for limit

setLimit

public void setLimit(Integer limit)

Setter for limit

createRecordPipe

public RecordPipe createRecordPipe(RunBackendStepInput runBackendStepInput,
 Integer overrideCapacity)

Create the record pipe to be used for this process step. Here in case a subclass needs a different type of pipe - for example, a DistinctFilteringRecordPipe.