summaryrefslogtreecommitdiffstats
path: root/src/net/java/joglutils/msg/test/BasicFetcher.java
blob: 277e7fb79f2774fb52b9e98c49f8a7023f9a8f6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/*
 * Copyright 2007 Sun Microsystems, Inc., 4150 Network Circle,
 * Santa Clara, California 95054, U.S.A. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Sun Microsystems nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package net.java.joglutils.msg.test;

import java.awt.EventQueue;
import java.awt.image.*;
import java.io.*;
import java.net.*;
import java.util.*;
import java.util.concurrent.*;
import javax.imageio.*;

/**
 * Basic implementation of Fetcher using ImageIO and a single-threaded
 * ExecutorService.
 *
 * @author Kenneth Russell
 */

public class BasicFetcher<IDENT> implements Fetcher<IDENT> {
  private volatile ArrayList<ProgressListener> listeners = new ArrayList<ProgressListener>();
  private Map<FetchKey, Future<BufferedImage>> activeTasks = new HashMap<FetchKey, Future<BufferedImage>>();

  private ExecutorService threadPool;

  public BasicFetcher() {
    threadPool = Executors.newSingleThreadExecutor(new ThreadFactory() {
        public Thread newThread(Runnable r) {
          Thread t = Executors.defaultThreadFactory().newThread(r);
          t.setPriority(Thread.NORM_PRIORITY - 2);
          return t;
        }
      });
  }

  public synchronized BufferedImage getImage(final Object imageDescriptor,
                                             final IDENT clientIdentifier,
                                             final int requestedImageSize) {
    FetchKey key = new FetchKey(imageDescriptor, clientIdentifier, requestedImageSize);
    Future<BufferedImage> result = activeTasks.get(key);
    if (result != null) {
      try {
        return result.get(1, TimeUnit.MILLISECONDS);
      } catch (Exception e) {
        return null;
      }
    }

    FutureTask<BufferedImage> task = new FutureTask<BufferedImage>(new Callable<BufferedImage>() {
      public BufferedImage call() {
        try {
          if (imageDescriptor instanceof File) {
            return ImageIO.read((File) imageDescriptor);
          } else if (imageDescriptor instanceof URL) {
            return ImageIO.read((URL) imageDescriptor);
          } else {
            throw new RuntimeException("Unsupported ImageDescriptorType " + imageDescriptor.getClass().getName());
          }
        } catch (Exception e) {
          System.out.println("Exception loading " + imageDescriptor + ":");
          e.printStackTrace();
          return null;
        } finally {
          fireProgressEnd(new ProgressEvent(BasicFetcher.this,
                                            imageDescriptor,
                                            clientIdentifier,
                                            1.0f,
                                            true));
        }
      }
    });
    activeTasks.put(key, task);
    threadPool.execute(task);
    return null;
  }

  public void cancelDownload(Object imageDescriptor,
                             IDENT clientIdentifier,
                             int requestedImageSize) {
  }

  public synchronized void addProgressListener(ProgressListener listener) {
    ArrayList<ProgressListener> newListeners = (ArrayList<ProgressListener>) listeners.clone();
    newListeners.add(listener);
    listeners = newListeners;
  }

  public synchronized void removeProgressListener(ProgressListener listener) {
    ArrayList<ProgressListener> newListeners = (ArrayList<ProgressListener>) listeners.clone();
    newListeners.remove(listener);
    listeners = newListeners;
  }

  //----------------------------------------------------------------------
  // Internals only below this point
  //

  class FetchKey {
    private Object imageDescriptor;
    private IDENT  clientIdentifier;
    private int    requestedImageSize;

    public FetchKey(Object imageDescriptor,
                    IDENT clientIdentifier,
                    int requestedImageSize) {
      this.imageDescriptor = imageDescriptor;
      this.clientIdentifier = clientIdentifier;
      this.requestedImageSize = requestedImageSize;
    }

    public Object getImageDescriptor   () { return imageDescriptor;    }
    public IDENT  getClientIdentifier  () { return clientIdentifier;   }
    public int    getRequestedImageSize() { return requestedImageSize; }

    public boolean equals(Object o) {
      if (this == o) return true;
      if (o == null) return false;
      if (getClass() != o.getClass()) return false;

      FetchKey other = (FetchKey) o;
      return (requestedImageSize == other.requestedImageSize &&
              imageDescriptor.equals(other.imageDescriptor) &&
              clientIdentifier.equals(other.clientIdentifier));
    }

    public int hashCode() {
      int result;
      result = clientIdentifier.hashCode();
      result = 29 * result + imageDescriptor.hashCode();
      result = 29 * result + requestedImageSize;
      return result;
    }
  }

  private synchronized void fireProgressStart(final ProgressEvent e) {
    List<ProgressListener> curListeners = listeners;
    for (ProgressListener listener : curListeners) {
      final ProgressListener finalListener = listener;
      invokeLaterOnEDT(new Runnable() {
          public void run() {
            finalListener.progressStart(e);
          }
        });
    }
  }

  private synchronized void fireProgressUpdate(final ProgressEvent e) {
    List<ProgressListener> curListeners = listeners;
    for (ProgressListener listener : curListeners) {
      final ProgressListener finalListener = listener;
      invokeLaterOnEDT(new Runnable() {
          public void run() {
            finalListener.progressUpdate(e);
          }
        });
    }
  }

  private synchronized void fireProgressEnd(final ProgressEvent e) {
    List<ProgressListener> curListeners = listeners;
    for (ProgressListener listener : curListeners) {
      final ProgressListener finalListener = listener;
      invokeLaterOnEDT(new Runnable() {
          public void run() {
            finalListener.progressEnd(e);
          }
        });
    }
  }

  private void invokeLaterOnEDT(Runnable runnable) {
    if (EventQueue.isDispatchThread()) {
      runnable.run();
    } else {
      EventQueue.invokeLater(runnable);
    }
  }
}