Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.layer0.utils / src / org / simantics / layer0 / utils / representation / StringRepresentation2.java

diff --git a/bundles/org.simantics.layer0.utils/src/org/simantics/layer0/utils/representation/StringRepresentation2.java b/bundles/org.simantics.layer0.utils/src/org/simantics/layer0/utils/representation/StringRepresentation2.java
new file mode 100644 (file)
index 0000000..438c2d9
--- /dev/null
+++ b/bundles/org.simantics.layer0.utils/src/org/simantics/layer0/utils/representation/StringRepresentation2.java
@@ -0,0 +1,57 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.layer0.utils.representation;\r
+\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.exception.DatabaseException;\r
+\r
+/**\r
+ * An interface for fetching string representations for a resource. Also\r
+ * supports handling of vector-valued resources.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface StringRepresentation2 {\r
+\r
+    /**\r
+     * @return a string representation of the underlying resource\r
+     */\r
+    String get(ReadGraph g) throws DatabaseException;\r
+\r
+    /**\r
+     * If the underlying resource contains a value, this method can be used\r
+     * retrieve its array size.\r
+     * \r
+     * @return -1 if there is no value, >= 0 otherwise.\r
+     */\r
+    int getArraySize(ReadGraph g) throws DatabaseException;\r
+\r
+    /**\r
+     * If the underlying resource contains a value, this method can be used to\r
+     * get a string representation of one of its indices.\r
+     * \r
+     * @param index\r
+     * @return\r
+     */\r
+    String get(ReadGraph g, int index) throws DatabaseException;\r
+\r
+    /**\r
+     * If the underlying resource contains a value, this method can be used to\r
+     * get a string representation of the specified sequential range of indices.\r
+     * \r
+     * @param start\r
+     * @param size\r
+     * @return\r
+     */\r
+    String get(ReadGraph g, int start, int size) throws DatabaseException;\r
+\r
+}\r