source/mir/entity/EntityRelation.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 import mir.storage.StorageObject;
  33 import mir.storage.StorageObjectExc;
  34 import mir.storage.StorageObjectFailure;
  35
  36 public class EntityRelation {
  37
  38   public String         fromId;
  39   public String         toId;
  40   public StorageObject  storage;
  41   public int            type;
  42
  43   public final static int TO_ONE    =  1;
  44   public final static int TO_MANY   =  2;
  45
  46
  47   /**
  48    *  Kontruktor fuer EntityRelation
  49    *  @param fromId ist der Feldname in der ausgehenden Tabelle fuer die Relation
  50    *  @param toId ist der Feldname in der Zieltablle
  51    *  @param storage ist das StorageObject, ueber das der Zugriff auf die abhaengige
  52    *         Tabelle erfolgt.
  53    *  @param type ist der Typ der EntityRelation (TO_ONE oder TO_MANY)
  54    */
  55
  56   public EntityRelation(String fromId, String toId, StorageObject storage, int type) {
  57       this.fromId = fromId;
  58       this.toId = toId;
  59       this.storage = storage;
  60       this.type = type;
  61   }
  62
  63   /**
  64    *   @return Liefert eine abhaengige Entity mit den verknuepften
  65    *           Entities, wenn es sich um eine TO_ONE Beziehung handelt, ansonsten
  66    *           null.
  67    */
  68
  69   public Entity getOne(Entity entity) throws StorageObjectExc {
  70     if (type==TO_ONE) {
  71       return storage.selectById(entity.getValue(fromId));
  72     }
  73     else return null;
  74   }
  75
  76   /**
  77    *   @return Liefert eine freemarker.template.SimpleList mit den verknuepften
  78    *           Entities, wenn es sich um eine TO_MANY Liste handelt, ansonsten
  79    *           null.
  80    */
  81
  82   public EntityList getMany(Entity entity) throws StorageObjectFailure{
  83     if (type==TO_MANY) {
  84       return storage.selectByFieldValue(toId, entity.getValue(fromId));
  85     }
  86     else return null;
  87   }
  88
  89   /**
  90    *   @return Liefert eine freemarker.template.SimpleList mit den verknuepften
  91    *           Entities, wenn es sich um eine TO_MANY Liste handelt, ansonsten
  92    *           null.
  93    */
  94
  95   public EntityList getMany(Entity entity, String order) throws StorageObjectFailure{
  96     if (type==TO_MANY) {
  97       return storage.selectByWhereClause(toId+"="+entity.getValue(fromId), order,-1);
  98     }
  99     else return null;
 100   }
 101
 102   /**
 103    *   @return Liefert eine freemarker.template.SimpleList mit den verknuepften
 104    *           Entities, wenn es sich um eine TO_MANY Liste handelt, ansonsten
 105    *           null.
 106    */
 107
 108   public EntityList getMany(Entity entity, String order, String whereClause) throws StorageObjectFailure{
 109     if (type==TO_MANY) {
 110       return storage.selectByWhereClause(toId + "=" + entity.getValue(fromId) + " and " + whereClause, order,-1);
 111     }
 112     else return null;
 113   }
 114
 115   /**
 116    *   @return The reference name of the related table.
 117    */
 118
 119   public String getName() {
 120     return "to" + storage.getTableName();
 121   }
 122
 123
 124 }