gov/nasa/worldwind/formats/rpf/RpfFrameFilenameUtil.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government as represented by
   3 the Administrator of the National Aeronautics and Space Administration.
   4 All Rights Reserved.
   5 */
   6 package gov.nasa.worldwind.formats.rpf;
   7
   8 import gov.nasa.worldwind.*;
   9
  10 import static java.util.logging.Level.*;
  11
  12 /**
  13  * @author dcollins
  14  * @version $Id: RpfFrameFilenameUtil.java 1762 2007-05-07 19:43:55Z dcollins $
  15  */
  16 public class RpfFrameFilenameUtil
  17 {
  18     /* [Section 30.6, MIL-C-89038] */
  19     /* [Section A.3.6, MIL-PRF-89041A] */
  20     public static final char[] BASE34_ALPHABET =
  21         {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', 'G',
  22             'H', 'J', 'K', 'L', 'M', 'N', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z'};
  23     private static char[] charArray;
  24
  25     /* [Section 30.6, MIL-C-89038] */
  26     /* [Section A.3.6, MIL-PRF-89041A] */
  27     public static char[] base34ValueOf(int i, char[] dest, int offset, int count)
  28     {
  29         if (dest == null || dest.length < count)
  30             dest = new char[count];
  31         for (int digit = count + offset - 1; digit >= offset; digit--)
  32         {
  33             dest[digit] = BASE34_ALPHABET[i % 34];
  34             i /= 34;
  35         }
  36         return dest;
  37     }
  38
  39     private static void ensureCharArray(int length)
  40     {
  41         if (charArray == null || charArray.length < length)
  42             charArray = new char[length];
  43     }
  44
  45     public static String filenameFor(RpfFrameProperties frameProperties, String rpfDataType)
  46     {
  47         validateFrameProperties(frameProperties);
  48         if (rpfDataType == null)
  49         {
  50             String message = WorldWind.retrieveErrMsg("nullValue.StringIsNull");
  51             WorldWind.logger().log(FINE, message);
  52             throw new IllegalArgumentException(message);
  53         }
  54         ensureCharArray(12);
  55         if (rpfDataType.compareToIgnoreCase("CADRG") == 0)
  56             filenameForCadrgOrCib(frameProperties, 5, 2, charArray);
  57         else if (rpfDataType.compareToIgnoreCase("CIB") == 0)
  58             filenameForCadrgOrCib(frameProperties, 6, 1, charArray);
  59         else
  60         {
  61             String message = WorldWind.retrieveErrMsg("RpfFrameFilenameUtil.UnknownRpfDataType") + rpfDataType;
  62             WorldWind.logger().log(FINE, message);
  63             throw new IllegalArgumentException(message);
  64         }
  65         return new String(charArray, 0, 12);
  66     }
  67
  68     public static String filenameFor(RpfFrameProperties frameProperties)
  69     {
  70         validateFrameProperties(frameProperties);
  71         return filenameFor(frameProperties, frameProperties.dataSeries.rpfDataType);
  72     }
  73
  74     /* [Section 30.6, MIL-C-89038] */
  75     /* [Section A.3.6, MIL-PRF-89041A] */
  76     private static void filenameForCadrgOrCib(RpfFrameProperties frameProperties, int frameChars, int versionChars,
  77         char[] dest)
  78     {
  79         int index = 0;
  80         base34ValueOf(frameProperties.frameNumber, dest, index, frameChars);
  81         index += frameChars;
  82         base34ValueOf(frameProperties.version, dest, index, versionChars);
  83         index += versionChars;
  84         dest[index++] = frameProperties.producer.id;
  85         dest[index++] = '.';
  86         frameProperties.dataSeries.seriesCode.getChars(0, 2, dest, index);
  87         index += 2;
  88         dest[index] = frameProperties.zone.zoneCode;
  89     }
  90
  91     /* [Section 30.6, MIL-C-89038] */
  92     /* [Section A.3.6, MIL-PRF-89041A] */
  93     public static int parseBase34(char[] src, int offset, int count)
  94     {
  95         int i = 0;
  96         for (int digit = offset; digit < offset + count; digit++)
  97         {
  98             int index;
  99             char charUpper = Character.toUpperCase(src[digit]);
 100             if (charUpper >= '0' && charUpper <= '9')
 101                 index = charUpper - '0';
 102             else if (charUpper >= 'A' && charUpper <= 'H')
 103                 index = 10 + charUpper - 'A';
 104             else if (charUpper >= 'J' && charUpper <= 'N')
 105                 index = 18 + charUpper - 'J';
 106             else if (charUpper >= 'P' && charUpper <= 'Z')
 107                 index = 23 + charUpper - 'P';
 108             else
 109             {
 110                 String message = WorldWind.retrieveErrMsg("RpfFrameFilenameUtil.Base34Error");
 111                 WorldWind.logger().log(FINE, message);
 112                 throw new IllegalArgumentException(message);
 113             }
 114             i = (i * 34) + index;
 115         }
 116         return i;
 117     }
 118
 119     public static RpfFrameProperties parseFilename(String filename, String rpfDataType)
 120     {
 121         if (filename == null || rpfDataType == null)
 122         {
 123             String message = WorldWind.retrieveErrMsg("nullValue.StringIsNull");
 124             WorldWind.logger().log(FINE, message);
 125             throw new IllegalArgumentException(message);
 126         }
 127         if (filename.length() != 12)
 128         {
 129             String message = WorldWind.retrieveErrMsg("RpfFrameFilenameUtil.BadFilenameLength") + filename;
 130             WorldWind.logger().log(FINE, message);
 131             throw new RpfFrameFilenameFormatException(message);
 132         }
 133         ensureCharArray(12);
 134         filename.getChars(0, 12, charArray, 0);
 135         RpfFrameProperties frameProperties;
 136         if (rpfDataType.compareToIgnoreCase("CADRG") == 0)
 137             frameProperties = parseFilenameCadrgOrCib(charArray, 5, 2);
 138         else if (rpfDataType.compareToIgnoreCase("CIB") == 0)
 139             frameProperties = parseFilenameCadrgOrCib(charArray, 6, 1);
 140         else
 141         {
 142             String message = WorldWind.retrieveErrMsg("RpfFrameFilenameUtil.UnknownRpfDataType") + rpfDataType;
 143             WorldWind.logger().log(FINE, message);
 144             throw new IllegalArgumentException(message);
 145         }
 146         return frameProperties;
 147     }
 148
 149     public static RpfFrameProperties parseFilename(String filename)
 150     {
 151         if (filename == null)
 152         {
 153             String message = WorldWind.retrieveErrMsg("nullValue.StringIsNull");
 154             WorldWind.logger().log(FINE, message);
 155             throw new IllegalArgumentException(message);
 156         }
 157         if (filename.length() != 12)
 158         {
 159             String message = WorldWind.retrieveErrMsg("RpfFrameFilenameUtil.BadFilenameLength") + filename;
 160             WorldWind.logger().log(FINE, message);
 161             throw new RpfFrameFilenameFormatException(message);
 162         }
 163         RpfDataSeries dataSeries;
 164         try
 165         {
 166             dataSeries = RpfDataSeries.dataSeriesFor(filename.substring(9, 11));
 167         }
 168         catch (EnumConstantNotPresentException e)
 169         {
 170             String message = WorldWind.retrieveErrMsg("RpfFrameFilenameUtil.EnumNotFound");
 171             WorldWind.logger().log(FINE, message);
 172             throw new RpfFrameFilenameFormatException(message, e);
 173         }
 174         return parseFilename(filename, dataSeries.rpfDataType);
 175     }
 176
 177     /* [Section 30.6, MIL-C-89038] */
 178     /* [Section A.3.6, MIL-PRF-89041A] */
 179     private static RpfFrameProperties parseFilenameCadrgOrCib(char[] src, int frameChars, int versionChars)
 180     {
 181         int index = 0;
 182
 183         int frameNumber;
 184         int version;
 185         try
 186         {
 187             frameNumber = parseBase34(src, index, frameChars);
 188             index += frameChars;
 189             version = parseBase34(src, index, versionChars);
 190             index += versionChars;
 191         }
 192         catch (IllegalArgumentException e)
 193         {
 194             String message = WorldWind.retrieveErrMsg("RpfFrameFilenameUtil.IntegerNotParsed");
 195             WorldWind.logger().log(FINE, message);
 196             throw new RpfFrameFilenameFormatException(message, e);
 197         }
 198
 199         RpfProducer producer;
 200         RpfDataSeries dataSeries;
 201         RpfZone zone;
 202         try
 203         {
 204             producer = RpfProducer.producerFor(src[index]);
 205             index += 2;
 206             dataSeries = RpfDataSeries.dataSeriesFor(new String(src, index, 2));
 207             index += 2;
 208             zone = RpfZone.zoneFor(src[index]);
 209         }
 210         catch (EnumConstantNotPresentException e)
 211         {
 212             String message = WorldWind.retrieveErrMsg("RpfFrameFilenameUtil.EnumNotFound");
 213             WorldWind.logger().log(FINE, message);
 214             throw new RpfFrameFilenameFormatException(message, e);
 215         }
 216
 217         return new RpfFrameProperties(zone, frameNumber, dataSeries, producer, version);
 218     }
 219
 220     private static void validateFrameProperties(RpfFrameProperties frameProperties)
 221     {
 222         if (frameProperties == null)
 223         {
 224             String message = WorldWind.retrieveErrMsg("nullValue.RpfFramePropertiesIsNull");
 225             WorldWind.logger().log(FINE, message);
 226             throw new IllegalArgumentException(message);
 227         }
 228         if (frameProperties.zone == null)
 229         {
 230             String message = WorldWind.retrieveErrMsg("nullValue.RpfZoneIsNull");
 231             WorldWind.logger().log(FINE, message);
 232             throw new IllegalArgumentException(message);
 233         }
 234         if (frameProperties.frameNumber < 0)
 235         {
 236             String message = WorldWind.retrieveErrMsg("RpfFrameProperties.BadFrameNumber")
 237                 + frameProperties.frameNumber;
 238             WorldWind.logger().log(FINE, message);
 239             throw new IllegalArgumentException(message);
 240         }
 241         if (frameProperties.dataSeries == null)
 242         {
 243             String message = WorldWind.retrieveErrMsg("nullValue.RpfDataSeriesIsNull");
 244             WorldWind.logger().log(FINE, message);
 245             throw new IllegalArgumentException(message);
 246         }
 247         if (frameProperties.producer == null)
 248         {
 249             String message = WorldWind.retrieveErrMsg("nullValue.RpfProducerIsNull");
 250             WorldWind.logger().log(FINE, message);
 251             throw new IllegalArgumentException(message);
 252         }
 253         if (frameProperties.version < 0)
 254         {
 255             String message = WorldWind.retrieveErrMsg("RpfFrameProperties.BadVersion")
 256                 + frameProperties.version;
 257             WorldWind.logger().log(FINE, message);
 258             throw new IllegalArgumentException(message);
 259         }
 260     }
 261 }