Package com.adaptris.edi.container

Class Segment

java.lang.Object

com.adaptris.edi.container.Segment

All Implemented Interfaces:

ContainerPart, SearchableListItem

public class Segment
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Segment()	Creates a new instance of Segment

Method Summary

Modifier and Type	Method	Description
void	addChild(ContainerPart child)	adds a child ContainerPart to this one.
void	doAction(String queryString, Action action, ContainerPart output)	Method to perform an XPATH style query on the ContainerPart heirarchy.
void	document(StringBuffer sb, int indent)	write out an XML representation of this ContainerPart and all sub-parts
ContainerPart	getChild(int index)	gets a child ContainerPart.
int	getChildCount()	gets the number of child elements
ArrayList<?>	getChildList(String type, String id)	Method to retrieve child elements keyed by Type and ID values
String	getId()	returns the ID of this container part
ContainerPart	getParent()	returns the parent ContainerPart to this ContainerPart.
ContainerPart	getRoot()	returns the root ContainerPart in this tree structure
String	getType()	returns the ID of this ContainerPart.
protected String	replaceEntity(String input)
void	setId(String id)	sets the ID of this ContainerPart.
void	setParent(ContainerPart parent)	sets the parent ContainerPart of this ContainerPart.
void	setRoot(ContainerPart root)	sets the root ContainerPart of this ContainerPart tree.
void	writeXML(OutputStream out, int indent)	write out an XML representation of this ContainerPart and all sub-parts
void	writeXML(Writer out, int indent)	write out an XML representation of this ContainerPart and all sub-parts

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

addChild

public void addChild(ContainerPart child)

adds a child ContainerPart to this one. Parts are added in list order and cannot be re-ordered at this time.

Specified by:

addChild in interface ContainerPart

Parameters:

child - the child ContainerPart

getChild

public ContainerPart getChild(int index)

gets a child ContainerPart.

Specified by:

getChild in interface ContainerPart

Parameters:

index - the index of the child ContainerPart (starting from 0 and up to getChildCount() - 1)

Returns:

the ContainerPart referenced

See Also:

• ContainerPart.getChildCount()

getChildCount

public int getChildCount()

gets the number of child elements

Specified by:

getChildCount in interface ContainerPart

Returns:

the number of child elements held by this ContainerPart

getId

public String getId()

returns the ID of this container part

Specified by:

getId in interface ContainerPart

Specified by:

getId in interface SearchableListItem

Returns:

the ID String

getParent

public ContainerPart getParent()
                        throws ContainerException

returns the parent ContainerPart to this ContainerPart. An exception may be thrown by this method if overridden

Specified by:

getParent in interface ContainerPart

Returns:

parent ContainerPart

Throws:

Exception

ContainerException

getRoot

public ContainerPart getRoot()

returns the root ContainerPart in this tree structure

Specified by:

getRoot in interface ContainerPart

Returns:

root ContainerPart

getType

public String getType()

returns the ID of this ContainerPart. Will correspond to the static types array in com.adaptris.edi.model.DataModelPart

Specified by:

getType in interface ContainerPart

Specified by:

getType in interface SearchableListItem

Returns:

String type

See Also:

• DataModelPart

setId

public void setId(String id)

sets the ID of this ContainerPart. Should correspond to static types array in com.adaptris.edi.model.DataModelPart.

Specified by:

setId in interface ContainerPart

Parameters:

id -

See Also:

• DataModelPart

setParent

public void setParent(ContainerPart parent)
               throws ContainerException

sets the parent ContainerPart of this ContainerPart. May be overridden to throw an exception in certain circumstances.

Specified by:

setParent in interface ContainerPart

Parameters:

parent -

Throws:

Exception

ContainerException

setRoot

public void setRoot(ContainerPart root)

sets the root ContainerPart of this ContainerPart tree. Will recursively set the root ContainerPart through all child Parts. Thus only needs to be called once per tree structure and always ensures that all ContainerParts reference the same root Part.

Specified by:

setRoot in interface ContainerPart

Parameters:

root -

document

public void document(StringBuffer sb,
 int indent)

Description copied from interface: ContainerPart

write out an XML representation of this ContainerPart and all sub-parts

Specified by:

document in interface ContainerPart

See Also:

• ContainerPart.document(java.lang.StringBuffer, int)

writeXML

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

Description copied from interface: ContainerPart

write out an XML representation of this ContainerPart and all sub-parts

Specified by:

writeXML in interface ContainerPart

Throws:

EdiException - wrapping other exceptions

IOException

writeXML

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

Description copied from interface: ContainerPart

write out an XML representation of this ContainerPart and all sub-parts

Specified by:

writeXML in interface ContainerPart

Throws:

EdiException - wrapping other exceptions

IOException

See Also:

• ContainerPart.writeXML(java.io.Writer, int)

getChildList

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

Method to retrieve child elements keyed by Type and ID values

Specified by:

getChildList in interface ContainerPart

Parameters:

type - the type of element to retrieve

id - the id of the element to retrieve

Returns:

ArrayList containing the retrieved elements

Throws:

ContainerException

doAction

public void doAction(String queryString,
 Action action,
 ContainerPart output)
              throws EdiException

Method to perform an XPATH style query on the ContainerPart heirarchy. Syntax rules to follow...

Specified by:

doAction in interface ContainerPart

Parameters:

queryString - the string containing the query to be processed

action - the action to run

output - the ContainerPart which will be the parent of the result

Throws:

EdiException - wrapping other exceptions.

replaceEntity

protected String replaceEntity(String input)