info.monitorenter.gui.chart.io.AStaticDataCollector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jchart2d Show documentation

JChart2D is an easy to use component for displaying two- dimensional traces in a coordinate system written in Java.

The newest version!

/*
 *  AbstractDataCollector.java  a configurable threaded collector for tracepoints in jchart2d.
 *  Copyright (C) 2004 - 2011 Achim Westermann, created on 10.12.2004, 14:48:09
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 * 
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *  If you modify or optimize the code in a useful way please let me know.
 *  [email protected]
 *
 */
package info.monitorenter.gui.chart.io;

import info.monitorenter.gui.chart.ITrace2D;

import java.io.IOException;


/**
 * 
 * Base class for data collectors that fill traces for static charts in one run.
 * 
 * 
 * Extend from this class and override the method {@link #collectData()}.
 * 
 *
 * @author Achim Westermann 
 *
 * @version $Revision: 1.3 $
 */
public abstract class AStaticDataCollector {

  /**
   * Target trace where all collected data is added.
   */
  protected ITrace2D m_trace;

  /**
   * Constructor with target trace.
   * 
   *
   * @param trace
   *          the trace collected points will be added to.
   */
  public AStaticDataCollector(final ITrace2D trace) {
    super();
    this.m_trace = trace;
  }

  /**
   * Collects all ITracePoint instances from it's underlying
   * source and adds it to the internal trace.
   * 

   *
   * @throws IOException
   *           if parsing or IO operations fails.
   */
  public abstract void collectData() throws IOException;

  /**
   * Returns the trace data is added to.
   * 
   *
   * @return the trace data is added to.
   */
  public ITrace2D getTrace() {
    return this.m_trace;
  }
}