com.americancoders.edi
Class CompositeDE

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

public class CompositeDE
extends java.lang.Object
implements IDataElementContainer

class for all Composite Data Elements

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.

Field Summary
protected  java.lang.Object[] deArray
           
protected  java.lang.String id
           
protected  TemplateComposite myTemplate
           
protected  int sequence
           
protected  java.lang.String xmlTag
           
 
Constructor Summary
CompositeDE(java.lang.String inID)
          creates a compsosite with an id
CompositeDE(java.lang.String inID, int inSequence, java.lang.String inXMLTag)
          creates a composite with an id, sequence and a xmltag
CompositeDE(TemplateComposite inTemplateComposite)
          creates a compsosite using a templage
 
Method Summary
 void addDataElement(DataElement dataElementObject)
          sets a DataElement in the Container
 void buildDE(int pos)
          defines a dataelement by the predefined templateDE array
 java.lang.String get()
          returns all the data associated
 java.lang.String get(char separator)
          returns all the data associated
 DataElement getDataElement(int inSequence)
          returns a data element by its sequence number, not location within vector
 DataElement getDataElement(java.lang.String inID)
          returns a data element by its id
 int getDataElementSize()
          returns the number of defined data element
 java.lang.String getFormattedText(int formatType)
          returns the formatted text type == 1 returns XML format otherwise "description: value"
 java.lang.String getID()
          returns the id field
 int getSequence()
          returns the sequence
 java.lang.String getXMLTag()
          returns the xml tag field
 boolean parse(ITokenizer TransactionTokenizedString)
          parsing logic for compositeDE
 void parse(org.w3c.dom.Node node)
          parses a XML EDI Document adds to datalement vector
 void setSequence(int inSequence)
          sets the sequence
 void setXMLTag(java.lang.String inXMLTag)
          sets xmltag field
 
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

deArray

protected java.lang.Object[] deArray

xmlTag

protected java.lang.String xmlTag

myTemplate

protected TemplateComposite myTemplate

sequence

protected int sequence
Constructor Detail

CompositeDE

public CompositeDE(java.lang.String inID,
                   int inSequence,
                   java.lang.String inXMLTag)
creates a composite with an id, sequence and a xmltag
Parameters:
String - id
int - sequence
String - tag

CompositeDE

public CompositeDE(TemplateComposite inTemplateComposite)
creates a compsosite using a templage
Parameters:
templatecomposite -  

CompositeDE

public CompositeDE(java.lang.String inID)
creates a compsosite with an id
Parameters:
String - id
Method Detail

buildDE

public void buildDE(int pos)
defines a dataelement by the predefined templateDE array
Parameters:
int - position in templateDE array
Throws:
java.lang.Exception - thrown by data element instantiation.

setXMLTag

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

getID

public java.lang.String getID()
returns the id field
Returns:
String id value

getXMLTag

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

setSequence

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

getSequence

public int getSequence()
returns the sequence
Returns:
int

getDataElementSize

public int getDataElementSize()
returns the number of defined data element
Returns:
int DataElement count

getDataElement

public DataElement getDataElement(java.lang.String inID)
returns a data element by its id
Specified by:
getDataElement in interface IDataElementContainer
Parameters:
String - id of the data element
Returns:
DataElement

getDataElement

public DataElement getDataElement(int inSequence)
returns a data element by its sequence number, not location within vector
Specified by:
getDataElement in interface IDataElementContainer
Parameters:
int - sequence number of data element
Returns:
DataElement

addDataElement

public void addDataElement(DataElement dataElementObject)
sets a DataElement in the Container
Specified by:
addDataElement in interface IDataElementContainer
Parameters:
String - id of the DataElement
Returns:
DataElement DataElement object

parse

public boolean parse(ITokenizer TransactionTokenizedString)
              throws java.lang.Exception
parsing logic for compositeDE
Parameters:
ITokenizer - any tokenizable object

parse

public void parse(org.w3c.dom.Node node)
           throws java.lang.Exception
parses a XML EDI Document adds to datalement vector
Parameters:
Node - input XML node

get

public java.lang.String get()
returns all the data associated
Specified by:
get in interface IDataElementContainer
Returns:
String for all DataElements

get

public java.lang.String get(char separator)
                     throws java.lang.Exception
returns all the data associated
Parameters:
char - separator character
Returns:
String for all Dataelements
Throws:
java.lang.Exception - thrown when data is missing from a data element

getFormattedText

public java.lang.String getFormattedText(int formatType)
returns the formatted text