Open Business Objects for EDI
v3.6.0

com.americancoders.edi
Class Table

java.lang.Object
  |
  +--com.americancoders.edi.SegmentContainer
        |
        +--com.americancoders.edi.LoopAndSegmentContainer
              |
              +--com.americancoders.edi.Table
All Implemented Interfaces:
IContainedObject, IIdentifier, ISegmentContainer

public class Table
extends LoopAndSegmentContainer
implements IContainedObject

class for Tables a general class for the transaction set's heading detail and summary.

OBOE - Open Business Objects for EDI

Part of the OBOE Basic Extended Package
An EDI and XML Translator Written In Java
Copyright 1998-2009 - 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:
3.6.0
Author:
Joe McVerry - American Coders, Ltd.

Field Summary
protected  com.americancoders.edi.IContainedObject parent
           
protected  java.lang.String xmlTag
          String XML tag
 
Fields inherited from class com.americancoders.edi.SegmentContainer
container, dupSegment, myTemplateContainer
 
Constructor Summary
Table(com.americancoders.edi.TemplateTable inTemplateTable, com.americancoders.edi.IContainedObject inParent)
          constructor
 
Method Summary
 java.lang.String getFormattedText(int formatType)
          returns a preformatted string
 java.lang.String getID()
          returns the table id, since there are no table ids method returns a zero-length string
 com.americancoders.edi.IContainedObject getParent()
          gets parent attribute
 com.americancoders.edi.TemplateSegmentContainer getTemplateSegmentContainer()
          return the Template
 com.americancoders.edi.TemplateTable getTemplateTable()
          return the tables template
 java.lang.String getXMLTag()
          returns the xml tag field
 void setParent(com.americancoders.edi.IContainedObject inParent)
          sets parent attribute
 void setXMLTag(java.lang.String inXMLTag)
          sets the xml tag field
 java.lang.String toString()
           
 void useDefault()
          sets the default value for the data elements
part of Extended Edition package
will create mandatory subsegments.
 boolean validate(com.americancoders.edi.DocumentErrors inDErr)
          validates if the container is defined correctly
doesn't throw exception, places error messages in DocumentErrors object
 void writeFormattedText(java.io.Writer inWriter, int formatType)
          writes a preformatted string
 
Methods inherited from class com.americancoders.edi.LoopAndSegmentContainer
addLoop, addLoopToVector, continueParse, createLoop, defineContainer, doYouWantThisNode, doYouWantThisSegment, equivalentLoops, getContainerSize, getCount, getCount, getLoop, getLoop, getLoop, getLoop, getLoopAndSegmentCount, getLoopByDataElementValue, getLoopCount, getLoopCount, getSegmentCount, getSegmentCount, getTemplateLoopContainer, getVector, isLoop, isLoop, isNull, isVector, parse, parse, parse, removeLoop, removeLoop, removeLoop, removeLoop, resetToFirstEquivalentLoop, setLoopAt, setLoopAt, setTemplateLoopContainer, trim, validate, whyNotUsed
 
Methods inherited from class com.americancoders.edi.SegmentContainer
addSegment, addSegment, addSegment, addSegmentToVector, createSegment, createSegment, createSegmentByIDAndName, equivalentSegments, getSegment, getSegment, getSegment, getSegment, getSegment, getSegment, getSegmentByDataElementValue, getSegmentCount, isSegment, isSegment, removeSegment, removeSegment, removeSegment, removeSegment, resetToFirstEquivalentSegment, setSegmentAt, setSegmentAt
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

xmlTag

protected java.lang.String xmlTag
String XML tag


parent

protected com.americancoders.edi.IContainedObject parent
Constructor Detail

Table

public Table(com.americancoders.edi.TemplateTable inTemplateTable,
             com.americancoders.edi.IContainedObject inParent)
constructor

Parameters:
inTemplateTable -
inParent - owning Object
Method Detail

getTemplateTable

public com.americancoders.edi.TemplateTable getTemplateTable()
return the tables template


getFormattedText

public java.lang.String getFormattedText(int formatType)
returns a preformatted string

Parameters:
formatType - int - x12, edifact...
Returns:
String formatted text

writeFormattedText

public void writeFormattedText(java.io.Writer inWriter,
                               int formatType)
                        throws java.io.IOException
writes a preformatted string

Parameters:
inWriter - writer object
formatType - int - x12, edifact...
java.io.IOException

getID

public java.lang.String getID()
returns the table id, since there are no table ids method returns a zero-length string

Specified by:
getID in interface IIdentifier
Specified by:
getID in class SegmentContainer
Returns:
String

setXMLTag

public void setXMLTag(java.lang.String inXMLTag)
sets the xml tag field

Parameters:
inXMLTag - String tag

getXMLTag

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

Specified by:
getXMLTag in interface IIdentifier
Returns:
String tag value

getTemplateSegmentContainer

public com.americancoders.edi.TemplateSegmentContainer getTemplateSegmentContainer()
return the Template

Specified by:
getTemplateSegmentContainer in interface ISegmentContainer
Returns:
TemplateSegmentContainer

useDefault

public void useDefault()
sets the default value for the data elements
part of Extended Edition package
will create mandatory subsegments.
if mandatory subsegment is part of vector (collection) will create the first one


validate

public boolean validate(com.americancoders.edi.DocumentErrors inDErr)
Description copied from class: LoopAndSegmentContainer
validates if the container is defined correctly
doesn't throw exception, places error messages in DocumentErrors object

Overrides:
validate in class LoopAndSegmentContainer
Returns:
boolean true if built correctly

setParent

public void setParent(com.americancoders.edi.IContainedObject inParent)
sets parent attribute

Specified by:
setParent in interface IContainedObject
Parameters:
inParent - TemplateSegmentContainer

getParent

public com.americancoders.edi.IContainedObject getParent()
gets parent attribute

Specified by:
getParent in interface IContainedObject
Returns:
TemplateSegmentContainer

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Open Business Objects for EDI
v3.6.0


OBOE is a trademark or registered trademark of American Coders, Ltd. in the US and other countries.
Copyright 1999-2004 American Coders, Ltd.
POB 97462
Raleigh NC 27624 USA
All Rights Reserved.