org.kuali.ole.sys.batch

Class FlatFileInformation

java.lang.Object

org.kuali.ole.sys.batch.FlatFileInformation

public class FlatFileInformation
extends Object

A holder of error messages and informative messages associated with a single logical file within a larger physical file

Constructor Summary

Constructors

Constructor and Description
FlatFileInformation() Constructs a new FlatFileInformation
FlatFileInformation(String fileName) Constructs a new FlatFileInformation

Method Summary

Methods

Modifier and Type	Method and Description
void	addFileErrorMessage(String message) Adds an error message for this logical file
void	addFileInfoMessage(String message) Adds an informative message for this logical file
String	getFileName()
Map<String,FlatFileTransactionInformation>	getFlatFileIdentifierToTransactionInfomationMap()
List<String[]>	getMessages()
FlatFileTransactionInformation	getOrAddFlatFileData(String flatFileDataIdentifier, FlatFileTransactionInformation flatFileTransactionInformation) Adds the given messages about a transaction to the map of transaction messages if necessary and returns the first set of messages about a transaction put into the map
void	setFileName(String fileName) Sets the name of the physical file the logical file this holds messages for is associated with
void	setFlatFileIdentifierToTransactionInfomationMap(Map<String,FlatFileTransactionInformation> flatFileIdentifierToTransactionInfomationMap) Sets the map that associates the transaction identifier to its associated messages
void	setMessages(List<String[]> messages) Sets the full List of messages associated with this logical file

Methods inherited from class java.lang.Object

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

Constructor Detail

FlatFileInformation

public FlatFileInformation()

Constructs a new FlatFileInformation

FlatFileInformation

public FlatFileInformation(String fileName)

Constructs a new FlatFileInformation

Parameters:

fileName - the file name of the physical file with the encapsulated logical file therein

Method Detail

getOrAddFlatFileData

public FlatFileTransactionInformation getOrAddFlatFileData(String flatFileDataIdentifier,
                                                  FlatFileTransactionInformation flatFileTransactionInformation)

Adds the given messages about a transaction to the map of transaction messages if necessary and returns the first set of messages about a transaction put into the map

Parameters:

flatFileDataIdentifier - the identifier of the transaction

flatFileTransactionInformation - the messages about that transaction

Returns:

the messages about the transaction, either just added or previously added

addFileErrorMessage

public void addFileErrorMessage(String message)

Adds an error message for this logical file

Parameters:

message - the error message

addFileInfoMessage

public void addFileInfoMessage(String message)

Adds an informative message for this logical file

Parameters:

message - the informative message

getFileName

public String getFileName()

Returns:

the name of the physical file the logical file this holds messages for is associated with

setFileName

public void setFileName(String fileName)

Sets the name of the physical file the logical file this holds messages for is associated with

Parameters:

fileName - the name of the physical file the logical file this holds messages for is associated with

getMessages

public List<String[]> getMessages()

Returns:

the full List of messages associated with this logical file

setMessages

public void setMessages(List<String[]> messages)

Sets the full List of messages associated with this logical file

Parameters:

messages - the List of messages

getFlatFileIdentifierToTransactionInfomationMap

public Map<String,FlatFileTransactionInformation> getFlatFileIdentifierToTransactionInfomationMap()

Returns:

the map that associates the transaction identifier to its associated messages

setFlatFileIdentifierToTransactionInfomationMap

public void setFlatFileIdentifierToTransactionInfomationMap(Map<String,FlatFileTransactionInformation> flatFileIdentifierToTransactionInfomationMap)

Sets the map that associates the transaction identifier to its associated messages

Parameters:

flatFileIdentifierToTransactionInfomationMap - the map that associates the transaction identifier to its associated messages