Open Business Objects for EDI
v3.6.0

com.americancoders.edi
Interface EDIDocumentHandler

All Known Implementing Classes:
EDIFactDocumentHandler, LargeDocumentHandler, SampleEDIFactDocumentHandler, SampleEDIFactDocumentHandlerAndViewer, SampleX12DocumentHandler, SampleX12DocumentHandlerAndViewer, TradacomsDocumentHandler, X12DocumentHandler, X12DocumentHandlerXMLBuilder

public interface EDIDocumentHandler

interface to handle high level edi objects. once the handler is registered with the EDIDocumentParser the Parser will call make individual method calls when the objects are created or finished


Method Summary
 void endEnvelope(com.americancoders.edi.Envelope inEnv)
          called when an Evelope is finished
 void endFunctionalGroup(com.americancoders.edi.FunctionalGroup inFG)
          called when an FunctionalGroup object is finished
 void endSegment(com.americancoders.edi.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(com.americancoders.edi.TransactionSet inTS)
          called when an TransactionSet object is finished
 com.americancoders.edi.DocumentErrors getDocumentErrors()
           
 void startEnvelope(com.americancoders.edi.Envelope inEnv)
          called when an Envelope object is created
 void startFunctionalGroup(com.americancoders.edi.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(com.americancoders.edi.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(com.americancoders.edi.TransactionSet inTS)
          called when an TransactionSet object is created
 

Method Detail

startParsing

public void startParsing(java.io.Reader inReader)
                  throws OBOEException
starts the parser with the passed Reader object

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(com.americancoders.edi.Envelope inEnv)
called when an Envelope object is created

Parameters:
inEnv - Envelope found

startFunctionalGroup

public void startFunctionalGroup(com.americancoders.edi.FunctionalGroup inFG)
called when an FunctionalGroup object is created

Parameters:
inFG - FunctionalGroup found

startTransactionSet

public void startTransactionSet(com.americancoders.edi.TransactionSet inTS)
called when an TransactionSet object is created

Parameters:
inTS - TransactionSet found

startSegment

public void startSegment(com.americancoders.edi.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

Parameters:
inSeg - Segment found

endEnvelope

public void endEnvelope(com.americancoders.edi.Envelope inEnv)
called when an Evelope is finished

Parameters:
inEnv - envelope found

endFunctionalGroup

public void endFunctionalGroup(com.americancoders.edi.FunctionalGroup inFG)
called when an FunctionalGroup object is finished

Parameters:
inFG - FunctionalGroup found

endTransactionSet

public void endTransactionSet(com.americancoders.edi.TransactionSet inTS)
called when an TransactionSet object is finished

Parameters:
inTS - TransactionSet found

endSegment

public void endSegment(com.americancoders.edi.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

Parameters:
inSeg - Segment found

getDocumentErrors

public com.americancoders.edi.DocumentErrors getDocumentErrors()

Open Business Objects for EDI
v3.6.0


OBOE is a trademark or registered trademark of American Coders, Ltd. in the US and other countries.
Copyright 1999-2004 American Coders, Ltd.
POB 97462
Raleigh NC 27624 USA
All Rights Reserved.