1 package org.simantics.document.linking.report.evaluator;
\r
3 import java.util.List;
\r
4 import java.util.Map;
\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
14 * Base interface for user configurable content.
\r
16 * @author Marko Luukkainen <marko.luukkainen@vtt.fi>
\r
19 public interface EvaluatorItem {
\r
22 * Returns rootNode of the evaluation tree, or null.
\r
25 public EvaluatorRoot getRoot();
\r
28 * Return parent node, or null.
\r
31 public EvaluatorNode getParent();
\r
34 * Sets parent node. This method is for internal use only.
\r
37 void setParent(EvaluatorNode parent);
\r
40 * Returns result of evaluation as a single String. Lines are separated with line.separator system property. All styling hints are omitted.
\r
45 * @throws DatabaseException
\r
47 public String getValue(ReadGraph graph, Variable variable, Map<Object, Object> context) throws DatabaseException;
\r
50 * Returns result of evaluation as collection of lines with styling hints.
\r
55 * @throws DatabaseException
\r
57 public List<DocumentLine> getLines(ReadGraph graph, Variable variable, Map<Object, Object> context) throws DatabaseException;
\r
60 * Copies the evaluation node and its children.
\r
63 public EvaluatorItem copy();
\r
67 public ImageDescriptor getImage();
\r