bundles/org.simantics.db.layer0/src/org/simantics/db/layer0/adapter/Modifier.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.db.layer0.adapter;\r
  13 \r
  14 import org.simantics.db.WriteGraph;\r
  15 import org.simantics.db.exception.DatabaseException;\r
  16 \r
  17 public interface Modifier<T> {\r
  18         \r
  19     /**\r
  20      * @return an initial text to be modified\r
  21      */\r
  22         String getValue();\r
  23         \r
  24     /**\r
  25      * Validates the given string. Returns an error message to display if the\r
  26      * new text is invalid. Returns <code>null</code> if there is no error. Note\r
  27      * that the empty string is not treated the same as <code>null</code>; it\r
  28      * indicates an error state but with no message to display.\r
  29      * \r
  30      * @param newText the text to check for validity\r
  31      * @return an error message or <code>null</code> if no error\r
  32      */\r
  33     String isValid(T newValue);\r
  34 \r
  35     /**\r
  36      * @param graph access to the graph database\r
  37      * @param value the new value to set\r
  38      */\r
  39     void modify(WriteGraph graph, T value) throws DatabaseException;\r
  40 }\r