bundles/org.simantics.document.linking.ui/src/org/simantics/document/linking/report/evaluator/EvaluatorItem.java

   1 package org.simantics.document.linking.report.evaluator;\r
   2 \r
   3 import java.util.List;\r
   4 import java.util.Map;\r
   5 \r
   6 import org.eclipse.jface.resource.ImageDescriptor;\r
   7 import org.simantics.db.ReadGraph;\r
   8 import org.simantics.db.exception.DatabaseException;\r
   9 import org.simantics.db.layer0.variable.Variable;\r
  10 import org.simantics.document.linking.report.DocumentLine;\r
  11 \r
  12 \r
  13 /**\r
  14  * Base interface for user configurable content.\r
  15  * \r
  16  * @author Marko Luukkainen <marko.luukkainen@vtt.fi>\r
  17  *\r
  18  */\r
  19 public interface EvaluatorItem {\r
  20         \r
  21         /**\r
  22          * Returns rootNode of the evaluation tree, or null.\r
  23          * @return\r
  24          */\r
  25         public EvaluatorRoot getRoot();\r
  26         \r
  27         /**\r
  28          * Return parent node, or null.\r
  29          * @return\r
  30          */\r
  31         public EvaluatorNode getParent();\r
  32         \r
  33         /**\r
  34          * Sets parent node. This method is for internal use only. \r
  35          * @param parent\r
  36          */\r
  37         void setParent(EvaluatorNode parent);\r
  38         \r
  39         /**\r
  40          * Returns result of evaluation as a single String. Lines are separated with line.separator system property. All styling hints are omitted.\r
  41          * @param graph\r
  42          * @param variable\r
  43          * @param context\r
  44          * @return\r
  45          * @throws DatabaseException\r
  46          */\r
  47         public String getValue(ReadGraph graph, Variable variable, Map<Object, Object> context) throws DatabaseException;\r
  48         \r
  49         /**\r
  50          * Returns result of evaluation as collection of lines with styling hints.\r
  51          * @param graph\r
  52          * @param variable\r
  53          * @param context\r
  54          * @return\r
  55          * @throws DatabaseException\r
  56          */\r
  57         public List<DocumentLine> getLines(ReadGraph graph, Variable variable, Map<Object, Object> context) throws DatabaseException;\r
  58         \r
  59         /**\r
  60          * Copies the evaluation node and its children.\r
  61          * @return\r
  62          */\r
  63         public EvaluatorItem copy();\r
  64         \r
  65         \r
  66         \r
  67         public ImageDescriptor getImage();\r
  68         \r
  69         \r
  70         \r
  71 }\r