|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.cs.invoker.base.BeanInvokerFormatter
Provides all Format/unFormat and Decoration APIs for C/S Connectivity usage
Field Summary | |
---|---|
static int |
DEFAULT_BUFFER_SIZE
|
Constructor Summary | |
---|---|
BeanInvokerFormatter()
|
Method Summary | |
---|---|
java.lang.String |
addCodeSetTranslator(java.lang.String requestData,
java.lang.String toCodeSet)
Modifies the strings using the specified code page. |
java.lang.String |
addCompressor(java.lang.String requestData)
Compresses and decompresses the data field contents by using the Deflater and Inflater classes in the java.util.zip package. |
java.lang.String |
addDelimiter(java.lang.String requestData,
java.lang.String delimChar)
Appends a delimiter character after a formatted string. |
java.lang.String |
addFixDataLength(java.lang.String requestData,
int length,
java.lang.String justify,
char padCharacter,
boolean noEmpty)
Adjusts a formatted string to a fixed length by either truncating it or by padding and justifying it. |
java.lang.String |
addIdentifier(java.lang.String requestData,
char idChar)
Prefixes or appends one character to the formatted string. |
java.lang.String |
addMaximumLength(java.lang.String requestData,
int maxLength)
Truncates the string if it is over the specified length. |
java.lang.Object |
addNullChecker(java.lang.Object requestData)
Handles conversions between strings and data Object when either the string is an empty string or the data has a null value. |
java.lang.String |
formatDate(java.util.Date requestData)
formatDate with default value |
java.lang.String |
formatDate(java.util.Date requestData,
boolean useSeparator,
java.lang.String ordering,
boolean isFourDigYear,
java.lang.String separator)
Formats a Date object. |
java.lang.String |
formatFloat(java.lang.Object requestData)
formatFloat with default value |
java.lang.String |
formatFloat(java.lang.Object requestData,
int size,
java.lang.String byteOrdering)
Formats a floating point number. |
java.lang.String |
formatInteger(java.lang.Object requestData)
formatInteger with default value |
java.lang.String |
formatInteger(java.lang.Object requestData,
int size,
java.lang.String byteOrdering)
Formats an integer from one to eight bytes in size. |
java.lang.String |
formatNumericString(java.lang.String requestData)
formatNumericString with default value |
java.lang.String |
formatNumericString(java.lang.String requestData,
int decPlaces,
char decimalsSepChar,
char thousandsSepChar,
boolean isShowDecimalsSep,
boolean isShowThousandsSep,
java.lang.String signRule,
java.lang.String usePositiveSign)
Formats a string of number characters. |
java.lang.String |
formatString(java.lang.String requestData)
formatString with default value |
java.lang.String |
formatString(java.lang.String requestData,
java.lang.String formatAs)
Format the String value. |
java.lang.String |
formatTime(java.util.Date requestData)
formatTime with default value |
java.lang.String |
formatTime(java.util.Date requestData,
boolean useSeparator,
java.lang.String hours,
boolean isShowSeconds,
java.lang.String separator,
java.lang.String amString,
java.lang.String pmString)
Formats a time in the Date object. |
TypedDataConverter |
getTypedDataConverter()
|
java.lang.String |
removeCodeSetTranslator(java.lang.String requestData,
java.lang.String toCodeSet)
Remove code set |
java.lang.String |
removeCompressor(java.lang.String requestData)
Remove Compressor |
java.lang.String |
removeCompressor(java.lang.String requestData,
int intArray)
Returns the uncompressed String resulting from aString. |
java.lang.String |
removeDelimiter(java.lang.String requestData,
java.lang.String delimiter)
Remove a delimiter at the end |
java.lang.String |
removeFixDataLength(java.lang.String requestData,
int length,
java.lang.String justify,
char padCharacter,
boolean noEmpty)
Remoe fix data length |
java.lang.String |
removeIdentifier(java.lang.String requestData,
char idChar)
Remove a Identifier |
java.util.Date |
unformatDate(java.lang.String requestData)
unformatDate with default value |
java.util.Date |
unformatDate(java.lang.String requestData,
boolean useSeparator,
java.lang.String ordering,
boolean isFourDigYear,
java.lang.String separator)
unFormats a Date object. |
java.lang.Object |
unformatFloat(java.lang.String requestData)
unformatFloat with default value |
java.lang.Object |
unformatFloat(java.lang.String requestData,
int size,
java.lang.String byteOrdering)
unFormats a floating point number. |
java.lang.Object |
unformatInteger(java.lang.String requestData)
unformatInteger with default value |
java.lang.Object |
unformatInteger(java.lang.String requestData,
int size,
java.lang.String byteOrdering,
boolean signRule)
unformats an integer from one to eight bytes in size |
java.lang.Number |
unformatNumericString(java.lang.String requestData)
unformatNumericString with default value |
java.lang.Number |
unformatNumericString(java.lang.String requestData,
int decPlaces,
char decimalsSepChar,
char thousandsSepChar,
boolean isShowDecimalsSep)
unFormats a string of number characters. |
java.lang.String |
unformatString(java.lang.String requestData)
unformatString with default value |
java.lang.String |
unformatString(java.lang.String requestData,
java.lang.String unformatAs)
unFormat the String value. |
java.util.Date |
unformatTime(java.lang.String requestData)
unformatTime with default value |
java.util.Date |
unformatTime(java.lang.String requestData,
boolean useSeparator,
java.lang.String hours,
boolean isShowSeconds,
java.lang.String separator,
java.lang.String amString,
java.lang.String pmString)
unFormats a time in the Date object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int DEFAULT_BUFFER_SIZE
Constructor Detail |
public BeanInvokerFormatter()
Method Detail |
public java.lang.String formatString(java.lang.String requestData, java.lang.String formatAs) throws DSEInvalidArgumentException
requestData
- Data needs to be formatformatAs
- "uppercase" or "lowercase" or "null(default)"
DSEInvalidArgumentException
public java.lang.String formatString(java.lang.String requestData) throws DSEInvalidArgumentException
requestData
- formatted request data
DSEInvalidArgumentException
public java.lang.String unformatString(java.lang.String requestData, java.lang.String unformatAs) throws DSEInvalidArgumentException
requestData
- Data needs to be formatunformatAs
- "uppercase" or "lowercase" or "null(default)"
DSEInvalidArgumentException
public java.lang.String unformatString(java.lang.String requestData) throws DSEInvalidArgumentException
requestData
- formatted request data
DSEInvalidArgumentException
public java.lang.String formatInteger(java.lang.Object requestData, int size, java.lang.String byteOrdering) throws DSEInvalidArgumentException
requestData
- Data needs to be formatsize
- The size of the float. The size of the integer. The valid values are: byteOrdering
- The byte ordering of the float. The valid values are pc (for little-endian) and host (for big-endian). The default value is pc.
DSEInvalidArgumentException
public java.lang.String formatInteger(java.lang.Object requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.lang.Object unformatInteger(java.lang.String requestData, int size, java.lang.String byteOrdering, boolean signRule) throws DSEInvalidArgumentException
requestData
- Data needs to be formatsize
- The size of the float. The size of the integer. The valid values are: byteOrdering
- The byte ordering of the float. The valid values are pc (for little-endian) and host (for big-endian). The default value is pc.signRule
- A boolean that indicates whether the integer uses a sign. The default value is no.
DSEInvalidArgumentException
public java.lang.Object unformatInteger(java.lang.String requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.lang.String formatNumericString(java.lang.String requestData, int decPlaces, char decimalsSepChar, char thousandsSepChar, boolean isShowDecimalsSep, boolean isShowThousandsSep, java.lang.String signRule, java.lang.String usePositiveSign) throws DSEInvalidArgumentException
requestData
- Data needs to be formatdecPlaces
- The number of positions to the right of decimal. The default value is 0.decimalsSepChar
- The character used as the decimal separator. The default is provided by the java.text.DecimalFormat class.thousandsSepChar
- The character used as the thousands separator. The default is provided by the java.text.DecimalFormat class.isShowDecimalsSep
- A boolean that indicates whether the string uses the decimal separator. The default value is yes.isShowThousandsSep
- A boolean that indicates whether the string uses the thousands separator. The default value is yes.signRule
- The rule used to display the sign. The valid values are:usePositiveSign
- The representation of the positive sign. The valid values are:DSEInvalidArgumentException
public java.lang.String formatNumericString(java.lang.String requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.lang.Number unformatNumericString(java.lang.String requestData, int decPlaces, char decimalsSepChar, char thousandsSepChar, boolean isShowDecimalsSep) throws DSEInvalidArgumentException
requestData
- String needs to be unformatdecPlaces
- The number of positions to the right of decimal. The default value is 0.decimalsSepChar
- The character used as the decimal separator. The default is provided by the java.text.DecimalFormat class.thousandsSepChar
- The character used as the thousands separator. The default is provided by the java.text.DecimalFormat class.isShowDecimalsSep
- A boolean that indicates whether the string uses the decimal separator. The default value is yes.
DSEInvalidArgumentException
public java.lang.Number unformatNumericString(java.lang.String requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.lang.String formatFloat(java.lang.Object requestData, int size, java.lang.String byteOrdering) throws DSEInvalidArgumentException
requestData
- Data needs to be formatsize
- The size of the float. The size of the integer. The valid values are: byteOrdering
- The byte ordering of the float. The valid values are pc (for little-endian) and host (for big-endian). The default value is pc.
DSEInvalidArgumentException
public java.lang.String formatFloat(java.lang.Object requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.lang.Object unformatFloat(java.lang.String requestData, int size, java.lang.String byteOrdering) throws DSEInvalidArgumentException
requestData
- Data needs to be formatsize
- The size of the float. The size of the integer. The valid values are:
DSEInvalidArgumentException
public java.lang.Object unformatFloat(java.lang.String requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.lang.String formatDate(java.util.Date requestData, boolean useSeparator, java.lang.String ordering, boolean isFourDigYear, java.lang.String separator) throws DSEInvalidArgumentException
requestData
- Data needs to be formatuseSeparator
- A boolean that indicates whether the date uses the separator character. The default value is yes.ordering
- The order in which the elements of a date appear. The valid values are:isFourDigYear
- A boolean that indicates whether the formatter uses four digits to represent the year. The default value is no.separator
- The character used to separate day, month, and year characters. The default value is the forward slash (/).
DSEInvalidArgumentException
public java.lang.String formatDate(java.util.Date requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.util.Date unformatDate(java.lang.String requestData, boolean useSeparator, java.lang.String ordering, boolean isFourDigYear, java.lang.String separator) throws DSEInvalidArgumentException
requestData
- Data needs to be formatuseSeparator
- A boolean that indicates whether the date uses the separator character. The default value is yes.ordering
- The order in which the elements of a date appear. The valid values are:isFourDigYear
- A boolean that indicates whether the formatter uses four digits to represent the year. The default value is no.separator
- The character used to separate day, month, and year characters. The default value is the forward slash (/).
DSEInvalidArgumentException
public java.util.Date unformatDate(java.lang.String requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.lang.String formatTime(java.util.Date requestData, boolean useSeparator, java.lang.String hours, boolean isShowSeconds, java.lang.String separator, java.lang.String amString, java.lang.String pmString) throws DSEInvalidArgumentException
requestData
- Data needs to be formatuseSeparator
- A boolean that indicates whether the time uses the separator character. The default value is yes.hours
- The type of clock. The valid values are:
12 (12 hours)
24 (24 hours) (default)isShowSeconds
- A boolean that indicates whether the time shows seconds. The default value is yes.separator
- The character used to separate day, month, and year characters. The default value is the forward slash (/).amString
- The String used to indicate morning. The default value is am.pmString
- The String used to indicate afternoon. The default value is pm.
DSEInvalidArgumentException
public java.lang.String formatTime(java.util.Date requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.util.Date unformatTime(java.lang.String requestData, boolean useSeparator, java.lang.String hours, boolean isShowSeconds, java.lang.String separator, java.lang.String amString, java.lang.String pmString) throws DSEInvalidArgumentException
requestData
- Data needs to be formatuseSeparator
- A boolean that indicates whether the time uses the separator character. The default value is yes.hours
- The type of clock. The valid values are:isShowSeconds
- A boolean that indicates whether the time shows seconds. The default value is yes.separator
- The character used to separate day, month, and year characters. The default value is the forward slash (/).amString
- The String used to indicate morning. The default value is am.pmString
- The String used to indicate afternoon. The default value is pm.
DSEInvalidArgumentException
public java.util.Date unformatTime(java.lang.String requestData) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.lang.String addDelimiter(java.lang.String requestData, java.lang.String delimChar) throws DSEInvalidArgumentException
requestData
- Data needs to be formatdelimChar
- The character to use as the delimiter. The default value is "+".
DSEInvalidArgumentException
public java.lang.String removeDelimiter(java.lang.String requestData, java.lang.String delimiter)
requestData
- Data needs to be formatdelimiter
- The character to use as the delimiter. The default value is "+".
public java.lang.String addIdentifier(java.lang.String requestData, char idChar) throws DSEInvalidArgumentException
requestData
- Data needs to be formatidChar
- The identifier for the element.
DSEInvalidArgumentException
public java.lang.String removeIdentifier(java.lang.String requestData, char idChar) throws DSEInvalidArgumentException
requestData
- idChar
-
DSEInvalidArgumentException
public java.lang.String addCompressor(java.lang.String requestData) throws DSEInvalidArgumentException
requestData
- Data needs to be format
DSEInvalidArgumentException
public java.lang.String removeCompressor(java.lang.String requestData) throws DSEInvalidArgumentException
requestData
-
DSEInvalidArgumentException
public java.lang.String removeCompressor(java.lang.String requestData, int intArray) throws DSEInvalidArgumentException
requestData
- intArray
-
DSEInvalidArgumentException
- - The exception descriptionpublic java.lang.String addFixDataLength(java.lang.String requestData, int length, java.lang.String justify, char padCharacter, boolean noEmpty) throws DSEInvalidArgumentException
requestData
- Data needs to be formatlength
- The length of the string after the decoration is applied.justify
- The justification to be applied to the string:padCharacter
- The character to use to pad the string so that it has the specified length.noEmpty
- A boolean that indicates whether to return the pad character when the resulting string is empty after applying the decorator. The default value is no.
DSEInvalidArgumentException
public java.lang.String removeFixDataLength(java.lang.String requestData, int length, java.lang.String justify, char padCharacter, boolean noEmpty) throws DSEInvalidArgumentException
requestData
- length
- justify
- padCharacter
- noEmpty
-
DSEInvalidArgumentException
public java.lang.String addMaximumLength(java.lang.String requestData, int maxLength) throws DSEInvalidArgumentException
requestData
- Data needs to be formatmaxLength
- The length of the string after the decoration is applied.
DSEInvalidArgumentException
public java.lang.String addCodeSetTranslator(java.lang.String requestData, java.lang.String toCodeSet) throws DSEInvalidArgumentException
requestData
- Data needs to be formattoCodeSet
- The value of the code page. The default value is "Cp037".
DSEInvalidArgumentException
public java.lang.String removeCodeSetTranslator(java.lang.String requestData, java.lang.String toCodeSet) throws DSEInvalidArgumentException
requestData
- toCodeSet
-
DSEInvalidArgumentException
public java.lang.Object addNullChecker(java.lang.Object requestData) throws DSEInvalidArgumentException
requestData
- Data needs to be format
DSEInvalidArgumentException
public TypedDataConverter getTypedDataConverter()
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |