com.pervasive.datarush.operators.io.paraccel

Class InitializeWorkerBase<ExecState>

java.lang.Object

com.pervasive.datarush.operators.AbstractLogicalOperator

com.pervasive.datarush.operators.StreamingOperator

com.pervasive.datarush.operators.ExecutableOperator

com.pervasive.datarush.operators.io.paraccel.InitializeWorkerBase<ExecState>

All Implemented Interfaces:

LogicalOperator

Direct Known Subclasses:

MatrixSinkInitializeWorker

public abstract class InitializeWorkerBase<ExecState>
extends ExecutableOperator

Field Summary

Fields

Modifier and Type	Field and Description
protected int	endPortRange
protected static org.apache.commons.logging.Log	logger
protected int	retryCount
protected int	startPortRange
protected String	table
protected List<String>	targetColumns
protected int	traceLevel
protected int	workerParallelism

Constructor Summary

Constructors

Constructor and Description
InitializeWorkerBase()

Method Summary

Modifier and Type	Method and Description
protected abstract void	cancel(ExecState state)
protected abstract void	checkRetryState(ExecState invokerRef)
protected void	computeMetadata(StreamingMetadataContext ctx) Implementations must adhere to the following contracts
protected abstract ExecState	createInvoker(ExecutionContext ctx, String invokerId)
protected void	execute(ExecutionContext ctx) Executes the operator.
int	getEndPortRange()
int	getRetryCount()
List<com.pervasive.datarush.operators.io.paraccel.SliceIdentifier>	getSliceIdentifiers()
SimpleModelPort<com.pervasive.datarush.operators.io.paraccel.SliceInfo>	getSliceOutput()
int	getStartPortRange()
String	getTable()
List<String>	getTargetColumns()
int	getTimeoutInterval()
int	getTraceLevel()
int	getWorkerParallelism()
protected abstract void	initializeProtocol(String invokerId, ExecState invoker, InetAddress inetAddr, int port, com.pervasive.datarush.operators.io.paraccel.SliceInfo sliceInfo, int partitionCount)
void	setEndPortRange(int endPortRange)
void	setRetryCount(int retryCount)
void	setSliceIdentifiers(List<com.pervasive.datarush.operators.io.paraccel.SliceIdentifier> sliceIdentifiers)
void	setStartPortRange(int startPortRange)
void	setTable(String table)
void	setTargetColumns(List<String> targetColumns)
void	setTimeoutInterval(int timeoutInterval)
void	setTraceLevel(int traceLevel)
void	setWorkerParallelism(int workerParallelism)

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

Field Detail

logger

protected static final org.apache.commons.logging.Log logger

workerParallelism

protected int workerParallelism

targetColumns

protected List<String> targetColumns

traceLevel

protected int traceLevel

retryCount

protected int retryCount

table

protected String table

startPortRange

protected int startPortRange

endPortRange

protected int endPortRange

Constructor Detail

InitializeWorkerBase

public InitializeWorkerBase()

Method Detail

getSliceOutput

public SimpleModelPort<com.pervasive.datarush.operators.io.paraccel.SliceInfo> getSliceOutput()

getSliceIdentifiers

public List<com.pervasive.datarush.operators.io.paraccel.SliceIdentifier> getSliceIdentifiers()

setSliceIdentifiers

public void setSliceIdentifiers(List<com.pervasive.datarush.operators.io.paraccel.SliceIdentifier> sliceIdentifiers)

getWorkerParallelism

public int getWorkerParallelism()

setWorkerParallelism

public void setWorkerParallelism(int workerParallelism)

getTargetColumns

public List<String> getTargetColumns()

setTargetColumns

public void setTargetColumns(List<String> targetColumns)

getTraceLevel

public int getTraceLevel()

setTraceLevel

public void setTraceLevel(int traceLevel)

getRetryCount

public int getRetryCount()

setRetryCount

public void setRetryCount(int retryCount)

getTimeoutInterval

public int getTimeoutInterval()

setTimeoutInterval

public void setTimeoutInterval(int timeoutInterval)

getTable

public String getTable()

setTable

public void setTable(String table)

getStartPortRange

public int getStartPortRange()

setStartPortRange

public void setStartPortRange(int startPortRange)

getEndPortRange

public int getEndPortRange()

setEndPortRange

public void setEndPortRange(int endPortRange)

computeMetadata

protected void computeMetadata(StreamingMetadataContext ctx)

Description copied from class: StreamingOperator

Implementations must adhere to the following contracts

General

Regardless of input ports/output port types, all implementations must do the following:

1. Validation. Validation of configuration should always be performed first.
2. Declare parallelizability.. Implementations must declare parallelizability by calling StreamingMetadataContext.parallelize(ParallelismStrategy).

Input record ports

Implementations with input record ports must declare the following:

1. Required data ordering:
Implementations that have data ordering requirements must declare them by calling RecordPort#setRequiredDataOrdering, otherwise data may arrive in any order.
2. Required data distribution (only applies to parallelizable operators):
Implementations that have data distribution requirements must declare them by calling RecordPort#setRequiredDataDistribution, otherwise data will arrive in an unspecified partial distribution.

Note that if the upstream operator's output distribution/ordering is compatible with those required, we avoid a re-sort/re-distribution which is generally a very large savings from a performance standpoint. In addition, some operators may chose to query the upstream output distribution/ordering by calling RecordPort#getSourceDataDistribution and RecordPort#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:

1. Type: Implementations must declare their output type by calling RecordPort#setType.

Implementations with output record ports may declare the following:

1. Output data ordering: Implementations that can make guarantees as to their output ordering may do so by calling RecordPort#setOutputDataOrdering
2. 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

Note that both of these properties are optional; if unspecified, performance may suffer since the framework may unnecessarily re-sort/re-distributed the data.

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:

1. Merge handler: Model reducers must declare a merge handler by calling AbstractModelPort#setMergeHandler.

Note that 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:

1. pmmlModelSpec: Implementations must declare the PMML model spec by calling PMMLPort.setPMMLModelSpec.

Specified by:

computeMetadata in class StreamingOperator

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:

1. Following execution, all input ports must be at end-of-data.
2. Following execution, all output ports must be at end-of-data.

Specified by:

execute in class ExecutableOperator

Parameters:

ctx - context in which to lookup physical ports bound to logical ports

cancel

protected abstract void cancel(ExecState state)

createInvoker

protected abstract ExecState createInvoker(ExecutionContext ctx,
                                           String invokerId)

initializeProtocol

protected abstract void initializeProtocol(String invokerId,
                                           ExecState invoker,
                                           InetAddress inetAddr,
                                           int port,
                                           com.pervasive.datarush.operators.io.paraccel.SliceInfo sliceInfo,
                                           int partitionCount)

checkRetryState

protected abstract void checkRetryState(ExecState invokerRef)