com.americancoders.edi.EDIFact
Class EDIFactDocumentHandler

java.lang.Object
  com.americancoders.edi.EDIFact.EDIFactDocumentHandler

All Implemented Interfaces:

EDIDocumentHandler

public class EDIFactDocumentHandler

extends java.lang.Object

implements EDIDocumentHandler

class to parse input string for all defined OBOE Transaction Sets
EDIFact dependent

Constructor Summary

EDIFactDocumentHandler()
create a parser for transaction set and parser what is coming from Reader object

EDIFactDocumentHandler(java.io.Reader inReader)
create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available

EDIFactDocumentHandler(java.lang.String inString)
create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available

Method Summary

void	endEnvelope(Envelope inEnv) called when an Evelope is finished
void	endFunctionalGroup(FunctionalGroup inFG) called when an FunctionalGroup object is finished
void	endSegment(Segment inSeg) called when an Segment object is finished only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
void	endTransactionSet(TransactionSet inTS) called when an TransactionSet object is finished
DocumentErrors	getDocumentErrors()
Envelope	getEnvelope() returns the envelope that was parsed
EDIFactDocumentParser	getParser()
static void	main(java.lang.String[] args) main method used for testing purposes format: java filetoparse writes valid xml format of file to System.out
void	startEnvelope(Envelope inEnv) called when an Envelope object is created
void	startFunctionalGroup(FunctionalGroup inFG) called when an FunctionalGroup object is created
void	startParsing(java.io.Reader inReader) starts the parser with the passed Reader object
void	startSegment(Segment inSeg) called when an Segment object is created only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet
void	startTransactionSet(TransactionSet inTS) called when an TransactionSet object is created

Methods inherited from class java.lang.Object

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

Constructor Detail

EDIFactDocumentHandler

public EDIFactDocumentHandler()

create a parser for transaction set and parser what is coming from Reader object

EDIFactDocumentHandler

public EDIFactDocumentHandler(java.io.Reader inReader)
                       throws OBOEException

create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available

Parameters:

inReader - the edi document in a java io reader object

Throws:

OBOEException - - unknown transaction set, this transaction set is undefined to OBOE - parsing errors

EDIFactDocumentHandler

public EDIFactDocumentHandler(java.lang.String inString)
                       throws OBOEException

create a parser for transaction set and parser what is coming from Reader object
if you use this constructor and there are document errors the method will not make the envelope object available

Parameters:

inString - file name of the edi document

Throws:

OBOEException - - unknown transaction set, this transaction set is undefined to OBOE - parsing erros

Method Detail

startParsing

public void startParsing(java.io.Reader inReader)
                  throws OBOEException

starts the parser with the passed Reader object

Specified by:

startParsing in interface EDIDocumentHandler

Parameters:

inReader - the edi document in a java io reader object

Throws:

OBOEException - - unknown transaction set, this transaction set is undefined to OBOE - parsing erros

startEnvelope

public void startEnvelope(Envelope inEnv)

called when an Envelope object is created

Specified by:

startEnvelope in interface EDIDocumentHandler

Parameters:

inEnv - Envelope found

startFunctionalGroup

public void startFunctionalGroup(FunctionalGroup inFG)

called when an FunctionalGroup object is created

Specified by:

startFunctionalGroup in interface EDIDocumentHandler

Parameters:

inFG - FunctionalGroup found

startTransactionSet

public void startTransactionSet(TransactionSet inTS)

called when an TransactionSet object is created

Specified by:

startTransactionSet in interface EDIDocumentHandler

Parameters:

inTS - TransactionSet found

startSegment

public void startSegment(Segment inSeg)

called when an Segment object is created
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet

Specified by:

startSegment in interface EDIDocumentHandler

Parameters:

inSeg - Segment found

endEnvelope

public void endEnvelope(Envelope inEnv)

called when an Evelope is finished

Specified by:

endEnvelope in interface EDIDocumentHandler

Parameters:

inEnv - envelope found

endFunctionalGroup

public void endFunctionalGroup(FunctionalGroup inFG)

called when an FunctionalGroup object is finished

Specified by:

endFunctionalGroup in interface EDIDocumentHandler

Parameters:

inFG - FunctionalGroup found

endTransactionSet

public void endTransactionSet(TransactionSet inTS)

called when an TransactionSet object is finished

Specified by:

endTransactionSet in interface EDIDocumentHandler

Parameters:

inTS - TransactionSet found

endSegment

public void endSegment(Segment inSeg)

called when an Segment object is finished
only called for segments at the Envelope and functionalGroup level does not get called for segments within TransactionSet

Specified by:

endSegment in interface EDIDocumentHandler

Parameters:

inSeg - Segment found

getEnvelope

public Envelope getEnvelope()

returns the envelope that was parsed

Returns:

Envelope - the envelope when object was built.

main

public static void main(java.lang.String[] args)

main method used for testing purposes
format: java filetoparse
writes valid xml format of file to System.out

Parameters:

args - String array - only one arg accepted - file to parse

getDocumentErrors

public DocumentErrors getDocumentErrors()

Specified by:

getDocumentErrors in interface EDIDocumentHandler

getParser

public EDIFactDocumentParser getParser()