SPL File MapStoreTypes.spl

SPL standard and specialized toolkits > com.ibm.streams.geospatial 3.0.2 > com.ibm.streams.geospatial > MapStoreTypes.spl

Content

Types

• MapStoreTypes.Events: The MapStore operator sends event tuples to indicate important state changes.
• MapStoreTypes.TupleTypes: The MapStore operator sends two types of tuples to its output port.

Composites

composite MapStoreTypes

Types that are used together with the MapStore operator.

Static Types

MapStoreTypes.Events = enum { started, waitingForData, ready };

The MapStore operator sends event tuples to indicate important state changes. The following events are supported:

• started

  Indicates an operator start or restart. Reasons can be a new submitted job or a restarted PE (streamtool restartpe, or a restartable operator that failed).

  This event is sent as soon as all ports are ready.

• waitingForData

  Indicates that the operator waits for map data and has, therefore, locked the mutex that prevents the PointMapMatcher operator from reading. This event occurs under the following conditions:

  • The MapStore operator created the shared map store.

  • The MapStore operator detected the existing shared map store during the startup phase, and the existing status was either waitingForData or modifying with faultHandling set to strict.

  • A window punctuation is received but one or more erroneous geometry data tuples were processed (= failed modification)

  • with faultHandling set to strict.

• ready

  Indicates that the map data is valid. The mutex that prevents the PointMapMatcher operator from reading, is released. This event occurs under the following conditions:

  • A window punctuation is received and the faultHandling parameter is set to permissive.

  • A window punctuation is received and all processed geometry data tuples were valid.

  • The MapStore operator started or restarted, and attaches to an existing shared map store with ready status, or modifying status with faultHandling set to permissive. The event is sent after the started event.

MapStoreTypes.TupleTypes = enum { event, failure };

The MapStore operator sends two types of tuples to its output port.

• failure

  For each erroneous tuple that is received on the geometry data input port, the MapStore operator sends a failure tuple.

  Possible error scenarios are:

  • An internal error when adding or removing a node
  • An internal error when adding or removing an edge
  • An internal error when clearing the map

• event

  The MapStore operator sends event tuples to indicate important state changes. The SPL application can use these events to react properly on new states. For more details about the events, see the Events type.