src/jalview/io/BackupFilenameParts.java

   1 package jalview.io;
   2
   3 import jalview.bin.Cache;
   4
   5 import java.io.File;
   6
   7 public class BackupFilenameParts
   8 {
   9   private String base;
  10
  11   private String templateStart;
  12
  13   private int num;
  14
  15   private int digits;
  16
  17   private String templateEnd;
  18
  19   private boolean isBackupFile;
  20
  21   private BackupFilenameParts()
  22   {
  23     this.isBackupFile = false;
  24   }
  25
  26   public BackupFilenameParts(File file, String base, String template,
  27           int digits)
  28   {
  29     this(file.getName(), base, template, digits);
  30   }
  31
  32   public BackupFilenameParts(String filename, String base, String template,
  33           int suggesteddigits)
  34   {
  35     this(filename, base, template, suggesteddigits, false);
  36   }
  37
  38   public BackupFilenameParts(String filename, String base, String template,
  39           int suggesteddigits, boolean extensionMatch)
  40   {
  41     this.isBackupFile = false;
  42
  43     int numcharstart = template.indexOf(BackupFiles.NUM_PLACEHOLDER);
  44     int digits = 0;
  45     String templateStart = template;
  46     String templateEnd = "";
  47     if (numcharstart > -1)
  48     {
  49       templateStart = template.substring(0, numcharstart);
  50       templateEnd = template.substring(
  51               numcharstart + BackupFiles.NUM_PLACEHOLDER.length());
  52       digits = suggesteddigits;
  53     }
  54
  55     String savedFilename = "";
  56     // if extensionOnly is set then reset the filename to the last occurrence of the extension+templateStart and try the match
  57     if (extensionMatch)
  58     {
  59       // only trying to match from extension onwards
  60
  61       int extensioncharstart = filename
  62               .lastIndexOf('.' + base + templateStart);
  63       if (extensioncharstart == -1)
  64       {
  65         return;
  66       }
  67
  68       savedFilename = filename.substring(0, extensioncharstart + 1); // include
  69                                                                      // the "."
  70       filename = filename.substring(extensioncharstart + 1);
  71     }
  72
  73     // full filename match
  74
  75     // calculate minimum length of a backup filename
  76     int minlength = base.length() + template.length()
  77             - BackupFiles.NUM_PLACEHOLDER.length() + digits;
  78
  79     if (!(filename.startsWith(base + templateStart)
  80             && filename.endsWith(templateEnd)
  81             && filename.length() >= minlength))
  82     {
  83       // non-starter
  84       return;
  85     }
  86
  87     int startLength = base.length() + templateStart.length();
  88     int endLength = templateEnd.length();
  89     String numString = numcharstart > -1
  90             ? filename.substring(startLength, filename.length() - endLength)
  91             : "";
  92
  93     if (filename.length() >= startLength + digits + endLength
  94             && filename.startsWith(base + templateStart)
  95             && filename.endsWith(templateEnd)
  96             && numString.matches("[0-9]*"))
  97     {
  98       this.base = extensionMatch ? savedFilename + base : base;
  99       this.templateStart = templateStart;
 100       this.num = numString.length() > 0 ? Integer.parseInt(numString) : 0;
 101       this.digits = digits;
 102       this.templateEnd = templateEnd;
 103       this.isBackupFile = true;
 104     }
 105
 106   }
 107
 108   public static BackupFilenameParts currentBackupFilenameParts(
 109           String filename, String base, boolean extensionMatch)
 110   {
 111     BackupFilenameParts bfp = new BackupFilenameParts();
 112     String template = Cache.getDefault(BackupFiles.SUFFIX, null);
 113     if (template == null)
 114     {
 115       return bfp;
 116     }
 117     int digits;
 118     try
 119     {
 120       digits = Integer
 121               .parseInt(Cache.getDefault(BackupFiles.SUFFIX_DIGITS, null));
 122     } catch (Exception e)
 123     {
 124       return bfp;
 125     }
 126     return new BackupFilenameParts(filename, base, template, digits,
 127             extensionMatch);
 128   }
 129
 130   public boolean isBackupFile()
 131   {
 132     return this.isBackupFile;
 133   }
 134
 135   public int indexNum()
 136   {
 137     return this.num;
 138   }
 139
 140   public static String getBackupFilename(int index, String base,
 141           String template, int digits)
 142   {
 143     String numString = String.format("%0" + digits + "d", index);
 144     String backupSuffix = template.replaceFirst(BackupFiles.NUM_PLACEHOLDER,
 145             numString);
 146     String backupfilename = base + backupSuffix;
 147     return backupfilename;
 148   }
 149 }