Package com.aquima.interactions.framework.util.textdata

Class FixedWidthTextReader

java.lang.Object

com.aquima.interactions.framework.util.textdata.AbstractTextDataReader

com.aquima.interactions.framework.util.textdata.FixedWidthTextReader

public class FixedWidthTextReader
extends AbstractTextDataReader

This class can be used to read a fixed width text resource.

Fixed width text files are special cases of text files where the format is specified by column widths, pad character and left/right alignment. Column widths are in units of characters. So if you have data in a text file where the first column always has exactly 10 characters, and the second column has exactly 5, the third has exactly 12 (and so on), then you have a fixed width text file.

Each row (line) contains one record of information; each record can contain multiple pieces of data (fields), each data field (column) has a precise number of characters. The data is padded with spaces (or any character you specify) if it does not completely use all the characters allotted to it. Further, each piece of data can be left, right or center justified, meaning the padding of characters can occur on either side (or both, for center).

Since:

6.3

Author:

Jon van Leuven

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNMENT_CENTER	Center alignment
static final int	ALIGNMENT_LEFT	Left alignment
static final int	ALIGNMENT_RIGHT	Right alignment
static final int	DEFAULT_ALIGNMENT	Default alignment: left
static final char	DEFAULT_PADDING_CHARACTER	Default padding character: space character

Fields inherited from class com.aquima.interactions.framework.util.textdata.AbstractTextDataReader

DEFAULT_SKIP_LINES

Constructor Summary

Constructors

Constructor	Description
FixedWidthTextReader(IResource resource, int[] columnWidths)	Constructs FixedWidthTextReader with supplied column widths.
FixedWidthTextReader(IResource resource, int[] columnWidths, char paddingCharacter)	Constructs FixedWidthTextReader with supplied column widths and padding character.
FixedWidthTextReader(IResource resource, int[] columnWidths, char paddingCharacter, int alignment, int skipLines)	Constructs FixedWidthTextReader with supplied column widths, padding character and alignment.
FixedWidthTextReader(IResource resource, int[] columnWidths, char paddingCharacter, int alignment, int skipLines, String charset)	Constructs FixedWidthTextReader with supplied column widths, padding character, alignment, number of lines to skip and charset.
FixedWidthTextReader(IResource resource, int[] columnWidths, char paddingCharacter, int alignment, String charset)	Constructs FixedWidthTextReader with supplied column widths, padding character, alignment and charset.

Method Summary

Modifier and Type	Method	Description
protected String[]	parseLine(String nextLine)	Parses an incoming String and returns an array of elements.

Methods inherited from class com.aquima.interactions.framework.util.textdata.AbstractTextDataReader

close, getNextLine, getNextLinePreserveEmptyLines, readAll, readNext

Methods inherited from class java.lang.Object

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

Field Details

ALIGNMENT_LEFT

public static final int ALIGNMENT_LEFT

Left alignment

See Also:

• Constant Field Values

ALIGNMENT_RIGHT

public static final int ALIGNMENT_RIGHT

Right alignment

See Also:

• Constant Field Values

ALIGNMENT_CENTER

public static final int ALIGNMENT_CENTER

Center alignment

See Also:

• Constant Field Values

DEFAULT_ALIGNMENT

public static final int DEFAULT_ALIGNMENT

Default alignment: left

See Also:

• Constant Field Values

DEFAULT_PADDING_CHARACTER

public static final char DEFAULT_PADDING_CHARACTER

Default padding character: space character

See Also:

• Constant Field Values

Constructor Details

FixedWidthTextReader

public FixedWidthTextReader(IResource resource,
 int[] columnWidths)
                     throws ResourceException

Constructs FixedWidthTextReader with supplied column widths.

Parameters:

resource - the resource to an underlying text source.

columnWidths - an array of the column widths.

Throws:

ResourceException - Occurs when problem reading the text source.

FixedWidthTextReader

public FixedWidthTextReader(IResource resource,
 int[] columnWidths,
 char paddingCharacter)
                     throws ResourceException

Constructs FixedWidthTextReader with supplied column widths and padding character.

Parameters:

resource - the resource to an underlying text source.

columnWidths - an array of the column widths.

paddingCharacter - the padding character used to trim the columns.

Throws:

ResourceException - Occurs when problem reading the text source.

FixedWidthTextReader

public FixedWidthTextReader(IResource resource,
 int[] columnWidths,
 char paddingCharacter,
 int alignment,
 String charset)
                     throws ResourceException

Constructs FixedWidthTextReader with supplied column widths, padding character, alignment and charset.

Parameters:

resource - the resource to an underlying text source.

columnWidths - an array of the column widths.

paddingCharacter - the padding character used to trim the columns.

alignment - The alignment to use (left/right or center).

charset - the charset to use for decoding

Throws:

ResourceException - Occurs when problem reading the text source.

See Also:

• ALIGNMENT_LEFT
• ALIGNMENT_RIGHT
• ALIGNMENT_CENTER

FixedWidthTextReader

public FixedWidthTextReader(IResource resource,
 int[] columnWidths,
 char paddingCharacter,
 int alignment,
 int skipLines)
                     throws ResourceException

Constructs FixedWidthTextReader with supplied column widths, padding character and alignment.

Parameters:

resource - the resource to an underlying text source.

columnWidths - an array of the column widths.

paddingCharacter - the padding character used to trim the columns.

alignment - The alignment to use (left/right or center).

Throws:

ResourceException - Occurs when problem reading the text source.

See Also:

• ALIGNMENT_LEFT
• ALIGNMENT_RIGHT
• ALIGNMENT_CENTER

FixedWidthTextReader

public FixedWidthTextReader(IResource resource,
 int[] columnWidths,
 char paddingCharacter,
 int alignment,
 int skipLines,
 String charset)
                     throws ResourceException

Constructs FixedWidthTextReader with supplied column widths, padding character, alignment, number of lines to skip and charset.

Parameters:

resource - the resource to an underlying text source.

columnWidths - an array of the column widths.

paddingCharacter - the padding character used to trim the columns.

alignment - the alignment to use (left/right or center).

skipLines - the line number to skip for start reading.

charset - the charset used for decoding.

Throws:

ResourceException - Occurs when problem reading the text source.

See Also:

• ALIGNMENT_LEFT
• ALIGNMENT_RIGHT
• ALIGNMENT_CENTER

Method Details

parseLine

protected String[] parseLine(String nextLine)
                      throws IOException

Description copied from class: AbstractTextDataReader

Parses an incoming String and returns an array of elements.

Specified by:

parseLine in class AbstractTextDataReader

Parameters:

nextLine - the string to parse

Returns:

the comma-tokenized list of elements, or null if nextLine is null

Throws:

IOException - if bad things happen during the read