|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.americancoders.edi.TemplateSegment
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
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 |
protected java.lang.String id
protected java.lang.String name
protected int sequence
protected java.lang.String description
protected java.lang.String xmlTag
protected int occurs
protected char required
Constructor Detail |
public 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)
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
string
- inID segment idstring
- inName segment nameint
- segment sequenceString
- segment descriptionint
- the number of times the segment occurschar
- requirementString
- xml tagpublic TemplateSegment(java.lang.String inId, java.lang.String inName, int inSequence, java.lang.String inDescription, int inOccurs, char inRequired)
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
string
- inID segment idstring
- inName segment nameint
- segment sequenceString
- segment descriptionint
- the number of times the segment occurschar
- requirementMethod Detail |
public int getTemplateSegmentSize()
public int getTemplateDESize()
public void setID(java.lang.String inID)
string
- inID segment idpublic void setName(java.lang.String inName)
string
- inNamepublic java.lang.String getID()
public java.lang.String getName()
public void setSequence(int inSequence)
int
- sequencepublic int getSequence()
public void setDescription(java.lang.String inDesc)
public java.lang.String getDescription()
public void setOccurs(int inOccurs)
int
- occurspublic int getOccurs()
public void setRequired(char inRequired)
char
- requiredpublic char getRequired()
public void setXMLTag(java.lang.String inXMLTag)
String
- public java.lang.String getXMLTag()
public void addTemplateSegment(TemplateSegment inTemplateSegment)
TemplateSegment
- public TemplateSegment getTemplateSegment(int at)
int
- position in segment containerpublic TemplateSegment getTemplateSegment(java.lang.String id)
String
- secondary segment idpublic boolean validSegment(java.lang.String id)
String
- id to findpublic void addCompositeDE(TemplateComposite inTemplateComposite)
TemplateComposite
- public void addDataElement(TemplateDE inTemplateDE)
TemplateDE
- public boolean isTemplateComposite(int at)
int
- position in containerpublic TemplateComposite getTemplateComposite(int at)
int
- position in containerpublic TemplateComposite getTemplateComposite(java.lang.String id)
String
- id of TemplateComposite in containerpublic TemplateDE getTemplateDE(int at)
int
- position in containerpublic TemplateDE getTemplateDE(java.lang.String id)
String
- id of TemplateDE in containerpublic Segment createSegment(java.lang.String id) throws java.lang.Exception
String
- idpublic boolean areYouAGroup()
public boolean doYouNeedThisSegment(java.lang.String inID)
String
- idpublic int doYouUseThisElement(java.lang.String inID)
String
- idpublic int doYouUseThisXMLElement(java.lang.String inXML, int startAt)
String
- idint
- whereToStartLooking, prevents duplicate DE's from getting only the firstpublic void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
ObjectInput
- object input streampublic void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
ObjectInput
- object input stream
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |