bundles/org.simantics.structural2/src/org/simantics/structural2/variables/Connection2.java

   1 /*******************************************************************************
   2  * Copyright (c) 2018 Association for Decentralized Information Management in
   3  * 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  *     Semantum Oy - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.structural2.variables;
  13
  14 import java.util.Collection;
  15
  16 import org.simantics.db.ReadGraph;
  17 import org.simantics.db.Resource;
  18 import org.simantics.db.exception.DatabaseException;
  19 import org.simantics.db.layer0.variable.Variable;
  20
  21 /**
  22  * Improves query result cacheability over {@link Connection}.
  23  *
  24  * @author Antti Villberg
  25  * @since 1.36.0
  26  * @see Connection
  27  */
  28 public interface Connection2 {
  29
  30     /**
  31      * Return absolute URIs of the connection points. An optional (may be null) relationType may be used
  32      * to filter the returned connection points.
  33      */
  34     Collection<String> getConnectionPointURIs(ReadGraph graph, Variable component, Resource relationType) throws DatabaseException;
  35
  36     /**
  37      * Return the connection points. An optional (may be null) relationType may be used
  38      * to filter the returned connection points.
  39      */
  40     Collection<Variable> getConnectionPoints(ReadGraph graph, Variable component, Resource relationType) throws DatabaseException;
  41
  42     Collection<VariableConnectionPointDescriptor> getConnectionPointDescriptors(ReadGraph graph, Variable component, Resource relationType) throws DatabaseException;
  43
  44 }