bundles/org.simantics.browsing.ui.graph.impl/src/org/simantics/browsing/ui/graph/impl/AbstractFactoryStringModifier.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.db.ReadGraph;\r
  16 import org.simantics.db.RequestProcessor;\r
  17 import org.simantics.db.Resource;\r
  18 import org.simantics.db.Session;\r
  19 import org.simantics.db.WriteGraph;\r
  20 import org.simantics.db.common.request.ReadRequest;\r
  21 import org.simantics.db.exception.DatabaseException;\r
  22 import org.simantics.db.layer0.adapter.StringModifier;\r
  23 import org.simantics.db.layer0.adapter.StringModifierFactory;\r
  24 \r
  25 /**\r
  26  * Please implement:\r
  27  * <ul>\r
  28  * <li>{@link #doModify(String)} - perform the requested modification.</li>\r
  29  * </ul>\r
  30  * \r
  31  * <p>\r
  32  * Other points of customization:\r
  33  * </p>\r
  34  * <ul>\r
  35  * <li>{@link #createModifierInput(String)} - constructs an input for\r
  36  * {@link org.simantics.db.layer0.adapter.Modifier#modify(WriteGraph, Object)}\r
  37  * from the specified label given by the user.\r
  38  * <li>{@link #getInitialValue(ReadGraph)} - returns the value that should be shown\r
  39  * initially when editing. The default implementation just adapts the input to\r
  40  * its String representation, but you may want to customize this.</li>\r
  41  * <li>{@link #verifyModification(String)} - allows for last chance denial of\r
  42  * the modification after the user has signalled approval of the modification.</li>\r
  43  * </ul>\r
  44  * \r
  45  * @author Tuukka Lehtonen\r
  46  * \r
  47  * @param <T> the input class of the used\r
  48  *        {@link org.simantics.db.layer0.adapter.Modifier}\r
  49  */\r
  50 public abstract class AbstractFactoryStringModifier implements Modifier {\r
  51 \r
  52     protected Session        session;\r
  53 \r
  54     protected Resource       subject;\r
  55 \r
  56     protected Resource       predicate;\r
  57     \r
  58     protected Resource       object;\r
  59 \r
  60     protected String         initialValue;\r
  61 \r
  62     protected StringModifierFactory modifierFactory;\r
  63     protected StringModifier        modifier;\r
  64 \r
  65     /**\r
  66      * If <code>non-null</code>, the modifier could not be fetched, e.g. adapted\r
  67      * from the specified INodeContext.\r
  68      */\r
  69     protected Throwable      modifierFailed;\r
  70 \r
  71 \r
  72     /**\r
  73      * @param context\r
  74      * @param session\r
  75      */\r
  76     public AbstractFactoryStringModifier(Resource subject, Resource predicate, Resource object, RequestProcessor processor) {\r
  77         this.subject = subject;\r
  78         this.predicate = predicate;\r
  79         this.object = object;\r
  80         this.session = processor.getSession();\r
  81 \r
  82         try {\r
  83             processor.syncRequest(new ReadRequest() {\r
  84                 @Override\r
  85                 public void run(ReadGraph g) throws DatabaseException {\r
  86                     initialValue = getInitialValue(g);\r
  87                     initializeModifier(g);\r
  88                 }\r
  89             });\r
  90         } catch (DatabaseException e) {\r
  91             modifierFailed = e;\r
  92         }\r
  93     }\r
  94 \r
  95     protected void initializeModifier(ReadGraph graph) throws DatabaseException {\r
  96         modifierFactory = graph.getPossibleAdapter(subject, StringModifierFactory.class);\r
  97         if (modifierFactory != null)\r
  98             modifier = modifierFactory.createModifier(graph, predicate, object);\r
  99         if (modifier == null) {\r
 100             modifierFactory = null;\r
 101             modifier = graph.adapt(object, StringModifier.class);\r
 102         }\r
 103     }\r
 104 \r
 105     /**\r
 106      * @param g\r
 107      * @return the value that shall be returned by {@link #getValue()}\r
 108      */\r
 109     protected String getInitialValue(ReadGraph g) throws DatabaseException {\r
 110         return g.adapt(object, String.class);\r
 111     }\r
 112 \r
 113     /**\r
 114      * @return the modifier\r
 115      */\r
 116     protected StringModifier getModifier() {\r
 117         return modifier;\r
 118     }\r
 119 \r
 120     protected StringModifierFactory getModifierFactory() {\r
 121         return modifierFactory;\r
 122     }\r
 123     \r
 124     @Override\r
 125     public String getValue() {\r
 126         return initialValue;\r
 127     }\r
 128 \r
 129     @Override\r
 130     public String isValid(String label) {\r
 131         if (modifierFailed != null)\r
 132             return modifierFailed.getMessage();\r
 133         if (modifier == null)\r
 134             return "No modifier available";\r
 135         String t = createModifierInput(label);\r
 136         return modifier.isValid(t);\r
 137     }\r
 138 \r
 139     @Override\r
 140     public final void modify(String label) {\r
 141         if (modifierFailed != null)\r
 142             // TODO: throw exception?\r
 143             return;\r
 144         String t = createModifierInput(label);\r
 145         if (!verifyModification(t))\r
 146             return;\r
 147         doModify(t);\r
 148     }\r
 149 \r
 150     /**\r
 151      * Called one last time before actually performing the modifying write\r
 152      * transaction to verify whether this is really desired or not.\r
 153      * \r
 154      * <p>\r
 155      * This default implementation will always allow the modification to proceed.\r
 156      * </p>\r
 157      * \r
 158      * @param label the label to be given to the modifier\r
 159      * @return <code>true</code> to go forward with the transaction,\r
 160      *         <code>false</code> to bail out\r
 161      */\r
 162     protected boolean verifyModification(String label) {\r
 163         return true;\r
 164     }\r
 165 \r
 166     public abstract void doModify(String label);\r
 167 \r
 168     /**\r
 169      * Override if necessary.\r
 170      * \r
 171      * @param label\r
 172      * @return\r
 173      */\r
 174     public String createModifierInput(String label) {\r
 175         return label;\r
 176     }\r
 177 \r
 178 };\r