Package com.adaptris.edi.model

Class Segment

java.lang.Object

com.adaptris.edi.model.Segment

All Implemented Interfaces:

DataModelPart, SearchableListItem

public class Segment
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	log

Fields inherited from interface com.adaptris.edi.model.DataModelPart

ATTRIBUTE, COMPOSITE, COMPOSITE_FIELD, ELEMENT, FIELD, ID, RECORD, ROOT, SEGMENT, TEXT, types

Constructor Summary

Constructors

Constructor	Description
Segment()	Creates a new instance of Segment

Method Summary

Modifier and Type	Method	Description
void	addChild(DataModelPart child)	Add a child DataModelPart to this tree
protected void	checkType(ContainerPart container, String expectedType)
protected String	convertNull(String s, boolean toEmptyString)
void	document(StringBuffer sb, int indent)
protected byte[]	escapeCharacters(byte[] bytes, char character, char escape, String charset)
DataModelPart	getChild(int index)	Return the child DataModelPart held at the specified index
int	getChildCount()	Returns the number of child DataModelParts held by this DataModelPart
ArrayList<?>	getChildList(String type, String id)	Method to retrieve child elements keyed by Type and ID values
String	getId()	Gets the ID of this DataModelPart
DataModelPart	getParent()	Gets the parent of this DataModelPart
int	getRepetitions()	returns the number of times that the data represented by this DataModelPart may repeat in a file.
DataModelPart	getRoot()	Gets the Root DataModelPart of this tree
String	getType()	Returns the type of this DataModelPart
ContainerPart	parse(StreamParser input, Options options)	Parses a section of an input file provided in the supplied StreamParser.
void	produce(OutputStream output, ContainerPart container, String charset, Options options)
void	resort()	method to re-sort the child DataModelParts, useful if either ID or or Type values have changed
void	setId(String id)	Sets the ID of this DataModelPart
void	setParent(DataModelPart parent)	Sets the parent of this DataModelPart
void	setRepetitions(int repetitions)	sets the number of times that the data represented by this DataModelPart may repeat in a file.
void	setRoot(DataModelPart root)	Sets the Root DataModelPart of this tree recursively.
void	setType(String type)	Sets the type of this DataModelPart
protected byte[]	stripCharacters(byte[] bytes, char character, char escape, String charset)
boolean	supportsChild(int dataModelType)	Segment supports type of 'Segment' and 'Record'
void	validate(ContainerPart container)	dummy method - functionality not yet present
void	writeXML(OutputStream out, int indent)
void	writeXML(Writer out, int indent)

Methods inherited from class java.lang.Object

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

Field Details

log

protected transient org.slf4j.Logger log

Constructor Details

Segment

public Segment()

Creates a new instance of Segment

Method Details

produce

public void produce(OutputStream output,
 ContainerPart container,
 String charset,
 Options options)
             throws ModelException

Throws:

ModelException

parse

public ContainerPart parse(StreamParser input,
 Options options)
                    throws ModelException

Parses a section of an input file provided in the supplied StreamParser.

Parameters:

input - the StreamParser to parse

Returns:

ContainerPart tree containing the structure of the parsed data

Throws:

ModelException - if an error is encountered

validate

public void validate(ContainerPart container)
              throws ModelException

dummy method - functionality not yet present

Throws:

ModelException

supportsChild

public boolean supportsChild(int dataModelType)

Segment supports type of 'Segment' and 'Record'

getParent

public DataModelPart getParent()
                        throws ModelException

Gets the parent of this DataModelPart

Specified by:

getParent in interface DataModelPart

Returns:

parent DataModelPart

Throws:

ModelException

setParent

public void setParent(DataModelPart parent)
               throws ModelException

Sets the parent of this DataModelPart

Specified by:

setParent in interface DataModelPart

Parameters:

parent - DataModelPart

Throws:

ModelException

getId

public String getId()

Gets the ID of this DataModelPart

Specified by:

getId in interface DataModelPart

Specified by:

getId in interface SearchableListItem

Returns:

ID

getRoot

public DataModelPart getRoot()

Gets the Root DataModelPart of this tree

Specified by:

getRoot in interface DataModelPart

Returns:

root DataModelPart

setRoot

public void setRoot(DataModelPart root)

Sets the Root DataModelPart of this tree recursively. Will propogate the root element to all child DataModelParts.

Specified by:

setRoot in interface DataModelPart

Parameters:

root - DataModelPart

addChild

public void addChild(DataModelPart child)
              throws ModelException

Add a child DataModelPart to this tree

Specified by:

addChild in interface DataModelPart

Parameters:

child - DataModelPart to be added

Throws:

ModelException

getChild

public DataModelPart getChild(int index)
                       throws ModelException

Return the child DataModelPart held at the specified index

Specified by:

getChild in interface DataModelPart

Parameters:

index - the position of the child to be returned

Returns:

the child DataModelPart

Throws:

ModelException

getChildCount

public int getChildCount()

Returns the number of child DataModelParts held by this DataModelPart

Specified by:

getChildCount in interface DataModelPart

getType

public String getType()

Returns the type of this DataModelPart

Specified by:

getType in interface DataModelPart

Specified by:

getType in interface SearchableListItem

setId

public void setId(String id)

Sets the ID of this DataModelPart

Specified by:

setId in interface DataModelPart

setType

public void setType(String type)

Sets the type of this DataModelPart

Specified by:

setType in interface DataModelPart

getRepetitions

public int getRepetitions()

returns the number of times that the data represented by this DataModelPart may repeat in a file. E.g. a DataModelPart representing a Line Record in a file would probably specify a repetitions value of zero, indicating that unlimited repetitions may ocur

Specified by:

getRepetitions in interface DataModelPart

setRepetitions

public void setRepetitions(int repetitions)

sets the number of times that the data represented by this DataModelPart may repeat in a file.

Specified by:

setRepetitions in interface DataModelPart

document

public void document(StringBuffer sb,
 int indent)

Specified by:

document in interface DataModelPart

writeXML

public void writeXML(OutputStream out,
 int indent)
              throws EdiException,
IOException

Specified by:

writeXML in interface DataModelPart

Throws:

EdiException

IOException

writeXML

public void writeXML(Writer out,
 int indent)
              throws EdiException,
IOException

Specified by:

writeXML in interface DataModelPart

Throws:

EdiException

IOException

getChildList

public ArrayList<?> getChildList(String type,
 String id)
                          throws ModelException

Method to retrieve child elements keyed by Type and ID values

Specified by:

getChildList in interface DataModelPart

Parameters:

type - the type of element to retrieve

id - the id of the element to retrieve

Returns:

ArrayList containing the retrieved elements

Throws:

ModelException

resort

public void resort()

method to re-sort the child DataModelParts, useful if either ID or or Type values have changed

Specified by:

resort in interface DataModelPart

checkType

protected void checkType(ContainerPart container,
 String expectedType)
                  throws ModelException

Throws:

ModelException

stripCharacters

protected byte[] stripCharacters(byte[] bytes,
 char character,
 char escape,
 String charset)

escapeCharacters

protected byte[] escapeCharacters(byte[] bytes,
 char character,
 char escape,
 String charset)

convertNull

protected String convertNull(String s,
 boolean toEmptyString)