source/mir/entity/StorableObjectEntity.java

   1 /*
   2  * Copyright (C) 2001, 2002 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  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mir.entity;
  31
  32 /**
  33  * Title:         StorableObjectEntity
  34  * Description:   Basic Container that can be handled by ObjectStore
  35  * Copyright:     Copyright (c) 2002
  36  * Company:       indy
  37  * @author        rk
  38  * @version       1.0
  39  */
  40
  41 import java.sql.ResultSet;
  42 import java.sql.SQLException;
  43 import java.util.Set;
  44
  45 import mir.storage.Database;
  46 import mir.storage.store.StorableObject;
  47 import mir.storage.store.StoreIdentifier;
  48
  49
  50 public class StorableObjectEntity extends AbstractEntity
  51                 implements StorableObject {
  52
  53   /**
  54    *  Method:       getStoreIdentifier
  55    *  Description:  returns unique StoreIdentifer under which the Entity
  56    *                is Stored. Based upon primary key and tablename.
  57    *
  58    *  @return       StoreIdentifier
  59    */
  60   public StoreIdentifier getStoreIdentifier() {
  61     String id = getId();
  62     if ( id!=null && database!= null )
  63      return new StoreIdentifier(this, id+"@"+database.getTableName());
  64     return null;
  65   }
  66
  67   public static final StoreIdentifier getStoreIdentifier(
  68      Class theEntityClass, String theTable, String id) {
  69      if (id == null) {
  70         return null;
  71      }
  72                 return new StoreIdentifier(theEntityClass, id + "@" + theTable);
  73   }
  74
  75   public static final StoreIdentifier getStoreIdentifier(Database theStorage,
  76      Class theEntityClass, ResultSet rs) throws SQLException {
  77
  78         String idcol = theStorage.getIdFieldName();
  79         String idval = rs.getObject(idcol).toString();
  80
  81         if (idval != null) {
  82            return getStoreIdentifier(theEntityClass,
  83               theStorage.getTableName(), idval);
  84         }
  85
  86      return null;
  87   }
  88
  89   /**
  90    *  Method:       getNotifyOnReleaseSet()
  91    *  Description:  returns empty Set, GenericContainer does not implement
  92    *                dependencies.
  93    *
  94    *  @return       null
  95    */
  96   public Set getNotifyOnReleaseSet() { return null; }
  97
  98 }