bundles/org.simantics.browsing.ui.graph.impl/src/org/simantics/browsing/ui/graph/impl/VariableModifier.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.browsing.ui.graph.impl;\r
  13 \r
  14 import org.simantics.browsing.ui.content.Labeler.Modifier;\r
  15 import org.simantics.databoard.Bindings;\r
  16 import org.simantics.databoard.Datatypes;\r
  17 import org.simantics.databoard.binding.Binding;\r
  18 import org.simantics.databoard.binding.NumberBinding;\r
  19 import org.simantics.databoard.binding.StringBinding;\r
  20 import org.simantics.databoard.binding.error.BindingException;\r
  21 import org.simantics.databoard.binding.mutable.MutableStringBinding;\r
  22 import org.simantics.databoard.parser.repository.DataTypeSyntaxError;\r
  23 import org.simantics.databoard.parser.repository.DataValueRepository;\r
  24 import org.simantics.databoard.primitives.MutableString;\r
  25 import org.simantics.databoard.type.Datatype;\r
  26 import org.simantics.databoard.type.NumberType;\r
  27 import org.simantics.databoard.units.IUnitConverter;\r
  28 import org.simantics.databoard.util.Range;\r
  29 import org.simantics.db.ReadGraph;\r
  30 import org.simantics.db.RequestProcessor;\r
  31 import org.simantics.db.Resource;\r
  32 import org.simantics.db.Session;\r
  33 import org.simantics.db.UndoContext;\r
  34 import org.simantics.db.WriteGraph;\r
  35 import org.simantics.db.common.request.ReadRequest;\r
  36 import org.simantics.db.common.request.WriteRequest;\r
  37 import org.simantics.db.exception.DatabaseException;\r
  38 import org.simantics.db.layer0.util.PrimitiveValueParser;\r
  39 import org.simantics.db.layer0.variable.InputValidator;\r
  40 import org.simantics.db.layer0.variable.InputValidatorFactory;\r
  41 import org.simantics.db.layer0.variable.Variable;\r
  42 import org.simantics.db.layer0.variable.VariableWrite;\r
  43 import org.simantics.db.layer0.variable.Variables;\r
  44 import org.simantics.scl.runtime.function.Function1;\r
  45 import org.simantics.utils.datastructures.Callback;\r
  46 import org.simantics.utils.format.FormattingUtils;\r
  47 import org.simantics.utils.ui.ErrorLogger;\r
  48 \r
  49 /**\r
  50  * @author Tuukka Lehtonen\r
  51  */\r
  52 public class VariableModifier implements Modifier {\r
  53 \r
  54     final protected Session     session;\r
  55     final protected UndoContext undoContext;\r
  56     final protected Variable    variable;\r
  57     final protected String      targetUnit;\r
  58 \r
  59     private String              initialValue;\r
  60     protected Throwable         modifierFailed;\r
  61     private Datatype            datatype;\r
  62     protected Binding           binding;\r
  63     protected InputValidator    variableInputValidator;\r
  64 \r
  65     public VariableModifier(RequestProcessor processor, Variable variable) {\r
  66         this(processor, variable, null);\r
  67     }\r
  68 \r
  69     public VariableModifier(RequestProcessor processor, Variable variable, String targetUnit) {\r
  70         this.variable = variable;\r
  71         this.session = processor.getSession();\r
  72         this.undoContext = null;\r
  73         this.targetUnit = targetUnit;\r
  74 \r
  75         initializeModifier(processor);\r
  76     }\r
  77 \r
  78     public VariableModifier(RequestProcessor processor, UndoContext undoContext, Variable variable, String targetUnit) {\r
  79         this.variable = variable;\r
  80         this.undoContext = undoContext;\r
  81         this.session = processor.getSession();\r
  82         this.targetUnit = targetUnit;\r
  83 \r
  84         initializeModifier(processor);\r
  85     }\r
  86 \r
  87     protected void initializeModifier(RequestProcessor processor) {\r
  88         try {\r
  89             processor.syncRequest(new ReadRequest() {\r
  90                 @Override\r
  91                 public void run(ReadGraph graph) throws DatabaseException {\r
  92                         String expression = variable.getPossiblePropertyValue(graph, Variables.EXPRESSION);\r
  93                         if(expression == null) {\r
  94                             datatype = variable.getPossibleDatatype(graph);\r
  95                             if (datatype == null) {\r
  96                                 // Deprecated.\r
  97                                 // This is here for some backwards compatibility.\r
  98                                 datatype = variable.getInterface(graph, Datatype.class);\r
  99                                 if (datatype == null)\r
 100                                     throw new org.simantics.db.exception.BindingException("no datatype for variable " + variable, null);\r
 101                             }\r
 102                             initialValue = getInitialValue(graph, datatype);\r
 103                             binding = Bindings.getBinding(datatype);\r
 104                             initializeValidator(graph, variable);\r
 105                         }\r
 106                         else {\r
 107                                 initialValue = "= " + expression;\r
 108                                 binding = Bindings.STRING;\r
 109                                 datatype = Datatypes.STRING;\r
 110                         }\r
 111                 }\r
 112             });\r
 113         } catch (DatabaseException e) {\r
 114             ErrorLogger.defaultLogError("Modifier initialization failed, see exception for details.", e);\r
 115             modifierFailed = e;\r
 116         }\r
 117     }\r
 118 \r
 119     protected void initializeValidator(ReadGraph graph, Variable var) throws DatabaseException {\r
 120         //System.out.println(var.getURI(graph));\r
 121 \r
 122         Resource resource = var.getPossibleRepresents(graph);\r
 123 //        if (resource != null)\r
 124 //            System.out.println("represents: " + graph.getPossibleURI(resource));\r
 125 \r
 126         Resource pr = variable.getPossiblePredicateResource(graph);\r
 127         \r
 128 //        Variable predicate = variable.getPossiblePropertyValue(graph, Variables.PREDICATE);\r
 129 //        if (predicate != null) {\r
 130 //            Resource pr = predicate.getPropertyValue(graph, Variables.REPRESENTS);\r
 131             if (pr != null)\r
 132                 variableInputValidator = tryInputValidatorFactory(graph, var, resource, pr);\r
 133 //        }\r
 134 \r
 135         if (variableInputValidator == null) {\r
 136             final Function1<String, String> validator = variable.getPossiblePropertyValue(graph, Variables.INPUT_VALIDATOR);\r
 137             if (validator != null)\r
 138                 variableInputValidator = new InputValidator() {\r
 139                     \r
 140                     @Override\r
 141                     public String isValid(Object newValue) {\r
 142                         return validator.apply((String)newValue);\r
 143                     }\r
 144                 };\r
 145         }\r
 146 \r
 147         if (variableInputValidator == null) {\r
 148             Variable parent = variable.getParent(graph);\r
 149             if (parent != null) {\r
 150                 Resource parentResource = parent.getPossibleRepresents(graph);\r
 151                 if (parentResource != null)\r
 152                     variableInputValidator = tryInputValidatorFactory(graph, var, resource, parentResource);\r
 153             }\r
 154         }\r
 155 \r
 156         if (variableInputValidator == null)\r
 157             variableInputValidator = var.getInterface(graph, InputValidator.class);\r
 158         \r
 159     }\r
 160 \r
 161     private InputValidator tryInputValidatorFactory(ReadGraph graph, Variable var, Resource varRepresents, Resource r) throws DatabaseException {\r
 162         //System.out.println("tryInputValidatorFactory(" + var.getURI(graph) + ", " + NameUtils.getSafeName(graph, varRepresents) + ", " + NameUtils.getSafeName(graph, r) + ")");\r
 163         InputValidatorFactory validatorFactory = graph.getPossibleAdapter(r, InputValidatorFactory.class);\r
 164         if (validatorFactory == null)\r
 165             return null;\r
 166         //System.out.println("got validator factory: " + validatorFactory);\r
 167         return validatorFactory.create(graph, var);\r
 168     }\r
 169 \r
 170     protected void doModify(final String label) {\r
 171         if(label.startsWith("=")) {\r
 172                 session.asyncRequest(new WriteRequest() {\r
 173                                 @Override\r
 174                                 public void perform(WriteGraph graph) throws DatabaseException {\r
 175                                         variable.setPropertyValue(graph, Variables.EXPRESSION, \r
 176                                                         label.substring(1).trim());\r
 177                                 }\r
 178                         });\r
 179         }\r
 180         else {\r
 181                 if(initialValue.startsWith("="))\r
 182                                 try {\r
 183                                         session.syncRequest(new WriteRequest() {\r
 184                                                 @Override\r
 185                                                 public void perform(WriteGraph graph) throws DatabaseException {\r
 186                                                         variable.setPropertyValue(graph, Variables.EXPRESSION, null);\r
 187                                                 }\r
 188                                         });\r
 189                                 } catch (DatabaseException e) {\r
 190                                         e.printStackTrace();\r
 191                                 }\r
 192                 session.asyncRequest(new VariableWrite(variable, label, null, targetUnit), new Callback<DatabaseException>() {\r
 193                     @Override               \r
 194                     public void run(DatabaseException parameter) {\r
 195                         if (parameter != null)\r
 196                             ErrorLogger.defaultLogError(parameter);\r
 197                         else\r
 198                                 modifySuccessful();\r
 199                     }\r
 200                 });\r
 201         }\r
 202     }\r
 203 \r
 204     protected void modifySuccessful() {\r
 205         }\r
 206 \r
 207         protected String getInitialValue(ReadGraph graph, Datatype dataType) throws DatabaseException {\r
 208         // TODO: more generic support through DataValuePrinter\r
 209         Object value = variable.getPossibleValue(graph);\r
 210         if(value == null) return "";\r
 211         String unit = Variables.getPossibleUnit(graph, variable);\r
 212         //String unit = variable.getPossiblePropertyValue(graph, Variables.UNIT);\r
 213         if(value instanceof Double && unit != null && targetUnit != null) {\r
 214             IUnitConverter converter = VariableWrite.converter(unit, targetUnit);\r
 215             value = converter.convert((Double)value);\r
 216         }\r
 217         return FormattingUtils.US.engineeringFormat(value);\r
 218     }\r
 219 \r
 220     @Override\r
 221     public String getValue() {\r
 222         return initialValue;\r
 223     }\r
 224 \r
 225     @Override\r
 226     public String isValid(String label) {\r
 227         if (label.startsWith("="))\r
 228             return null;\r
 229 \r
 230         if (modifierFailed != null)\r
 231             return "Could not resolve validator for this value, modification denied. Reason: " + modifierFailed.getMessage();\r
 232 \r
 233         if (variableInputValidator != null)\r
 234             return variableInputValidator.isValid(label);\r
 235 \r
 236         try {\r
 237             if (binding instanceof StringBinding) {\r
 238                 // Use the binding to validate strings since they might have\r
 239                 // mime-types and/or patterns attached.\r
 240                 if (binding instanceof MutableStringBinding) {\r
 241                     binding.assertInstaceIsValid(new MutableString(label));\r
 242                 } else {\r
 243                     binding.assertInstaceIsValid(label);\r
 244                 }\r
 245             } else {\r
 246                 if (binding instanceof NumberBinding) {\r
 247                     // Numbers are always parsed in US locale, although both ',' and\r
 248                     // '.' are accepted as decimal separators.\r
 249                     label = label.replace(",", ".");\r
 250                     //Object value = binding.parseValue(label, new DataValueRepository());\r
 251                     Object value = PrimitiveValueParser.parse(label, datatype);\r
 252                     NumberType numberType = (NumberType) datatype;\r
 253                     Range range = numberType.getRange();\r
 254                     if (range != null && !range.contains((Number) value))\r
 255                         return "Value is not in range " + range;\r
 256                 } else {\r
 257                     binding.parseValue(label, new DataValueRepository());\r
 258                 }\r
 259             }\r
 260             return null;\r
 261         } catch (IllegalArgumentException e) {\r
 262             // Parsing failed.\r
 263             return e.getLocalizedMessage();\r
 264         } catch (DataTypeSyntaxError e) {\r
 265             // Failed to parse label with binding\r
 266             return e.getLocalizedMessage();\r
 267         } catch (BindingException e) {\r
 268             return e.getLocalizedMessage();\r
 269         }\r
 270     }\r
 271 \r
 272     @Override\r
 273     public final void modify(String label) {\r
 274         if (modifierFailed != null)\r
 275             // Should never end up here, isValid should prevent it.\r
 276             throw new Error("modifier failed: " + modifierFailed.getMessage());\r
 277         doModify(label);\r
 278     }\r
 279 \r
 280 };\r