com.americancoders.edi
Class TemplateSegment

java.lang.Object
  com.americancoders.edi.TemplateSegment

All Implemented Interfaces:

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

public class TemplateSegment

extends java.lang.Object

implements java.io.Externalizable, IContainedObject, ITemplateElementContainer

TemplateSegment holds preliminary segment structure

OBOE - Open Business Objects for EDI

Part of the OBOE Basic Extended Package
An EDI and XML Translator Written In Java
Copyright 1998-2007 - 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.5.2

Author:

Joe McVerry - American Coders, Ltd.

See Also:

Serialized Form

Field Summary

protected java.lang.String	description segment description
protected java.lang.String	id segment id
protected java.lang.String	name segment name
protected int	occurs segment how many times it can occur
protected IContainedObject	parent
protected char	required segment required indicator
protected int	sequence segment sequence within table or parent segment
protected boolean	used
protected java.lang.String	xmlTag segment XML tag

Constructor Summary

TemplateSegment()
templateSegment constructor used by externalize mehtods

TemplateSegment(java.lang.String inId, java.lang.String inName, int inSequence, java.lang.String inDescription, int inOccurs, char inRequired, java.lang.String inXMLTag, boolean inUsed, IContainedObject inParent)
templateSegment, there are two flavors of segments Templates and regular templates are used to define a segment dynamically and are used to build the static form of segments contains template data elements and secondary segments

Method Summary

void	addTemplateComposite(TemplateComposite inTemplateComposite) adds TemplateComposite to container checks for duplicate entry at sequence position
void	addTemplateDE(TemplateDE inTemplateDE) adds TemplateDE to container checks for duplicate entry at sequence position
boolean	canYouPrevalidate() returns true if the template segment can prevalidate an incoming edi transaction segment.
int	doYouUseThisElement(java.lang.String inID, int startAt) routine to ask if it uses a dataelement
int	doYouUseThisXMLElement(java.lang.String inXML, int startAt) routine to ask if it uses a dataelement
char	getDelimiter(char inOriginal) returns the new delimiter based on the old delimiter
java.lang.String	getDescription() returns the Description for the Segment
java.util.Vector	getElementRules() returns entire elementrule vector
java.lang.String	getID() gets TemplateSegment id
IDListProcessor	getIDListThatPrevalidates() returns the idlist that allows for prevalidation used by OBOECodeGenerator
java.lang.String	getName() gets TemplateSegment name
int	getOccurs() gets occurance value
IContainedObject	getParent() gets parent attribute
char	getRequired() gets required flag
int	getSequence() gets sequence id
TemplateComposite	getTemplateComposite(int at) gets TemplateComposite from TemplateDE container
TemplateComposite	getTemplateComposite(java.lang.String id) gets TemplateComposite from TemplateDE container
TemplateDE	getTemplateDE(int at) gets TemplateDE from TemplateDE container
TemplateDE	getTemplateDE(java.lang.String id) gets TemplateDE from TemplateDE container
int	getTemplateDESize() returns the number of templateDEs
java.lang.String	getXMLTag() returns the xml tag field
boolean	isTemplateComposite(int at) tests if the element at a position is a TemplateComposite
boolean	isTemplateDE(int at) tests if the element at a position is a TemplateDE
boolean	isThisYou(ITokenizer inToken) looking into the tokenized string we ask the first idde field if the data in the same position is one of its codes
boolean	isThisYou(java.lang.String primaryIDValue) ask the first idde field if the data in the same position is one of its codes
boolean	isUsed() returns used attribute
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 TemplateSegment id
void	setName(java.lang.String inName) sets TemplateSegment name
void	setOccurs(int inOccurs) sets occurance value
void	setParent(IContainedObject inParent) sets parent attribute
void	setRequired(char inRequired) sets required value
void	setSequence(int inSequence) sets sequence id
void	setUsed(boolean used) sets used attribute
void	setXMLTag(java.lang.String inXMLTag) sets the xmlTag field
void	whyNotYou(Tokenizer et, SegmentContainer errContainer) asking template what parsing id field it doesn't like so that it would create a prevalidated segment.
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

segment id

name

protected java.lang.String name

segment name

sequence

protected int sequence

segment sequence within table or parent segment

description

protected java.lang.String description

segment description

xmlTag

protected java.lang.String xmlTag

segment XML tag

occurs

protected int occurs

segment how many times it can occur

required

protected char required

segment required indicator

used

protected boolean used

parent

protected IContainedObject parent

Constructor Detail

TemplateSegment

public TemplateSegment()

templateSegment constructor used by externalize mehtods

TemplateSegment

public TemplateSegment(java.lang.String inId,
                       java.lang.String inName,
                       int inSequence,
                       java.lang.String inDescription,
                       int inOccurs,
                       char inRequired,
                       java.lang.String inXMLTag,
                       boolean inUsed,
                       IContainedObject inParent)

templateSegment, there are two flavors of segments Templates and regular

templates are used to define a segment dynamically

and are used to build the static form of segments

contains template data elements and secondary segments

Parameters:

inId - String id

inName - String name

inSequence - int sequence within seg or comp

inDescription - String description

inOccurs - int for multiple occurring segments

inRequired - char required indicator

inXMLTag - String XML tag

inUsed - boolean

inParent - owning Object

Method Detail

isUsed

public boolean isUsed()

returns used attribute

Returns:

boolean

setUsed

public void setUsed(boolean used)

sets used attribute

Parameters:

used - boolean

getTemplateDESize

public int getTemplateDESize()

returns the number of templateDEs

Specified by:

getTemplateDESize in interface ITemplateElementContainer

Returns:

int

setID

public void setID(java.lang.String inID)

sets TemplateSegment id

Parameters:

inID - String id

setName

public void setName(java.lang.String inName)

sets TemplateSegment name

Parameters:

inName - String name

getID

public java.lang.String getID()

gets TemplateSegment id

Specified by:

getID in interface IIdentifier

Returns:

String

getName

public java.lang.String getName()

gets TemplateSegment name

Returns:

string name

setSequence

public void setSequence(int inSequence)

sets sequence id

Parameters:

inSequence - int sequence within table or parent segment

getSequence

public int getSequence()

gets sequence id

Returns:

int sequence

setDescription

public void setDescription(java.lang.String inDesc)

sets Description for the Segmemt

Parameters:

inDesc - String description

getDescription

public java.lang.String getDescription()

returns the Description for the Segment

Returns:

String

setOccurs

public void setOccurs(int inOccurs)

sets occurance value

Parameters:

inOccurs - int

getOccurs

public int getOccurs()

gets occurance value

Returns:

int occurs

setRequired

public void setRequired(char inRequired)

sets required value

Parameters:

inRequired - char

getRequired

public char getRequired()

gets required flag

Returns:

char required

setXMLTag

public void setXMLTag(java.lang.String inXMLTag)

sets the xmlTag field

Parameters:

inXMLTag - String XML tag

getXMLTag

public java.lang.String getXMLTag()

returns the xml tag field

Specified by:

getXMLTag in interface IIdentifier

Returns:

String tag value

addTemplateComposite

public void addTemplateComposite(TemplateComposite inTemplateComposite)
                          throws OBOEException

adds TemplateComposite to container
checks for duplicate entry at sequence position

Specified by:

addTemplateComposite in interface ITemplateElementContainer

Parameters:

inTemplateComposite - TemplateComposite to add

Throws:

OBOEException - - Sequence position already filled

addTemplateDE

public void addTemplateDE(TemplateDE inTemplateDE)

adds TemplateDE to container
checks for duplicate entry at sequence position

Specified by:

addTemplateDE in interface ITemplateElementContainer

Parameters:

inTemplateDE - TemplateDE to add

Throws:

OBOEException - -Sequence position already filled

isTemplateDE

public boolean isTemplateDE(int at)

tests if the element at a position is a TemplateDE

Specified by:

isTemplateDE in interface ITemplateElementContainer

Parameters:

at - int position
position is relative to 1.

Returns:

boolean

isTemplateComposite

public boolean isTemplateComposite(int at)

tests if the element at a position is a TemplateComposite

Specified by:

isTemplateComposite in interface ITemplateElementContainer

Parameters:

at - int position
position is relative to 1.

Returns:

boolean

getTemplateComposite

public TemplateComposite getTemplateComposite(int at)

gets TemplateComposite from TemplateDE container

Parameters:

at - int position
position is relative to 1.

Returns:

TemplateComposite

getTemplateComposite

public TemplateComposite getTemplateComposite(java.lang.String id)

gets TemplateComposite from TemplateDE container

Parameters:

id - String id

Returns:

TemplateComposite

getTemplateDE

public TemplateDE getTemplateDE(int at)

gets TemplateDE from TemplateDE container

Parameters:

at - int position
position is relative to 1.

Returns:

TemplateDE

getTemplateDE

public TemplateDE getTemplateDE(java.lang.String id)

gets TemplateDE from TemplateDE container

Parameters:

id - String id

Returns:

TemplateDE

doYouUseThisElement

public int doYouUseThisElement(java.lang.String inID,
                               int startAt)

routine to ask if it uses a dataelement

Parameters:

inID - String id

Returns:

boolen true the segment id is part of this group

doYouUseThisXMLElement

public int doYouUseThisXMLElement(java.lang.String inXML,
                                  int startAt)

routine to ask if it uses a dataelement

Parameters:

inXML - String xml tag

startAt - int starting position

Returns:

boolen true the segment id is part of this group

getElementRules

public java.util.Vector getElementRules()

returns entire elementrule vector

Returns:

Vector of element rules
or null in Basic Edition

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(IContainedObject inParent)

sets parent attribute

Specified by:

setParent in interface IContainedObject

Parameters:

inParent - TemplateSegmentContainer

getParent

public IContainedObject getParent()

gets parent attribute

Specified by:

getParent in interface IContainedObject

Returns:

TemplateSegmentContainer

canYouPrevalidate

public boolean canYouPrevalidate()

returns true if the template segment can prevalidate an incoming edi transaction segment. If yes then this incoming segment is the segment.
implemented for HIPAA

prevalidation requirement
• at least one mandatory ID field

Returns:

boolean

getIDListThatPrevalidates

public IDListProcessor getIDListThatPrevalidates()

returns the idlist that allows for prevalidation used by OBOECodeGenerator

Returns:

IDListProcessor

isThisYou

public boolean isThisYou(ITokenizer inToken)

looking into the tokenized string we ask the first idde field if the data in the same position is one of its codes

Returns:

boolean

isThisYou

public boolean isThisYou(java.lang.String primaryIDValue)

ask the first idde field if the data in the same position is one of its codes

Parameters:

primaryIDValue - String to search on

Returns:

boolean

whyNotYou

public void whyNotYou(Tokenizer et,
                      SegmentContainer errContainer)

asking template what parsing id field it doesn't like so that it would create a prevalidated segment.

Returns:

string

getDelimiter

public char getDelimiter(char inOriginal)

Description copied from interface: IContainedObject

returns the new delimiter based on the old delimiter

Specified by:

getDelimiter in interface IContainedObject

Parameters:

inOriginal -

Returns:

newDelimiter character