bundles/org.simantics.db.layer0/src/org/simantics/db/layer0/adapter/Modifier.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.db.layer0.adapter;
  13
  14 import org.simantics.db.WriteGraph;
  15 import org.simantics.db.exception.DatabaseException;
  16
  17 public interface Modifier<T> {
  18
  19     /**
  20      * @return an initial text to be modified
  21      */
  22         String getValue();
  23
  24     /**
  25      * Validates the given string. Returns an error message to display if the
  26      * new text is invalid. Returns <code>null</code> if there is no error. Note
  27      * that the empty string is not treated the same as <code>null</code>; it
  28      * indicates an error state but with no message to display.
  29      *
  30      * @param newText the text to check for validity
  31      * @return an error message or <code>null</code> if no error
  32      */
  33     String isValid(T newValue);
  34
  35     /**
  36      * @param graph access to the graph database
  37      * @param value the new value to set
  38      */
  39     void modify(WriteGraph graph, T value) throws DatabaseException;
  40 }