com.americancoders.edi
Class TemplateDE

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

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

class for Template Data Elements
template de's are dynamic definitions for de's

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  int maxLength
           
protected  int minLength
           
protected  java.lang.String name
           
protected  java.lang.String referenceId
           
protected  char required
           
protected  int sequence
           
protected  java.lang.String type
           
protected  java.lang.String xmlTag
           
 
Constructor Summary
TemplateDE()
          constructs the Data Element type used for serialization
TemplateDE(java.lang.String inID, java.lang.String inName, int inSequence, java.lang.String inType, char inRequired, java.lang.String inDesc, int inMinLength, int inMaxLength)
          constructs the Data Element type
TemplateDE(java.lang.String inID, java.lang.String inName, int inSequence, java.lang.String inType, char inRequired, java.lang.String inDesc, int inMinLength, int inMaxLength, java.lang.String inXMLTag)
          constructs the Data Element type
TemplateDE(java.lang.String inID, java.lang.String inName, int inSequence, java.lang.String inType, char inRequired, java.lang.String inDesc, int inMinLength, int inMaxLength, java.lang.String inXMLTag, IDList inIDList)
          constructs the Data Element type
 
Method Summary
 java.lang.String getDescription()
          returns the Description for the Data Element
 java.lang.String getID()
          gets the Data Element id
 IDList getIDList()
          gets the idList Object
 int getMaxLength()
          gets the maximum length for the Data Element
 int getMinLength()
          gets the minimum length for the Data Element
 java.lang.String getName()
          gets the Data Element name
 char getRequired()
          gets the Data Element required
 int getSequence()
          gets the Data Element sequence
 java.lang.String getType()
          gets the Data Element type
 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 Data Element
 void setID(java.lang.String inID)
          sets the Data Element id
 void setIDList(IDList inIdList)
          sets the idList Object
 void setMaxLength(int inMaxLength)
          sets the maximum length for the Data Element
 void setMinLength(int inMinLength)
          sets the minimum length for the Data Element
 void setName(java.lang.String inname)
          sets the Data Element name
 void setRequired(char inRequired)
          sets the Data Element required
 void setSequence(int inSequence)
          sets the Data Element sequence
 void setType(java.lang.String inType)
          sets the Data Element type
 void setXMLTag(java.lang.String inXMLTag)
          sets the xml tag 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

type

protected java.lang.String type

sequence

protected int sequence

id

protected java.lang.String id

name

protected java.lang.String name

required

protected char required

referenceId

protected java.lang.String referenceId

minLength

protected int minLength

maxLength

protected int maxLength

description

protected java.lang.String description

xmlTag

protected java.lang.String xmlTag
Constructor Detail

TemplateDE

public TemplateDE()
constructs the Data Element type used for serialization

TemplateDE

public TemplateDE(java.lang.String inID,
                  java.lang.String inName,
                  int inSequence,
                  java.lang.String inType,
                  char inRequired,
                  java.lang.String inDesc,
                  int inMinLength,
                  int inMaxLength,
                  java.lang.String inXMLTag,
                  IDList inIDList)
constructs the Data Element type
Parameters:
String - id
String - name
int - sequence within segment or composite
String - type
char - required
int - minimum allowed length
int - maximum allowed length
String - xml tag
String - idListFile xml file name containing List information

TemplateDE

public TemplateDE(java.lang.String inID,
                  java.lang.String inName,
                  int inSequence,
                  java.lang.String inType,
                  char inRequired,
                  java.lang.String inDesc,
                  int inMinLength,
                  int inMaxLength,
                  java.lang.String inXMLTag)
constructs the Data Element type
Parameters:
String - id
String - name
int - sequence within segment or composite
String - type
char - required
int - minimum allowed length
int - maximum allowed length
String - xml tag

TemplateDE

public TemplateDE(java.lang.String inID,
                  java.lang.String inName,
                  int inSequence,
                  java.lang.String inType,
                  char inRequired,
                  java.lang.String inDesc,
                  int inMinLength,
                  int inMaxLength)
constructs the Data Element type
Parameters:
String - id
String - name
int - sequence within segment or composite
String - type
char - required
int - minimum allowed length
int - maximum allowed length
Method Detail

setType

public void setType(java.lang.String inType)
sets the Data Element type
Parameters:
String -  

getType

public java.lang.String getType()
gets the Data Element type
Returns:
String

setRequired

public void setRequired(char inRequired)
sets the Data Element required
Parameters:
char -  

getRequired

public char getRequired()
gets the Data Element required
Returns:
char

setID

public void setID(java.lang.String inID)
sets the Data Element id
Parameters:
String -  

getID

public java.lang.String getID()
gets the Data Element id
Specified by:
getID in interface IIdentifier
Returns:
String

setName

public void setName(java.lang.String inname)
sets the Data Element name
Parameters:
String -  

getName

public java.lang.String getName()
gets the Data Element name
Returns:
String

setSequence

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

getSequence

public int getSequence()
gets the Data Element sequence
Returns:
int

setMinLength

public void setMinLength(int inMinLength)
sets the minimum length for the Data Element
Parameters:
int -  

setMaxLength

public void setMaxLength(int inMaxLength)
sets the maximum length for the Data Element
Parameters:
int -  

getMinLength

public int getMinLength()
gets the minimum length for the Data Element
Returns:
int

getMaxLength

public int getMaxLength()
gets the maximum length for the Data Element
Returns:
int

setDescription

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

getDescription

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

setXMLTag

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

getXMLTag

public java.lang.String getXMLTag()
returns the xml tag field
Specified by:
getXMLTag in interface IIdentifier
Returns:
String tag value

setIDList

public void setIDList(IDList inIdList)
sets the idList Object
Parameters:
IDList -  

getIDList

public IDList getIDList()
gets the idList Object
Returns:
IDList

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 -