com.americancoders.edi
Class TemplateTable

java.lang.Object
  |
  +--com.americancoders.edi.TemplateSegmentContainer
        |
        +--com.americancoders.edi.TemplateLoopContainer
              |
              +--com.americancoders.edi.TemplateTable

All Implemented Interfaces:

java.io.Externalizable, IContainedObject, IIdentifier, ITemplateSegmentContainer, java.io.Serializable

public class TemplateTable

extends TemplateLoopContainer

implements java.io.Externalizable, IContainedObject

class for Template 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.

See Also:

Serialized Form

Field Summary

protected java.lang.String

xmlTag String XML tag

Fields inherited from class com.americancoders.edi.TemplateSegmentContainer

templateContainer

Constructor Summary

TemplateTable()
constructor takes no parameters

TemplateTable(java.lang.String xmlTag, com.americancoders.edi.IContainedObject inParent)
Constructor

Method Summary

boolean	doYouWantThisNode(org.w3c.dom.Node node) tests if the node is part of this table
java.lang.String	getID() returns the table id, since there are no tables id it returns a zero-length string
com.americancoders.edi.IContainedObject	getParent() gets parent attribute
java.lang.String	getXMLTag() returns the xml tag field
void	readExternal(java.io.ObjectInput in) used by externalize methods
void	setParent(com.americancoders.edi.IContainedObject inParent) sets parent attribute
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 com.americancoders.edi.TemplateLoopContainer

addTemplateLoop, createSegment, getContainerSize, getTemplateLoop, getTemplateLoop, getTemplateLoopByIDAndName, isLoop

Methods inherited from class com.americancoders.edi.TemplateSegmentContainer

addTemplateSegment, getCount, getCount, getTemplateSegment, getTemplateSegment, getTemplateSegment, getTemplateSegmentByIDAndName, isSegment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

xmlTag

protected java.lang.String xmlTag

String XML tag

Constructor Detail

TemplateTable

public TemplateTable()

constructor takes no parameters

TemplateTable

public TemplateTable(java.lang.String xmlTag,
                     com.americancoders.edi.IContainedObject inParent)

Constructor

Parameters:

xmlTag - String XML tag

inParent - owning Object

Method Detail

doYouWantThisNode

public boolean doYouWantThisNode(org.w3c.dom.Node node)
                          throws OBOEException

tests if the node is part of this table

Parameters:

node - DOM node of transaction data

Returns:

boolean true it is part of this table

Throws:

OBOEException - thrown when the transaction id string is incorrect

OBOEException - thrown when an unknown segment id string is foundi

getID

public java.lang.String getID()

returns the table id, since there are no tables id it returns a zero-length string

Specified by:

getID in interface IIdentifier

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

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:

in - ObjectInput 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:

out - ObjectOutput stream

Throws:

java.io.IOException - java.io error

setParent

public void setParent(com.americancoders.edi.IContainedObject inParent)

sets parent attribute

Specified by:

setParent in interface IContainedObject

Parameters:

inParent - templateContainer

getParent

public com.americancoders.edi.IContainedObject getParent()

gets parent attribute

Specified by:

getParent in interface IContainedObject

Returns:

templateContainer