bundles/org.simantics.simulation/src/org/simantics/simulation/data/VariableHandle.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007 VTT Technical Research Centre of Finland and others.\r
   3  * All rights reserved. This program and the accompanying materials\r
   4  * are made available under the terms of the Eclipse Public License v1.0\r
   5  * which accompanies this distribution, and is available at\r
   6  * http://www.eclipse.org/legal/epl-v10.html\r
   7  *\r
   8  * Contributors:\r
   9  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  10  *******************************************************************************/\r
  11 package org.simantics.simulation.data;\r
  12 \r
  13 import org.simantics.databoard.accessor.error.AccessorException;\r
  14 import org.simantics.databoard.binding.Binding;\r
  15 \r
  16 /**\r
  17  * A handle to a variable of a {@link Datasource}.\r
  18  *\r
  19  * @author Toni Kalajainen <toni.kalajainen@vtt.fi>\r
  20  */\r
  21 public interface VariableHandle {\r
  22 \r
  23         /**\r
  24          * @return key (ID) of the variable\r
  25          */\r
  26         String key();\r
  27 \r
  28         /**\r
  29          * @return binding for the variable\r
  30          */\r
  31         Binding binding();\r
  32 \r
  33         /**\r
  34          * @return current value associated with this handle\r
  35          * @throws AccessorException if value cannot be retrieved\r
  36          */\r
  37         Object getValue() throws AccessorException;\r
  38 \r
  39         /**\r
  40          * Frees any resource related to this handle.\r
  41          */\r
  42         void dispose();\r
  43 \r
  44 }\r
  45 \r