com.americancoders.edi
Class DateDE

java.lang.Object
  |
  +--com.americancoders.edi.DataElement
        |
        +--com.americancoders.edi.DateDE

public class DateDE
extends DataElement

class for Data Elements defined as Date

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.

Fields inherited from class com.americancoders.edi.DataElement
description, id, maxLength, minLength, referenceId, required, sequence, value, xmlTag
 
Constructor Summary
DateDE(java.lang.String inID, int inSequence, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength)
          constructs a DateDE object
DateDE(java.lang.String inID, int inSequence, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength, java.lang.String inXMLTag)
          constructs a DateDE object
DateDE(java.lang.String inDate, java.lang.String inID, int inSequence, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength)
          constructs a DateDE object using an input string in the format YYYYMMDD where YY is year MM is month, DD is day of month
 
Method Summary
 java.lang.String get()
          returns the date stored in YYYYMMDD format where YY is year MM is month, DD is day of month
 int get(int field)
          returns the date field as stored
 java.util.Calendar getCalendar()
          returns the calendar field as stored
 java.lang.String getFormattedText(int formatType)
          formats text of data element
Short Description of DataElement is defined in the class
value is the current value set in the object
 void set(int field, int value)
          sets a specific part of the date field
 void set(java.lang.String inDate)
          sets the value stored using an input string in the format YYYYMMDD where YY is year MM is month, DD is day of month
 
Methods inherited from class com.americancoders.edi.DataElement
getDescription, getID, getLength, getMaxLength, getMinLength, getRequired, getSequence, getType, getXMLTag, setDescription, setID, setMaxLength, setMinLength, setRequired, setSequence, setValue, setXMLTag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DateDE

public DateDE(java.lang.String inID,
              int inSequence,
              java.lang.String inDesc,
              char inRequired,
              int inMinLength,
              int inMaxLength,
              java.lang.String inXMLTag)
constructs a DateDE object
Parameters:
String - x12 id
int - sequence
String - description
char - required
int - minimum allowed length
int - maximum allowed length
String - xml tag

DateDE

public DateDE(java.lang.String inID,
              int inSequence,
              java.lang.String inDesc,
              char inRequired,
              int inMinLength,
              int inMaxLength)
constructs a DateDE object
Parameters:
String - x12 id
int - sequence
String - description
char - required
int - minimum allowed length
int - maximum allowed length

DateDE

public DateDE(java.lang.String inDate,
              java.lang.String inID,
              int inSequence,
              java.lang.String inDesc,
              char inRequired,
              int inMinLength,
              int inMaxLength)
constructs a DateDE object using an input string in the format YYYYMMDD where
Parameters:
String - x12 id
int - sequence
String - description
char - required
int - minimum allowed length
int - maximum allowed length
inDate - String field in format YYYYMMDD
Method Detail

get

public java.lang.String get()
returns the date stored in YYYYMMDD format where
Overrides:
get in class DataElement
Returns:
String in format YYYYMMDD

get

public int get(int field)
returns the date field as stored
Parameters:
int - field identifier
use the java.util.Calendar fields:
  1. YEAR,
  2. MONTH,
  3. DAY_OF_MONTH
Returns:
int
See Also:
Calendar

getCalendar

public java.util.Calendar getCalendar()
returns the calendar field as stored
Returns:
java.util.Calendar, or null if stored date value is empty
See Also:
Calendar

set

public void set(java.lang.String inDate)
sets the value stored using an input string in the format YYYYMMDD where
Overrides:
set in class DataElement
Parameters:
String - field in format YYYYMMDD

set

public void set(int field,
                int value)
sets a specific part of the date field
Parameters:
int - field identifier
use the java.util.Calendar fields:
  1. YEAR,
  2. MONTH,
  3. DAY_OF_MONTH
int - value
See Also:
Calendar

getFormattedText

public java.lang.String getFormattedText(int formatType)
formats text of data element
Short Description of DataElement is defined in the class
value is the current value set in the object
Overrides:
getFormattedText in class DataElement
Parameters:
int - formatType