001/* ----------------------------------------------------------------------------
002   The Kiwi Toolkit - A Java Class Library
003   Copyright (C) 1998-2004 Mark A. Lindner
004
005   This library is free software; you can redistribute it and/or
006   modify it under the terms of the GNU General Public License as
007   published by the Free Software Foundation; either version 2 of the
008   License, or (at your option) any later version.
009
010   This library is distributed in the hope that it will be useful,
011   but WITHOUT ANY WARRANTY; without even the implied warranty of
012   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013   General Public License for more details.
014
015   You should have received a copy of the GNU General Public License
016   along with this library; if not, write to the Free Software
017   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
018   02111-1307, USA.
019 
020   The author may be contacted at: mark_a_lindner@yahoo.com
021   ----------------------------------------------------------------------------
022   $Log: DataSample.java,v $
023   Revision 1.5  2004/05/05 22:24:14  markl
024   comment block updates
025
026   Revision 1.4  2003/01/19 09:33:21  markl
027   Javadoc & comment header updates.
028
029   Revision 1.3  2001/03/12 07:23:29  markl
030   Javadoc cleanup.
031
032   Revision 1.2  2000/10/15 09:40:29  markl
033   Added javadoc and final API polishing.
034
035   Revision 1.1  2000/10/13 02:04:20  markl
036   Added remaining classes, and integrated components with models.
037   ----------------------------------------------------------------------------
038*/
039
040package kiwi.ui.graph;
041
042/** A class that represents a data sample. A data sample consists of one or
043 * more variables and their values. These variables correspond to those
044 * defined in a chart definition (<code>Chart</code> object).
045 *
046 * @see kiwi.ui.graph.ChartValue
047 * @see kiwi.ui.graph.Chart
048 *
049 * @author Mark Lindner
050 */
051
052public interface DataSample
053  {
054  /** Get the value associated with the specified variable.
055   *
056   * @param var The variable name.
057   * @return The value for the variable, or <code>null</code> if the variable
058   * was not found or has no value.
059   */
060  
061  public Object getValue(String var);
062  }
063
064/* end of source file */