bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/children/ChildRule.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2010, 2011 Association for Decentralized Information Management in\r
   3  * 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.model.children;\r
  13 \r
  14 import java.util.Collection;\r
  15 \r
  16 import org.simantics.db.ReadGraph;\r
  17 import org.simantics.db.exception.DatabaseException;\r
  18 \r
  19 /**\r
  20  * A child rule is a part of child contribution that tells how the child nodes are found.\r
  21  * @author Hannu Niemistö\r
  22  */\r
  23 public interface ChildRule {\r
  24     /**\r
  25      * Checks if the child rule is compatible with the content type.\r
  26      * Because this check is made when contribution is created, \r
  27      * the type of the parent content is not checked anymore in getChildren.\r
  28      */\r
  29     boolean isCompatible(Class<?> contentType);\r
  30     \r
  31     /**\r
  32      * Given parent content produces child contents.\r
  33      */\r
  34     Collection<?> getChildren(ReadGraph graph, Object parent) throws DatabaseException;\r
  35     \r
  36     /**\r
  37      * Given child content produces possible parent contents.\r
  38      */\r
  39     Collection<?> getParents(ReadGraph graph, Object child) throws DatabaseException;\r
  40 }\r