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
10 * VTT Technical Research Centre of Finland - initial API and implementation
\r
11 *******************************************************************************/
\r
12 package org.simantics.db.layer0.genericrelation;
\r
14 import java.util.Collection;
\r
15 import java.util.List;
\r
16 import java.util.Map;
\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
26 * TODO: make a statement about synchronization requirements imposed by the interface
\r
28 * TODO: what exceptions are the methods supposed to throw? any checked exceptions?
\r
30 * @author Antti Villberg
\r
32 public interface IndexedRelations {
\r
40 * @param maxResultCount
\r
42 * @throws IndexException
\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
47 public List<Resource> queryResources(IProgressMonitor monitor, String search, RequestProcessor session,
\r
48 Resource relation, Resource input, int maxResultCount) throws IndexException;
\r
57 * @throws IndexException
\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
71 * @throws IndexException
\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
77 public void removeAll(IProgressMonitor monitor, RequestProcessor processor, GenericRelation relation,
\r
78 Resource resource, Resource input)
\r
79 throws IndexException;
\r
90 * @throws IndexException
\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
96 public void reset(IProgressMonitor monitor, RequestProcessor processor, Resource resource, Resource input)
\r
97 throws IndexException;
\r