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 the com.oreilly.servlet library, any library
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
  24  * the above that use the same license as the above), and distribute linked
  25  * combinations including the two.  You must obey the GNU General Public
  26  * License in all respects for all of the code used other than the above
  27  * mentioned libraries.  If you modify this file, you may extend this exception
  28  * to your version of the file, but you are not obligated to do so.  If you do
  29  * not wish to do so, delete this exception statement from your version.
  30  */
  31
  32 package mir.entity;
  33
  34 import mir.storage.*;
  35 import mir.misc.*;
  36 import freemarker.template.*;
  37
  38 public class EntityRelation {
  39
  40   public String         fromId;
  41   public String         toId;
  42   public StorageObject  storage;
  43   public int            type;
  44
  45   public final static int TO_ONE    =  1;
  46   public final static int TO_MANY   =  2;
  47
  48
  49   /**
  50    *  Kontruktor fuer EntityRelation
  51    *  @param fromId ist der Feldname in der ausgehenden Tabelle fuer die Relation
  52    *  @param toId ist der Feldname in der Zieltablle
  53    *  @param storage ist das StorageObject, ueber das der Zugriff auf die abhaengige
  54    *         Tabelle erfolgt.
  55    *  @param type ist der Typ der EntityRelation (TO_ONE oder TO_MANY)
  56    */
  57
  58   public EntityRelation(String fromId, String toId, StorageObject storage, int type) {
  59       this.fromId = fromId;
  60       this.toId = toId;
  61       this.storage = storage;
  62       this.type = type;
  63   }
  64
  65   /**
  66    *   @return Liefert eine abhaengige Entity mit den verknuepften
  67    *           Entities, wenn es sich um eine TO_ONE Beziehung handelt, ansonsten
  68    *           null.
  69    */
  70
  71   public Entity getOne(Entity entity) throws StorageObjectException {
  72     if (type==TO_ONE) {
  73       return storage.selectById(entity.getValue(fromId));
  74     }
  75     else return null;
  76   }
  77
  78   /**
  79    *   @return Liefert eine freemarker.template.SimpleList mit den verknuepften
  80    *           Entities, wenn es sich um eine TO_MANY Liste handelt, ansonsten
  81    *           null.
  82    */
  83
  84   public EntityList getMany(Entity entity) throws StorageObjectException{
  85     if (type==TO_MANY) {
  86       return storage.selectByFieldValue(toId, entity.getValue(fromId));
  87     }
  88     else return null;
  89   }
  90
  91   /**
  92    *   @return Liefert eine freemarker.template.SimpleList mit den verknuepften
  93    *           Entities, wenn es sich um eine TO_MANY Liste handelt, ansonsten
  94    *           null.
  95    */
  96
  97   public EntityList getMany(Entity entity, String order) throws StorageObjectException{
  98     if (type==TO_MANY) {
  99       return storage.selectByWhereClause(toId+"="+entity.getValue(fromId), order,-1);
 100     }
 101     else return null;
 102   }
 103
 104   /**
 105    *   @return Liefert eine freemarker.template.SimpleList mit den verknuepften
 106    *           Entities, wenn es sich um eine TO_MANY Liste handelt, ansonsten
 107    *           null.
 108    */
 109
 110   public EntityList getMany(Entity entity, String order, String whereClause) throws StorageObjectException{
 111     if (type==TO_MANY) {
 112       return storage.selectByWhereClause(toId + "=" + entity.getValue(fromId) + " and " + whereClause, order,-1);
 113     }
 114     else return null;
 115   }
 116
 117   /**
 118    *   @return The reference name of the related table.
 119    */
 120
 121   public String getName() {
 122     return "to" + storage.getTableName();
 123   }
 124
 125
 126 }