gate.util
Interface Benchmarkable

All Known Implementing Classes:
AbstractController, ANNIETransducer, Batch, ConditionalSerialAnalyserController, ConditionalSerialController, DefaultTokeniser, MultiPhaseTransducer, OntologyAwareTransducer, PronominalCoref, RealtimeCorpusController, Rule, SentenceSplitter, SerialAnalyserController, SerialController, SinglePhaseTransducer, Transducer, Transducer, VPChunker

public interface Benchmarkable

Resources that want to log their progress or results into a shared log centrally maintained by GATE, should implement this interface and use the java.util.Benchmark class to log their entries.

Author:
niraj

Method Summary
 String getBenchmarkId()
          Returns the benchmark ID of this resource.
 void setBenchmarkId(String benchmarkId)
          This method sets the benchmarkID for this resource.
 

Method Detail

getBenchmarkId

String getBenchmarkId()
Returns the benchmark ID of this resource.


setBenchmarkId

void setBenchmarkId(String benchmarkId)
This method sets the benchmarkID for this resource. The resource must use this as the prefix for any sub-events it logs.

Parameters:
benchmarkId - the benchmark ID, which must not contain spaces as it is already used as a separator in the log, you can use Benchmark.createBenchmarkId(String, String) for it.