CacheUtils.java

// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.plugins.streetside.cache;


import java.io.IOException;

import org.openstreetmap.josm.data.cache.CacheEntry;
import org.openstreetmap.josm.data.cache.CacheEntryAttributes;
import org.openstreetmap.josm.data.cache.ICachedLoaderListener;
import org.openstreetmap.josm.plugins.streetside.StreetsideImage;
import org.openstreetmap.josm.plugins.streetside.cubemap.CubemapBuilder;
import org.openstreetmap.josm.tools.Logging;

/**
* Utility methods for working with cache.
*
* @author nokutu
*
*/
public final class CacheUtils {

private static IgnoreDownload ignoreDownload = new IgnoreDownload();

/** Picture quality */
public enum PICTURE {
 /** Thumbnail quality picture (320 p) */
 THUMBNAIL,
 /** Full quality picture (2048 p) */
 FULL_IMAGE,
 /** Both of them */
 BOTH,
 /** Streetside cubemap */
 CUBEMAP
}

private CacheUtils() {
 // Private constructor to avoid instantiation
}

/**
* Downloads the the thumbnail and the full resolution picture of the given
* image. Does nothing if it is already in cache.
*
* @param img
*          The image whose picture is going to be downloaded.
*/
public static void downloadPicture(StreetsideImage img) {
 downloadPicture(img, PICTURE.BOTH);
}

/**
* Downloads the the thumbnail and the full resolution picture of the given
* image. Does nothing if it is already in cache.
*
* @param img
*          The image whose picture is going to be downloaded.
*/
public static void downloadCubemap(StreetsideImage cm) {
	// TODO: causes errors. Analyze @rrh
	//downloadPicture(cm, PICTURE.CUBEMAP);
}

/**
* Downloads the picture of the given image. Does nothing when it is already
* in cache.
*
* @param img
*          The image to be downloaded.
* @param pic
*          The picture type to be downloaded (full quality, thumbnail or
*          both.)
*/
public static void downloadPicture(StreetsideImage img, PICTURE pic) {
 switch (pic) {
   case BOTH:
     if (new StreetsideCache(img.getId(), StreetsideCache.Type.THUMBNAIL).get() == null)
       submit(img.getId(), StreetsideCache.Type.THUMBNAIL, ignoreDownload);
     if (new StreetsideCache(img.getId(), StreetsideCache.Type.FULL_IMAGE).get() == null)
       submit(img.getId(), StreetsideCache.Type.FULL_IMAGE, ignoreDownload);
     break;
   case THUMBNAIL:
     submit(img.getId(), StreetsideCache.Type.THUMBNAIL, ignoreDownload);
     break;
   case FULL_IMAGE:
   // TODO: is this still useful? @rrh
   case CUBEMAP:
	   if(img.getId()==null) {
		   Logging.error("Download cancelled. Image id is null.");
	   } else {
		   CubemapBuilder.getInstance().downloadCubemapImages(img.getId());
	   }
	   break;
   default:
     submit(img.getId(), StreetsideCache.Type.FULL_IMAGE, ignoreDownload);
     break;
 }
}

/**
* Downloads the picture of the given image. Does nothing when it is already
* in cache.
*
* @param cm
*          The cubemap to be downloaded.
* @param pic
*          The picture type to be downloaded (full quality, thumbnail, both, or cubemap.)
*/
/*public static void downloadCubemapFront(StreetsideImage cm, PICTURE pic) {
 switch (pic) {
   case CUBEMAP:
	   for (int i = 0; i < 6; i++) {
			for (int j = 0; j < 4; j++) {
				for (int k = 0; k < 4; k++) {
					String cubeface = CubemapUtils.getFaceNumberForCount(i);
					String tileNr = CubemapUtils.rowCol2StreetsideCellAddressMap
							.get(Integer.toString(j) + Integer.toString(k));
					long tileId = Long.parseLong(cm.getId() + cubeface + tileNr);

					submit(cm.getId(), StreetsideCache.Type.CUBEMAP_FRONT, ignoreDownload);

				}
			}
		}
	   break;
   default:
     submit(cm.getId(), StreetsideCache.Type.CUBEMAP_FRONT, ignoreDownload);
     break;
 }
}*/

/*public static void downloadCubemapRight(StreetsideImage cm, PICTURE pic) {
	 switch (pic) {
	   case CUBEMAP:
		   for (int i = 0; i < 6; i++) {
				for (int j = 0; j < 4; j++) {
					for (int k = 0; k < 4; k++) {
						String cubeface = CubemapUtils.getFaceNumberForCount(i);
						String tileNr = CubemapUtils.rowCol2StreetsideCellAddressMap
								.get(Integer.toString(j) + Integer.toString(k));
						long tileId = Long.parseLong(cm.getId() + cubeface + tileNr);

						submit(cm.getId(), StreetsideCache.Type.CUBEMAP_RIGHT, ignoreDownload);

					}
				}
			}
		   break;
	   default:
	     submit(cm.getId(), StreetsideCache.Type.CUBEMAP_RIGHT, ignoreDownload);
	     break;
	 }
	}*/

/*public static void downloadCubemapBack(StreetsideImage cm, PICTURE pic) {
	 switch (pic) {
	   case CUBEMAP:
		   for (int i = 0; i < 6; i++) {
				for (int j = 0; j < 4; j++) {
					for (int k = 0; k < 4; k++) {
						String cubeface = CubemapUtils.getFaceNumberForCount(i);
						String tileNr = CubemapUtils.rowCol2StreetsideCellAddressMap
								.get(Integer.toString(j) + Integer.toString(k));
						long tileId = Long.parseLong(cm.getId() + cubeface + tileNr);

						submit(cm.getId(), StreetsideCache.Type.CUBEMAP_BACK, ignoreDownload);

					}
				}
			}
		   break;
	   default:
	     submit(cm.getId(), StreetsideCache.Type.CUBEMAP_BACK, ignoreDownload);
	     break;
	 }
	}*/

/*public static void downloadCubemapLeft(StreetsideImage cm, PICTURE pic) {
	 switch (pic) {
	   case CUBEMAP:
		   for (int i = 0; i < 6; i++) {
				for (int j = 0; j < 4; j++) {
					for (int k = 0; k < 4; k++) {
						String cubeface = CubemapUtils.getFaceNumberForCount(i);
						String tileNr = CubemapUtils.rowCol2StreetsideCellAddressMap
								.get(Integer.toString(j) + Integer.toString(k));
						long tileId = Long.parseLong(cm.getId() + cubeface + tileNr);

						submit(cm.getId(), StreetsideCache.Type.CUBEMAP_LEFT, ignoreDownload);

					}
				}
			}
		   break;
	   default:
	     submit(cm.getId(), StreetsideCache.Type.CUBEMAP_LEFT, ignoreDownload);
	     break;
	 }
	}*/

/*public static void downloadCubemapUp(StreetsideImage cm, PICTURE pic) {
	 switch (pic) {
	   case CUBEMAP:
		   for (int i = 0; i < 6; i++) {
				for (int j = 0; j < 4; j++) {
					for (int k = 0; k < 4; k++) {
						String cubeface = CubemapUtils.getFaceNumberForCount(i);
						String tileNr = CubemapUtils.rowCol2StreetsideCellAddressMap
								.get(Integer.toString(j) + Integer.toString(k));
						long tileId = Long.parseLong(cm.getId() + cubeface + tileNr);

						submit(cm.getId(), StreetsideCache.Type.CUBEMAP_UP, ignoreDownload);

					}
				}
			}
		   break;
	   default:
	     submit(cm.getId(), StreetsideCache.Type.CUBEMAP_UP, ignoreDownload);
	     break;
	 }
	}*/

/*public static void downloadCubemapDown(StreetsideImage cm, PICTURE pic) {
	 switch (pic) {
	   case CUBEMAP:
		   for (int i = 0; i < 6; i++) {
				for (int j = 0; j < 4; j++) {
					for (int k = 0; k < 4; k++) {
						String cubeface = CubemapUtils.getFaceNumberForCount(i);
						String tileNr = CubemapUtils.rowCol2StreetsideCellAddressMap
								.get(Integer.toString(j) + Integer.toString(k));
						long tileId = Long.parseLong(cm.getId() + cubeface + tileNr);

						submit(cm.getId(), StreetsideCache.Type.CUBEMAP_DOWN, ignoreDownload);

					}
				}
			}
		   break;
	   default:
	     submit(cm.getId(), StreetsideCache.Type.CUBEMAP_DOWN, ignoreDownload);
	     break;
	 }
	}*/

/**
* Requests the picture with the given key and quality and uses the given
* listener.
*
* @param key
*          The key of the picture to be requested.
* @param type
*          The quality of the picture to be requested.
* @param lis
*          The listener that is going to receive the picture.
*/
public static void submit(String key, StreetsideCache.Type type,
   ICachedLoaderListener lis) {
 try {
   new StreetsideCache(key, type).submit(lis, false);
 } catch (IOException e) {
   Logging.error(e);
 }
}

private static class IgnoreDownload implements ICachedLoaderListener {

 @Override
 public void loadingFinished(CacheEntry arg0, CacheEntryAttributes arg1, LoadResult arg2) {
   // Ignore download
 }
}
}