org.kuali.kfs.sys.businessobject
Interface AccountingLineParser

All Known Implementing Classes:

AccountingLineParserBase, AssetPaymentAccountingLineParser, AuxiliaryVoucherAccountingLineParser, BasicFormatWithLineDescriptionAccountingLineParser, BudgetAdjustmentAccountingLineParser, CustomerInvoiceAccountingLineParser, GeneralErrorCorrectionDocumentAccountingLineParser, IndirectCostAdjustmentDocumentAccountingLineParser, JournalVoucherAccountingLineParser, LaborJournalVoucherAccountingLineParser, LaborLedgerAccountingLineParser, NonCheckDisbursementDocumentAccountingLineParser, PreEncumbranceDocumentAccountingLineParser, PurApAccountingLineParser

public interface AccountingLineParser

Defines an abstraction for parsing serialized AccountingLines

Method Summary

String	getExpectedAccountingLineFormatAsString(Class<? extends AccountingLine> accountingLineClass)
String[]	getSourceAccountingLineFormat()
String[]	getTargetAccountingLineFormat()
List	importSourceAccountingLines(String fileName, InputStream stream, AccountingDocument document) generates a list of SourceAccountingLine from the inputStream
List	importTargetAccountingLines(String fileName, InputStream stream, AccountingDocument document) generates a list of TargetAccountingLine from the inputStream
SourceAccountingLine	parseSourceAccountingLine(AccountingDocument transactionalDocument, String sourceAccountingLineString) parses a comma deliminated string into an SourceAccountingLine by populating the attributes found in the getSourceAccountingLineFormat()
TargetAccountingLine	parseTargetAccountingLine(AccountingDocument transactionalDocument, String targetAccountingLineString) parses a comma deliminated string into an TargetAccountingLine by populating the attributes found in the getTargetAccountingLineFormat()

Method Detail

getSourceAccountingLineFormat

String[] getSourceAccountingLineFormat()

Returns:

SourceAccountingLine attribute format

getTargetAccountingLineFormat

String[] getTargetAccountingLineFormat()

Returns:

TargetAccountingLine attribute format

getExpectedAccountingLineFormatAsString

String getExpectedAccountingLineFormatAsString(Class<? extends AccountingLine> accountingLineClass)

Parameters:

accountingLineClass -

Returns:

String representation of the String[] attribute format with each attribute seperated by a comma.

parseSourceAccountingLine

SourceAccountingLine parseSourceAccountingLine(AccountingDocument transactionalDocument,
                                               String sourceAccountingLineString)

parses a comma deliminated string into an SourceAccountingLine by populating the attributes found in the getSourceAccountingLineFormat()

Parameters:

transactionalDocument -

sourceAccountingLineString -

Returns:

SourceAccountingLine

parseTargetAccountingLine

TargetAccountingLine parseTargetAccountingLine(AccountingDocument transactionalDocument,
                                               String targetAccountingLineString)

parses a comma deliminated string into an TargetAccountingLine by populating the attributes found in the getTargetAccountingLineFormat()

Parameters:

transactionalDocument -

targetAccountingLineString -

Returns:

TargetAccountingLine

importSourceAccountingLines

List importSourceAccountingLines(String fileName,
                                 InputStream stream,
                                 AccountingDocument document)

generates a list of SourceAccountingLine from the inputStream

Parameters:

stream -

document -

Returns:

List containing SourceAccountingLines

importTargetAccountingLines

List importTargetAccountingLines(String fileName,
                                 InputStream stream,
                                 AccountingDocument document)

generates a list of TargetAccountingLine from the inputStream

Parameters:

stream -

document -

Returns:

List containing SourceAccountingLines