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.defragment;
22:
23: /**
24: * The ID mapping used internally during a defragmentation run.
25: *
26: * @see Defragment
27: */
28: public interface ContextIDMapping {
29:
30: /**
31: * Returns a previously registered mapping ID for the given ID if it exists.
32: * If lenient mode is set to true, will provide the mapping ID for the next
33: * smaller original ID a mapping exists for. Otherwise returns 0.
34: *
35: * @param origID The original ID
36: * @param lenient If true, lenient mode will be used for lookup, strict mode otherwise.
37: * @return The mapping ID for the given original ID or 0, if none has been registered.
38: */
39: int mappedID(int origID, boolean lenient);
40:
41: /**
42: * Registers a mapping for the given IDs.
43: *
44: * @param origID The original ID
45: * @param mappedID The ID to be mapped to the original ID.
46: * @param isClassID true if the given original ID specifies a class slot, false otherwise.
47: */
48: void mapIDs(int origID, int mappedID, boolean isClassID);
49:
50: /**
51: * Prepares the mapping for use.
52: */
53: void open();
54:
55: /**
56: * Shuts down the mapping after use.
57: */
58: void close();
59: }
|