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                 if (!_sources.isEmpty()) {
  55                         _sources.remove(_sources.size()-1);
  56                 }
  57         }
  58
  59         /**
  60          * @return the number of files loaded
  61          */
  62         public int getNumFiles()
  63         {
  64                 return _sources.size();
  65         }
  66
  67
  68         /**
  69          * @return The source name, if a single file
  70          */
  71         public String getFilename()
  72         {
  73                 if (getNumFiles() == 1) {
  74                         return _sources.get(0).getName();
  75                 }
  76                 return "";
  77         }
  78
  79         /**
  80          * @param inIndex index number, starting from zero
  81          * @return source info object
  82          */
  83         public SourceInfo getSource(int inIndex)
  84         {
  85                 return _sources.get(inIndex);
  86         }
  87
  88         /**
  89          * Get the SourceInfo object (if any) for the given point
  90          * @param inPoint point object
  91          * @return SourceInfo object if there is one, otherwise null
  92          */
  93         public SourceInfo getSourceForPoint(DataPoint inPoint)
  94         {
  95                 for (SourceInfo source : _sources)
  96                 {
  97                         if (source.getIndex(inPoint) >= 0) {
  98                                 return source;
  99                         }
 100                 }
 101                 return null;
 102         }
 103
 104         /**
 105          * @return the info about the last file loaded, if any
 106          */
 107         public SourceInfo getLastFileInfo()
 108         {
 109                 if (getNumFiles() == 0)
 110                 {
 111                         return null;
 112                 }
 113                 return getSource(getNumFiles()-1);
 114         }
 115
 116         /**
 117          * @return the most recent file title loaded, if any
 118          */
 119         public String getLastFileTitle()
 120         {
 121                 final int numFiles = getNumFiles();
 122                 if (numFiles == 0)
 123                 {
 124                         return null;
 125                 }
 126                 for (int i=(numFiles-1); i>=0; i--)
 127                 {
 128                         SourceInfo info = getSource(i);
 129                         if (info != null)
 130                         {
 131                                 String title = info.getFileTitle();
 132                                 if (title != null && !title.equals(""))
 133                                 {
 134                                         return title;
 135                                 }
 136                         }
 137                 }
 138                 return null;
 139         }
 140
 141         /**
 142          * Clone contents of file info
 143          */
 144         @SuppressWarnings("unchecked")
 145         public FileInfo clone()
 146         {
 147                 // copy source list
 148                 ArrayList<SourceInfo> copy = (ArrayList<SourceInfo>) _sources.clone();
 149                 return new FileInfo(copy);
 150         }
 151 }