A C D F G J L M O R S T U W

A

addConverter(Converter) - Method in class com.blackbear.flatworm.ConversionHelper

Facilitates the storage of multiple converters used by the convert method during processing

addConverter(Converter) - Method in class com.blackbear.flatworm.FileFormat

Facilitates the storage of multiple converters.

addRecord(Record) - Method in class com.blackbear.flatworm.FileFormat

C

Callback - Class in com.blackbear.flatworm

Used primarily by FileParser to store information about object and methods used to hadle parse events.

Callback(Object, Method) - Constructor for class com.blackbear.flatworm.Callback

close() - Method in class com.blackbear.flatworm.FileCreator

Close the output file, since we are using buffered IO, this is very important.

close() - Method in class com.blackbear.flatworm.FileParser

Close the input file

com.blackbear.flatworm - package com.blackbear.flatworm

com.blackbear.flatworm.converters - package com.blackbear.flatworm.converters

com.blackbear.flatworm.errors - package com.blackbear.flatworm.errors

ConfigurationReader - Class in com.blackbear.flatworm

The ConfigurationReader class is used to initialize Flatworm with an XML configuration file which describes the format and conversion options to be applied to the input file to produce output beans.

ConfigurationReader() - Constructor for class com.blackbear.flatworm.ConfigurationReader

ConversionHelper - Class in com.blackbear.flatworm

The ConversionHelper was created to seperate formatting responsibility into a seperate class.

ConversionHelper() - Constructor for class com.blackbear.flatworm.ConversionHelper

ConversionOption - Class in com.blackbear.flatworm

Bean class used to store the values from the Conversion-Option XML tag

convert(String, String, HashMap, String) - Method in class com.blackbear.flatworm.ConversionHelper

convert(String, Object, HashMap, String) - Method in class com.blackbear.flatworm.ConversionHelper

convertBigDecimal(String, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

Conversion function for BigDecimal, returns the source string with padding removed if requested, converted into a big decimal.

convertBigDecimal(Object, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

convertChar(String, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

Conversion function for String, returns the source string with padding removed if requested.

convertChar(Object, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

Object->String conversion function.

convertDate(String, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

Conversion function for Date, returns the source string with padding removed if requested, converted into a date.

convertDate(Object, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

Date->String conversion function.

convertDecimal(String, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

Conversion function for Double, returns the source string with padding removed if requested, converted into a double.

convertDecimal(Object, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

convertInteger(String, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

Conversion function for Integer, returns the source string with padding removed if requested, converted into a integer.

convertInteger(Object, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

convertLong(String, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

Conversion function for Long, returns the source string with padding removed if requested, converted into a long.

convertLong(Object, HashMap) - Method in class com.blackbear.flatworm.converters.CoreConverters

CoreConverters - Class in com.blackbear.flatworm.converters

CoreConverters contains methods to convert the most commonly encountered text types to native Java types.

CoreConverters() - Constructor for class com.blackbear.flatworm.converters.CoreConverters

D

defaultValue(String, String, HashMap) - Static method in class com.blackbear.flatworm.Util

If str is length zero (after trimming), value is returned.

F

FileCreator - Class in com.blackbear.flatworm

Used to create a flatfile.

FileCreator(String, String) - Constructor for class com.blackbear.flatworm.FileCreator

Constructor for FileCreator

FileCreator(String, OutputStream) - Constructor for class com.blackbear.flatworm.FileCreator

FileCreator(InputStream, String) - Constructor for class com.blackbear.flatworm.FileCreator

FileCreator(InputStream, OutputStream) - Constructor for class com.blackbear.flatworm.FileCreator

FileFormat - Class in com.blackbear.flatworm

The FileFormat is the point of entry into the Flatworm parser.

FileFormat() - Constructor for class com.blackbear.flatworm.FileFormat

FileParser - Class in com.blackbear.flatworm

Used to read a flatfile.

FileParser(String, String) - Constructor for class com.blackbear.flatworm.FileParser

Constructor for FileParser

FlatwormConfigurationValueException - Exception in com.blackbear.flatworm.errors

The exception thrown when a value is missing or inconsistant values are given in the configuation file.

FlatwormConfigurationValueException(String) - Constructor for exception com.blackbear.flatworm.errors.FlatwormConfigurationValueException

FlatwormConversionException - Exception in com.blackbear.flatworm.errors

The exception thrown when an error occurs during field conversion.

FlatwormConversionException(String) - Constructor for exception com.blackbear.flatworm.errors.FlatwormConversionException

FlatwormCreatorException - Exception in com.blackbear.flatworm.errors

The exception thrown when a value is missing or inconsistant values are given in the configuation file.

FlatwormCreatorException(String) - Constructor for exception com.blackbear.flatworm.errors.FlatwormCreatorException

FlatwormException - Exception in com.blackbear.flatworm.errors

The base exception for all Flatworm exceptions.

FlatwormException() - Constructor for exception com.blackbear.flatworm.errors.FlatwormException

FlatwormException(String) - Constructor for exception com.blackbear.flatworm.errors.FlatwormException

FlatwormInputLineLengthException - Exception in com.blackbear.flatworm.errors

The exception thrown when an attempt is made to read past the end of an input line.

FlatwormInputLineLengthException(String) - Constructor for exception com.blackbear.flatworm.errors.FlatwormInputLineLengthException

FlatwormInvalidRecordException - Exception in com.blackbear.flatworm.errors

Thrown if no match is found for an input file in the re

FlatwormInvalidRecordException(String) - Constructor for exception com.blackbear.flatworm.errors.FlatwormInvalidRecordException

FlatwormParserException - Exception in com.blackbear.flatworm.errors

The exception thrown when a value is missing or inconsistant values are given in the configuation file.

FlatwormParserException(String) - Constructor for exception com.blackbear.flatworm.errors.FlatwormParserException

FlatwormUnsetFieldValueException - Exception in com.blackbear.flatworm.errors

Exception thrown if code attempts to access the start, end or length of a field if it is not set.

FlatwormUnsetFieldValueException(String) - Constructor for exception com.blackbear.flatworm.errors.FlatwormUnsetFieldValueException

formatDate(Date, String, HashMap) - Static method in class com.blackbear.flatworm.Util

Different from the method in CoreConverters, this one is used for file creation

Specified in flatworm XML file like: <conversion-option name="format" value="yyyy-MM-dd"/>

G

getBean(String) - Method in class com.blackbear.flatworm.MatchedRecord

Gets a specific bean, or null if not found.

getConvertionHelper() - Method in class com.blackbear.flatworm.FileFormat

FileFormat is the keeper of ConversionHelper, but does not actually use it.

getInstance() - Method in class com.blackbear.flatworm.Callback

getLastLine() - Method in class com.blackbear.flatworm.FileFormat

getMethod() - Method in class com.blackbear.flatworm.Callback

getName() - Method in class com.blackbear.flatworm.ConversionOption

getNextRecord(BufferedReader) - Method in class com.blackbear.flatworm.FileFormat

When called with a BufferedReader, reads sufficient lines to parse a record, and returns the beans created.

getRecord(String) - Method in class com.blackbear.flatworm.FileFormat

getRecordName() - Method in class com.blackbear.flatworm.MatchedRecord

Gets the name of the record found.

getRecords() - Method in class com.blackbear.flatworm.FileFormat

getValue() - Method in class com.blackbear.flatworm.ConversionOption

getValue(HashMap, String) - Static method in class com.blackbear.flatworm.Util

Conversion-Option now stored in class, more than a simple Hashmap lookup

J

justify(String, String, HashMap, int) - Static method in class com.blackbear.flatworm.Util

Removes pre-determined chracters from string based on Java Patterns

Specified in flatworm XML file like: <conversion-option name="justify" value="right"/>

L

loadConfigurationFile(String) - Method in class com.blackbear.flatworm.ConfigurationReader

loadConfigurationFile takes an XML configuration file, and returns a FileFormat object, which can be used to parse an input file into beans.

loadConfigurationFile(InputStream) - Method in class com.blackbear.flatworm.ConfigurationReader

M

MatchedRecord - Class in com.blackbear.flatworm

The MatchedRecord is used to return the record data from a FileFormat record request.

MatchedRecord(String, HashMap) - Constructor for class com.blackbear.flatworm.MatchedRecord

O

open() - Method in class com.blackbear.flatworm.FileCreator

Open the newfile for writing

open() - Method in class com.blackbear.flatworm.FileParser

Open the buffered reader for the input file

R

read() - Method in class com.blackbear.flatworm.FileParser

Read the entire input file.

S

setBean(String, Object) - Method in class com.blackbear.flatworm.FileCreator

This is a convienence method that lets the writer know about your bean without having to pass a HashMap to write()

setBeanHandler(String, Object, String) - Method in class com.blackbear.flatworm.FileParser

Let's the parser know which object and method to call when a record has been successfully parsed and needs handling

setExceptionHandler(Object, String) - Method in class com.blackbear.flatworm.FileParser

Let's the parser know which object and method to call when an exception occurs during record processing.

setName(String) - Method in class com.blackbear.flatworm.ConversionOption

setRecords(HashMap) - Method in class com.blackbear.flatworm.FileFormat

setRecordSeperator(String) - Method in class com.blackbear.flatworm.FileCreator

Flatworm does not assume you want a newline between records, call this method to set your record delimiter.

setValue(String) - Method in class com.blackbear.flatworm.ConversionOption

split(String, char, char) - Static method in class com.blackbear.flatworm.Util

split divides a string into many strings based on a delimiter The main difference between this split and the one that comes with Java is this one will ignore delimiters that are within quoted fields NOTE: Delimiter will be ignored once chrQuote is encountered.

strip(String, String, HashMap) - Static method in class com.blackbear.flatworm.Util

Removes pre-determined chracters from string based on Java Patterns

Specified in flatworm XML file like: <conversion-option name="strip-chars" value="non-numeric"/>

substring(String, String, HashMap) - Static method in class com.blackbear.flatworm.Util

Specified in flatworm XML file like: <conversion-option name="substring" value="1,10"/>

T

testMultiplePadCharacters() - Method in class com.blackbear.flatworm.UtilTest

testRemoveBlanks() - Method in class com.blackbear.flatworm.UtilTest

toString() - Method in class com.blackbear.flatworm.MatchedRecord

transformString(String, HashMap, int) - Method in class com.blackbear.flatworm.ConversionHelper

Handles the processing of the Conversion-Options from the flatworm XML file

U

Util - Class in com.blackbear.flatworm

Static final class to hold string manipulation methods

Util() - Constructor for class com.blackbear.flatworm.Util

UtilTest - Class in com.blackbear.flatworm

UtilTest() - Constructor for class com.blackbear.flatworm.UtilTest

W

write(String) - Method in class com.blackbear.flatworm.FileCreator

Write information to the output file.

A C D F G J L M O R S T U W