org.youscope.common.table

Interface TableConsumer

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

DeviceSettingJob, FluigentJob, NemesysJob, OnixJob

public interface TableConsumer
extends java.rmi.Remote

Indicates that a given measurement component consumes table data, and allows to obtain information on the layout of the consumed tables.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
void	consumeTable(Table table) Passes the table to the measurement component, such that it can interpret it the next time it is executed.
TableDefinition	getConsumedTableDefinition() Returns the definition of the table layout of the tables consumed by this consumer, e.g.

Method Detail

consumeTable

void consumeTable(Table table)
           throws java.rmi.RemoteException,
                  TableException,
                  java.lang.NullPointerException

Passes the table to the measurement component, such that it can interpret it the next time it is executed. The component should not immediately take any action except checking if the layout of the table is correct. The table must have the same number, types and names of the columns as returned by getConsumedTableDefinition(). Columns might have another definition if null entries are allowed. However, if null entries are not allowed for the tables consumed by this consumer as indicated by getConsumedTableDefinition(), the corresponding entries in the column of the table passed in this function must be non-null.

Parameters:

table - The table to consume.

Throws:

java.rmi.RemoteException

TableException - Thrown if the table has the wrong layout, or if entries of the table are null which should not be null.

java.lang.NullPointerException - Thrown if table is null.

getConsumedTableDefinition

TableDefinition getConsumedTableDefinition()
                                    throws java.rmi.RemoteException

Returns the definition of the table layout of the tables consumed by this consumer, e.g. the number and types of its columns.

Returns:

Information about of the consumed tables.

Throws:

java.rmi.RemoteException