com.americancoders.edi
Class CharDE

java.lang.Object
  com.americancoders.edi.DataElement
      com.americancoders.edi.CharDE

All Implemented Interfaces:

IContainedObject, IIdentifier

public class CharDE

extends DataElement

class for all Data Elements defined as character and alphanumeric

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.

Field Summary

protected int	cursor
protected java.lang.String[]	value

Fields inherited from class com.americancoders.edi.DataElement

parent

Constructor Summary

CharDE(TemplateDE inTDE, IContainedObject inParent)
constructs from its template

Method Summary

java.lang.String	get() returns the value for the Data Element
java.lang.String	get(int inPos) returns the value for the Data Element
java.lang.String	getFormattedText(int formatType) formats text of data element Description of DataElement is defined in the class value is the current value set in the object
int	getLength() gets the current length for the Data Element
void	set(byte[] inValue) sets the fields contents, not formatted
void	set(java.lang.String inValue) sets the fields contents, cursor set to zero
void	setNext(java.lang.String inValue) sets the next field contents by moving cursor, cursor will wrap around
boolean	validate(DocumentErrors inDErr) sets error in DocumentErrors
java.lang.String	validate(java.lang.String inText) returns error responses of contents

Methods inherited from class com.americancoders.edi.DataElement

getDelimiter, getDescription, getFixedLengthFormattedText, getID, getMaxLength, getMinLength, getName, getOccurs, getParent, getRequired, getSequence, getTemplate, getType, getXMLTag, isUsed, setParent, toString

Methods inherited from class java.lang.Object

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

Field Detail

value

protected java.lang.String[] value

cursor

protected int cursor

Constructor Detail

CharDE

public CharDE(TemplateDE inTDE,
              IContainedObject inParent)

constructs from its template

Parameters:

inTDE - TemplateDE

inParent - owning Object

Method Detail

getLength

public int getLength()

gets the current length for the Data Element

Specified by:

getLength in class DataElement

Returns:

int retuns length of set value, can have a null exception if value is not set.

set

public void set(java.lang.String inValue)

sets the fields contents, cursor set to zero

Specified by:

set in class DataElement

Parameters:

inValue - String contents

Throws:

OBOEException

setNext

public void setNext(java.lang.String inValue)

sets the next field contents by moving cursor, cursor will wrap around

Specified by:

setNext in class DataElement

Parameters:

inValue - String contents

Throws:

OBOEException

set

public void set(byte[] inValue)
         throws OBOEException

sets the fields contents, not formatted

Specified by:

set in class DataElement

Parameters:

inValue - byte array, converted to string and set(String) is called

Throws:

OBOEException - inValue contains format characters if field defined with type of N#

get

public java.lang.String get()

returns the value for the Data Element

Specified by:

get in class DataElement

Returns:

String

get

public java.lang.String get(int inPos)

returns the value for the Data Element

Parameters:

inPos - int position in array

Returns:

String

getFormattedText

public java.lang.String getFormattedText(int formatType)

formats text of data element
Description of DataElement is defined in the class
value is the current value set in the object

Specified by:

getFormattedText in class DataElement

Parameters:

formatType - int format type x12, edifact...

Returns:

String of formatted text

validate

public java.lang.String validate(java.lang.String inText)

returns error responses of contents

Specified by:

validate in class DataElement

Parameters:

inText - String text

Returns:

String, null if no error

validate

public boolean validate(DocumentErrors inDErr)

sets error in DocumentErrors

Specified by:

validate in class DataElement

Parameters:

inDErr - DocumentErrors object

Returns:

boolean false = error.