com.highqsoft.fwk.util

Class FwkSimpleASCIIColumnsReader

java.lang.Object

javax.swing.filechooser.FileFilter

com.highqsoft.fwk.FwkFileFilter

com.highqsoft.fwk.util.FwkSimpleASCIIColumnsReader

All Implemented Interfaces:

FwkComponentInterface, FwkFileFilterInterface, FwkReadColumnsFromStreamInterface

public class FwkSimpleASCIIColumnsReader
extends FwkFileFilter
implements FwkReadColumnsFromStreamInterface

This object read columns from an ASCII file.

Since:

$Date: 2017/04/06 13:29:08 $

Version:

$Revision: 1.17 $

Author:

Andreas Hofmann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FwkSimpleASCIIColumnsReader.DataObserver The data observer class.
protected class	FwkSimpleASCIIColumnsReader.InvalidValue A class to remember invalid values.
static class	FwkSimpleASCIIColumnsReader.MessagePrinter Message listener that dumps the messages to the standard out.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	colCounter
protected java.lang.String[]	colNames
static java.lang.String	COLUMNNAME
protected static int	COLUMNNAMES
static int	DATAINCREMENT
static java.lang.String	EXTENSION
static int	INCREMENT
protected static double	INVALID_AVL
protected static double	INVALID_VALUE
protected double	invalidValue
protected java.util.HashMap	messageListener
protected FwkSimpleASCIIColumnsReader.DataObserver[]	observers
protected static int	UNITNAMES
protected java.lang.String[]	units
protected static int	VALUES

Fields inherited from class com.highqsoft.fwk.FwkFileFilter

version

Constructor Summary

Constructors

Constructor and Description
FwkSimpleASCIIColumnsReader() The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(java.io.File f) Whether the given file is accepted by this filter.
protected java.lang.String	addColumnName(java.lang.String name) Add a column name.
void	addFwkMessageListener(FwkMessageListener fwkMessageListener) Add a message listener.
protected java.lang.String	addUnit(int colNo, java.lang.String unit) Add a unit name.
protected void	addValue(int colno, double value) Add a value.
protected void	fireMessage(int lineNo, java.lang.String message) Fire a message.
protected int	getCount(int colno)
java.lang.String	getDescription() The description of this filter.
FwkMessageListener[]	getFwkMessageListeners() Get all known message listeners.
int	getSize() Get the total number of columns.
protected boolean	isInvalid(java.lang.String s) Returns a boolean whether the given string a invalid value.
static void	main(java.lang.String[] args) The main testing routine.
FwkColumnAccessInterface[]	read(java.lang.String ref, java.io.InputStream is) Read columns from stream.
void	removeFwkMessageListener(FwkMessageListener fwkMessageListener) Remove the message listener.
protected void	resetColumnNames() Reset the array of colum names.
void	setAsInvalid(double val) Use this method to set the value that sould be used for invalid value.

Methods inherited from class com.highqsoft.fwk.FwkFileFilter

accept, addExtension, getExtension, getVersion, isExtensionListInDescription, setDescription, setExtensionListInDescription, setPattern

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkFileFilterInterface

accept

Field Detail

EXTENSION

public static final java.lang.String EXTENSION

COLUMNNAME

public static final java.lang.String COLUMNNAME

INCREMENT

public static final int INCREMENT

See Also:

Constant Field Values

DATAINCREMENT

public static final int DATAINCREMENT

See Also:

Constant Field Values

COLUMNNAMES

protected static final int COLUMNNAMES

See Also:

Constant Field Values

UNITNAMES

protected static final int UNITNAMES

See Also:

Constant Field Values

VALUES

protected static final int VALUES

See Also:

Constant Field Values

INVALID_AVL

protected static final double INVALID_AVL

See Also:

Constant Field Values

INVALID_VALUE

protected static final double INVALID_VALUE

See Also:

Constant Field Values

invalidValue

protected double invalidValue

messageListener

protected java.util.HashMap messageListener

colNames

protected java.lang.String[] colNames

colCounter

protected int colCounter

units

protected java.lang.String[] units

observers

protected FwkSimpleASCIIColumnsReader.DataObserver[] observers

Constructor Detail

FwkSimpleASCIIColumnsReader

public FwkSimpleASCIIColumnsReader()

The constructor.

Method Detail

setAsInvalid

public void setAsInvalid(double val)

Use this method to set the value that sould be used for invalid value.

Parameters:

val -

addFwkMessageListener

public void addFwkMessageListener(FwkMessageListener fwkMessageListener)

Add a message listener.

Parameters:

fwkMessageListener - the listener

removeFwkMessageListener

public void removeFwkMessageListener(FwkMessageListener fwkMessageListener)

Remove the message listener.

Parameters:

fwkMessageListener - the listener.

getFwkMessageListeners

public FwkMessageListener[] getFwkMessageListeners()

Get all known message listeners.

Returns:

an array of message listeners.

fireMessage

protected void fireMessage(int lineNo,
               java.lang.String message)

Fire a message.

Parameters:

message - the message to be fired.

resetColumnNames

protected void resetColumnNames()

Reset the array of colum names.

addColumnName

protected java.lang.String addColumnName(java.lang.String name)

Add a column name.

Parameters:

name - the new column names.

addUnit

protected java.lang.String addUnit(int colNo,
                       java.lang.String unit)

Add a unit name.

Parameters:

unit - the name of the new unit.

addValue

protected void addValue(int colno,
            double value)

Add a value.

Parameters:

colno - The column number.

val - the new value.

getCount

protected int getCount(int colno)

getSize

public int getSize()

Get the total number of columns.

Returns:

the total number of read columns.

accept

public boolean accept(java.io.File f)

Whether the given file is accepted by this filter.

Specified by:

accept in interface FwkFileFilterInterface

Overrides:

accept in class FwkFileFilter

Parameters:

f - The file to be checked.

Returns:

true if the file is accepted.

See Also:

FwkFileFilter.getExtension(java.io.File), FileFilter#accepts

getDescription

public java.lang.String getDescription()

The description of this filter.

Specified by:

getDescription in interface FwkFileFilterInterface

Overrides:

getDescription in class FwkFileFilter

Returns:

the description.

See Also:

setDescription, setExtensionListInDescription, isExtensionListInDescription, FileFilter.getDescription()

read

public FwkColumnAccessInterface[] read(java.lang.String ref,
                              java.io.InputStream is)
                                throws FwkException

Read columns from stream.

Specified by:

read in interface FwkReadColumnsFromStreamInterface

Parameters:

ref - The reference for input stream. This could be the file specification.

is - The input stream from that the column should be read.

Returns:

the columns read from file.

Throws:

an - exception when ever a problem occurs.

FwkException

isInvalid

protected boolean isInvalid(java.lang.String s)

Returns a boolean whether the given string a invalid value.

Parameters:

s - a substring from parser.

Returns:

true if the the given string is an invalid value.

main

public static void main(java.lang.String[] args)

The main testing routine.