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.ext;
22:
23: /**
24: * the internal representation of a stored class.
25: */
26: public interface StoredClass {
27:
28: /**
29: * returns the name of this stored class.
30: */
31: public String getName();
32:
33: /**
34: * returns an array of IDs of all stored object instances of this stored class.
35: */
36: public long[] getIDs();
37:
38: /**
39: * returns the StoredClass for the parent of the class, this StoredClass represents.
40: */
41: public StoredClass getParentStoredClass();
42:
43: /**
44: * returns all stored fields of this stored class.
45: */
46: public StoredField[] getStoredFields();
47:
48: /**
49: * returns true if this StoredClass has a class index.
50: */
51: public boolean hasClassIndex();
52:
53: /**
54: * renames this stored class.
55: * <br><br>After renaming one or multiple classes the ObjectContainer has
56: * to be closed and reopened to allow internal caches to be refreshed.
57: * <br><br>.NET: As the name you should provide [Classname, Assemblyname]<br><br>
58: * @param name the new name
59: */
60: public void rename(String name);
61:
62: // TODO: add field creation
63:
64: /**
65: * returns an existing stored field of this stored class.
66: * @param name the name of the field
67: * @param type the type of the field.
68: * There are four possibilities how to supply the type:<br>
69: * - a Class object. (.NET: a Type object)<br>
70: * - a fully qualified classname.<br>
71: * - any object to be used as a template.<br><br>
72: * - null, if the first found field should be returned.
73: * @return the {@link StoredField}
74: */
75: public StoredField storedField(String name, Object type);
76:
77: }
|