01: /*
02: * (c) Copyright 2006 by Volker Bergmann. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, is permitted under the terms of the
06: * GNU General Public License.
07: *
08: * For redistributing this software or a derivative work under a license other
09: * than the GPL-compatible Free Software License as defined by the Free
10: * Software Foundation or approved by OSI, you must first obtain a commercial
11: * license to this software product from Volker Bergmann.
12: *
13: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14: * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
15: * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
16: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
17: * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
18: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24: * POSSIBILITY OF SUCH DAMAGE.
25: */
26:
27: package org.databene.model.storage;
28:
29: import org.databene.commons.Heavyweight;
30: import org.databene.commons.TypedIterable;
31: import org.databene.model.data.DescriptorProvider;
32: import org.databene.model.data.Entity;
33:
34: /**
35: * Abstraction of an Entity storage system.<br/><br/>
36: * <br/>
37: * Created: 27.06.2007 23:02:21
38: * @since 0.4.0
39: * @author Volker Bergmann
40: */
41: public interface StorageSystem extends DescriptorProvider, Heavyweight {
42:
43: /** Returns a name that identifies the database */
44: String getId();
45:
46: /** Creates an iterator that provides all entities of given type. */
47: TypedIterable<Entity> queryEntities(String type, String selector);
48:
49: /** Queries for entity ids */
50: <T> TypedIterable<T> queryEntityIds(String entityName,
51: String selector);
52:
53: /** Creates an Iterable for repetitive iteration through the results of the specified query. */
54: <T> TypedIterable<T> query(String selector);
55:
56: /** Enqueues an entity for {@link #flush()}ing. */
57: void store(Entity entity);
58:
59: /** Assures that all data that has been {@link #store(Entity)}d, is send to the target system. */
60: void flush();
61:
62: /** Closes the database. */
63: void close();
64: }
|