01: /* Copyright (C) 2004 - 2007 db4objects Inc. http://www.db4o.com
02:
03: This file is part of the db4o open source object database.
04:
05: db4o is free software; you can redistribute it and/or modify it under
06: the terms of version 2 of the GNU General Public License as published
07: by the Free Software Foundation and as clarified by db4objects' GPL
08: interpretation policy, available at
09: http://www.db4o.com/about/company/legalpolicies/gplinterpretation/
10: Alternatively you can write to db4objects, Inc., 1900 S Norfolk Street,
11: Suite 350, San Mateo, CA 94403, USA.
12:
13: db4o is distributed in the hope that it will be useful, but WITHOUT ANY
14: WARRANTY; without even the implied warranty of MERCHANTABILITY or
15: FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16: for more details.
17:
18: You should have received a copy of the GNU General Public License along
19: with this program; if not, write to the Free Software Foundation, Inc.,
20: 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
21: package com.db4o.types;
22:
23: import java.util.*;
24:
25: /**
26: * db4o Map implementation for database-aware maps.
27: * <br><br>
28: * A <code>Db4oMap</code> supplies the methods specified in java.util.Map.<br><br>
29: * All access to the map is controlled by the {@link com.db4o.ObjectContainer ObjectContainer} to help the
30: * programmer produce expected results with as little work as possible:<br>
31: * - newly added objects are automatically persisted.<br>
32: * - map elements are automatically activated when they are needed. The activation
33: * depth is configurable with {@link Db4oCollection#activationDepth(int)}.<br>
34: * - removed objects can be deleted automatically, if the list is configured
35: * with {@link Db4oCollection#deleteRemoved(boolean)}<br><br>
36: * Usage:<br>
37: * - declare a <code>java.util.Map</code> variable on your persistent classes.<br>
38: * - fill this variable with a method in the ObjectContainer collection factory.<br><br>
39: * <b>Example:</b><br><br>
40: * <code>class MyClass{<br>
41: * Map myMap;<br>
42: * }<br><br>
43: * MyClass myObject = new MyClass();<br>
44: * myObject.myMap = objectContainer.ext().collections().newHashMap();
45: * @see com.db4o.ext.ExtObjectContainer#collections
46: */
47: public interface Db4oMap extends Db4oCollection, Map {
48:
49: }
|