ASCIIDataFile

java.lang.Object
- BasicIO.ASCIIDataFile

```
public class ASCIIDataFile
extends java.lang.Object
```
ASCIIDataFile reads data from tab deliminted text files such as produced by ASCIIOutputFile. There are various read methods in this class. readInt, readDouble, etc Each of these read methods (with the exception of readLine & readC) reads a field at a time returning the data in the field as a type corresponding to the read method. For example readInt returns an int value, and readDouble returns a double value of the field.

Fields are seperated by tabs and new line markers. Fields are read in sequential order. The first read will read the first field, the 2nd read will read the 2nd field and so forth.

readLine will return as a String all of the data in the file from the current point to the next newline character. The next read will thus read the first field on the next line. The new line marker is not part of the returned String.

readC reads raw characters, meaning it will read newline characterers and the tab characters delimiting fields. It doesn't read an entire field, so each readC returns the next character in the field. If a readC is followed by read that reads an entire field, the subsequent read will read the remainder of the field.

Version:

1.0 July 08, 2.0 (09/06/30)

Author:

A. Cheesman, David Hughes

Constructor Summary

Constructors
Constructor and Description
`ASCIIDataFile()` Constructs an ASCIIDataFile, prompting the user via Dialog Box for a file to read from.
`ASCIIDataFile(java.io.File file)` Constructs an ASCIIDataFile using the file provided.
`ASCIIDataFile(java.lang.String filename)` Constructs an ASCIIDataFile and tries to open a file with the path provided in the String.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the file
`java.io.File`	`getFile()` Returns the file being used
`boolean`	`isDataError()` Returns true if last operation failed because of a data error, meaning the data did not conform to format.
`boolean`	`isEOF()` Returns true if the last operation failed because of EOF, false otherwise.
`void`	`nextLine()` The next read will start at the first field (or first character) of the next line.
`boolean`	`readBoolean()` Reads the next field as a boolean.
`byte`	`readByte()` Reads the next field as a byte.
`char`	`readC()` Reads the next char in the file, including control characters (tab, newline).
`char`	`readChar()` Reads the next field as a char.
`double`	`readDouble()` Reads the next field as a double.
`float`	`readFloat()` Reads the next field as a float.
`int`	`readInt()` Reads the next field as a int.
`java.lang.String`	`readLine()` Returns an entire line, including control characters.
`long`	`readLong()` Reads the next field as a long.
`short`	`readShort()` Reads the next field as a short.
`java.lang.String`	`readString()` Reads the next field, returning it as a String.
`void`	`skipToEOL()` Deprecated. Use nextLine() instead.
`boolean`	`successful()` Returns true if the last operation was succesfull, false otherwise.

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

- Constructor Detail
  - ASCIIDataFile
```
public ASCIIDataFile()
```
    Constructs an ASCIIDataFile, prompting the user via Dialog Box for a file to read from.
  - ASCIIDataFile
```
public ASCIIDataFile(java.lang.String filename)
```
    Constructs an ASCIIDataFile and tries to open a file with the path provided in the String.
    
    Parameters:
    
    filename - the name of the file to read from
  - ASCIIDataFile
```
public ASCIIDataFile(java.io.File file)
```
    Constructs an ASCIIDataFile using the file provided.
    
    Parameters:
    
    file - the file to read from
- Method Detail
  - getFile
```
public java.io.File getFile()
```
    Returns the file being used
    
    Returns:
    
    the file being used.
  - skipToEOL
```
public void skipToEOL()
```
    Deprecated. Use nextLine() instead.
    
    The next read will start at the first field (or first character) of the next line.
  - readLine
```
public java.lang.String readLine()
```
    Returns an entire line, including control characters. The returning String does not contain the EOL character.
    
    Returns:
    
    A line of the file
  - close
```
public void close()
```
    Closes the file
  - successful
```
public boolean successful()
```
    Returns true if the last operation was succesfull, false otherwise.
    An operation can fail for several reasons:
    - a read operation was peformed and it is the end of the file. isEOF will return true in this case.
    - a field can not be converted into the specified type, results. isDataError will return true in this case.
    
    Returns:
    
    True if last operation was succesfull, false otherwise.
    
    See Also:
    
    isEOF(), isDataError()
  - isEOF
```
public boolean isEOF()
```
    Returns true if the last operation failed because of EOF, false otherwise.
    
    Returns:
    
    True if the last operation failed because of EOF, false otherwise.
  - isDataError
```
public boolean isDataError()
```
    Returns true if last operation failed because of a data error, meaning the data did not conform to format.
    
    Returns:
    
    True if there was a data error in the last operation, false otherwise.
  - readByte
```
public byte readByte()
```
    Reads the next field as a byte.
    
    Returns:
    
    the next field as a byte.
  - readChar
```
public char readChar()
```
    Reads the next field as a char.
    
    Returns:
    
    the next field as a char.
  - readC
```
public char readC()
```
    Reads the next char in the file, including control characters (tab, newline).
    
    Returns:
    
    the next char in the file.
  - readDouble
```
public double readDouble()
```
    Reads the next field as a double.
    
    Returns:
    
    the next field as a double.
  - readFloat
```
public float readFloat()
```
    Reads the next field as a float.
    
    Returns:
    
    the next field as a float.
  - readInt
```
public int readInt()
```
    Reads the next field as a int.
    
    Returns:
    
    the next field as a int.
  - readShort
```
public short readShort()
```
    Reads the next field as a short.
    
    Returns:
    
    the next field as a short.
  - readLong
```
public long readLong()
```
    Reads the next field as a long.
    
    Returns:
    
    the next field as a long.
  - readString
```
public java.lang.String readString()
```
    Reads the next field, returning it as a String.
    
    Returns:
    
    the next field as a String.
  - readBoolean
```
public boolean readBoolean()
```
    Reads the next field as a boolean.
    
    Returns:
    
    the next field as a boolean.
  - nextLine
```
public void nextLine()
```
    The next read will start at the first field (or first character) of the next line.

Class ASCIIDataFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ASCIIDataFile

ASCIIDataFile

ASCIIDataFile

Method Detail

getFile

skipToEOL

readLine

close

successful

isEOF

isDataError

readByte

readChar

readC

readDouble

readFloat

readInt

readShort

readLong

readString

readBoolean

nextLine