com.americancoders.edi
Class NumericDE

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

public class NumericDE
extends DataElement

class for Data Elements defined as Numeric (Nx - where x is an integer representing number of decimal places)

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.

Field Summary
protected  int fractionDigits
           
 
Fields inherited from class com.americancoders.edi.DataElement
description, id, maxLength, minLength, referenceId, required, sequence, value, xmlTag
 
Constructor Summary
NumericDE(java.lang.String inID, int inSequence, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength)
          constructs a NumericDE object
NumericDE(java.lang.String inID, int inSequence, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength, java.lang.String inXMLTag)
          constructs a NumericDE object
NumericDE(java.lang.String inID, int inSequence, java.lang.String inType, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength)
          constructs a NumericDE object
NumericDE(java.lang.String inID, int inSequence, java.lang.String inType, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength, java.lang.String inXMLTag)
          constructs a NumericDE object
NumericDE(java.lang.String inNumber, java.lang.String inID, int inSequence, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength)
          constructs a NumericDE object using an input string
NumericDE(java.lang.String inNumber, java.lang.String inID, int inSequence, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength, java.lang.String inXMLTag)
          constructs a NumericDE object using an input string
NumericDE(java.lang.String inNumber, java.lang.String inID, int inSequence, java.lang.String inType, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength)
          constructs a NumericDE object
NumericDE(java.lang.String inNumber, java.lang.String inID, int inSequence, java.lang.String inType, java.lang.String inDesc, char inRequired, int inMinLength, int inMaxLength, java.lang.String inXMLTag)
          constructs a NumericDE object
 
Method Summary
 int getDecimalPositions()
          gets the number of decimal positions
 java.lang.String getFormattedText(int formatType)
          builds a formatted String of the object
 void setFormatted(java.lang.String inNumber)
          sets NumericDE object using an input string
use class set method to set values with assumed decimal
 
Methods inherited from class com.americancoders.edi.DataElement
get, getDescription, getID, getLength, getMaxLength, getMinLength, getRequired, getSequence, getType, getXMLTag, set, 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
 

Field Detail

fractionDigits

protected int fractionDigits
Constructor Detail

NumericDE

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

NumericDE

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

NumericDE

public NumericDE(java.lang.String inNumber,
                 java.lang.String inID,
                 int inSequence,
                 java.lang.String inDesc,
                 char inRequired,
                 int inMinLength,
                 int inMaxLength,
                 java.lang.String inXMLTag)
constructs a NumericDE object using an input string
Parameters:
inValue - String field in a numeric format
String - x12 id
int - sequence within structure
String - description
char - required
int - minimum allowed length
int - maximum allowed length
String - xml tag

NumericDE

public NumericDE(java.lang.String inNumber,
                 java.lang.String inID,
                 int inSequence,
                 java.lang.String inDesc,
                 char inRequired,
                 int inMinLength,
                 int inMaxLength)
constructs a NumericDE object using an input string
Parameters:
inValue - String field in a numeric format
String - x12 id
int - sequence within structure
String - description
char - required
int - minimum allowed length
int - maximum allowed length

NumericDE

public NumericDE(java.lang.String inID,
                 int inSequence,
                 java.lang.String inType,
                 java.lang.String inDesc,
                 char inRequired,
                 int inMinLength,
                 int inMaxLength,
                 java.lang.String inXMLTag)
constructs a NumericDE object
Parameters:
String - x12 id
int - sequence within structure
String - x12 type used to detemine the number of digits
String - description
char - required
int - minimum allowed length
int - maximum allowed length
String - xml tag

NumericDE

public NumericDE(java.lang.String inID,
                 int inSequence,
                 java.lang.String inType,
                 java.lang.String inDesc,
                 char inRequired,
                 int inMinLength,
                 int inMaxLength)
constructs a NumericDE object
Parameters:
String - x12 id
int - sequence within structure
String - x12 type used to detemine the number of digits
String - description
char - required
int - minimum allowed length
int - maximum allowed length

NumericDE

public NumericDE(java.lang.String inNumber,
                 java.lang.String inID,
                 int inSequence,
                 java.lang.String inType,
                 java.lang.String inDesc,
                 char inRequired,
                 int inMinLength,
                 int inMaxLength,
                 java.lang.String inXMLTag)
constructs a NumericDE object
Parameters:
String - value
String - x12 id
int - sequence within structure
String - x12 type used to detemine the number of digits
String - description
char - required
int - minimum allowed length
int - maximum allowed length
String - xml tag

NumericDE

public NumericDE(java.lang.String inNumber,
                 java.lang.String inID,
                 int inSequence,
                 java.lang.String inType,
                 java.lang.String inDesc,
                 char inRequired,
                 int inMinLength,
                 int inMaxLength)
constructs a NumericDE object
Parameters:
String - x12 value
String - x12 id
int - sequence within structure
String - x12 type used to detemine the number of digits
String - description
char - required
int - minimum allowed length
int - maximum allowed length
Method Detail

getDecimalPositions

public int getDecimalPositions()
gets the number of decimal positions
Returns:
int number of decimal positions

setFormatted

public void setFormatted(java.lang.String inNumber)
sets NumericDE object using an input string
use class set method to set values with assumed decimal
Parameters:
inValue - String field in a numeric format with decimal

getFormattedText

public java.lang.String getFormattedText(int formatType)
builds a formatted String of the object
Overrides:
getFormattedText in class DataElement
Parameters:
int - type
Returns:
String