Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.trend / src / org / simantics / trend / configuration / TrendItem.java

diff --git a/bundles/org.simantics.trend/src/org/simantics/trend/configuration/TrendItem.java b/bundles/org.simantics.trend/src/org/simantics/trend/configuration/TrendItem.java
new file mode 100644 (file)
index 0000000..c53b693
--- /dev/null
+++ b/bundles/org.simantics.trend/src/org/simantics/trend/configuration/TrendItem.java
@@ -0,0 +1,150 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007 VTT Technical Research Centre of Finland and others.\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.trend.configuration;\r
+\r
+import org.simantics.databoard.annotations.Identifier;\r
+import org.simantics.databoard.annotations.Optional;\r
+import org.simantics.databoard.util.Bean;\r
+import org.simantics.utils.strings.AlphanumComparator;\r
+\r
+/**\r
+ * @author Toni Kalajainen\r
+ */\r
+public class TrendItem extends Bean {\r
+       \r
+       // Sorting and color index\r
+       public int index;\r
+       \r
+       // Chart Label\r
+       public @Optional String label;  \r
+       // Normal Label (eg. The label in CSV file)\r
+       public @Optional String simpleLabel;\r
+       // Variable reference in user friendly format\r
+       public @Optional String variableReference;\r
+       \r
+       // GroupId in the history\r
+       public @Identifier String groupId;\r
+       // ItemId in the group\r
+       public @Identifier String groupItemId;\r
+       // Variable id in format understood by org.simantics.simulation.data.Datasource\r
+       public @Identifier String variableId;\r
+       \r
+       public Scale scale;\r
+       \r
+       // TODO Rename Binary to Bar\r
+       public enum Renderer { Analog, Binary } public Renderer renderer;\r
+       \r
+       public @Optional String unit;\r
+       \r
+       public DrawMode drawMode = DrawMode.getDefault();\r
+\r
+       // If true, the item shall not be shown in the chart.\r
+       public boolean hidden = false;\r
+\r
+       // Defines a custom stroke to be used when rendering this item.\r
+       public @Optional Float customStrokeWidth;\r
+\r
+       // Defines a custom color to be used when rendering this item.\r
+       // If not defined, color is calculated based on #index.\r
+       public @Optional float[] customColor;\r
+\r
+       public enum DrawMode {\r
+               DeviationAndLine,\r
+               DeviationAndAverage,\r
+               DeviationAndSample,\r
+               Average,\r
+               Line,\r
+               Sample,\r
+               Deviation;\r
+               public static DrawMode getDefault() {\r
+                       return DeviationAndLine; \r
+               }\r
+       }\r
+       \r
+       public TrendItem() {\r
+       }\r
+\r
+       public TrendItem(int index, String label, String subscriptionId, String variableId, Scale scale) {\r
+               this(index, label, subscriptionId, variableId, scale, Renderer.Analog);\r
+       }\r
+\r
+       public TrendItem(int index, String label, String subscriptionId, String variableId, Scale scale, Renderer renderer) {\r
+               this.index = index;\r
+               this.label = label;\r
+               this.variableId = variableId;\r
+               this.scale = scale;\r
+               this.renderer = renderer;\r
+               this.groupId = subscriptionId;\r
+               this.groupItemId = variableId;\r
+       }       \r
+\r
+       public TrendItem(int index, String label, String subscriptionId, String variableId, Scale scale, Renderer renderer, double min, double max) {\r
+               this.index = index;\r
+               this.label = label;\r
+               this.variableId = variableId;\r
+               this.scale = new Scale.Manual(min, max);\r
+               this.renderer = renderer;\r
+               this.groupId = subscriptionId;\r
+               this.groupItemId = variableId;\r
+       }\r
+       \r
+       public TrendItem(int index, String label, String subscriptionId, String variableId, Scale scale, Renderer renderer, double min, double max, DrawMode drawMode) {\r
+               this.index = index;\r
+               this.label = label;\r
+               this.variableId = variableId;\r
+               this.scale = new Scale.Manual(min, max);\r
+               this.renderer = renderer;\r
+               this.groupId = subscriptionId;\r
+               this.groupItemId = variableId;\r
+               this.drawMode = drawMode;\r
+       }\r
+       \r
+       @Override\r
+       public int compareTo(Bean o) {\r
+               if ( o instanceof TrendItem == false ) return 0;\r
+               TrendItem other = (TrendItem) o;\r
+               \r
+               int c = renderer.ordinal() - other.renderer.ordinal();\r
+               if ( c!=0 ) return c;\r
+               \r
+               c = index - other.index;\r
+               if ( c!=0 ) return c;\r
+               \r
+               String myLabel1 = label!=null?label:"";\r
+               String otLabel1 = other.label!=null?other.label:"";\r
+               c = AlphanumComparator.CASE_INSENSITIVE_COMPARATOR.compare(myLabel1, otLabel1);\r
+               if ( c!=0 ) return c;\r
+               \r
+               String myLabel2 = simpleLabel!=null?simpleLabel:"";\r
+               String otLabel2 = other.simpleLabel!=null?other.simpleLabel:"";\r
+               c = AlphanumComparator.CASE_INSENSITIVE_COMPARATOR.compare(myLabel2, otLabel2);\r
+               if ( c!=0 ) return c;\r
+               \r
+               String mySid = groupId!=null?groupId:""; \r
+               String otSid = other.groupId!=null?other.groupId:""; \r
+               c = mySid.compareTo(otSid);\r
+               if ( c!=0 ) return c;\r
+\r
+               String myGiid = groupItemId!=null?groupItemId:""; \r
+               String otGiid = other.groupItemId!=null?other.groupItemId:""; \r
+               c = myGiid.compareTo(otGiid);\r
+               if ( c!=0 ) return c;\r
+\r
+               String myVid = variableId!=null?variableId:""; \r
+               String otVid = other.variableId!=null?other.variableId:""; \r
+               c = myVid.compareTo(otVid);\r
+               if ( c!=0 ) return c;\r
+               \r
+               return c;               \r
+       }\r
+       \r
+}\r
+\r