com.pervasive.datarush.operators.join

Class FilterExistJoinProcess

java.lang.Object

com.pervasive.datarush.operators.AbstractLogicalOperator

com.pervasive.datarush.operators.StreamingOperator

com.pervasive.datarush.operators.ExecutableOperator

com.pervasive.datarush.operators.join.FilterExistJoinProcess

All Implemented Interfaces:

LogicalOperator

public class FilterExistJoinProcess
extends ExecutableOperator

Constructor Summary

Constructors

Constructor and Description
FilterExistJoinProcess()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	computeMetadata(StreamingMetadataContext ctx) Implementations must adhere to the following contracts
protected void	execute(ExecutionContext ctx) Executes the operator.
RecordPort	getAntioutput()
ScalarValuedFunction	getJoinCondition()
JoinKey[]	getJoinKeys()
RecordPort	getLeft()
protected int	getNumInputCopies(LogicalPort p) May be overridden to specify that multiple input copies are needed for a given input port.
RecordPort	getOutput()
RecordPort	getRight()
void	setJoinCondition(ScalarValuedFunction joinCondition)
void	setJoinKeys(JoinKey[] joinKeys)

Methods inherited from class com.pervasive.datarush.operators.ExecutableOperator

cloneForExecution, 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

Constructor Detail

FilterExistJoinProcess

public FilterExistJoinProcess()

Method Detail

getJoinCondition

public final ScalarValuedFunction getJoinCondition()

setJoinCondition

public final void setJoinCondition(ScalarValuedFunction joinCondition)

getJoinKeys

public final JoinKey[] getJoinKeys()

setJoinKeys

public void setJoinKeys(JoinKey[] joinKeys)

getLeft

public final RecordPort getLeft()

getRight

public final RecordPort getRight()

getOutput

public final RecordPort getOutput()

getAntioutput

public final RecordPort getAntioutput()

computeMetadata

protected final 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(com.pervasive.datarush.operators.MetadataCalculationContext, com.pervasive.datarush.ports.record.DataOrdering), 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(com.pervasive.datarush.operators.MetadataCalculationContext, com.pervasive.datarush.ports.record.DataDistribution), 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(com.pervasive.datarush.operators.MetadataContext) and RecordPort.getSourceDataOrdering(com.pervasive.datarush.operators.MetadataContext). 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(com.pervasive.datarush.operators.MetadataCalculationContext, com.pervasive.datarush.types.RecordTokenType).

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(com.pervasive.datarush.operators.MetadataCalculationContext, com.pervasive.datarush.ports.record.DataOrdering)
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(com.pervasive.datarush.operators.MetadataCalculationContext, com.pervasive.datarush.ports.record.DataDistribution)

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(com.pervasive.datarush.operators.MetadataCalculationContext, com.pervasive.datarush.ports.model.ModelMergeHandler<T>).

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

getNumInputCopies

protected final int getNumInputCopies(LogicalPort p)

Description copied from class: ExecutableOperator

May be overridden to specify that multiple input copies are needed for a given input port. By default this is one. This can be used in rare cases when we must examine multiple positions in the same input stream.

Overrides:

getNumInputCopies in class ExecutableOperator

Parameters:

p - the port

Returns:

the number of input copies for the port