com.adaptris.adapter.edistream.parser.edi

Class EdiGenericParser

java.lang.Object

com.adaptris.adapter.edistream.parser.AbstractParser

com.adaptris.adapter.edistream.parser.edi.EdiGenericParser

public class EdiGenericParser
extends AbstractParser

Main EDI parser class, used to parse EDI text into an object structure.
Note that this parser parses the Edi Document line by line ie segment by segment. It's main purpose is just to convert a line into a segment object and fire and event to any listeners of it's progress of parsing the document.
This parser does not build a complete tree of the document as it serves no purpose, since this is a streaming process the each line of input is converted to output almost immediately.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	charset
protected IEdiSeparatorSet	separatorSet
protected boolean	stripWhiteSpaceFromData

Fields inherited from class com.adaptris.adapter.edistream.parser.AbstractParser

eventListeners

Constructor Summary

Constructors

Constructor and Description
EdiGenericParser()

Method Summary

Modifier and Type	Method and Description
protected EdiElement	createComposite(java.lang.String fieldStr) Creates a composite object that generated from the given composite edi string
protected Composite	createCompositeUsingTokenizer(java.lang.String fieldStr)
protected EdiElement	createField(java.lang.String fieldStr) Creates a field object that has the given data text
protected java.util.List<EdiElement>	createFieldsFromStrings(java.util.List<java.lang.String> fieldElements) Takes the list of strings and converts them to a List of EdiElements where the elements can be of subtype Field or Composite.
java.lang.String	getCharset()
IEdiSeparatorSet	getSeparatorSet()
protected boolean	isComposite(java.lang.String fieldStr) Determines if the given field String is actually a composite, by detecting the presence of the composite data separator.
boolean	isStripWhiteSpaceFromData()
EdiElement	parse(java.io.InputStream is) Main processing method that takes an InputStream which contains the EDI file to be processed.
EdiElement	parse(java.io.Reader ir)
protected EdiElement	parse(StreamParser sp)
protected EdiElement	parseEntireInput(StreamParser sp)
protected Segment	parseSegmentFromText(java.lang.String segmentText) Given a Edi text representation of a segment ie a single edi line, this routine returns an object representation of it.
protected java.util.List<java.lang.String>	readSegmentFields(java.lang.String segmentFieldLine) Parses the field of the edi segment text line and returns a list of the individual fields.
protected java.lang.String	readSegmentID(StreamParser sp) Reads in the first part of a segment - the name of the segment or ID
protected java.lang.String	readSegmentString(StreamParser sp) Reads in an entire line that represents an edi segment from the stream
void	setCharset(java.lang.String charset)
void	setSeparatorSet(IEdiSeparatorSet separatorSet)
void	setStripWhiteSpaceFromData(boolean stripWhiteSpaceFromData)
protected java.lang.String	splitSegmentFieldsFromID(java.lang.String segmentLine, java.lang.String segmentID) Due to issues with the Stream Parser, this method was implemented to split the first part of the edi segment line from the second part that contains all the fields.

Methods inherited from class com.adaptris.adapter.edistream.parser.AbstractParser

addParsedEventListener, fireElementEndParseEvent, fireElementStartParseEvent, removeParsedEventListener

Methods inherited from class java.lang.Object

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

Field Detail

separatorSet

protected IEdiSeparatorSet separatorSet

charset

protected java.lang.String charset

stripWhiteSpaceFromData

protected boolean stripWhiteSpaceFromData

Constructor Detail

EdiGenericParser

public EdiGenericParser()

Method Detail

parse

public EdiElement parse(java.io.InputStream is)
                 throws java.lang.Exception

Main processing method that takes an InputStream which contains the EDI file to be processed.

Parameters:

is - - InputStream for the edi data

Returns:

- object structure representation of the edi data

Throws:

java.lang.Exception

parse

public EdiElement parse(java.io.Reader ir)
                 throws java.lang.Exception

Throws:

java.lang.Exception

parseEntireInput

protected EdiElement parseEntireInput(StreamParser sp)
                               throws java.lang.Exception

Throws:

java.lang.Exception

parse

protected EdiElement parse(StreamParser sp)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getSeparatorSet

public IEdiSeparatorSet getSeparatorSet()

setSeparatorSet

public void setSeparatorSet(IEdiSeparatorSet separatorSet)

getCharset

public java.lang.String getCharset()

setCharset

public void setCharset(java.lang.String charset)

readSegmentString

protected java.lang.String readSegmentString(StreamParser sp)

Reads in an entire line that represents an edi segment from the stream

Parameters:

sp - - Stream parser from which we are reading the edi

Returns:

- String segment text or null

readSegmentID

protected java.lang.String readSegmentID(StreamParser sp)

Reads in the first part of a segment - the name of the segment or ID

Parameters:

sp - - Stream from which to read edi input

Returns:

String that is the Segment name/ID or null

splitSegmentFieldsFromID

protected java.lang.String splitSegmentFieldsFromID(java.lang.String segmentLine,
                                                    java.lang.String segmentID)

Due to issues with the Stream Parser, this method was implemented to split the first part of the edi segment line from the second part that contains all the fields.

Parameters:

segmentLine - - the entire edi segment line

segmentID - - the segment id, that should match the start of the segmentLine

Returns:

substring of the segmentLine from position 4.

readSegmentFields

protected java.util.List<java.lang.String> readSegmentFields(java.lang.String segmentFieldLine)

Parses the field of the edi segment text line and returns a list of the individual fields.

Parameters:

segmentFieldLine - - second part of edi segment line, should just be fields separated with the field delimeter

Returns:

new List that holds the fields

parseSegmentFromText

protected Segment parseSegmentFromText(java.lang.String segmentText)
                                throws EdiValidationException,
                                       EdiMandatoryElementMissingException,
                                       EdiFailedToParseSegmentException

Given a Edi text representation of a segment ie a single edi line, this routine returns an object representation of it.

Parameters:

segmentText - - edi segment line

Returns:

new Segment object or null

Throws:

EdiValidationException

EdiMandatoryElementMissingException

EdiFailedToParseSegmentException

createFieldsFromStrings

protected java.util.List<EdiElement> createFieldsFromStrings(java.util.List<java.lang.String> fieldElements)

Takes the list of strings and converts them to a List of EdiElements where the elements can be of subtype Field or Composite.

Parameters:

fieldElements - - list of text segment fields

Returns:

new List

createField

protected EdiElement createField(java.lang.String fieldStr)

Creates a field object that has the given data text

Parameters:

fieldStr - - data text

Returns:

new Field instance

createComposite

protected EdiElement createComposite(java.lang.String fieldStr)

Creates a composite object that generated from the given composite edi string

Parameters:

fieldStr - - edi composite string

Returns:

- new Composite object instance

createCompositeUsingTokenizer

protected Composite createCompositeUsingTokenizer(java.lang.String fieldStr)

isComposite

protected boolean isComposite(java.lang.String fieldStr)

Determines if the given field String is actually a composite, by detecting the presence of the composite data separator.

Parameters:

fieldStr - - text to check.

Returns:

True if the fieldStr contains the composite separator

isStripWhiteSpaceFromData

public boolean isStripWhiteSpaceFromData()

setStripWhiteSpaceFromData

public void setStripWhiteSpaceFromData(boolean stripWhiteSpaceFromData)