bundles/org.simantics.db.layer0/src/org/simantics/db/layer0/genericrelation/IndexedRelations.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.genericrelation;\r
  13 \r
  14 import java.util.Collection;\r
  15 import java.util.List;\r
  16 import java.util.Map;\r
  17 \r
  18 import org.eclipse.core.runtime.IProgressMonitor;\r
  19 import org.simantics.db.RequestProcessor;\r
  20 import org.simantics.db.Resource;\r
  21 import org.simantics.db.layer0.adapter.GenericRelation;\r
  22 \r
  23 /**\r
  24  * TODO: how to use\r
  25  * \r
  26  * TODO: make a statement about synchronization requirements imposed by the interface\r
  27  * \r
  28  * TODO: what exceptions are the methods supposed to throw? any checked exceptions?\r
  29  * \r
  30  * @author Antti Villberg\r
  31  */\r
  32 public interface IndexedRelations {\r
  33 \r
  34     /**\r
  35      * @param monitor\r
  36      * @param search\r
  37      * @param session\r
  38      * @param relation\r
  39      * @param input\r
  40      * @param maxResultCount\r
  41      * @return\r
  42      * @throws IndexException\r
  43      */\r
  44     public List<Map<String, Object>> query(IProgressMonitor monitor, String search, RequestProcessor session,\r
  45             Resource relation, Resource input, int maxResultCount) throws IndexException;\r
  46 \r
  47     public List<Resource> queryResources(IProgressMonitor monitor, String search, RequestProcessor session,\r
  48             Resource relation, Resource input, int maxResultCount) throws IndexException;\r
  49 \r
  50     /**\r
  51      * @param monitor\r
  52      * @param processor\r
  53      * @param relation\r
  54      * @param resource\r
  55      * @param input\r
  56      * @param documents\r
  57      * @throws IndexException\r
  58      */\r
  59     public void insert(IProgressMonitor monitor, RequestProcessor processor, GenericRelation relation,\r
  60             Resource resource, Resource input, Collection<Object[]> documents)\r
  61     throws IndexException;\r
  62 \r
  63     /**\r
  64      * @param monitor\r
  65      * @param processor\r
  66      * @param relation\r
  67      * @param resource\r
  68      * @param input\r
  69      * @param key\r
  70      * @param keyValues\r
  71      * @throws IndexException\r
  72      */\r
  73     public void remove(IProgressMonitor monitor, RequestProcessor processor, GenericRelation relation,\r
  74             Resource resource, Resource input, String key, Collection<Object> keyValues)\r
  75     throws IndexException;\r
  76 \r
  77     public void removeAll(IProgressMonitor monitor, RequestProcessor processor, GenericRelation relation,\r
  78             Resource resource, Resource input)\r
  79     throws IndexException;\r
  80     \r
  81     /**\r
  82      * @param monitor\r
  83      * @param processor\r
  84      * @param relation\r
  85      * @param resource\r
  86      * @param input\r
  87      * @param key\r
  88      * @param keyValues\r
  89      * @param documents\r
  90      * @throws IndexException\r
  91      */\r
  92     public boolean replace(IProgressMonitor monitor, RequestProcessor processor, GenericRelation relation,\r
  93             Resource resource, Resource input, String key, Collection<Object> keyValues, Collection<Object[]> documents)\r
  94     throws IndexException;\r
  95 \r
  96     public void reset(IProgressMonitor monitor, RequestProcessor processor, Resource resource, Resource input)\r
  97     throws IndexException;\r
  98 \r
  99 }\r