src/tim/prune/data/FileInfo.java

   1 package tim.prune.data;
   2
   3 import java.util.ArrayList;
   4
   5 /**
   6  * Class to hold the information about the file(s)
   7  * from which the data was loaded from / saved to
   8  */
   9 public class FileInfo
  10 {
  11         /** List of sources */
  12         private ArrayList<SourceInfo> _sources = new ArrayList<SourceInfo>();
  13
  14
  15         /**
  16          * Empty constructor
  17          */
  18         public FileInfo()
  19         {}
  20
  21         /**
  22          * Private constructor for creating clone
  23          * @param inList list of sources
  24          */
  25         private FileInfo(ArrayList<SourceInfo> inList)
  26         {
  27                 _sources = inList;
  28         }
  29
  30         /**
  31          * Add a data source to the list
  32          * @param inInfo info object to add
  33          */
  34         public void addSource(SourceInfo inInfo)
  35         {
  36                 _sources.add(inInfo);
  37         }
  38
  39         /**
  40          * Replace the list of data sources with the given source
  41          * @param inInfo new source
  42          */
  43         public void replaceSource(SourceInfo inInfo)
  44         {
  45                 _sources.clear();
  46                 addSource(inInfo);
  47         }
  48
  49         /**
  50          * remove the last source added
  51          */
  52         public void removeSource()
  53         {
  54                 _sources.remove(_sources.size()-1);
  55         }
  56
  57         /**
  58          * @return the number of files loaded
  59          */
  60         public int getNumFiles()
  61         {
  62                 return _sources.size();
  63         }
  64
  65
  66         /**
  67          * @return The source name, if a single file
  68          */
  69         public String getFilename()
  70         {
  71                 if (getNumFiles() == 1) {
  72                         return _sources.get(0).getName();
  73                 }
  74                 return "";
  75         }
  76
  77         /**
  78          * @param inIndex index number, starting from zero
  79          * @return source info object
  80          */
  81         public SourceInfo getSource(int inIndex)
  82         {
  83                 return _sources.get(inIndex);
  84         }
  85
  86         /**
  87          * Get the SourceInfo object (if any) for the given point
  88          * @param inPoint point object
  89          * @return SourceInfo object if there is one, otherwise null
  90          */
  91         public SourceInfo getSourceForPoint(DataPoint inPoint)
  92         {
  93                 for (SourceInfo source : _sources)
  94                 {
  95                         if (source.getIndex(inPoint) >= 0) {
  96                                 return source;
  97                         }
  98                 }
  99                 return null;
 100         }
 101
 102         /**
 103          * @return the info about the last file loaded, if any
 104          */
 105         public SourceInfo getLastFileInfo()
 106         {
 107                 if (getNumFiles() == 0)
 108                 {
 109                         return null;
 110                 }
 111                 return getSource(getNumFiles()-1);
 112         }
 113
 114         /**
 115          * @return the most recent file title loaded, if any
 116          */
 117         public String getLastFileTitle()
 118         {
 119                 final int numFiles = getNumFiles();
 120                 if (numFiles == 0)
 121                 {
 122                         return null;
 123                 }
 124                 for (int i=(numFiles-1); i>=0; i--)
 125                 {
 126                         SourceInfo info = getSource(i);
 127                         if (info != null)
 128                         {
 129                                 String title = info.getFileTitle();
 130                                 if (title != null && !title.equals(""))
 131                                 {
 132                                         return title;
 133                                 }
 134                         }
 135                 }
 136                 return null;
 137         }
 138
 139         /**
 140          * Clone contents of file info
 141          */
 142         @SuppressWarnings("unchecked")
 143         public FileInfo clone()
 144         {
 145                 // copy source list
 146                 ArrayList<SourceInfo> copy = (ArrayList<SourceInfo>) _sources.clone();
 147                 return new FileInfo(copy);
 148         }
 149 }