ikr.simlib.result

Interface BatchExportable

All Known Implementing Classes:

ExactAutoCorrelationStatistic, FairnessStatistic, ProbFairnessStatistic, RateFairnessStatistic, SampleFairnessStatistic, StdAutoCorrelationStatistic, StdBoundaryStatistic, StdCorrelationStatistic, StdCounterStatistic, StdDistributionStatistic, StdIntegralStatistic, StdMedianStatistic, StdProbabilityStatistic, StdRateStatistic, StdSampleStatistic, UnlimitedUnbatchedBoundaryStatistic, VTBurstLevelRateStatistic, VTProbStatistic, VTRateStatistic, VTSampleStatistic, VTStatistic, WeightedDistStatistic, WeightedMeanStatistic

public interface BatchExportable

Classes supporting batch parallelization must implement this interface to support import and export of batch states.

A fair amount of freedom is given to implementors in how the results are written to the export files. The only constraints are, that

1. Results have to be ex-/imported in the same order
2. and neither more or less data may imported than has been exported (and vice versa).
3. The rules of the ResultWriter and ResultReader interfaces have to be followed (especially matching start and end tags).

Method Summary

Methods

Modifier and Type	Method and Description
void	exportBatch(ResultWriter writer) Exports the batch state to a result writer.
void	importBatch(ResultReader reader) Imports the state of a batch from the result reader.

Method Detail

exportBatch

void exportBatch(ResultWriter writer)
                 throws ResultException

Exports the batch state to a result writer. Everything written to the result writer has to be read in the same order in importBatch despite the keywords.

Parameters:

writer - the result writer which preserves the state

Throws:

ResultException - if any exception occurs while writing a result to the writer

importBatch

void importBatch(ResultReader reader)
                 throws ResultException

Imports the state of a batch from the result reader. The exported results have to read in the same order as written in exportBatch despite the keywords.

Parameters:

reader - the result reader which contains the batch state

Throws:

ResultException - if any exception occurs while reading a result from the reader