Package com.softwaremining.wrappers.format

Class Format

java.lang.Object

com.softwaremining.wrappers.format.Format

Direct Known Subclasses:

AbstractNumericFormat, AlphaNumericFormat

public abstract class Format
extends Object

Provides a formatter that emulates COBOL's NumericFormatBinaryX (COMP-X) functionality in Java. Given a decimal value and a specified total digit count, this class:
1) encodes the value as a two's-complement binary integer in big-endian order
2) decodes raw binary data back into numeric values, preserving sign and magnitude
3) enforces correct byte length based on digit count
4) handles overflow when the value exceeds the representable range
This implementation delivers a native, high-performance Java equivalent of COBOL's COMP-X numeric binary format for mission-critical data-conversion workflows.

Field Summary

Fields

Modifier and Type	Field	Description
protected static HashMap<Integer,String>	additionalParamsPostfixesMap
protected boolean	justifiedRight
static long	totalRuntime_convertFromDisplayToStorage
static long	totalRuntime_getInstance

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Format()
protected	Format(char[] picture)	constructor

Method Summary

Modifier and Type	Method	Description
final void	assignJustifiedRight(boolean justifiedRight)
String	convertFromDisplayToStorage(double value)
protected abstract String	convertFromDisplayToStorage(double value, boolean[] sizeError)	format a value according to the PIC definition
String	convertFromDisplayToStorage(long value, boolean[] sizeError)	format a value according to the PIC definition
final String	convertFromDisplayToStorage(Object value, boolean[] sizeError)	format a value according to the PIC definition
String	convertFromDisplayToStorage(String value)	format a value according to the PIC definition
abstract String	convertFromDisplayToStorage(String value, boolean[] sizeError)	format a value according to the PIC definition
abstract String	convertFromDisplayToStorage(BigDecimal value, boolean[] sizeError)
abstract String	convertFromDisplayToStorage(BigInteger value, boolean[] sizeError)
abstract String	convertFromStorageToDisplayFormat(String formattedString)
protected static Collection<Format>	getAllFormatInstances()
static Format	getInstance(char[] picture, int additionalParam)
static Format	getInstance(String picture, int additionalParam)
abstract int	getNumberOfDigits()	Returns the number of integer digits of used for Integer and Decimal parts of a number.
char[]	getPicture()
abstract Object	getSQLObject(String formattedString)
abstract int	getStorageCellSize()	This is the number of characters in field.
abstract boolean	isCompressed()
final boolean	isJustifiedRight()
void	setPicture(char[] picture)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

totalRuntime_getInstance

public static long totalRuntime_getInstance

totalRuntime_convertFromDisplayToStorage

public static long totalRuntime_convertFromDisplayToStorage

justifiedRight

protected boolean justifiedRight

additionalParamsPostfixesMap

protected static HashMap<Integer,String> additionalParamsPostfixesMap

Constructor Details

Format

protected Format()

Format

protected Format(char[] picture)

constructor

Parameters:

picture -

Method Details

setPicture

public void setPicture(char[] picture)

getPicture

public char[] getPicture()

convertFromDisplayToStorage

public final String convertFromDisplayToStorage(Object value,
 boolean[] sizeError)

format a value according to the PIC definition

convertFromDisplayToStorage

public abstract String convertFromDisplayToStorage(String value,
 boolean[] sizeError)

format a value according to the PIC definition

convertFromDisplayToStorage

public String convertFromDisplayToStorage(String value)

format a value according to the PIC definition

convertFromDisplayToStorage

protected abstract String convertFromDisplayToStorage(double value,
 boolean[] sizeError)

format a value according to the PIC definition

convertFromDisplayToStorage

public String convertFromDisplayToStorage(double value)

convertFromDisplayToStorage

public String convertFromDisplayToStorage(long value,
 boolean[] sizeError)

format a value according to the PIC definition

convertFromDisplayToStorage

public abstract String convertFromDisplayToStorage(BigDecimal value,
 boolean[] sizeError)

convertFromDisplayToStorage

public abstract String convertFromDisplayToStorage(BigInteger value,
 boolean[] sizeError)

convertFromStorageToDisplayFormat

public abstract String convertFromStorageToDisplayFormat(String formattedString)

getStorageCellSize

public abstract int getStorageCellSize()

This is the number of characters in field.
For example, PIC X(10) will have 10 characters
or PIC 9(16) will have 16 characters
but PIC 9(16) COMP-3 will have 8 characters

Returns:

cellsize

isCompressed

public abstract boolean isCompressed()

getSQLObject

public abstract Object getSQLObject(String formattedString)

getInstance

public static Format getInstance(char[] picture,
 int additionalParam)

getInstance

public static Format getInstance(String picture,
 int additionalParam)

getAllFormatInstances

protected static Collection<Format> getAllFormatInstances()

assignJustifiedRight

public final void assignJustifiedRight(boolean justifiedRight)

isJustifiedRight

public final boolean isJustifiedRight()

getNumberOfDigits

public abstract int getNumberOfDigits()

Returns the number of integer digits of used for Integer and Decimal parts of a number. For example, given a definition of S9(5)v9(3); the NumberOfDigists is 11.

Returns:

toString

public String toString()

Overrides:

toString in class Object