gate.util.Benchmarkable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gate-core Show documentation

GATE - general achitecture for text engineering - is open source software capable of solving almost any text processing problem. This artifact enables you to embed the core GATE Embedded with its essential dependencies. You will able to use the GATE Embedded API and load and store GATE XML documents. This artifact is the perfect dependency for CREOLE plugins or for applications that need to customize the GATE dependencies due to confict with their own dependencies or for lower footprint.

The newest version!

/*
 *  Benchmarkable.java
 *
 *  Copyright (c) 1995-2012, The University of Sheffield. See the file
 *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
 *
 *  This file is part of GATE (see http://gate.ac.uk/), and is free
 *  software, licenced under the GNU Library General Public License,
 *  Version 2, June 1991 (in the distribution as file licence.html,
 *  and also available at http://gate.ac.uk/gate/licence.html).
 */

package gate.util;


/**
 * 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
 */
public interface Benchmarkable {

  /**
   * Returns the benchmark ID of this resource.
   */
  public String getBenchmarkId();

  /**
   * This method sets the benchmarkID for this resource. The resource
   * must use this as the prefix for any sub-events it logs.
   * 
   * @param benchmarkId the benchmark ID, which must not contain spaces
   *  as it is already used as a separator in the log, you can use
   * {@link Benchmark#createBenchmarkId(String, String)} for it. 
   */
  public void setBenchmarkId(String benchmarkId);

}