com.americancoders.edi
Class TemplateSegment

java.lang.Object
  |
  +--com.americancoders.edi.TemplateSegment

public class TemplateSegment
extends java.lang.Object
implements ITemplateSegmentContainer, java.io.Externalizable

TemplateSegment holds preliminary segment structure

OBOE - Open Business Objects for EDI
An EDI and XML Translator Written In Java
Copyright 1998-2000 - 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:
1.4.1
Author:
Joe McVerry, American Coders Ltd.
See Also:
Serialized Form

Field Summary
protected  java.lang.String description
           
protected  java.lang.String id
           
protected  java.lang.String name
           
protected  int occurs
           
protected  char required
           
protected  int sequence
           
protected  java.lang.String xmlTag
           
 
Constructor Summary
TemplateSegment()
          templateSegment constructor used by externalize mehtods
TemplateSegment(java.lang.String inId, java.lang.String inName, int inSequence, java.lang.String inDescription, int inOccurs, char inRequired)
          templateSegmentVector, there are two flavors of segments Templates and regular
TemplateSegment(java.lang.String inId, java.lang.String inName, int inSequence, java.lang.String inDescription, int inOccurs, char inRequired, java.lang.String inXMLTag)
          templateSegmentVector, there are two flavors of segments Templates and regular
 
Method Summary
 void addCompositeDE(TemplateComposite inTemplateComposite)
          adds to TemplateDE container
 void addDataElement(TemplateDE inTemplateDE)
          adds to TemplateDE container
 void addTemplateSegment(TemplateSegment inTemplateSegment)
          adds to secondary TemplateSegment container
 boolean areYouAGroup()
          Simple routine to determine if the segment contains no data elements
if it returns true then it is a EDIFact Group
 Segment createSegment(java.lang.String id)
          creates a static segment
 boolean doYouNeedThisSegment(java.lang.String inID)
          routine to ask a group if it uses a segment
 int doYouUseThisElement(java.lang.String inID)
          routine to ask if it uses a dataelement
 int doYouUseThisXMLElement(java.lang.String inXML, int startAt)
          routine to ask if it uses a dataelement
 java.lang.String getDescription()
          returns the Description for the Segment
 java.lang.String getID()
          gets TemplateSegment id
 java.lang.String getName()
          gets TemplateSegment name
 int getOccurs()
          gets occurance value
 char getRequired()
          gets required flag
 int getSequence()
          gets sequence id
 TemplateComposite getTemplateComposite(int at)
          gets TemplateComposite from TemplateDE container
 TemplateComposite getTemplateComposite(java.lang.String id)
          gets TemplateComposite from TemplateDE container
 TemplateDE getTemplateDE(int at)
          gets TemplateDE from TemplateDE container
 TemplateDE getTemplateDE(java.lang.String id)
          gets TemplateDE from TemplateDE container
 int getTemplateDESize()
          returns the number of templateDEs
 TemplateSegment getTemplateSegment(int at)
          returns secondary TemplateSegment from container
 TemplateSegment getTemplateSegment(java.lang.String id)
          returns secondary TemplateSegment from container
 int getTemplateSegmentSize()
          returns the number of templatesegments
 java.lang.String getXMLTag()
          returns the xml tag field
 boolean isTemplateComposite(int at)
          tests if the element at a position is a TemplateComposite
 void readExternal(java.io.ObjectInput in)
          used by externalize methods
 void setDescription(java.lang.String inDesc)
          sets Description for the Segmemt
 void setID(java.lang.String inID)
          sets TemplateSegment id
 void setName(java.lang.String inName)
          sets TemplateSegment name
 void setOccurs(int inOccurs)
          sets occurance value
 void setRequired(char inRequired)
          sets required value
 void setSequence(int inSequence)
          sets sequence id
 void setXMLTag(java.lang.String inXMLTag)
          sets the xmlTag field
 boolean validSegment(java.lang.String id)
          returns true if id is one of the secondary TemplateSegment's id
 void writeExternal(java.io.ObjectOutput out)
          used by externalize methods
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

protected java.lang.String id

name

protected java.lang.String name

sequence

protected int sequence

description

protected java.lang.String description

xmlTag

protected java.lang.String xmlTag

occurs

protected int occurs

required

protected char required
Constructor Detail

TemplateSegment

public TemplateSegment()
templateSegment constructor used by externalize mehtods

TemplateSegment

public TemplateSegment(java.lang.String inId,
                       java.lang.String inName,
                       int inSequence,
                       java.lang.String inDescription,
                       int inOccurs,
                       char inRequired,
                       java.lang.String inXMLTag)
templateSegmentVector, there are two flavors of segments Templates and regular

templates are used to define a segment dynamically

and are used to build the static form of segments

contains template data elements and secondary segments

Parameters:
string - inID segment id
string - inName segment name
int - segment sequence
String - segment description
int - the number of times the segment occurs
char - requirement
String - xml tag

TemplateSegment

public TemplateSegment(java.lang.String inId,
                       java.lang.String inName,
                       int inSequence,
                       java.lang.String inDescription,
                       int inOccurs,
                       char inRequired)
templateSegmentVector, there are two flavors of segments Templates and regular

templates are used to define a segment dynamically

and are used to build the static form of segments

contains template data elements and secondary segments

Parameters:
string - inID segment id
string - inName segment name
int - segment sequence
String - segment description
int - the number of times the segment occurs
char - requirement
Method Detail

getTemplateSegmentSize

public int getTemplateSegmentSize()
returns the number of templatesegments
Specified by:
getTemplateSegmentSize in interface ITemplateSegmentContainer
Returns:
int

getTemplateDESize

public int getTemplateDESize()
returns the number of templateDEs
Returns:
int

setID

public void setID(java.lang.String inID)
sets TemplateSegment id
Parameters:
string - inID segment id

setName

public void setName(java.lang.String inName)
sets TemplateSegment name
Parameters:
string - inName

getID

public java.lang.String getID()
gets TemplateSegment id

getName

public java.lang.String getName()
gets TemplateSegment name

setSequence

public void setSequence(int inSequence)
sets sequence id
Parameters:
int - sequence

getSequence

public int getSequence()
gets sequence id
Returns:
int sequence

setDescription

public void setDescription(java.lang.String inDesc)
sets Description for the Segmemt

getDescription

public java.lang.String getDescription()
returns the Description for the Segment
Returns:
String

setOccurs

public void setOccurs(int inOccurs)
sets occurance value
Parameters:
int - occurs

getOccurs

public int getOccurs()
gets occurance value
Returns:
int occurs

setRequired

public void setRequired(char inRequired)
sets required value
Parameters:
char - required

getRequired

public char getRequired()
gets required flag
Returns:
char required

setXMLTag

public void setXMLTag(java.lang.String inXMLTag)
sets the xmlTag field
Parameters:
String -  

getXMLTag

public java.lang.String getXMLTag()
returns the xml tag field
Returns:
String tag value

addTemplateSegment

public void addTemplateSegment(TemplateSegment inTemplateSegment)
adds to secondary TemplateSegment container
Specified by:
addTemplateSegment in interface ITemplateSegmentContainer
Parameters:
TemplateSegment -  

getTemplateSegment

public TemplateSegment getTemplateSegment(int at)
returns secondary TemplateSegment from container
Parameters:
int - position in segment container
Returns:
TemplateSegment

getTemplateSegment

public TemplateSegment getTemplateSegment(java.lang.String id)
returns secondary TemplateSegment from container
Specified by:
getTemplateSegment in interface ITemplateSegmentContainer
Parameters:
String - secondary segment id
Returns:
TemplateSegment

validSegment

public boolean validSegment(java.lang.String id)
returns true if id is one of the secondary TemplateSegment's id
Parameters:
String - id to find
Returns:
boolean found or not found

addCompositeDE

public void addCompositeDE(TemplateComposite inTemplateComposite)
adds to TemplateDE container
Parameters:
TemplateComposite -  

addDataElement

public void addDataElement(TemplateDE inTemplateDE)
adds to TemplateDE container
Parameters:
TemplateDE -  

isTemplateComposite

public boolean isTemplateComposite(int at)
tests if the element at a position is a TemplateComposite
Parameters:
int - position in container
Returns:
boolean

getTemplateComposite

public TemplateComposite getTemplateComposite(int at)
gets TemplateComposite from TemplateDE container
Parameters:
int - position in container
Returns:
TemplateComposite

getTemplateComposite

public TemplateComposite getTemplateComposite(java.lang.String id)
gets TemplateComposite from TemplateDE container
Parameters:
String - id of TemplateComposite in container
Returns:
TemplateComposite

getTemplateDE

public TemplateDE getTemplateDE(int at)
gets TemplateDE from TemplateDE container
Parameters:
int - position in container
Returns:
TemplateDE

getTemplateDE

public TemplateDE getTemplateDE(java.lang.String id)
gets TemplateDE from TemplateDE container
Parameters:
String - id of TemplateDE in container
Returns:
TemplateDE

createSegment

public Segment createSegment(java.lang.String id)
                      throws java.lang.Exception
creates a static segment
Specified by:
createSegment in interface ITemplateSegmentContainer
Parameters:
String - id
Returns:
Segment based on this Template

areYouAGroup

public boolean areYouAGroup()
Simple routine to determine if the segment contains no data elements
if it returns true then it is a EDIFact Group
Returns:
boolean true - EDIFact group, contains no data elements

doYouNeedThisSegment

public boolean doYouNeedThisSegment(java.lang.String inID)
routine to ask a group if it uses a segment
Parameters:
String - id
Returns:
boolen true the segment id is part of this group

doYouUseThisElement

public int doYouUseThisElement(java.lang.String inID)
routine to ask if it uses a dataelement
Parameters:
String - id
Returns:
boolen true the segment id is part of this group

doYouUseThisXMLElement

public int doYouUseThisXMLElement(java.lang.String inXML,
                                  int startAt)
routine to ask if it uses a dataelement
Parameters:
String - id
int - whereToStartLooking, prevents duplicate DE's from getting only the first
Returns:
boolen true the segment id is part of this group

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
used by externalize methods
Specified by:
readExternal in interface java.io.Externalizable
Parameters:
ObjectInput - object input stream
Throws:
java.io.IOException - - most likely class changed since written
java.lang.ClassNotFoundException - - only when dummy constructro not found

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
used by externalize methods
Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
ObjectInput - object input stream
Throws:
java.io.IOException -