gov.sandia.cognition.math.matrix

Class VectorReader

java.lang.Object

gov.sandia.cognition.math.matrix.VectorReader

@CodeReview(reviewer="Jonathan McClain",
            date="2006-05-22",
            changesNeeded=true,
            comments="Changes marked by triple slash",
            response=@CodeReviewResponse(respondent="Justin Basilico",date="2006-07-20",moreChangesNeeded=false,comments="Changes from J.T.\'s code review"))
public class VectorReader
extends java.lang.Object

Reads a Vector from a single line in a file

Since:

1.0

Author:

Kevin R. Dixon

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMENT_LINE_PREFIX The start of a comment line has the "#" string at the beginning.

Constructor Summary

Constructors

Constructor and Description
VectorReader(java.io.Reader reader) Creates a new instance of VectorReader
VectorReader(ReaderTokenizer tokenizer) Creates a new instance of VectorReader

Method Summary

Modifier and Type	Method and Description
protected ReaderTokenizer	getTokenizer() Getter for tokenizer
static Vector	parseVector(java.util.Collection<java.lang.String> tokens) Parses a Vector from the given list of element tokens.
Vector	read() Reads a Vector off of the next line in the file
java.util.List<Vector>	readCollection(boolean mustBeSameSize) Reads a collection of Vectors from the Reader
protected void	setTokenizer(ReaderTokenizer tokenizer) Setter for tokenizer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMENT_LINE_PREFIX

public static final java.lang.String COMMENT_LINE_PREFIX

The start of a comment line has the "#" string at the beginning.

See Also:

Constant Field Values

Constructor Detail

VectorReader

public VectorReader(java.io.Reader reader)

Creates a new instance of VectorReader

Parameters:

reader - Java-based reader from which to pull the Vector

VectorReader

public VectorReader(ReaderTokenizer tokenizer)

Creates a new instance of VectorReader

Parameters:

tokenizer - Parses the input stream and pulls out tokens

Method Detail

read

public Vector read()
            throws java.io.IOException

Reads a Vector off of the next line in the file

Returns:

Vector that is on the next line in the file, or null if no values were found

Throws:

java.io.IOException - on a bad readLine on the BufferedReader

parseVector

public static Vector parseVector(java.util.Collection<java.lang.String> tokens)

Parses a Vector from the given list of element tokens.

Parameters:

tokens - The collection of element tokens.

Returns:

A new Vector created from the given tokens.

readCollection

public java.util.List<Vector> readCollection(boolean mustBeSameSize)
                                      throws java.io.IOException

Reads a collection of Vectors from the Reader

Parameters:

mustBeSameSize - true if the Vectors must be same size, false allows any sized Vectors in the List

Returns:

List of Vectors, where the nth Vector was the nth row in the Reader

Throws:

java.io.IOException - if the Reader isn't valid or doesn't contain a Vector

getTokenizer

protected ReaderTokenizer getTokenizer()

Getter for tokenizer

Returns:

Parses the input stream and pulls out tokens

setTokenizer

protected void setTokenizer(ReaderTokenizer tokenizer)

Setter for tokenizer

Parameters:

tokenizer - Parses the input stream and pulls out tokens