com.americancoders.edi
Class TemplateComposite

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

public class TemplateComposite
extends java.lang.Object
implements IIdentifier, java.io.Externalizable

See Also:
Serialized Form

Field Summary
protected  java.lang.String description
           
protected  java.lang.String id
           
protected  java.lang.String name
           
protected  int sequence
           
protected  java.lang.String xmlTag
           
 
Constructor Summary
TemplateComposite()
           
TemplateComposite(java.lang.String inId, java.lang.String inName, int inSequence, java.lang.String inDescription)
          TemplateCompositeVector, there are two flavors of composites Templates and regular
TemplateComposite(java.lang.String inId, java.lang.String inName, int inSequence, java.lang.String inDescription, java.lang.String inXMLTag)
          TemplateCompositeVector, there are two flavors of composites Templates and regular
 
Method Summary
 void addDataElement(TemplateDE inTemplateDE)
          adds to TemplateDE container
 CompositeDE createComposite(java.lang.String id)
          creates a static composite
 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 TemplateComposite id
 java.lang.String getName()
          gets TemplateComposite name
 int getSequence()
          gets sequence
 TemplateDE getTemplateDE(int at)
          gets TemplateDE from TemplateDE container by position
 TemplateDE getTemplateDE(java.lang.String id)
          gets TemplateDE from TemplateDE container by ID
 int getTemplateDESize()
           
 java.lang.String getXMLTag()
          returns the xml tag field
 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 TemplateComposite id
 void setName(java.lang.String inName)
           
 void setSequence(int inSequence)
          sets sequence
 void setXMLTag(java.lang.String inXMLTag)
          sets the xmltag field
 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
Constructor Detail

TemplateComposite

public TemplateComposite()

TemplateComposite

public TemplateComposite(java.lang.String inId,
                         java.lang.String inName,
                         int inSequence,
                         java.lang.String inDescription,
                         java.lang.String inXMLTag)
TemplateCompositeVector, there are two flavors of composites Templates and regular

templates are used to define a composite dynamically

and are used to build the static form of composites

contains template data element

Parameters:
string - inID composite id
string - inName composite name
int - composite sequence
String - composite description
String - xml tag

TemplateComposite

public TemplateComposite(java.lang.String inId,
                         java.lang.String inName,
                         int inSequence,
                         java.lang.String inDescription)
TemplateCompositeVector, there are two flavors of composites Templates and regular

templates are used to define a composite dynamically

and are used to build the static form of composites

contains template data elements and secondary composites

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

getTemplateDESize

public int getTemplateDESize()

setID

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

setName

public void setName(java.lang.String inName)

getID

public java.lang.String getID()
gets TemplateComposite id
Specified by:
getID in interface IIdentifier

getName

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

setSequence

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

getSequence

public int getSequence()
gets sequence
Returns:
int sequence

setDescription

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

getDescription

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

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
Specified by:
getXMLTag in interface IIdentifier
Returns:
String tag value

addDataElement

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

getTemplateDE

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

getTemplateDE

public TemplateDE getTemplateDE(java.lang.String id)
gets TemplateDE from TemplateDE container by ID
Parameters:
String - id of TemplateDE in container
Returns:
TemplateDE null if not found

createComposite

public CompositeDE createComposite(java.lang.String id)
                            throws java.lang.Exception
creates a static composite
Parameters:
String - id
Returns:
Segment based on this Template

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 composite 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 -