Package org.apache.iotdb.pipe.api.event

Class UserDefinedEvent

java.lang.Object

org.apache.iotdb.pipe.api.event.UserDefinedEvent

All Implemented Interfaces:

Event

public abstract class UserDefinedEvent
extends Object
implements Event

User defined event is used to wrap data generated by users, keeping a source event to automatically report the processing progress to pipe engine.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Event	sourceEvent	The user defined event is generated from this source event.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserDefinedEvent()	Generate a user defined event without source event.
protected	UserDefinedEvent(Event sourceEvent)

Method Summary

Modifier and Type	Method	Description
Event	getSourceEvent()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

sourceEvent

protected final Event sourceEvent

The user defined event is generated from this source event.

Constructor Details

UserDefinedEvent

protected UserDefinedEvent(Event sourceEvent)

Parameters:

sourceEvent - The source event of this user defined event which is used to report the processing progress to pipe engine. Please notice that the source event should satisfy the following conditions: 1. A source event can only be assigned to one user defined event. 2. If more than one user defined events are generated from the same source event, only the last generated user defined event can be assigned with the source event, others should be assigned null, or call UserDefinedEvent() to generate a user defined event without source event.

UserDefinedEvent

protected UserDefinedEvent()

Generate a user defined event without source event.

Method Details

getSourceEvent

public Event getSourceEvent()