Module datarush.library
Class GenerateRepeatingCycle
- java.lang.Object
-
- com.pervasive.datarush.operators.AbstractLogicalOperator
-
- com.pervasive.datarush.operators.StreamingOperator
-
- com.pervasive.datarush.operators.ExecutableOperator
-
- com.pervasive.datarush.operators.source.GenerateRepeatingCycle
-
- All Implemented Interfaces:
LogicalOperator
,RecordSourceOperator
,SourceOperator<RecordPort>
public final class GenerateRepeatingCycle extends ExecutableOperator implements RecordSourceOperator
Generates a cycle of repeating values. First all the rows of the input are copied to the output, then all the rows of the input are copied to the output again, etc. Output stops when the desired row count is reached.NOTE: this operator is non-parallel
-
-
Constructor Summary
Constructors Constructor Description GenerateRepeatingCycle()
The default constructor.GenerateRepeatingCycle(long rowCount)
Creates a new instance ofGenerateRepeatingCycle
, specifying the minimal set of required parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
computeMetadata(StreamingMetadataContext ctx)
Implementations must adhere to the following contractsprotected void
execute(ExecutionContext ctx)
Executes the operator.RecordPort
getInput()
The flow of data to be repeated cyclically.RecordPort
getOutput()
Gets the flow of generated values.long
getRowCount()
Returns the number of values to generatevoid
setRowCount(long rowCount)
Sets the number of values to generate-
Methods inherited from class com.pervasive.datarush.operators.ExecutableOperator
cloneForExecution, getNumInputCopies, getPortSettings, handleInactiveOutput
-
Methods inherited from class com.pervasive.datarush.operators.AbstractLogicalOperator
disableParallelism, getInputPorts, getOutputPorts, newInput, newInput, newOutput, newRecordInput, newRecordInput, newRecordOutput, notifyError
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.pervasive.datarush.operators.LogicalOperator
disableParallelism, getInputPorts, getOutputPorts
-
-
-
-
Constructor Detail
-
GenerateRepeatingCycle
public GenerateRepeatingCycle()
The default constructor. Prior to graph compilation the following properties should be specified:
-
GenerateRepeatingCycle
public GenerateRepeatingCycle(long rowCount)
Creates a new instance ofGenerateRepeatingCycle
, specifying the minimal set of required parameters.- Parameters:
rowCount
- the number of rows
-
-
Method Detail
-
getRowCount
public long getRowCount()
Returns the number of values to generate- Returns:
- the number of values to generate
-
setRowCount
public void setRowCount(long rowCount)
Sets the number of values to generate- Parameters:
rowCount
- the number of values to generate
-
getInput
public RecordPort getInput()
The flow of data to be repeated cyclically. The data must contain at least one row, and must be small enough to fit in memory.- Returns:
- the input data port
-
getOutput
public RecordPort getOutput()
Gets the flow of generated values. This flow will be of the same type as the original input flow.- Specified by:
getOutput
in interfaceRecordSourceOperator
- Specified by:
getOutput
in interfaceSourceOperator<RecordPort>
- Returns:
- the flow of generated values
-
computeMetadata
protected void computeMetadata(StreamingMetadataContext ctx)
Description copied from class:StreamingOperator
Implementations must adhere to the following contractsGeneral
Regardless of input ports/output port types, all implementations must do the following:- Validation. Validation of configuration should always be performed first.
- Declare parallelizability.. Implementations must declare parallelizability by calling
StreamingMetadataContext.parallelize(ParallelismStrategy)
.
Input record ports
Implementations with input record ports must declare the following:- Required data ordering: Implementations that have data ordering requirements must declare them by calling
- Required data distribution (only applies to parallelizable operators): Implementations that have data distribution requirements must declare them by calling
RecordPort#setRequiredDataOrdering
, otherwise data may arrive in any order.RecordPort#setRequiredDataDistribution
, otherwise data will arrive in anunspecified partial distribution
.RecordPort#getSourceDataDistribution
andRecordPort#getSourceDataOrdering
. These should be viewed as a hints to help chose a more efficient algorithm. In such cases, though, operators must still declare data ordering and data distribution requirements; otherwise there is no guarantee that data will arrive sorted/distributed as required.Output record ports
Implementations with output record ports must declare the following:- Type: Implementations must declare their output type by calling
RecordPort#setType
.
- Output data ordering: Implementations that can make guarantees as to their output
ordering may do so by calling
RecordPort#setOutputDataOrdering
- Output data distribution (only applies to parallelizable operators): Implementations that can make guarantees as to their output
distribution may do so by calling
RecordPort#setOutputDataDistribution
Input model ports
In general, there is nothing special to declare for input model ports. Models are implicitly duplicated to all partitions when going from non-parallel to parallel operators. The case of a model going from a parallel to a non-parallel node is a special case of a "model reducer" operator. In the case of a model reducer, the downstream operator, must declare the following:- Merge handler: Model reducers must declare a merge handler by
calling
AbstractModelPort#setMergeHandler
.
MergeModel
is a convenient, re-usable model reducer, parameterized with a merge-handler.Output model ports
SimpleModelPort
's have no associated metadata and therefore there is never any output metadata to declare.PMMLPort
's, on the other hand, do have associated metadata. For all PMMLPorts, implementations must declare the following:- pmmlModelSpec: Implementations must declare the PMML model spec
by calling
PMMLPort.setPMMLModelSpec
.
- Specified by:
computeMetadata
in classStreamingOperator
- Parameters:
ctx
- the context
-
execute
protected void execute(ExecutionContext ctx)
Description copied from class:ExecutableOperator
Executes the operator. Implementations should adhere to the following contracts:- Following execution, all input ports must be at end-of-data.
- Following execution, all output ports must be at end-of-data.
- Specified by:
execute
in classExecutableOperator
- Parameters:
ctx
- context in which to lookup physical ports bound to logical ports
-
-