com.americancoders.edi
Class TemplateLoopContainer

java.lang.Object
  |
  +--com.americancoders.edi.TemplateSegmentContainer
        |
        +--com.americancoders.edi.TemplateLoopContainer

All Implemented Interfaces:

IContainedObject, IIdentifier, ITemplateSegmentContainer

Direct Known Subclasses:

TemplateLoop, TemplateTable

public abstract class TemplateLoopContainer

extends TemplateSegmentContainer

Template Loop Container

OBOE - Open Business Objects for EDI

Part of the OBOE Basic Extended Package
An EDI and XML Translator Written In Java
Copyright 1998-2009 - American Coders, LTD - Raleigh NC USA
All rights reserved
American Coders, Ltd
P. O. Box 97462
Raleigh, NC 27624 USA
1-919-846-2014
http://www.americancoders.com

Version:

3.6.0

Author:

Joe McVerry - American Coders, Ltd.

Field Summary

Fields inherited from class com.americancoders.edi.TemplateSegmentContainer

templateContainer

Constructor Summary

TemplateLoopContainer()

Method Summary

void	addTemplateLoop(com.americancoders.edi.TemplateLoop inTemplateLoop) adds a TemplateLoop to the vector
com.americancoders.edi.Segment	createSegment(java.lang.String id) creates a subsegment
int	getContainerSize() returns the number of template segments
com.americancoders.edi.TemplateLoop	getTemplateLoop(int inPosition) gets a TemplateLoop from the vector
com.americancoders.edi.TemplateLoop	getTemplateLoop(java.lang.String inID) gets a TemplateLoop from the vector
com.americancoders.edi.TemplateLoop	getTemplateLoopByIDAndName(java.lang.String inID, java.lang.String inName) gets a TemplateLoop from the vector
boolean	isLoop(int i)

Methods inherited from class com.americancoders.edi.TemplateSegmentContainer

addTemplateSegment, getCount, getCount, getTemplateSegment, getTemplateSegment, getTemplateSegment, getTemplateSegmentByIDAndName, isSegment

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.americancoders.edi.IContainedObject

getParent, setParent

Methods inherited from interface com.americancoders.edi.IIdentifier

getID, getXMLTag

Constructor Detail

TemplateLoopContainer

public TemplateLoopContainer()

Method Detail

createSegment

public com.americancoders.edi.Segment createSegment(java.lang.String id)
                                             throws OBOEException

creates a subsegment

Parameters:

id - String id of subsegment to create

Returns:

Segment based on this Template

Throws:

OBOEException - unknown id

addTemplateLoop

public void addTemplateLoop(com.americancoders.edi.TemplateLoop inTemplateLoop)

adds a TemplateLoop to the vector

Parameters:

inTemplateLoop - TemplateLoop to add

getContainerSize

public int getContainerSize()

returns the number of template segments

Returns:

int

getTemplateLoop

public com.americancoders.edi.TemplateLoop getTemplateLoop(int inPosition)

gets a TemplateLoop from the vector

Parameters:

inPosition - int position in array

Returns:

TemplateLoop

getTemplateLoop

public com.americancoders.edi.TemplateLoop getTemplateLoop(java.lang.String inID)

gets a TemplateLoop from the vector

Parameters:

inID - String template's loop id

Returns:

TemplateLoop

getTemplateLoopByIDAndName

public com.americancoders.edi.TemplateLoop getTemplateLoopByIDAndName(java.lang.String inID,
                                                                      java.lang.String inName)

gets a TemplateLoop from the vector

Parameters:

inID - String template's loop id

inName - String template's loop Name

Returns:

TemplateLoop

isLoop

public boolean isLoop(int i)