preliminary support for a TAL template engine
[mir.git] / source / mir / generator / tal / CachingFileLoader.java
1 /*\r
2  * Copyright (C) 2001, 2002 The Mir-coders group\r
3  *\r
4  * This file is part of Mir.\r
5  *\r
6  * Mir is free software; you can redistribute it and/or modify\r
7  * it under the terms of the GNU General Public License as published by\r
8  * the Free Software Foundation; either version 2 of the License, or\r
9  * (at your option) any later version.\r
10  *\r
11  * Mir is distributed in the hope that it will be useful,\r
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14  * GNU General Public License for more details.\r
15  *\r
16  * You should have received a copy of the GNU General Public License\r
17  * along with Mir; if not, write to the Free Software\r
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
19  *\r
20  * In addition, as a special exception, The Mir-coders gives permission to link\r
21  * the code of this program with  any library licensed under the Apache Software License,\r
22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library\r
23  * (or with modified versions of the above that use the same license as the above),\r
24  * and distribute linked combinations including the two.  You must obey the\r
25  * GNU General Public License in all respects for all of the code used other than\r
26  * the above mentioned libraries.  If you modify this file, you may extend this\r
27  * exception to your version of the file, but you are not obligated to do so.\r
28  * If you do not wish to do so, delete this exception statement from your version.\r
29  */\r
30 package mir.generator.tal;\r
31 \r
32 import java.io.File;\r
33 import java.io.FileInputStream;\r
34 import java.io.FileNotFoundException;\r
35 import java.io.InputStream;\r
36 import java.util.HashMap;\r
37 import java.util.List;\r
38 import java.util.Map;\r
39 import java.util.Vector;\r
40 \r
41 public class CachingFileLoader {\r
42   private Map cachedObjects;\r
43   private List history;\r
44   private int capacity;\r
45   private CachedFileObjectFactory factory;\r
46 \r
47   public CachingFileLoader(int aCapacity, CachedFileObjectFactory aFactory) {\r
48     capacity = aCapacity;\r
49     cachedObjects = new HashMap();\r
50     history = new Vector();\r
51     factory = aFactory;\r
52   }\r
53 \r
54   private void cacheObject(String aFilename, long aLastModified, Object anObject) {\r
55     synchronized (this) {\r
56       history.remove(aFilename);\r
57       history.add(aFilename);\r
58       while (history.size()>capacity && history.size()>0) {\r
59         history.remove(0);\r
60       }\r
61       cachedObjects.put(aFilename, new CachedObject(aFilename, aLastModified, anObject));\r
62     }\r
63   }\r
64 \r
65   private Object constructObject(String aFilename) throws FileNotFoundException {\r
66     File file = new File(aFilename);\r
67     FileInputStream inputStream = new FileInputStream(file);\r
68     try {\r
69       Object result = factory.constructObject(inputStream);\r
70       cacheObject(aFilename, file.lastModified(), result);\r
71 \r
72       return result;\r
73     }\r
74     finally {\r
75       try {\r
76         inputStream.close();\r
77       }\r
78       catch (Throwable t) {\r
79       }\r
80     }\r
81   }\r
82 \r
83   private void revatilize(String aFilename) {\r
84     synchronized (this) {\r
85       history.remove(aFilename);\r
86       history.add(aFilename);\r
87     }\r
88   }\r
89 \r
90   private class CachedObject {\r
91     private String filename;\r
92     private long lastModified;\r
93     private Object object;\r
94 \r
95     public CachedObject(String aFilename, long aLastModified, Object anObject) {\r
96       filename = aFilename;\r
97       lastModified = aLastModified;\r
98       object = anObject;\r
99     }\r
100 \r
101     public Object getObject() {\r
102       return object;\r
103     }\r
104 \r
105     public String getFilename() {\r
106       return filename;\r
107     }\r
108 \r
109     public long getLastModified() {\r
110       return lastModified;\r
111     }\r
112   }\r
113 \r
114   public Object retrieveFile(String aFilename) throws FileNotFoundException {\r
115     synchronized (this) {\r
116       if (!cachedObjects.containsKey(aFilename)) {\r
117         return constructObject(aFilename);\r
118       }\r
119 \r
120       CachedObject cachedObject = (CachedObject) cachedObjects.get(aFilename);\r
121       File file = new File(aFilename);\r
122       if (file.lastModified() != cachedObject.getLastModified()) {\r
123         return constructObject(aFilename);\r
124       }\r
125 \r
126       revatilize(aFilename);\r
127 \r
128       return cachedObject.getObject();\r
129     }\r
130   }\r
131 \r
132   public interface CachedFileObjectFactory {\r
133     Object constructObject(InputStream aStream);\r
134   }\r
135 }