048d7eebee2916cf5194e905e54c3d8fffa07c1b
[mir.git] / source / mir / entity / StorableObjectEntity.java
1 /*
2  * Copyright (C) 2005 The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with  any library licensed under the Apache Software License.
22  * You must obey the GNU General Public License in all respects for all of the code used
23  * other than the above mentioned libraries.  If you modify this file, you may extend this
24  * exception to your version of the file, but you are not obligated to do so.
25  * If you do not wish to do so, delete this exception statement from your version.
26  */
27 package mir.entity;
28
29 import java.sql.ResultSet;
30 import java.sql.SQLException;
31 import java.util.Set;
32
33 import mir.storage.Database;
34 import mir.storage.store.StorableObject;
35 import mir.storage.store.StoreIdentifier;
36
37
38 public class StorableObjectEntity extends AbstractEntity
39                 implements StorableObject {
40
41   /**
42    *  Method:       getStoreIdentifier
43    *  Description:  returns unique StoreIdentifer under which the Entity
44    *                is Stored. Based upon primary key and tablename.
45    *
46    *  @return       StoreIdentifier
47    */
48   public StoreIdentifier getStoreIdentifier() {
49     String id = getId();
50     if ( id!=null && database!= null )
51      return new StoreIdentifier(this, id+"@"+database.getTableName());
52     return null;
53   }
54
55   public static final StoreIdentifier getStoreIdentifier(
56      Class theEntityClass, String theTable, String id) {
57      if (id == null) {
58         return null;
59      }
60                 return new StoreIdentifier(theEntityClass, id + "@" + theTable);
61   }
62
63   public static final StoreIdentifier getStoreIdentifier(Database theStorage,
64      Class theEntityClass, ResultSet rs) throws SQLException {
65
66         String idcol = theStorage.getIdFieldName();
67         String idval = rs.getObject(idcol).toString();
68
69         if (idval != null) {
70            return getStoreIdentifier(theEntityClass,
71               theStorage.getTableName(), idval);
72         }
73
74      return null;
75   }
76
77   /**
78    *  Method:       getNotifyOnReleaseSet()
79    *  Description:  returns empty Set, GenericContainer does not implement
80    *                dependencies.
81    *
82    *  @return       null
83    */
84   public Set getNotifyOnReleaseSet() { return null; }
85
86 }