IBM InfoSphere Streams Version 4.1.1

SPL File BloomFilterTypes.spl

SPL standard and specialized toolkits > com.ibm.streams.teda 1.0.2 > com.ibm.streams.teda.utility > BloomFilterTypes.spl

Content

Types

Composites

composite BloomFilterTypes

This composite specifies type definitions that are used with the status output port of the BloomFilter operator.

Static Types

BloomFilterTypes.Event = tuple<float64 threshold>;

Indicates which configured fill level threshold was reached.

To assign this information to the output attribute, use the Threshold() custom output function.

BloomFilterTypes.Kind = enum { response, event };

Indicates whether the sent tuple is a command response or an event that was raised because of the alarm threshold configuration.

To assign this information to an output attribute, use the Kind() custom output function.

BloomFilterTypes.Response = tuple<boolean success>;

Indicates whether a command, which was received on the command input port of the BloomFilter, failed or succeeded.

To assign this information to the output attribute, use the Succeeded() or !Failed() custom output functions.

BloomFilterTypes.Result = enum { unknown, unique, duplicate };

Specifies the result of the BloomFilter operation:

  • The tuple is evaluated to be unique.
  • The tuple is evaluated to be a duplicate.
  • The tuple cannot be evaluated and therefore, the result is unknown.

The unknown result occurs only if partitioning is used: The partitionBy expression is evaluated for the tuple. If the value indicates that a partition needs to be created that would be evicted immediately, then an evaluation is impossible. If the Result() custom output function is used, the tuple leaves the BloomFilter operator, else the tuple is dropped and the nDropped metric is increased.

To assign this information to an output attribute, use the Result() custom output function.

BloomFilterTypes.Status = tuple<uint64 nUniques, float64 fillLevel>;

The attributes of the type are filled with BloomFilter status information. This status information can be evaluated by downstream operators.

To assign this information to the output attribute, use the UniqueTupleCount() and FillLevel() output functions.