rebuilding head
[mir.git] / source / mir / entity / EntityBrowser.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
31 package mir.entity;
32
33 import java.util.List;
34
35 import mir.storage.StorageObject;
36 import mir.storage.StorageObjectFailure;
37 import mir.util.RewindableIterator;
38
39 public class EntityBrowser implements RewindableIterator {
40
41   private StorageObject storage;
42   private String mainTablePrefix;
43   private List extraTables;
44   private String whereClause;
45   private String orderByClause;
46   private int batchSize;
47   private EntityList currentBatch;
48
49   private int skip;
50   private int limit;
51
52   private int batchPosition;
53   private int positionInBatch;
54
55   public EntityBrowser(StorageObject aStorage, String aMainTablePrefix, List someExtraTables,
56      String aWhereClause, String anOrderByClause,
57      int aBatchSize, int aLimit, int aSkip) throws StorageObjectFailure {
58
59     storage=aStorage;
60     mainTablePrefix=aMainTablePrefix;
61     extraTables=someExtraTables;
62     whereClause=aWhereClause;
63     orderByClause=anOrderByClause;
64     batchSize=aBatchSize;
65     skip=aSkip;
66     limit=aLimit;
67
68     rewind();
69   }
70
71   public EntityBrowser(StorageObject aStorage, String aWhereClause, String anOrderByClause,
72                        int aBatchSize, int aLimit, int aSkip) throws StorageObjectFailure {
73     this(aStorage, "", null, aWhereClause, anOrderByClause, aBatchSize, aLimit, aSkip);
74   }
75
76   public EntityBrowser(StorageObject aStorage,
77           String aWhereClause, String anOrderByClause,
78           int aBatchSize) throws StorageObjectFailure {
79     this(aStorage, aWhereClause, anOrderByClause, aBatchSize, -1, 0);
80   }
81
82   public void readCurrentBatch(int aSkip) throws StorageObjectFailure {
83     currentBatch = storage.selectByWhereClause(mainTablePrefix, extraTables, whereClause, orderByClause, aSkip, batchSize);
84     batchPosition = aSkip;
85     positionInBatch = 0;
86   }
87
88   public void rewind() {
89     try {
90       readCurrentBatch(skip);
91     }
92     catch (Throwable t) {
93       throw new RuntimeException(t.getMessage());
94     }
95   }
96
97   public boolean hasNext() {
98     try {
99       if (limit>-1 && batchPosition+positionInBatch>=skip+limit)
100         return false;
101
102       if (positionInBatch>=currentBatch.size() && currentBatch.hasNextBatch()) {
103         readCurrentBatch(batchPosition+positionInBatch);
104       }
105
106       return (positionInBatch<currentBatch.size());
107     }
108     catch (Throwable t) {
109       throw new RuntimeException(t.getMessage());
110     }
111   }
112
113   public Object next() {
114     try {
115       if (hasNext()) {
116         Entity result = currentBatch.elementAt(positionInBatch);
117         positionInBatch=positionInBatch+1;
118
119         return result;
120       }
121       else {
122         return null;
123       }
124     }
125     catch (Throwable t) {
126       throw new RuntimeException(t.getMessage());
127     }
128   }
129
130   public void remove() {
131     throw new UnsupportedOperationException();
132   }
133 }