DataFile

java.lang.Object
- jplot.DataFile

```
public class DataFile
extends Object
```
This class contains all the info specific for one data file. The PlotPanel provides the columns to-be-plotted for a specific file, with a line-style class for each column. This class keeps track of this information.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(int columnIndex, LinePars lp)` Adds a column to the vector of columns.
`void`	`addItem(String item)` Adds an item to the vector.
`boolean`	`fillDataArrays(Vector dataArrays, int type, int fileIndex)` Reads the current file and returns the data arrays.
`String`	`getAbbreviatedFilename()` Return the abbreviated filename.
`String`	`getColumnName(int i)` Returns the name of one of the columns present here.
`File`	`getFile()` Return the file
`String`	`getFilenameWithoutPath()` Return the filename with the preceeding path stripped off.
`int`	`getGraphType()`
`int`	`getIndex()` Get the current datafile index
`String`	`getItem(int i)`
`long`	`getLastModified()` Returns the modification date of the file in ms, I guess.
`String`	`getLegend(int index)`
`LinePars`	`getLinePars(int index)` returns the linestyle of one of the vector items.
`String`	`getName()` Return the filename as such.
`int`	`getNumberOfColumns()` Return the number of columns (selected items)
`int`	`getNumberOfItems()`
`void`	`getSettings(XMLWrite xw, String fileName)` Adds the settings of this panel to the XML settings toolbox.
`int`	`getXColumn()` Returns the index of the column used for the X-axis
`int`	`getYColumn(int i)` Returns the index of the column used for the Y-axis.
`int`	`isSelected(int index)` Checks whether the argument is a column selected for output.
`boolean`	`loadColumnNames(Vector labels)` Reads the datafile for data.
`boolean`	`loadColumnNamesData(Vector labels)` Reads the datafile for data.
`void`	`removeColumn(int columnIndex)` remove a column from the vector of columns.
`void`	`setIndex(int i)` Sets the current datafile index to another value.
`void`	`setLastModified(long date)` Sets the modification date of the file to a specific value.
`void`	`setLinePars(int index, LinePars lp)` sets the linestyle of one of the vector items.
`void`	`setLinePars(LinePars lp)` sets the linestyle of all the vector items.
`void`	`setXColumn(int columnIndex)` Sets the index of the column used for the X-axis.
`void`	`updateSettings(XMLRead xr)` Updates the current settings with new data.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - loadColumnNamesData
```
public boolean loadColumnNamesData(Vector labels)
```
    Reads the datafile for data. The data is put in a specific purpose DataArray object, which contains x- and y values. Note that all blank lines or lines starting with '#' are skipped. One exception: lines starting with '# column 1:' etc. are supposed to provide the name of the column, hence '# column 1: nodes' means that column 1 has the name 'nodes', which will be used by this program in order to easily select columns. If the list of column names existed already, and if the new list of names is identical, return true. Else delete the current selection and return false.
    
    Parameters:
    
    labels - vector to store the labels defined in the datafile
    
    Returns:
    
    true if the current selection can be maintained, false otherwise.
  - loadColumnNames
```
public boolean loadColumnNames(Vector labels)
```
    Reads the datafile for data. The data is put in a specific purpose DataArray object, which contains x- and y values. Note that all blank lines or lines starting with '#' are skipped. One exception: lines starting with '# column 1:' etc. are supposed to provide the name of the column, hence '# column 1: nodes' means that column 1 has the name 'nodes', which will be used by this program in order to easily select columns. If the list of column names existed already, and if the new list of names is identical, return true. Else delete the current selection and return false.
    
    Parameters:
    
    labels - vector to store the labels defined in the datafile
    
    Returns:
    
    true if the current selection can be maintained, false otherwise.
  - getNumberOfItems
```
public int getNumberOfItems()
```
    Returns:
    
    the number of items present in the item vector.
  - getItem
```
public String getItem(int i)
```
    Returns:
    
    the item corresponding to index i.
  - addItem
```
public void addItem(String item)
```
    Adds an item to the vector.
    
    Parameters:
    
    item - name of the item added.
  - addColumn
```
public void addColumn(int columnIndex,
                      LinePars lp)
```
    Adds a column to the vector of columns. The column is added even if the column index is already selected (hence selecting several times the same column is allowed). This is useful if the user wants to plot the same data several times but in a different way. (histogram + lines, for example).
    
    Parameters:
    
    columnIndex - index of the column
    
    lp - parameters used to draw the line
  - setXColumn
```
public void setXColumn(int columnIndex)
```
    Sets the index of the column used for the X-axis.
    
    Parameters:
    
    columnIndex - index of the column
  - getXColumn
```
public int getXColumn()
```
    Returns the index of the column used for the X-axis
    
    Returns:
    
    index of the column
  - getYColumn
```
public int getYColumn(int i)
```
    Returns the index of the column used for the Y-axis.
    
    Parameters:
    
    i - index of the column item
    
    Returns:
    
    index of the column
  - getLinePars
```
public LinePars getLinePars(int index)
```
    returns the linestyle of one of the vector items.
    
    Parameters:
    
    index - index of the column
  - setLinePars
```
public void setLinePars(int index,
                        LinePars lp)
```
    sets the linestyle of one of the vector items.
    
    Parameters:
    
    index - index of the column
    
    lp - linepars instance (can't be null!)
  - setLinePars
```
public void setLinePars(LinePars lp)
```
    sets the linestyle of all the vector items.
    
    Parameters:
    
    lp - linepars instance
  - getLegend
```
public String getLegend(int index)
```
  - removeColumn
```
public void removeColumn(int columnIndex)
```
    remove a column from the vector of columns.
    
    Parameters:
    
    columnIndex - index of the column
  - getNumberOfColumns
```
public int getNumberOfColumns()
```
    Return the number of columns (selected items)
    
    Returns:
    
    number of Y-columns
  - getFile
```
public File getFile()
```
    Return the file
    
    Returns:
    
    file
  - getLastModified
```
public long getLastModified()
```
    Returns the modification date of the file in ms, I guess.
  - setLastModified
```
public void setLastModified(long date)
```
    Sets the modification date of the file to a specific value.
    
    Parameters:
    
    date - modification date of the current file.
  - getAbbreviatedFilename
```
public String getAbbreviatedFilename()
```
    Return the abbreviated filename. This name is different from the file itselves if it exceeds a a certain number of characters (about 45). Otherwise, the name is too long to fit in decent textboxes...
    
    Returns:
    
    an abbreviated version of the filename, if the latter is too long.
  - getFilenameWithoutPath
```
public String getFilenameWithoutPath()
```
    Return the filename with the preceeding path stripped off.
    
    Returns:
    
    an abbreviated version of the filename, without an eventual path.
  - getName
```
public String getName()
```
    Return the filename as such.
    
    Returns:
    
    the filename.
  - isSelected
```
public int isSelected(int index)
```
    Checks whether the argument is a column selected for output.
    
    Parameters:
    
    index - index which is sought for.
  - getColumnName
```
public String getColumnName(int i)
```
    Returns the name of one of the columns present here.
    
    Returns:
    
    name of column with index i
  - setIndex
```
public void setIndex(int i)
```
    Sets the current datafile index to another value.
    
    Parameters:
    
    i - new index
  - getIndex
```
public int getIndex()
```
    Get the current datafile index
    
    Parameters:
    
    i - new index
  - getGraphType
```
public int getGraphType()
```
    Returns:
    
    the graphstyle of the current dataset
  - fillDataArrays
```
public boolean fillDataArrays(Vector dataArrays,
                              int type,
                              int fileIndex)
```
    Reads the current file and returns the data arrays.
    
    Parameters:
    
    dataArrays - vector with data-arrays of type DataArray
    
    type - graph type (2D, piper, multiplot...)
    
    fileIndex - index of the file which contains the data. This is simply a number, 0 for the first datafile, 1 for the second, etc. etc., used internally to find back the file belonging to a data array.
    
    Returns:
    
    false if some weird error might occur during parsing.
  - getSettings
```
public void getSettings(XMLWrite xw,
                        String fileName)
```
    Adds the settings of this panel to the XML settings toolbox.
    
    Parameters:
    
    xw - instance with settings
  - updateSettings
```
public void updateSettings(XMLRead xr)
```
    Updates the current settings with new data. The data settings must be wrapped in a XMLRead object.
    
    Parameters:
    
    xr - read object, containing all the data

Class DataFile

Method Summary

Methods inherited from class java.lang.Object

Method Detail

loadColumnNamesData

loadColumnNames

getNumberOfItems

getItem

addItem

addColumn

setXColumn

getXColumn

getYColumn

getLinePars

setLinePars

setLinePars

getLegend

removeColumn

getNumberOfColumns

getFile

getLastModified

setLastModified

getAbbreviatedFilename

getFilenameWithoutPath

getName

isSelected

getColumnName

setIndex

getIndex

getGraphType

fillDataArrays

getSettings

updateSettings