01: /**********************************************************************
02: Copyright (c) 2005 Erik Bengtson and others. All rights reserved.
03: Licensed under the Apache License, Version 2.0 (the "License");
04: you may not use this file except in compliance with the License.
05: You may obtain a copy of the License at
06:
07: http://www.apache.org/licenses/LICENSE-2.0
08:
09: Unless required by applicable law or agreed to in writing, software
10: distributed under the License is distributed on an "AS IS" BASIS,
11: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: See the License for the specific language governing permissions and
13: limitations under the License.
14:
15: Contributors:
16: ...
17: **********************************************************************/package org.jpox.store;
18:
19: import org.jpox.metadata.AbstractMemberMetaData;
20: import org.jpox.metadata.DiscriminatorMetaData;
21: import org.jpox.metadata.MetaData;
22: import org.jpox.metadata.VersionMetaData;
23: import org.jpox.store.mapping.JavaTypeMapping;
24:
25: /**
26: * This represents a container of fields. Such as table (container of columns), file, etc.
27: * @version $Revision: 1.15 $
28: */
29: public interface DatastoreContainerObject extends DatastoreObject {
30: /**
31: * Method to add a new column to the internal representation.
32: * @param storedJavaType The type of the Java field to store
33: * @param name The name of the column
34: * @param mapping The type mapping for this column
35: * @param colmd The MetaData (ColumnMetaData for RDBMS)
36: * @return The new Column
37: */
38: DatastoreField addDatastoreField(String storedJavaType,
39: DatastoreIdentifier name, JavaTypeMapping mapping,
40: MetaData colmd);
41:
42: /**
43: * Checks if there is a DatastoreField for the identifier
44: * @param identifier the identifier of the DatastoreField
45: * @return true if the DatastoreField exists for the identifier
46: */
47: boolean hasDatastoreField(DatastoreIdentifier identifier);
48:
49: /**
50: * Accessor for the ID mapping of this container object.
51: * @return The ID Mapping (if present)
52: */
53: JavaTypeMapping getIDMapping();
54:
55: /**
56: * Accessor for the mapping for the specified FieldMetaData. A
57: * datastore container object may store many fields.
58: * @param fmd the FieldMetaData
59: * @return The Mapping for the field, or null if the FieldMetaData cannot be found
60: */
61: JavaTypeMapping getFieldMapping(AbstractMemberMetaData fmd);
62:
63: /**
64: * Accessor for Discriminator MetaData.
65: * @return Returns the Discriminator MetaData.
66: */
67: DiscriminatorMetaData getDiscriminatorMetaData();
68:
69: /**
70: * Accessor for the discriminator mapping specified.
71: * @param allowSuperclasses Whether we should return just the mapping from this table
72: * or whether we should return it when this table has none and the supertable has
73: * @return The discriminator mapping
74: **/
75: JavaTypeMapping getDiscriminatorMapping(boolean allowSuperclasses);
76:
77: /**
78: * Accessor for the Version MetaData.
79: * @return Returns the Version MetaData.
80: */
81: VersionMetaData getVersionMetaData();
82:
83: /**
84: * Accessor for the version mapping specified .
85: * @param allowSuperclasses Whether we should return just the mapping from this table
86: * or whether we should return it when this table has none and the supertable has
87: * @return The version mapping.
88: **/
89: JavaTypeMapping getVersionMapping(boolean allowSuperclasses);
90:
91: /**
92: * Accessor for the DatastoreFields infered from the java and metadata files.
93: * @return the DatastoreField[]
94: */
95: DatastoreField[] getDatastoreFieldsMetaData();
96:
97: }
|