Operator RegionMatch
The RegionMatch operator stores geographical regions (also called Geofences) together with a set of attributes per region. On the first input port it receives observations from moving devices and matches the device location against the stored regions. As a result it emits events if the device enters, leaves or is hanging out in a region. The regions can be added or removed via input port 2. The events are send to output port 1.
The operator uses the Spatiotemporal library to process the geographical data.
Consistent Region Support
The operator cannot participate in a consitent region.
Summary
- Ports
- This operator has 2 input ports and 1 output port.
- Windowing
- This operator does not accept any windowing configurations.
- Parameters
- This operator supports 6 parameters.
Optional: eventTypeAttribute, idAttribute, latitudeAttribute, longitudeAttribute, regionNameAttribute, timestampAttribute
- Metrics
- This operator does not report any metrics.
Properties
- Implementation
- Java
- Ports (0)
-
Port that ingests tuples containing device data, wich is matched against all configured reguins, to detect events.
The device data must contain a unique device identifier, a latitude and longitude for the current position and a timestamp of the observation (only used for hangout and timeout processing). See the operator parameters on how to specify the attribute names containing the values.
- Properties
-
- Optional: false
- ControlPort: false
- WindowingMode: NonWindowed
- WindowPunctuationInputMode: Oblivious
- Ports (1)
-
Port that ingests tuples containing the region data. The tuple has to comform to the type RegionInfo defined in RegionInfo.
- Properties
-
- Optional: false
- ControlPort: true
- WindowingMode: NonWindowed
- WindowPunctuationInputMode: Oblivious
- Assignments
- Java operators do not support output assignments.
- Ports (0)
-
The tuples from input port 1 will be augmented with the detected event information and send to this port. In case no event is detected, the event type will be 'None'. All attributes with the same name will be copied from the input tuple.
- Properties
-
- Optional: false
- WindowPunctuationOutputMode: Generating
Optional: eventTypeAttribute, idAttribute, latitudeAttribute, longitudeAttribute, regionNameAttribute, timestampAttribute
- eventTypeAttribute
-
The name of an output attribute of type RSTRING that will receive the event type (ENTER,EXIT,HANGOUT) if a match is detected. If not specified the default attribute name is 'matchEventType'.
- Properties
-
- Type: rstring
- Cardinality: 1
- Optional: true
- idAttribute
-
The name of an input attribute on port 1 (type RSTRING), that holds the unique identifier of the device. If not specified the default attribute name is 'id'.
- Properties
-
- Type: rstring
- Cardinality: 1
- Optional: true
- ExpressionMode: Attribute
- latitudeAttribute
-
The name of an input attribute on port 1 (type FLOAT64), that holds the latitude of the device. If not specified the default attribute name is 'latitude'.
- Properties
-
- Type: float64
- Cardinality: 1
- Optional: true
- ExpressionMode: Attribute
- longitudeAttribute
-
The name of an input attribute on port 1 (type FLOAT64), that holds the longitude of the device. If not specified the default attribute name is 'longitude'.
- Properties
-
- Type: float64
- Cardinality: 1
- Optional: true
- ExpressionMode: Attribute
- regionNameAttribute
-
The name of an output attribute of type RSTRING that will receive the name of the region if a match is detected. If not specified the default attribute name is 'regionName'.
- Properties
-
- Type: rstring
- Cardinality: 1
- Optional: true
- timestampAttribute
-
The name of an input attribute on port 1 (type timestamp), that holds the timestamp of the device measurement. If not specified the default attribute name is 'timeStamp'.
- Properties
-
- Cardinality: 1
- Optional: true
- ExpressionMode: Attribute
- Operator class library