org.kuali.ole.sys.batch

Class FlatFileParserBase

java.lang.Object

org.kuali.ole.sys.batch.BatchInputFileTypeBase

org.kuali.ole.sys.batch.FlatFileParserBase

All Implemented Interfaces:

BatchInputFileType, BatchInputType

public class FlatFileParserBase
extends BatchInputFileTypeBase

Implementation of BatchInputFileType which parses flat files

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.core.api.datetime.DateTimeService	dateTimeService
protected String	fileNamePrefix
protected String	fileTypeIdentifier
protected FlatFileSpecification	flatFileSpecification
protected static org.apache.log4j.Logger	LOG
protected FlatFileDataHandler	processor
protected String	titleKey

Constructor Summary

Constructors

Constructor and Description
FlatFileParserBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthorPrincipalName(File file) Determines the principal name of the author of a file from the file name
String	getFileName(String principalName, Object parsedFileContents, String fileUserIdentifier) Returns the name of an uploaded file
String	getFileNamePrefix()
String	getFileTypeIdentifer() Returns the unique identifier (Spring bean id) for the batch input type.
FlatFileDataHandler	getProcessor()
String	getTitleKey() Returns the key for the application constants message to display as the title for the upload screen.
Object	parse(byte[] fileByteContent) Reads each line of the flat file and uses the injected FlatFileSpecification to parse into an object graph
void	process(String fileName, Object parsedFileContents) Calls the processor if it is available
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService) Sets an implementation of the DateTimeService for use in parsing
void	setFileNamePrefix(String fileNamePrefix) Sets the prefix of the file name which this parser reads
void	setFileTypeIdentifer(String fileTypeIdentifier) All foundation developers are brilliant at spelling!
void	setFileTypeIdentifier(String fileTypeIdentifier) The correctly spelled setter name - just to avoid injection confusion
void	setFlatFileSpecification(AbstractFlatFileSpecificationBase flatFileClassIdentifier) Sets the FlatFileSpecification that instructs how to carry out the parse
void	setProcessor(FlatFileDataHandler processor) Sets the processor which will validate and process the file once all flat file data has been parsed
void	setTitleKey(String titleKey) Sets the key of the message to show in the title bar of the upload page for this file
boolean	validate(Object parsedFileContents) Performs specific validation on the parsed file contents.

Methods inherited from class org.kuali.ole.sys.batch.BatchInputFileTypeBase

getDirectoryPath, getFileExtension, getFileName, setDirectoryPath, setFileExtension

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

flatFileSpecification

protected FlatFileSpecification flatFileSpecification

fileNamePrefix

protected String fileNamePrefix

dateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService dateTimeService

fileTypeIdentifier

protected String fileTypeIdentifier

titleKey

protected String titleKey

processor

protected FlatFileDataHandler processor

Constructor Detail

FlatFileParserBase

public FlatFileParserBase()

Method Detail

getFileName

public String getFileName(String principalName,
                 Object parsedFileContents,
                 String fileUserIdentifier)

Returns the name of an uploaded file

Parameters:

principalName - - principal name of the user who is uploading the file

parsedFileContents - - object populated with the uploaded file contents

setFileTypeIdentifer

public void setFileTypeIdentifer(String fileTypeIdentifier)

All foundation developers are brilliant at spelling!

Parameters:

fileTypeIdentifier - the file identifier to set

setFileTypeIdentifier

public void setFileTypeIdentifier(String fileTypeIdentifier)

The correctly spelled setter name - just to avoid injection confusion

Parameters:

fileTypeIdentifier - the file type identifier

setTitleKey

public void setTitleKey(String titleKey)

Sets the key of the message to show in the title bar of the upload page for this file

Parameters:

titleKey -

getProcessor

public FlatFileDataHandler getProcessor()

Returns:

a FlatFileDataValidator associated with this instance of the FixedWidthFlatFileParserBase

setProcessor

public void setProcessor(FlatFileDataHandler processor)

Sets the processor which will validate and process the file once all flat file data has been parsed

Parameters:

processor - the implementation of FlatFileDataHandler to utilize

parse

public Object parse(byte[] fileByteContent)
             throws ParseException

Reads each line of the flat file and uses the injected FlatFileSpecification to parse into an object graph

Parameters:

fileByteContent - the contents file to parse

Returns:

an object graph of parsed objects

Throws:

ParseException

See Also:

BatchInputFileType.parse(byte[])

process

public void process(String fileName,
           Object parsedFileContents)

Calls the processor if it is available

Parameters:

fileName - name of the file

parsedFileContents - objects populated with file contents

validate

public boolean validate(Object parsedFileContents)

Description copied from interface: BatchInputFileType

Performs specific validation on the parsed file contents. If errors were found, method will return false and GlobalVariables.errorMap will contain the error message. If no errors were encountered the method will return true.

Parameters:

parsedFileContents - - object populated with the uploaded file contents

Returns:

currently always returns true; do we want to extend that sometime?

setFlatFileSpecification

public void setFlatFileSpecification(AbstractFlatFileSpecificationBase flatFileClassIdentifier)

Sets the FlatFileSpecification that instructs how to carry out the parse

Parameters:

flatFileClassIdentifier - the FlatFileSpecification that instructs how to carry out the parse

setFileNamePrefix

public void setFileNamePrefix(String fileNamePrefix)

Sets the prefix of the file name which this parser reads

Parameters:

fileNamePrefix -

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

Sets an implementation of the DateTimeService for use in parsing

Parameters:

dateTimeService -

getAuthorPrincipalName

public String getAuthorPrincipalName(File file)

Determines the principal name of the author of a file from the file name

Parameters:

file - the file to determine the author of

Returns:

the principal name of the author

getFileTypeIdentifer

public String getFileTypeIdentifer()

Description copied from interface: BatchInputFileType

Returns the unique identifier (Spring bean id) for the batch input type.

Returns:

the identifier for flat files of this type

getFileNamePrefix

public String getFileNamePrefix()

Returns:

the prefix of the name of flat files of this type

getTitleKey

public String getTitleKey()

Description copied from interface: BatchInputType

Returns the key for the application constants message to display as the title for the upload screen.

Returns:

the key of the message to be used as the title of the upload screen of this file type