SMILA (incubation) API documentation

org.eclipse.smila.processing
Class ProcessorMessage

java.lang.Object
  extended by org.eclipse.smila.processing.ProcessorMessage
Direct Known Subclasses:
SearchMessage

public class ProcessorMessage
extends java.lang.Object

Wrapper for the record ID arrays used in interfaces of SimplePipelet and ProcessingService. Maybe, these interfaces should be changed to use this type instead of Id[] for consistency with SearchPipelet and SearchProcessingServices. For now this class can be used in WorkflowProcessors to enable more uniform handling of ProcessorMessages and SearchMessages.

Author:
jschumacher

Constructor Summary
ProcessorMessage()
          default constructor.
ProcessorMessage(Id[] recordIds)
          create instance from data.
 
Method Summary
 Id[] getRecords()
           
 boolean hasRecords()
           
 void setRecords(java.util.Collection<Id> records)
          set records array from a list.
 void setRecords(Id[] records)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProcessorMessage

public ProcessorMessage()
default constructor.


ProcessorMessage

public ProcessorMessage(Id[] recordIds)
create instance from data.

Parameters:
recordIds - the records to process.
Method Detail

getRecords

public Id[] getRecords()
Returns:
the records to process.

setRecords

public void setRecords(Id[] records)
Parameters:
records - the records to process.

setRecords

public void setRecords(java.util.Collection<Id> records)
set records array from a list.

Parameters:
records - record list.

hasRecords

public boolean hasRecords()
Returns:
true, if the message contains a ID list (even an empty one). false, if the list is actually null.

SMILA (incubation) API documentation