org.kitesdk.morphline.api
Interface Command

All Known Implementing Classes:
AbstractCommand, AbstractFieldTransformCommand, AbstractParser

public interface Command

A command transforms a record into zero or more records. A command has a boolean return code, indicating success or failure. All record handlers in a morphline implement this interface. Commands are chained together. The parent of a command A is the command B that passes records to A. A is the child of B. Data is sent on the data plane whereas notifications are sent on the control plane, which is a separate communication channel.


Method Summary
 Command getParent()
          Returns the parent of this command.
 void notify(Record notification)
          Processes the given notification on the control plane of the subtree rooted at this command.
 boolean process(Record record)
          Processes the given record on the data plane of this command.
 

Method Detail

notify

void notify(Record notification)
Processes the given notification on the control plane of the subtree rooted at this command.


process

boolean process(Record record)
Processes the given record on the data plane of this command.

Returns:
true to indicate that processing shall continue, false to indicate that backtracking shall be done

getParent

Command getParent()
Returns the parent of this command. The parent of a command A is the command B that passes records to A. A is the child of B.



Copyright © 2013–2014. All rights reserved.