oracle.dss.util.format
Class BaseViewFormat

java.lang.Object
  oracle.dss.util.format.BaseViewFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Mergeable, MergeableXML

Direct Known Subclasses:

ViewFormat

public class BaseViewFormat
extends java.lang.Object
implements MergeableXML

Contains format properties for numbers.

See Also:

Serialized Form

Field Summary

static java.lang.String	a_currencySymbol
protected static java.lang.String	a_currencySymbolUsed
static java.lang.String	a_decimalDigit
protected static java.lang.String	a_decimalDigitUsed
static java.lang.String	a_decimalSeparator
protected static java.lang.String	a_decimalSeparatorUsed
static java.lang.String	a_ISOC
static java.lang.String	a_javaDateFormat
protected static java.lang.String	a_javaDateFormatUsed
static java.lang.String	a_leadingZero
protected static java.lang.String	a_leadingZeroUsed
static java.lang.String	a_negCurFmt
protected static java.lang.String	a_negCurFmtUsed
static java.lang.String	a_negNumFmt
protected static java.lang.String	a_negNumFmtUsed
static java.lang.String	a_negPctFmt
protected static java.lang.String	a_negPctFmtUsed
static java.lang.String	a_nfs
static java.lang.String	a_nft
static java.lang.String	a_numberType
protected static java.lang.String	a_numberTypeUsed
static java.lang.String	a_oracleDateFormat
protected static java.lang.String	a_oracleDateFormatUsed
static java.lang.String	a_posCurFmt
protected static java.lang.String	a_posCurFmtUsed
static java.lang.String	a_posNumFmt
protected static java.lang.String	a_posNumFmtUsed
static java.lang.String	a_scaleDownBillions
protected static java.lang.String	a_scaleDownBillionsUsed
static java.lang.String	a_scaleDownMillions
protected static java.lang.String	a_scaleDownMillionsUsed
static java.lang.String	a_scaleDownQuadrillions
protected static java.lang.String	a_scaleDownQuadrillionsUsed
static java.lang.String	a_scaleDownThousands
protected static java.lang.String	a_scaleDownThousandsUsed
static java.lang.String	a_scaleDownTrillions
protected static java.lang.String	a_scaleDownTrillionsUsed
static java.lang.String	a_scaleFactor
protected static java.lang.String	a_scaleFactorUsed
static java.lang.String	a_thousandSeparator
protected static java.lang.String	a_thousandSeparatorUsed
static int	BIBEANS_PATTERN_STR
protected static java.lang.String	currencySymbol
static int	CURRENCYSYMBOL
protected static boolean	currencySymbolUsed
static int	DATATYPE_BOOLEAN Data type: boolean.
static int	DATATYPE_DATE Data type: Date.
static int	DATATYPE_DOUBLE Data type: double.
static int	DATATYPE_FLOAT Data type: float.
static int	DATATYPE_INT Data type: integer.
static int	DATATYPE_LONG Data type: long.
static int	DATATYPE_SHORT Data type: short.
static int	DATATYPE_STRING Data type: String.
static int	DATATYPE_TIME Data type: Time.
static int	DATATYPE_TIMESTAMP Data type: Timestamp.
protected static int	DATE_FORMAT_BIT
protected static java.lang.String	dateFormat
static int	DATEFORMAT
protected static boolean	dateFormatUsed
protected static boolean	DEBUG
protected static java.lang.String	dec_sep_by_locale
static char	DEC_SEP_BY_LOCALE Decimal separator, based on locale.
protected static int	decimalDigit
static int	DECIMALDIGIT
protected static boolean	decimalDigitUsed
protected static char	decimalSeparator
static int	DECIMALSEPARATOR
protected static boolean	decimalSeparatorUsed
static java.lang.String	DEFAULT_CURRENCY_SYMBOL Currency symbol default: "$".
static boolean	DEFAULT_LEADING_ZERO Leading zero default: true.
static int	DEFAULT_NEG_CUR_FMT Negative currency format default for US English: "($1)".
static int	DEFAULT_NEG_NUM_FMT Negative number format default for US English: -1.
static java.lang.String	DEFAULT_NULL_STRING Null string default: " ".
static int	DEFAULT_NUM_TYPE Number type default: a general number.
static int	DEFAULT_POS_CUR_FMT Positive currency format default for US English: "$1".
static int	DEFAULT_POS_NUM_FMT Positive number format default for US English: "1".
static java.lang.String	DEFAULT_SCALE_DOWN_BILLIONS_STRING Default string for numbers that are scaled to billions: based on locale.
static java.lang.String	DEFAULT_SCALE_DOWN_MILLIONS_STRING Default string for numbers that are scaled to millions: based on locale.
static java.lang.String	DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING Default string for numbers that are scaled to quadrillions: based on locale.
static java.lang.String	DEFAULT_SCALE_DOWN_THOUSANDS_STRING Default string for numbers that are scaled to thousands: based on locale.
static java.lang.String	DEFAULT_SCALE_DOWN_TRILLIONS_STRING Default string for numbers that are scaled to trillions: based on locale.
static int	DEFAULT_SCALE_FACTOR Scale factor default: none.
static int	DEFAULT_SCALE_FACTOR_EXPONENT
protected static boolean	ISOC
protected static boolean	leadingZero
static int	LEADINGZERO
protected static boolean	leadingZeroUsed
protected boolean	m_bUseCallback
protected java.util.BitSet	m_formatUsedFlags
protected static java.lang.String	m_version_2_4_0_16
protected static java.lang.String	m_version_2_4_0_6
protected BaseViewFormatCallback	m_vfCallback
static int	MAX_DATATYPE
static int	MAX_NEG_CURFMT
static int	MAX_NEG_NUMFMT
static int	MAX_NEG_PCTFMT
static int	MAX_NUMTYPE
static int	MAX_POS_CURFMT
static int	MAX_POS_NUMFMT
static int	MAX_SCALEFACTOR
static int	MIN_DATATYPE
static int	MIN_NEG_CURFMT
static int	MIN_NEG_NUMFMT
static int	MIN_NEG_PCTFMT
static int	MIN_NUMTYPE
static int	MIN_POS_CURFMT
static int	MIN_POS_NUMFMT
static int	MIN_SCALEFACTOR
static int	NEG_CURFMT_BY_LOCALE Negative currency format, based on locale.
protected static java.lang.String	neg_curfmt_cur_neg_num
static int	NEG_CURFMT_CUR_NEG_NUM Negative currency format: "$-1".
protected static java.lang.String	neg_curfmt_cur_num_neg
static int	NEG_CURFMT_CUR_NUM_NEG Negative currency format: "$1-".
protected static java.lang.String	neg_curfmt_cur_spac_neg_num
static int	NEG_CURFMT_CUR_SPAC_NEG_NUM
protected static java.lang.String	neg_curfmt_cur_spac_num_neg
static int	NEG_CURFMT_CUR_SPAC_NUM_NEG
protected static java.lang.String	neg_curfmt_loc
protected static java.lang.String	neg_curfmt_neg_cur_num
static int	NEG_CURFMT_NEG_CUR_NUM Negative currency format: "-$1".
protected static java.lang.String	neg_curfmt_neg_cur_spac_num
static int	NEG_CURFMT_NEG_CUR_SPAC_NUM Negative currency format: "-$ 1".
protected static java.lang.String	neg_curfmt_neg_num_cur
static int	NEG_CURFMT_NEG_NUM_CUR Negative currency format: "(-1$)".
protected static java.lang.String	neg_curfmt_neg_num_spac_cur
static int	NEG_CURFMT_NEG_NUM_SPAC_CUR Negative currency format: "-1 $".
protected static java.lang.String	neg_curfmt_num_cur_neg
static int	NEG_CURFMT_NUM_CUR_NEG Negative currency format: "1$-".
protected static java.lang.String	neg_curfmt_num_neg_cur
static int	NEG_CURFMT_NUM_NEG_CUR Negative currency format: "1-$".
protected static java.lang.String	neg_curfmt_num_spac_cur_neg
static int	NEG_CURFMT_NUM_SPAC_CUR_NEG Negative currency format: "1 $-".
protected static java.lang.String	neg_curfmt_op_cur_num_cp
static int	NEG_CURFMT_OP_CUR_NUM_CP Negative currency format: "($1)".
protected static java.lang.String	neg_curfmt_op_num_cur_cp
static int	NEG_CURFMT_OP_NUM_CUR_CP Negative currency format: "(1$)".
static int	NEG_NUMFMT_BY_LOCALE Negative number format, based on locale.
protected static java.lang.String	neg_numfmt_loc
protected static java.lang.String	neg_numfmt_neg_num
static int	NEG_NUMFMT_NEG_NUM Negative number format: "-1".
protected static java.lang.String	neg_numfmt_num
static int	NEG_NUMFMT_NUM Negative number format: "1".
protected static java.lang.String	neg_numfmt_num_neg
static int	NEG_NUMFMT_NUM_NEG Negative number format: "1-".
protected static java.lang.String	neg_numfmt_op_num_cp
static int	NEG_NUMFMT_OP_NUM_CP Negative number format: "(1)".
protected static java.lang.String	neg_pctfmt_neg_num_pct
static int	NEG_PCTFMT_NEG_NUM_PCT
protected static java.lang.String	neg_pctfmt_op_num_pct_cp
static int	NEG_PCTFMT_OP_NUM_PCT_CP
protected static int	negCurFmt
static int	NEGCURFMT
protected static boolean	negCurFmtUsed
protected static int	negNumFmt
static int	NEGNUMFMT
protected static boolean	negNumFmtUsed
protected static int	negPctFmt
protected static boolean	negPctFmtUsed
protected static int	numberType
static int	NUMBERTYPE
protected static boolean	numberTypeUsed
protected static java.lang.String	numtype_currency
static int	NUMTYPE_CURRENCY Number type: currency.
protected static java.lang.String	numtype_general
static int	NUMTYPE_GENERAL Number type: general.
protected static java.lang.String	numtype_percent
static int	NUMTYPE_PERCENT Multiplies the given number by 100 and then adds % symbol to it.
protected static java.lang.String	numtype_percent_s
static int	NUMTYPE_PERCENT_SYMBOL
static int	OEO_PATTERN_STR Format String type: Oracle Express Objects (OEO) Number Format Mask The number format string represents a traditional OLAP-formatted String in the following format:
static java.lang.String	off
static java.lang.String	on
protected static java.lang.String	oracle_neg_cur_const
static int	ORACLE_NEG_CUR_CONST
protected static java.lang.String	oracle_neg_num_const
static int	ORACLE_NEG_NUM_CONST
static int	ORACLE_PATTERN_STR Format String type: Oracle RDBMS Number Format Mask The number format string represents a standard Oracle RDBMS number format mask.
static int	ORACLE_POS_CUR_CONST
protected static java.lang.String	oracle_pos_num_const
static int	ORACLE_POS_NUM_CONST
static int	ORACLEDATEFORMAT
static int	POS_CURFMT_BY_LOCALE Positive currency format, based on locale.
protected static java.lang.String	pos_curfmt_cur_num
static int	POS_CURFMT_CUR_NUM Positive currency format: "$1".
protected static java.lang.String	pos_curfmt_cur_num_pos
static int	POS_CURFMT_CUR_NUM_POS Positive currency format: "$1+".
protected static java.lang.String	pos_curfmt_cur_spac_num
static int	POS_CURFMT_CUR_SPAC_NUM Positive currency format: "$ 1".
protected static java.lang.String	pos_curfmt_loc
protected static java.lang.String	pos_curfmt_num_cur
static int	POS_CURFMT_NUM_CUR Positive currency format: "1$".
protected static java.lang.String	pos_curfmt_num_cur_pos
static int	POS_CURFMT_NUM_CUR_POS Positive currency format: "1$+".
protected static java.lang.String	pos_curfmt_num_pos_cur
static int	POS_CURFMT_NUM_POS_CUR Positive currency format: "1+$".
protected static java.lang.String	pos_curfmt_num_spac_cur
static int	POS_CURFMT_NUM_SPAC_CUR Positive currency format: "1 $".
protected static java.lang.String	pos_curfmt_num_spac_cur_pos
static int	POS_CURFMT_NUM_SPAC_CUR_POS Positive currency format: "1 $+".
protected static java.lang.String	pos_curfmt_pos_cur_num
static int	POS_CURFMT_POS_CUR_NUM Positive currency format: "+$1".
protected static java.lang.String	pos_curfmt_pos_cur_spac_num
static int	POS_CURFMT_POS_CUR_SPAC_NUM Positive currency format: "+$ 1".
protected static java.lang.String	pos_curfmt_pos_num_cur
static int	POS_CURFMT_POS_NUM_CUR Positive currency format: "+1$".
protected static java.lang.String	pos_curfmt_pos_num_spac_cur
static int	POS_CURFMT_POS_NUM_SPAC_CUR Positive currency format: "+1 $".
static int	POS_NUMFMT_BY_LOCALE Positive number format, based on locale.
protected static java.lang.String	pos_numfmt_loc
protected static java.lang.String	pos_numfmt_num
static int	POS_NUMFMT_NUM Positive number format: "1".
protected static java.lang.String	pos_numfmt_num_pos
static int	POS_NUMFMT_NUM_POS Positive number format: "1+".
protected static java.lang.String	pos_numfmt_pos_num
static int	POS_NUMFMT_POS_NUM Positive number format: "+1".
protected static int	posCurFmt
static int	POSCURFMT
protected static boolean	posCurFmtUsed
protected static int	posNumFmt
static int	POSNUMFMT
protected static boolean	posNumFmtUsed
protected static java.lang.String	scale_down_sym_loc
static java.lang.String	SCALE_DOWN_SYMBOL_BY_LOCALE Scale down symbol, based on locale.
protected static java.lang.String	scaleDownBillions
static int	SCALEDOWNBILLIONS
protected static boolean	scaleDownBillionsUsed
protected static java.lang.String	scaleDownMillions
static int	SCALEDOWNMILLIONS
protected static boolean	scaleDownMillionsUsed
protected static java.lang.String	scaleDownQuadrillions
static int	SCALEDOWNQUADRILLIONS
protected static boolean	scaleDownQuadrillionsUsed
protected static java.lang.String	scaleDownThousands
static int	SCALEDOWNTHOUSANDS
protected static boolean	scaleDownThousandsUsed
protected static java.lang.String	scaleDownTrillions
static int	SCALEDOWNTRILLIONS
protected static boolean	scaleDownTrillionsUsed
protected static int	scaleFactor
static int	SCALEFACTOR
static int	SCALEFACTOR_BASE_10
protected static java.lang.String	scalefactor_billions
static int	SCALEFACTOR_BILLIONS Scale factor: billions.
static int	SCALEFACTOR_EXPONENT
protected static java.lang.String	scalefactor_millions
static int	SCALEFACTOR_MILLIONS Scale factor: millions.
protected static java.lang.String	scalefactor_none
static int	SCALEFACTOR_NONE Scale factor: none.
protected static java.lang.String	scalefactor_quadrillions
static int	SCALEFACTOR_QUADRILLIONS Scale factor: quadrillions.
protected static java.lang.String	scalefactor_thousands
static int	SCALEFACTOR_THOUSANDS Scale factor: thousands.
protected static java.lang.String	scalefactor_trillions
static int	SCALEFACTOR_TRILLIONS Scale factor: trillions.
protected static boolean	scaleFactorUsed
protected static java.lang.String	thou_sep_by_locale
static char	THOU_SEP_BY_LOCALE Thousands separator, based on locale.
protected static char	thousandSeparator
static int	THOUSANDSEPARATOR
protected static boolean	thousandSeparatorUsed
static int	UNKNOWN_PATTERN_STR Format String type: Unknown Number Format Mask.
static java.lang.String	VIEW_FORMAT_NAME
protected static int	VIEWFORMAT_END

Constructor Summary

BaseViewFormat()
Constructor that uses default ViewFormat values.

BaseViewFormat(int numberType, char thousandSeparator, char decimalSeparator, java.lang.String currencySymbol, boolean leadingZero, int decimalDigit, int posNumFmt, int negNumFmt, int posCurFmt, int negCurFmt, int scaleFactor, java.lang.String scaleDownThousands, java.lang.String scaleDownMillions, java.lang.String scaleDownBillions, java.lang.String scaleDownTrillions, java.lang.String scaleDownQuadrillions, java.lang.String dateFormat)
Constructor that sets individual ViewFormat properties.

BaseViewFormat(java.lang.String strNumberFormatString, int nNumberFormatType)
Constructor that specifies how a number should be formatted, based on the specified format mask and type.

Method Summary

protected ErrorHandler	_getErrorHandler()
java.lang.String	booleanToLocString(java.lang.Boolean bValue)
java.lang.String	BooleanToString(boolean bValue) Generates a String representation of a Boolean value.
void	clearUsedBits() Sets all of the "used" ViewFormat properties to false.
java.lang.Object	clone() Clones this ViewFormat object.
static int	convertNegCurFmtToInt(java.lang.String value)
static int	convertNegNumFmtToInt(java.lang.String value)
static int	convertNonAutoScalingToScaleFactor(java.lang.String scaling)
static int	convertNumberTypeToInt(java.lang.String value)
static int	convertPosCurFmtToInt(java.lang.String value)
static int	convertPosNumFmtToInt(java.lang.String value)
static int	convertScaleFactorToInt(java.lang.String value)
java.lang.String	convertScaleFactorToScaling(boolean isScaleFactorUsed, int scaleFactor)
int	convertScalingToScaleFactor(java.lang.String scaling)
java.lang.String	DateToString(java.sql.Date dateValue) Generates a String representation of a java.sql.Date value.
java.lang.String	DoubleToString(double dValue) Generates a String representation of a double value.
boolean	equals(java.lang.Object o) Indicates whether the specified object is equivalent to this ViewFormat object.
java.lang.String	FloatToString(float fValue) Generates a String representation of a float value.
java.lang.String	getCurrencySymbol() Retrieves the character or String that indicates a currency value.
int	getDecimalDigit() Retrieves the number of digits that appear to the right of the decimal in a number.
char	getDecimalSeparator() Retrieves the character or String that separates the integer and decimal parts of numbers.
char	getDecimalSeparatorSymbol()
protected java.lang.Object	getExternalDefault(java.lang.String attributeName)
java.lang.String	getJavaDateFormat() Retrieves the Java date format for this ViewFormat.
java.util.Locale	getLocale()
int	getNegCurFmt() Retrieves the character or String that indicates a negative currency value.
int	getNegCurFmtValue()
int	getNegNumFmt() Retrieves the character or String that indicates a negative number value.
int	getNegNumFmtValue()
int	getNegPctFmt()
NumberConverter	getNumberConverter()
java.text.NumberFormat	getNumberFormat() This method is for internal use only and should only be called by GraphExportXMLWriter.
java.lang.String	getNumberFormatString()
java.lang.String	getNumberFormatString(int nNumberFormatType)
int	getNumberFormatType()
int	getNumberType() Retrieves the type of the number, such as general, currency, or percent.
java.lang.String	getOracleDateFormat() Retrieves the Oracle date format for this ViewFormat such as MM/DD/YYYY or DD/MM/YYYY.
int	getPosCurFmt() Retrieves the character or String that indicates a positive currency value.
int	getPosCurFmtValue()
int	getPosNumFmt() Retrieves the character or String that indicates a positive number value.
int	getPosNumFmtValue()
java.lang.String	getScaleDownBillions() Retrieves the character or String that represents the abbreviation for billions.
java.lang.String	getScaleDownBillionsSymbol()
java.lang.String	getScaleDownMillions() Retrieves the character or String that represents the abbreviation for millions.
java.lang.String	getScaleDownMillionsSymbol()
java.lang.String	getScaleDownQuadrillions() Retrieves the character or String that represents the abbreviation for quadrillions.
java.lang.String	getScaleDownQuadrillionsSymbol()
java.lang.String	getScaleDownThousands() Retrieves the character or String that represents the abbreviation for thousands.
java.lang.String	getScaleDownThousandsSymbol()
java.lang.String	getScaleDownTrillions() Retrieves the character or String that represents the abbreviation for trillions.
java.lang.String	getScaleDownTrillionsSymbol()
int	getScaleFactor() Retrieves the amount that a number is abbreviated.
int	getScaleFactorExponent()
char	getThousandSeparator() Retrieves the character or String that separates thousands in number values.
char	getThousandSeparatorSymbol()
boolean	getThousandSeparatorUsed()
java.util.TimeZone	getTimeZone()
oracle.dss.util.xml.ObjectNode	getXML(boolean allProperties)
oracle.dss.util.xml.ObjectNode	getXML(boolean allProperties, boolean emptyElement) Retrieves XML that represents properties and their values in the form of and ObjectNode.
void	init() Clears all properties from the ViewFormat.
void	init(int numberType, char thousandSeparator, char decimalSeparator, java.lang.String currencySymbol, boolean leadingZero, int decimalDigit, int posNumFmt, int negNumFmt, int posCurFmt, int negCurFmt, int scaleFactor, java.lang.String scaleDownThousands, java.lang.String scaleDownMillions, java.lang.String scaleDownBillions, java.lang.String scaleDownTrillions, java.lang.String scaleDownQuadrillions, java.lang.String dateFormat) Sets individual ViewFormat properties.
void	initWithString(java.lang.String strNumberFormatString, int nNumberFormatType) Initializes this BaseViewFormat from a format String.
java.lang.String	IntToString(int iValue) Formats an integer value as a String.
boolean	isAnythingOverridden() Indicates whether any of the property of this ViewFormat has been explicitly set.
boolean	isCurrencySymbolUsed() Indicates whether the CurrencySymbol property has been explicitly set.
boolean	isDecimalDigitUsed() Indicates whether the DecimalDigit property has been explicitly set.
boolean	isDecimalSeparatorUsed() Indicates whether the DecimalSeparator property has been explicitly set.
boolean	isISOCurrency()
boolean	isISOCurrencyUsed()
boolean	isJavaDateFormatUsed() Indicates whether the JavaDateFormat property has been explicitly set.
boolean	isLeadingZero() Indicates whether numbers that fall between 1.0 and -1.0 are displayed with leading zeros.
boolean	isLeadingZeroUsed() Indicates whether the LeadingZero property has been explicitly set.
boolean	isNegativeAngleBracketsUsed()
boolean	isNegCurFmtUsed() Indicates whether the NegCurFmt property has been explicitly set.
boolean	isNegNumFmtUsed() Indicates whether the NegNumFmt property has been explicitly set.
boolean	isNegPctFmtUsed()
boolean	isNumberFormatStringUsed()
boolean	isNumberTypeUsed() Indicates whether the NumberType property has been explicitly set.
boolean	isOracleDateFormatUsed() Indicates whether the OracleDateFormat property has been explicitly set.
boolean	isPercentUsed() Deprecated. As of 3.2.0.22, replaced by #getNumberType(int)
boolean	isPosCurFmtUsed() Indicates whether the PosCurFmt property has been explicitly set.
boolean	isPosNumFmtUsed() Indicates whether the PosNumFmt property has been explicitly set.
boolean	isScaleDownBillionsUsed() Indicates whether the ScaleDownBillions property has been explicitly set.
boolean	isScaleDownMillionsUsed() Indicates whether the ScaleDownMillions property has been explicitly set.
boolean	isScaleDownQuadrillionsUsed() Indicates whether the ScaleDownQuadrillions property has been explicitly set.
boolean	isScaleDownThousandsUsed() Indicates whether the ScaleDownThousands property has been explicitly set.
boolean	isScaleDownTrillionsUsed() Indicates whether the ScaleDownTrillions property has been explicitly set.
boolean	isScaleFactorExponentUsed()
boolean	isScaleFactorUsed() Indicates whether the ScaleFactor property has been explicitly set.
boolean	isThousandSeparatorUsed() Indicates whether the ThousandSeparator property has been explicitly set.
java.lang.Boolean	locStringToBoolean(java.lang.String sValue)
java.lang.String	LongToString(long lValue) Generates a String representation of a long value.
void	merge(Mergeable from) Merges the specified ViewFormat object with this object.
java.lang.String	ObjectToString(java.lang.Object objValue) Generates a String representation of an object.
void	setCurrencySymbol(java.lang.String sCurrencySymbol) Specifies the character or String that indicates a currency value.
void	setCurrencySymbolUsed(boolean bValue) Specifies whether the CurrencySymbol property has been explicitly set.
void	setDecimalDigit(int iDecimalDigit) Specifies the number of digits that appear to the right of the decimal in a number.
void	setDecimalDigitUsed(boolean bValue) Specifies whether the DecimalDigit property has been explicitly set.
void	setDecimalSeparator(char cDecimalSeparator) Specifies the character or String that separates the integer and decimal parts of numbers.
void	setDecimalSeparatorUsed(boolean bValue) Specifies whether the DecimalSeparator property has been explicitly set.
void	setDefaultCurrencySymbol(java.lang.String currSym)
void	setDefaultDecimalSeparator(char decSep)
void	setDefaultThousandSeparator(char thouSep)
void	setErrorHandler(ErrorHandler eh) Specifies the error handler for this BaseViewFormat.
void	setISOCurrency(boolean bISOCurr)
void	setISOCurrencyUsed(boolean bISOCurrUsed)
void	setJavaDateFormat(java.lang.String sDateFormat) Specifies the way in which the date is displayed, such as MM/dd/yyyy, or dd/MM/yyyy.
void	setJavaDateFormatUsed(boolean bValue) Specifies whether the JavaDateFormat property has been explicitly set.
void	setLeadingZero(boolean bLeadingZero) Specifies whether numbers that fall between 1.0 and -1.0 are displayed with leading zeros.
void	setLeadingZeroUsed(boolean bValue) Specifies whether the LeadingZero property has been explicitly set.
void	setLocale(java.util.Locale loc)
protected void	setLocale(java.util.Locale loc, boolean setAlways)
void	setNegativeAngleBracketsUsed(boolean bNegativeAngleBracketsUsed)
void	setNegCurFmt(int iNegCurFmt) Specifies the character or String that indicates a negative currency value.
void	setNegCurFmtUsed(boolean bValue) Specifies whether the NegCurFmt property has been explicitly set.
void	setNegNumFmt(int iNegNumFmt) Specifies the character or String that indicates a negative number value.
void	setNegNumFmtUsed(boolean bValue) Specifies whether the NegNumFmt property has been explicitly set.
void	setNegPctFmt(int format)
void	setNegPctFmtUsed(boolean bUsed)
void	setNumberConverter(NumberConverter converter)
void	setNumberFormatString(java.lang.String strNumberFormatString)
void	setNumberFormatStringUsed(boolean used)
int	setNumberFormatType(int nNumberFormatType)
void	setNumberType(int iNumberType) Specifies the type of the number, such as general, currency, or percent.
void	setNumberTypeUsed(boolean bValue) Specifies whether the NumberType property has been explicitly set.
void	setOracleDateFormat(java.lang.String sDateFormat) Specifies the way in which the oracle date is displayed, such as MM/DD/YYYY, or DD/MM/YYYY.
void	setOracleDateFormatUsed(boolean bValue) Specifies whether the OracleDateFormat property has been explicitly set.
void	setPercentUsed(boolean bPercentUsed) Deprecated. As of 3.2.0.22, replaced by setNumberType(int)
void	setPosCurFmt(int iPosCurFmt) Specifies the character or String that indicates a positive currency value.
void	setPosCurFmtUsed(boolean bValue) Specifies whether the PosCurFmt property has been explicitly set.
void	setPosNumFmt(int iPosNumFmt) Specifies the character or String that indicates a positive number value.
void	setPosNumFmtUsed(boolean bValue) Specifies whether the PosNumFmt property has been explicitly set.
void	setScaleDownBillions(java.lang.String sValue) Specifies the character or String that represents the abbreviation for billions.
void	setScaleDownBillionsUsed(boolean bValue) Specifies whether the ScaleDownBillions property has been explicitly set.
void	setScaleDownMillions(java.lang.String sValue) Specifies the character or String that represents the abbreviation for million.
void	setScaleDownMillionsUsed(boolean bValue) Specifies whether the ScaleDownMillions property has been explicitly set.
void	setScaleDownQuadrillions(java.lang.String sValue) Specifies the character or String that represents the abbreviation for quadrillions.
void	setScaleDownQuadrillionsUsed(boolean bValue) Specifies whether the ScaleDownQuadrillions property has been explicitly set.
void	setScaleDownThousands(java.lang.String sValue) Specifies the character or String that represents the abbreviation for thousands.
void	setScaleDownThousandsUsed(boolean bValue) Specifies whether the ScaleDownThousands property has been explicitly set.
void	setScaleDownTrillions(java.lang.String sValue) Specifies the character or String that represents the abbreviation for trillions.
void	setScaleDownTrillionsUsed(boolean bValue) Specifies whether the ScaleDownTrillions property has been explicitly set.
void	setScaleFactor(int iScaleFactor) Specifies how much to abbreviate a number.
void	setScaleFactorExponent(int nScaleFactorExponent)
void	setScaleFactorUsed(boolean bValue) Specifies whether the ScaleFactor property has been explicitly set.
void	setThousandSeparator(char cThousandSeparator) Specifies the character or String that separates thousands in number values.
void	setThousandSeparatorUsed(boolean bValue) Specifies whether the ThousandSeparator property has been explicitly set.
void	setTimeZone(java.util.TimeZone tz)
void	setViewFormatCallback(BaseViewFormatCallback vfc)
boolean	setXML(oracle.dss.util.xml.ObjectNode node, java.lang.String version, int reset) Specifies XML that represents properties and values.
boolean	setXML(oracle.dss.util.xml.ObjectNode node, java.lang.String version, int reset, java.util.HashMap map)
java.lang.String	ShortToString(short sValue) Generates a String representation of a short value.
java.lang.Boolean	StringToBoolean(java.lang.String sValue) Converts a String into a Boolean object.
java.sql.Date	StringToDate(java.lang.String sValue) Converts a String into a java.sql.Date object.
java.sql.Date	StringToDate(java.lang.String sValue, boolean dynamic)
double	StringToDouble(java.lang.String sValue) Converts a String into a double value.
float	StringToFloat(java.lang.String sValue) Converts a String into a float value.
int	StringToInt(java.lang.String sValue) Converts a String into an integer.
long	StringToLong(java.lang.String sValue) Converts a String into a long value.
java.lang.Object	StringToObject(java.lang.String sValue, int iDataType) Converts a String into an object.
short	StringToShort(java.lang.String sValue) Converts a String into a short value.
java.lang.String	StringToString(java.lang.String sValue) Converts a String into a String object, through the Date class.
java.sql.Time	StringToTime(java.lang.String sValue) Converts a String into a Time object.
java.sql.Timestamp	StringToTimestamp(java.lang.String sValue) Converts a String into a Timestamp object.
java.util.Date	StringToUtilDate(java.lang.String sValue) Converts a String into a Date object.
java.lang.String	TimestampToString(java.sql.Timestamp timeValue) Generates a String representation of a Timestamp value.
java.lang.String	TimeToString(java.sql.Time timeValue) Generates a String representation of a Time value.
java.lang.String	toString() Generates a String representation of this ViewFormat.
void	updateDefaultCurrencySymbol()
void	updateDefaultSymbols()
java.lang.String	UtilDateToString(java.util.Date dateValue) Generates a String representation of a Date value.
boolean	validateFormatString(java.lang.String strNumberFormatString, int nNumberFormatType) Validates a format String before setting its values on this BaseViewFormat.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEBUG

protected static final boolean DEBUG

See Also:

Constant Field Values

DEFAULT_NUM_TYPE

public static final int DEFAULT_NUM_TYPE

Number type default: a general number.

See Also:

Constant Field Values

DEFAULT_CURRENCY_SYMBOL

public static final java.lang.String DEFAULT_CURRENCY_SYMBOL

Currency symbol default: "$".

See Also:

Constant Field Values

DEFAULT_LEADING_ZERO

public static final boolean DEFAULT_LEADING_ZERO

Leading zero default: true.

See Also:

Constant Field Values

DEFAULT_POS_NUM_FMT

public static final int DEFAULT_POS_NUM_FMT

Positive number format default for US English: "1". The default positive number format for this BaseViewFormat is based on locale.

See Also:

Constant Field Values

DEFAULT_NEG_NUM_FMT

public static final int DEFAULT_NEG_NUM_FMT

Negative number format default for US English: -1. The default negative number format for this BaseViewFormat is based on locale.

See Also:

Constant Field Values

DEFAULT_POS_CUR_FMT

public static final int DEFAULT_POS_CUR_FMT

Positive currency format default for US English: "$1". The default positive currency format for this BaseViewFormat is based on locale.

See Also:

Constant Field Values

DEFAULT_NEG_CUR_FMT

public static final int DEFAULT_NEG_CUR_FMT

Negative currency format default for US English: "($1)". The default negative number format for this BaseViewFormat is based on locale.

See Also:

Constant Field Values

DEFAULT_SCALE_FACTOR

public static final int DEFAULT_SCALE_FACTOR

Scale factor default: none.

See Also:

Constant Field Values

DEFAULT_SCALE_FACTOR_EXPONENT

public static final int DEFAULT_SCALE_FACTOR_EXPONENT

See Also:

Constant Field Values

DEFAULT_SCALE_DOWN_THOUSANDS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_THOUSANDS_STRING

Default string for numbers that are scaled to thousands: based on locale. Default in US English is "K".

DEFAULT_SCALE_DOWN_MILLIONS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_MILLIONS_STRING

Default string for numbers that are scaled to millions: based on locale. Default in US English is "M".

DEFAULT_SCALE_DOWN_BILLIONS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_BILLIONS_STRING

Default string for numbers that are scaled to billions: based on locale. Default in US English is "B".

DEFAULT_SCALE_DOWN_TRILLIONS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_TRILLIONS_STRING

Default string for numbers that are scaled to trillions: based on locale. Default in US English is "T".

DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING

Default string for numbers that are scaled to quadrillions: based on locale. Default in US English is "Q".

SCALE_DOWN_SYMBOL_BY_LOCALE

public static final java.lang.String SCALE_DOWN_SYMBOL_BY_LOCALE

Scale down symbol, based on locale.

See Also:

Constant Field Values

THOU_SEP_BY_LOCALE

public static final char THOU_SEP_BY_LOCALE

Thousands separator, based on locale.

See Also:

Constant Field Values

DEC_SEP_BY_LOCALE

public static final char DEC_SEP_BY_LOCALE

Decimal separator, based on locale.

See Also:

Constant Field Values

DEFAULT_NULL_STRING

public static final java.lang.String DEFAULT_NULL_STRING

Null string default: " ".

See Also:

Constant Field Values

MIN_DATATYPE

public static final int MIN_DATATYPE

See Also:

Constant Field Values

DATATYPE_BOOLEAN

public static final int DATATYPE_BOOLEAN

Data type: boolean.

See Also:

Constant Field Values

DATATYPE_SHORT

public static final int DATATYPE_SHORT

Data type: short.

See Also:

Constant Field Values

DATATYPE_INT

public static final int DATATYPE_INT

Data type: integer.

See Also:

Constant Field Values

DATATYPE_LONG

public static final int DATATYPE_LONG

Data type: long.

See Also:

Constant Field Values

DATATYPE_DOUBLE

public static final int DATATYPE_DOUBLE

Data type: double.

See Also:

Constant Field Values

DATATYPE_FLOAT

public static final int DATATYPE_FLOAT

Data type: float.

See Also:

Constant Field Values

DATATYPE_STRING

public static final int DATATYPE_STRING

Data type: String.

See Also:

Constant Field Values

DATATYPE_DATE

public static final int DATATYPE_DATE

Data type: Date.

See Also:

Constant Field Values

DATATYPE_TIME

public static final int DATATYPE_TIME

Data type: Time.

See Also:

Constant Field Values

DATATYPE_TIMESTAMP

public static final int DATATYPE_TIMESTAMP

Data type: Timestamp.

See Also:

Constant Field Values

MAX_DATATYPE

public static final int MAX_DATATYPE

See Also:

Constant Field Values

MIN_NUMTYPE

public static final int MIN_NUMTYPE

See Also:

Constant Field Values

NUMTYPE_GENERAL

public static final int NUMTYPE_GENERAL

Number type: general.

See Also:

Constant Field Values

NUMTYPE_CURRENCY

public static final int NUMTYPE_CURRENCY

Number type: currency.

See Also:

Constant Field Values

NUMTYPE_PERCENT

public static final int NUMTYPE_PERCENT

Multiplies the given number by 100 and then adds % symbol to it.

See Also:

Constant Field Values

NUMTYPE_PERCENT_SYMBOL

public static final int NUMTYPE_PERCENT_SYMBOL

See Also:

Constant Field Values

MAX_NUMTYPE

public static final int MAX_NUMTYPE

See Also:

Constant Field Values

MIN_POS_NUMFMT

public static final int MIN_POS_NUMFMT

See Also:

Constant Field Values

POS_NUMFMT_NUM

public static final int POS_NUMFMT_NUM

Positive number format: "1".

See Also:

Constant Field Values

POS_NUMFMT_POS_NUM

public static final int POS_NUMFMT_POS_NUM

Positive number format: "+1".

See Also:

Constant Field Values

POS_NUMFMT_NUM_POS

public static final int POS_NUMFMT_NUM_POS

Positive number format: "1+".

See Also:

Constant Field Values

ORACLE_POS_NUM_CONST

public static final int ORACLE_POS_NUM_CONST

See Also:

Constant Field Values

POS_NUMFMT_BY_LOCALE

public static final int POS_NUMFMT_BY_LOCALE

Positive number format, based on locale.

See Also:

Constant Field Values

MAX_POS_NUMFMT

public static final int MAX_POS_NUMFMT

See Also:

Constant Field Values

MIN_NEG_NUMFMT

public static final int MIN_NEG_NUMFMT

See Also:

Constant Field Values

NEG_NUMFMT_OP_NUM_CP

public static final int NEG_NUMFMT_OP_NUM_CP

Negative number format: "(1)".

See Also:

Constant Field Values

NEG_NUMFMT_NEG_NUM

public static final int NEG_NUMFMT_NEG_NUM

Negative number format: "-1".

See Also:

Constant Field Values

NEG_NUMFMT_NUM_NEG

public static final int NEG_NUMFMT_NUM_NEG

Negative number format: "1-".

See Also:

Constant Field Values

NEG_NUMFMT_NUM

public static final int NEG_NUMFMT_NUM

Negative number format: "1".

See Also:

Constant Field Values

ORACLE_NEG_NUM_CONST

public static final int ORACLE_NEG_NUM_CONST

See Also:

Constant Field Values

NEG_NUMFMT_BY_LOCALE

public static final int NEG_NUMFMT_BY_LOCALE

Negative number format, based on locale.

See Also:

Constant Field Values

MAX_NEG_NUMFMT

public static final int MAX_NEG_NUMFMT

See Also:

Constant Field Values

MIN_POS_CURFMT

public static final int MIN_POS_CURFMT

See Also:

Constant Field Values

POS_CURFMT_CUR_NUM

public static final int POS_CURFMT_CUR_NUM

Positive currency format: "$1".

See Also:

Constant Field Values

POS_CURFMT_NUM_CUR

public static final int POS_CURFMT_NUM_CUR

Positive currency format: "1$".

See Also:

Constant Field Values

POS_CURFMT_CUR_SPAC_NUM

public static final int POS_CURFMT_CUR_SPAC_NUM

Positive currency format: "$ 1".

See Also:

Constant Field Values

POS_CURFMT_NUM_SPAC_CUR

public static final int POS_CURFMT_NUM_SPAC_CUR

Positive currency format: "1 $".

See Also:

Constant Field Values

POS_CURFMT_POS_CUR_NUM

public static final int POS_CURFMT_POS_CUR_NUM

Positive currency format: "+$1".

See Also:

Constant Field Values

POS_CURFMT_CUR_NUM_POS

public static final int POS_CURFMT_CUR_NUM_POS

Positive currency format: "$1+".

See Also:

Constant Field Values

POS_CURFMT_POS_NUM_CUR

public static final int POS_CURFMT_POS_NUM_CUR

Positive currency format: "+1$".

See Also:

Constant Field Values

POS_CURFMT_NUM_POS_CUR

public static final int POS_CURFMT_NUM_POS_CUR

Positive currency format: "1+$".

See Also:

Constant Field Values

POS_CURFMT_NUM_CUR_POS

public static final int POS_CURFMT_NUM_CUR_POS

Positive currency format: "1$+".

See Also:

Constant Field Values

POS_CURFMT_POS_NUM_SPAC_CUR

public static final int POS_CURFMT_POS_NUM_SPAC_CUR

Positive currency format: "+1 $".

See Also:

Constant Field Values

POS_CURFMT_POS_CUR_SPAC_NUM

public static final int POS_CURFMT_POS_CUR_SPAC_NUM

Positive currency format: "+$ 1".

See Also:

Constant Field Values

POS_CURFMT_NUM_SPAC_CUR_POS

public static final int POS_CURFMT_NUM_SPAC_CUR_POS

Positive currency format: "1 $+".

See Also:

Constant Field Values

ORACLE_POS_CUR_CONST

public static final int ORACLE_POS_CUR_CONST

See Also:

Constant Field Values

POS_CURFMT_BY_LOCALE

public static final int POS_CURFMT_BY_LOCALE

Positive currency format, based on locale.

See Also:

Constant Field Values

MAX_POS_CURFMT

public static final int MAX_POS_CURFMT

See Also:

Constant Field Values

MIN_NEG_CURFMT

public static final int MIN_NEG_CURFMT

See Also:

Constant Field Values

NEG_CURFMT_OP_CUR_NUM_CP

public static final int NEG_CURFMT_OP_CUR_NUM_CP

Negative currency format: "($1)".

See Also:

Constant Field Values

NEG_CURFMT_NEG_CUR_NUM

public static final int NEG_CURFMT_NEG_CUR_NUM

Negative currency format: "-$1".

See Also:

Constant Field Values

NEG_CURFMT_CUR_NEG_NUM

public static final int NEG_CURFMT_CUR_NEG_NUM

Negative currency format: "$-1".

See Also:

Constant Field Values

NEG_CURFMT_CUR_NUM_NEG

public static final int NEG_CURFMT_CUR_NUM_NEG

Negative currency format: "$1-".

See Also:

Constant Field Values

NEG_CURFMT_OP_NUM_CUR_CP

public static final int NEG_CURFMT_OP_NUM_CUR_CP

Negative currency format: "(1$)".

See Also:

Constant Field Values

NEG_CURFMT_NEG_NUM_CUR

public static final int NEG_CURFMT_NEG_NUM_CUR

Negative currency format: "(-1$)".

See Also:

Constant Field Values

NEG_CURFMT_NUM_NEG_CUR

public static final int NEG_CURFMT_NUM_NEG_CUR

Negative currency format: "1-$".

See Also:

Constant Field Values

NEG_CURFMT_NUM_CUR_NEG

public static final int NEG_CURFMT_NUM_CUR_NEG

Negative currency format: "1$-".

See Also:

Constant Field Values

NEG_CURFMT_NEG_NUM_SPAC_CUR

public static final int NEG_CURFMT_NEG_NUM_SPAC_CUR

Negative currency format: "-1 $".

See Also:

Constant Field Values

NEG_CURFMT_NEG_CUR_SPAC_NUM

public static final int NEG_CURFMT_NEG_CUR_SPAC_NUM

Negative currency format: "-$ 1".

See Also:

Constant Field Values

NEG_CURFMT_NUM_SPAC_CUR_NEG

public static final int NEG_CURFMT_NUM_SPAC_CUR_NEG

Negative currency format: "1 $-".

See Also:

Constant Field Values

ORACLE_NEG_CUR_CONST

public static final int ORACLE_NEG_CUR_CONST

See Also:

Constant Field Values

NEG_CURFMT_CUR_SPAC_NUM_NEG

public static final int NEG_CURFMT_CUR_SPAC_NUM_NEG

See Also:

Constant Field Values

NEG_CURFMT_CUR_SPAC_NEG_NUM

public static final int NEG_CURFMT_CUR_SPAC_NEG_NUM

See Also:

Constant Field Values

NEG_CURFMT_BY_LOCALE

public static final int NEG_CURFMT_BY_LOCALE

Negative currency format, based on locale.

See Also:

Constant Field Values

MAX_NEG_CURFMT

public static final int MAX_NEG_CURFMT

See Also:

Constant Field Values

MIN_NEG_PCTFMT

public static final int MIN_NEG_PCTFMT

See Also:

Constant Field Values

NEG_PCTFMT_NEG_NUM_PCT

public static final int NEG_PCTFMT_NEG_NUM_PCT

See Also:

Constant Field Values

NEG_PCTFMT_OP_NUM_PCT_CP

public static final int NEG_PCTFMT_OP_NUM_PCT_CP

See Also:

Constant Field Values

MAX_NEG_PCTFMT

public static final int MAX_NEG_PCTFMT

See Also:

Constant Field Values

MIN_SCALEFACTOR

public static final int MIN_SCALEFACTOR

See Also:

Constant Field Values

SCALEFACTOR_NONE

public static final int SCALEFACTOR_NONE

Scale factor: none.

See Also:

Constant Field Values

SCALEFACTOR_THOUSANDS

public static final int SCALEFACTOR_THOUSANDS

Scale factor: thousands.

See Also:

Constant Field Values

SCALEFACTOR_MILLIONS

public static final int SCALEFACTOR_MILLIONS

Scale factor: millions.

See Also:

Constant Field Values

SCALEFACTOR_BILLIONS

public static final int SCALEFACTOR_BILLIONS

Scale factor: billions.

See Also:

Constant Field Values

SCALEFACTOR_TRILLIONS

public static final int SCALEFACTOR_TRILLIONS

Scale factor: trillions.

See Also:

Constant Field Values

SCALEFACTOR_QUADRILLIONS

public static final int SCALEFACTOR_QUADRILLIONS

Scale factor: quadrillions.

See Also:

Constant Field Values

SCALEFACTOR_BASE_10

public static final int SCALEFACTOR_BASE_10

See Also:

Constant Field Values

MAX_SCALEFACTOR

public static final int MAX_SCALEFACTOR

See Also:

Constant Field Values

UNKNOWN_PATTERN_STR

public static final int UNKNOWN_PATTERN_STR

Format String type: Unknown Number Format Mask. The number format string represents a type that is unknown or has not been specified.

See Also:

Constant Field Values

OEO_PATTERN_STR

public static final int OEO_PATTERN_STR

Format String type: Oracle Express Objects (OEO) Number Format Mask The number format string represents a traditional OLAP-formatted String in the following format:

number format;positive format; negative format; scale; chars-to-use
 

The first three clauses must appear in the order that is specified. The last two clauses do not need to appear and can appear in any order after the first three clauses. For example, the following String:

 0; $1; -1; /3; $=$; .=.; ,=,"
 

Would format the number $7,000,000.00 as $7,000M.

See Also:

ORACLE_PATTERN_STR, BaseViewFormat(String, int), Constant Field Values

ORACLE_PATTERN_STR

public static final int ORACLE_PATTERN_STR

Format String type: Oracle RDBMS Number Format Mask The number format string represents a standard Oracle RDBMS number format mask.

For more information, see the "Oracle9i SQL Reference Release 1 (9.0.1) Part Number A90125-01" at http://download-west.oracle.com/otndoc/oracle9i/901_doc/server.901/a90125/sql_elements4.htm.

See Also:

OEO_PATTERN_STR, BaseViewFormat(String, int), Constant Field Values

BIBEANS_PATTERN_STR

public static final int BIBEANS_PATTERN_STR

See Also:

OEO_PATTERN_STR, ORACLE_PATTERN_STR, BaseViewFormat(String, int), Constant Field Values

VIEW_FORMAT_NAME

public static final java.lang.String VIEW_FORMAT_NAME

See Also:

Constant Field Values

CURRENCYSYMBOL

public static final int CURRENCYSYMBOL

See Also:

Constant Field Values

DATEFORMAT

public static final int DATEFORMAT

See Also:

Constant Field Values

DECIMALDIGIT

public static final int DECIMALDIGIT

See Also:

Constant Field Values

DECIMALSEPARATOR

public static final int DECIMALSEPARATOR

See Also:

Constant Field Values

LEADINGZERO

public static final int LEADINGZERO

See Also:

Constant Field Values

NEGCURFMT

public static final int NEGCURFMT

See Also:

Constant Field Values

NEGNUMFMT

public static final int NEGNUMFMT

See Also:

Constant Field Values

NUMBERTYPE

public static final int NUMBERTYPE

See Also:

Constant Field Values

POSCURFMT

public static final int POSCURFMT

See Also:

Constant Field Values

POSNUMFMT

public static final int POSNUMFMT

See Also:

Constant Field Values

SCALEDOWNBILLIONS

public static final int SCALEDOWNBILLIONS

See Also:

Constant Field Values

SCALEDOWNMILLIONS

public static final int SCALEDOWNMILLIONS

See Also:

Constant Field Values

SCALEDOWNQUADRILLIONS

public static final int SCALEDOWNQUADRILLIONS

See Also:

Constant Field Values

SCALEDOWNTHOUSANDS

public static final int SCALEDOWNTHOUSANDS

See Also:

Constant Field Values

SCALEDOWNTRILLIONS

public static final int SCALEDOWNTRILLIONS

See Also:

Constant Field Values

SCALEFACTOR

public static final int SCALEFACTOR

See Also:

Constant Field Values

THOUSANDSEPARATOR

public static final int THOUSANDSEPARATOR

See Also:

Constant Field Values

ORACLEDATEFORMAT

public static final int ORACLEDATEFORMAT

See Also:

Constant Field Values

SCALEFACTOR_EXPONENT

public static final int SCALEFACTOR_EXPONENT

See Also:

Constant Field Values

VIEWFORMAT_END

protected static final int VIEWFORMAT_END

See Also:

Constant Field Values

numtype_general

protected static final java.lang.String numtype_general

See Also:

Constant Field Values

numtype_currency

protected static final java.lang.String numtype_currency

See Also:

Constant Field Values

numtype_percent

protected static final java.lang.String numtype_percent

See Also:

Constant Field Values

numtype_percent_s

protected static final java.lang.String numtype_percent_s

See Also:

Constant Field Values

DATE_FORMAT_BIT

protected static final int DATE_FORMAT_BIT

See Also:

Constant Field Values

m_version_2_4_0_6

protected static final java.lang.String m_version_2_4_0_6

See Also:

Constant Field Values

m_version_2_4_0_16

protected static final java.lang.String m_version_2_4_0_16

See Also:

Constant Field Values

m_vfCallback

protected BaseViewFormatCallback m_vfCallback

m_bUseCallback

protected boolean m_bUseCallback

pos_numfmt_num

protected static final java.lang.String pos_numfmt_num

See Also:

Constant Field Values

pos_numfmt_pos_num

protected static final java.lang.String pos_numfmt_pos_num

See Also:

Constant Field Values

pos_numfmt_num_pos

protected static final java.lang.String pos_numfmt_num_pos

See Also:

Constant Field Values

oracle_pos_num_const

protected static final java.lang.String oracle_pos_num_const

See Also:

Constant Field Values

pos_numfmt_loc

protected static final java.lang.String pos_numfmt_loc

See Also:

Constant Field Values

neg_numfmt_op_num_cp

protected static final java.lang.String neg_numfmt_op_num_cp

See Also:

Constant Field Values

neg_numfmt_neg_num

protected static final java.lang.String neg_numfmt_neg_num

See Also:

Constant Field Values

neg_numfmt_num_neg

protected static final java.lang.String neg_numfmt_num_neg

See Also:

Constant Field Values

neg_numfmt_num

protected static final java.lang.String neg_numfmt_num

See Also:

Constant Field Values

oracle_neg_num_const

protected static final java.lang.String oracle_neg_num_const

See Also:

Constant Field Values

neg_numfmt_loc

protected static final java.lang.String neg_numfmt_loc

See Also:

Constant Field Values

pos_curfmt_cur_num

protected static final java.lang.String pos_curfmt_cur_num

See Also:

Constant Field Values

pos_curfmt_num_cur

protected static final java.lang.String pos_curfmt_num_cur

See Also:

Constant Field Values

pos_curfmt_cur_spac_num

protected static final java.lang.String pos_curfmt_cur_spac_num

See Also:

Constant Field Values

pos_curfmt_num_spac_cur

protected static final java.lang.String pos_curfmt_num_spac_cur

See Also:

Constant Field Values

pos_curfmt_cur_num_pos

protected static final java.lang.String pos_curfmt_cur_num_pos

See Also:

Constant Field Values

pos_curfmt_pos_num_cur

protected static final java.lang.String pos_curfmt_pos_num_cur

See Also:

Constant Field Values

pos_curfmt_num_pos_cur

protected static final java.lang.String pos_curfmt_num_pos_cur

See Also:

Constant Field Values

pos_curfmt_pos_cur_num

protected static final java.lang.String pos_curfmt_pos_cur_num

See Also:

Constant Field Values

pos_curfmt_num_cur_pos

protected static final java.lang.String pos_curfmt_num_cur_pos

See Also:

Constant Field Values

pos_curfmt_pos_num_spac_cur

protected static final java.lang.String pos_curfmt_pos_num_spac_cur

See Also:

Constant Field Values

pos_curfmt_pos_cur_spac_num

protected static final java.lang.String pos_curfmt_pos_cur_spac_num

See Also:

Constant Field Values

pos_curfmt_num_spac_cur_pos

protected static final java.lang.String pos_curfmt_num_spac_cur_pos

See Also:

Constant Field Values

pos_curfmt_loc

protected static final java.lang.String pos_curfmt_loc

See Also:

Constant Field Values

neg_curfmt_op_cur_num_cp

protected static final java.lang.String neg_curfmt_op_cur_num_cp

See Also:

Constant Field Values

neg_curfmt_neg_cur_num

protected static final java.lang.String neg_curfmt_neg_cur_num

See Also:

Constant Field Values

neg_curfmt_cur_neg_num

protected static final java.lang.String neg_curfmt_cur_neg_num

See Also:

Constant Field Values

neg_curfmt_cur_num_neg

protected static final java.lang.String neg_curfmt_cur_num_neg

See Also:

Constant Field Values

neg_curfmt_op_num_cur_cp

protected static final java.lang.String neg_curfmt_op_num_cur_cp

See Also:

Constant Field Values

neg_curfmt_neg_num_cur

protected static final java.lang.String neg_curfmt_neg_num_cur

See Also:

Constant Field Values

neg_curfmt_num_neg_cur

protected static final java.lang.String neg_curfmt_num_neg_cur

See Also:

Constant Field Values

neg_curfmt_num_cur_neg

protected static final java.lang.String neg_curfmt_num_cur_neg

See Also:

Constant Field Values

neg_curfmt_neg_num_spac_cur

protected static final java.lang.String neg_curfmt_neg_num_spac_cur

See Also:

Constant Field Values

neg_curfmt_neg_cur_spac_num

protected static final java.lang.String neg_curfmt_neg_cur_spac_num

See Also:

Constant Field Values

neg_curfmt_num_spac_cur_neg

protected static final java.lang.String neg_curfmt_num_spac_cur_neg

See Also:

Constant Field Values

oracle_neg_cur_const

protected static final java.lang.String oracle_neg_cur_const

See Also:

Constant Field Values

neg_curfmt_cur_spac_num_neg

protected static final java.lang.String neg_curfmt_cur_spac_num_neg

See Also:

Constant Field Values

neg_curfmt_cur_spac_neg_num

protected static final java.lang.String neg_curfmt_cur_spac_neg_num

See Also:

Constant Field Values

neg_curfmt_loc

protected static final java.lang.String neg_curfmt_loc

See Also:

Constant Field Values

neg_pctfmt_neg_num_pct

protected static final java.lang.String neg_pctfmt_neg_num_pct

See Also:

Constant Field Values

neg_pctfmt_op_num_pct_cp

protected static final java.lang.String neg_pctfmt_op_num_pct_cp

See Also:

Constant Field Values

thou_sep_by_locale

protected static final java.lang.String thou_sep_by_locale

See Also:

Constant Field Values

dec_sep_by_locale

protected static final java.lang.String dec_sep_by_locale

See Also:

Constant Field Values

scalefactor_none

protected static final java.lang.String scalefactor_none

See Also:

Constant Field Values

scalefactor_thousands

protected static final java.lang.String scalefactor_thousands

See Also:

Constant Field Values

scalefactor_millions

protected static final java.lang.String scalefactor_millions

See Also:

Constant Field Values

scalefactor_billions

protected static final java.lang.String scalefactor_billions

See Also:

Constant Field Values

scalefactor_trillions

protected static final java.lang.String scalefactor_trillions

See Also:

Constant Field Values

scalefactor_quadrillions

protected static final java.lang.String scalefactor_quadrillions

See Also:

Constant Field Values

scale_down_sym_loc

protected static final java.lang.String scale_down_sym_loc

See Also:

Constant Field Values

a_numberType

public static final java.lang.String a_numberType

See Also:

Constant Field Values

a_thousandSeparator

public static final java.lang.String a_thousandSeparator

See Also:

Constant Field Values

a_decimalSeparator

public static final java.lang.String a_decimalSeparator

See Also:

Constant Field Values

a_currencySymbol

public static final java.lang.String a_currencySymbol

See Also:

Constant Field Values

a_leadingZero

public static final java.lang.String a_leadingZero

See Also:

Constant Field Values

a_decimalDigit

public static final java.lang.String a_decimalDigit

See Also:

Constant Field Values

a_posNumFmt

public static final java.lang.String a_posNumFmt

See Also:

Constant Field Values

a_negNumFmt

public static final java.lang.String a_negNumFmt

See Also:

Constant Field Values

a_posCurFmt

public static final java.lang.String a_posCurFmt

See Also:

Constant Field Values

a_negCurFmt

public static final java.lang.String a_negCurFmt

See Also:

Constant Field Values

a_scaleFactor

public static final java.lang.String a_scaleFactor

See Also:

Constant Field Values

a_nfs

public static final java.lang.String a_nfs

See Also:

Constant Field Values

a_nft

public static final java.lang.String a_nft

See Also:

Constant Field Values

a_scaleDownThousands

public static final java.lang.String a_scaleDownThousands

See Also:

Constant Field Values

a_scaleDownMillions

public static final java.lang.String a_scaleDownMillions

See Also:

Constant Field Values

a_scaleDownBillions

public static final java.lang.String a_scaleDownBillions

See Also:

Constant Field Values

a_scaleDownTrillions

public static final java.lang.String a_scaleDownTrillions

See Also:

Constant Field Values

a_scaleDownQuadrillions

public static final java.lang.String a_scaleDownQuadrillions

See Also:

Constant Field Values

a_javaDateFormat

public static final java.lang.String a_javaDateFormat

See Also:

Constant Field Values

a_oracleDateFormat

public static final java.lang.String a_oracleDateFormat

See Also:

Constant Field Values

a_negPctFmt

public static final java.lang.String a_negPctFmt

See Also:

Constant Field Values

a_numberTypeUsed

protected static final java.lang.String a_numberTypeUsed

See Also:

Constant Field Values

a_thousandSeparatorUsed

protected static final java.lang.String a_thousandSeparatorUsed

See Also:

Constant Field Values

a_decimalSeparatorUsed

protected static final java.lang.String a_decimalSeparatorUsed

See Also:

Constant Field Values

a_currencySymbolUsed

protected static final java.lang.String a_currencySymbolUsed

See Also:

Constant Field Values

a_leadingZeroUsed

protected static final java.lang.String a_leadingZeroUsed

See Also:

Constant Field Values

a_decimalDigitUsed

protected static final java.lang.String a_decimalDigitUsed

See Also:

Constant Field Values

a_posNumFmtUsed

protected static final java.lang.String a_posNumFmtUsed

See Also:

Constant Field Values

a_negNumFmtUsed

protected static final java.lang.String a_negNumFmtUsed

See Also:

Constant Field Values

a_posCurFmtUsed

protected static final java.lang.String a_posCurFmtUsed

See Also:

Constant Field Values

a_negCurFmtUsed

protected static final java.lang.String a_negCurFmtUsed

See Also:

Constant Field Values

a_scaleFactorUsed

protected static final java.lang.String a_scaleFactorUsed

See Also:

Constant Field Values

a_scaleDownThousandsUsed

protected static final java.lang.String a_scaleDownThousandsUsed

See Also:

Constant Field Values

a_scaleDownMillionsUsed

protected static final java.lang.String a_scaleDownMillionsUsed

See Also:

Constant Field Values

a_scaleDownBillionsUsed

protected static final java.lang.String a_scaleDownBillionsUsed

See Also:

Constant Field Values

a_scaleDownTrillionsUsed

protected static final java.lang.String a_scaleDownTrillionsUsed

See Also:

Constant Field Values

a_scaleDownQuadrillionsUsed

protected static final java.lang.String a_scaleDownQuadrillionsUsed

See Also:

Constant Field Values

a_javaDateFormatUsed

protected static final java.lang.String a_javaDateFormatUsed

See Also:

Constant Field Values

a_oracleDateFormatUsed

protected static final java.lang.String a_oracleDateFormatUsed

See Also:

Constant Field Values

a_negPctFmtUsed

protected static final java.lang.String a_negPctFmtUsed

See Also:

Constant Field Values

a_ISOC

public static final java.lang.String a_ISOC

See Also:

Constant Field Values

numberType

protected static final int numberType

See Also:

Constant Field Values

thousandSeparator

protected static final char thousandSeparator

See Also:

Constant Field Values

decimalSeparator

protected static final char decimalSeparator

See Also:

Constant Field Values

leadingZero

protected static final boolean leadingZero

See Also:

Constant Field Values

currencySymbol

protected static final java.lang.String currencySymbol

See Also:

Constant Field Values

decimalDigit

protected static final int decimalDigit

See Also:

Constant Field Values

posNumFmt

protected static final int posNumFmt

See Also:

Constant Field Values

negNumFmt

protected static final int negNumFmt

See Also:

Constant Field Values

posCurFmt

protected static final int posCurFmt

See Also:

Constant Field Values

negCurFmt

protected static final int negCurFmt

See Also:

Constant Field Values

scaleFactor

protected static final int scaleFactor

See Also:

Constant Field Values

scaleDownThousands

protected static final java.lang.String scaleDownThousands

See Also:

Constant Field Values

scaleDownMillions

protected static final java.lang.String scaleDownMillions

See Also:

Constant Field Values

scaleDownBillions

protected static final java.lang.String scaleDownBillions

See Also:

Constant Field Values

scaleDownTrillions

protected static final java.lang.String scaleDownTrillions

See Also:

Constant Field Values

scaleDownQuadrillions

protected static final java.lang.String scaleDownQuadrillions

See Also:

Constant Field Values

dateFormat

protected static final java.lang.String dateFormat

See Also:

Constant Field Values

ISOC

protected static final boolean ISOC

See Also:

Constant Field Values

negPctFmt

protected static final int negPctFmt

See Also:

Constant Field Values

numberTypeUsed

protected static final boolean numberTypeUsed

See Also:

Constant Field Values

thousandSeparatorUsed

protected static final boolean thousandSeparatorUsed

See Also:

Constant Field Values

decimalSeparatorUsed

protected static final boolean decimalSeparatorUsed

See Also:

Constant Field Values

currencySymbolUsed

protected static final boolean currencySymbolUsed

See Also:

Constant Field Values

leadingZeroUsed

protected static final boolean leadingZeroUsed

See Also:

Constant Field Values

decimalDigitUsed

protected static final boolean decimalDigitUsed

See Also:

Constant Field Values

posNumFmtUsed

protected static final boolean posNumFmtUsed

See Also:

Constant Field Values

negNumFmtUsed

protected static final boolean negNumFmtUsed

See Also:

Constant Field Values

posCurFmtUsed

protected static final boolean posCurFmtUsed

See Also:

Constant Field Values

negCurFmtUsed

protected static final boolean negCurFmtUsed

See Also:

Constant Field Values

scaleFactorUsed

protected static final boolean scaleFactorUsed

See Also:

Constant Field Values

scaleDownThousandsUsed

protected static final boolean scaleDownThousandsUsed

See Also:

Constant Field Values

scaleDownMillionsUsed

protected static final boolean scaleDownMillionsUsed

See Also:

Constant Field Values

scaleDownBillionsUsed

protected static final boolean scaleDownBillionsUsed

See Also:

Constant Field Values

scaleDownTrillionsUsed

protected static final boolean scaleDownTrillionsUsed

See Also:

Constant Field Values

scaleDownQuadrillionsUsed

protected static final boolean scaleDownQuadrillionsUsed

See Also:

Constant Field Values

dateFormatUsed

protected static final boolean dateFormatUsed

See Also:

Constant Field Values

negPctFmtUsed

protected static final boolean negPctFmtUsed

See Also:

Constant Field Values

on

public static final java.lang.String on

See Also:

Constant Field Values

off

public static final java.lang.String off

See Also:

Constant Field Values

m_formatUsedFlags

protected java.util.BitSet m_formatUsedFlags

Constructor Detail

BaseViewFormat

public BaseViewFormat()

Constructor that uses default ViewFormat values. At this point, no properties have been explicitly set.

BaseViewFormat

public BaseViewFormat(int numberType,
                      char thousandSeparator,
                      char decimalSeparator,
                      java.lang.String currencySymbol,
                      boolean leadingZero,
                      int decimalDigit,
                      int posNumFmt,
                      int negNumFmt,
                      int posCurFmt,
                      int negCurFmt,
                      int scaleFactor,
                      java.lang.String scaleDownThousands,
                      java.lang.String scaleDownMillions,
                      java.lang.String scaleDownBillions,
                      java.lang.String scaleDownTrillions,
                      java.lang.String scaleDownQuadrillions,
                      java.lang.String dateFormat)

Constructor that sets individual ViewFormat properties. At this point, no property values have been set.

Parameters:

numberType - A constant that represents the type of the number, such as general, currency, date, or percent.

thousandSeparator - A character that groups integral digits into sets of three.

decimalSeparator - A character that separates integral and decimal digits.

currencySymbol - A character or String that indicates a currency value.

leadingZero - true to display the number values that fall between 1.0 and -1.0 with leading zeros, false to display them without leading zeros.

decimalDigit - The number of digits that appear to the right of the decimal divider.

posNumFmt - A constant that indicates a positive number.

negNumFmt - A constant that indicates a negative number.

posCurFmt - A constant that indicates a positive currency value.

negCurFmt - A constant that indicates a negative currency value.

scaleFactor - A constant that specifies the number of digits to the left to move the decimal point.

scaleDownThousands - A character or String that represents the abbreviation for thousand.

scaleDownMillions - A character or String that represents the abbreviation for million.

scaleDownBillions - A character or String that represents the abbreviation for billion.

scaleDownTrillions - A character or String that represents the abbreviation for trillion.

scaleDownQuadrillions - A character or String that represents the abbreviation for quadrillion.

dateFormat - The format that determines the way in which the date is displayed, such as MM/DD/YY, or DD/MM/YY.

BaseViewFormat

public BaseViewFormat(java.lang.String strNumberFormatString,
                      int nNumberFormatType)

Constructor that specifies how a number should be formatted, based on the specified format mask and type.

This constructor sets the properties of this ViewFormat object, according to the format string that is specified in this method. Any property that is initialized by the strNumberFormatString is marked as being used.

Parameters:

strNumberFormatString - A number format mask of property values for this ViewFormat object.

nNumberFormatType - A constant that represents the type of format String that strNumberFormatString represents. Valid constants are listed in the See Also section.

See Also:

OEO_PATTERN_STR, ORACLE_PATTERN_STR

Method Detail

init

public void init()

Clears all properties from the ViewFormat. This is equivalent to calling the empty constructor.

init

public void init(int numberType,
                 char thousandSeparator,
                 char decimalSeparator,
                 java.lang.String currencySymbol,
                 boolean leadingZero,
                 int decimalDigit,
                 int posNumFmt,
                 int negNumFmt,
                 int posCurFmt,
                 int negCurFmt,
                 int scaleFactor,
                 java.lang.String scaleDownThousands,
                 java.lang.String scaleDownMillions,
                 java.lang.String scaleDownBillions,
                 java.lang.String scaleDownTrillions,
                 java.lang.String scaleDownQuadrillions,
                 java.lang.String dateFormat)

Sets individual ViewFormat properties. At this point, no property values have been set.

Parameters:

numberType - A constant that represents the type of the number, such as general, currency, date, or percent.

thousandSeparator - A character that groups integral digits into sets of three.

decimalSeparator - A character that separates integral and decimal digits.

currencySymbol - A character or String that indicates a currency value.

leadingZero - true to display the number values that fall between 1.0 and -1.0 with leading zeros, false to display them without leading zeros.

decimalDigit - The number of digits that appear to the right of the decimal divider.

posNumFmt - A constant that indicates a positive number.

negNumFmt - A constant that indicates a negative number.

posCurFmt - A constant that indicates a positive currency value.

negCurFmt - A constant that indicates a negative currency value.

scaleFactor - A constant that specifies the number of digits to the left to move the decimal point.

scaleDownThousands - A character or String that represents the abbreviation for thousand.

scaleDownMillions - A character or String that represents the abbreviation for million.

scaleDownBillions - A character or String that represents the abbreviation for billion.

scaleDownTrillions - A character or String that represents the abbreviation for trillion.

scaleDownQuadrillions - A character or String that represents the abbreviation for quadrillion.

dateFormat - The format that determines the way in which the date is displayed, such as MM/DD/YY, or DD/MM/YY.

getXML

public oracle.dss.util.xml.ObjectNode getXML(boolean allProperties)

Parameters:

allProperties - true to store all property values in XML, false to store only values that are different from default values.

Returns:

XML for the properties and values.

See Also:

(boolean, boolean)

getXML

public oracle.dss.util.xml.ObjectNode getXML(boolean allProperties,
                                             boolean emptyElement)

Description copied from interface: MergeableXML

Retrieves XML that represents properties and their values in the form of and ObjectNode.

Specified by:

getXML in interface MergeableXML

Parameters:

allProperties - true to store all property values in XML, false to store only values that are different from default values.

emptyElement - true if an empty element needs to be returned when none of the property values have changed from default. false if null should should be returned when none of the property values have changed from default. This argument is considered only if allProperties is false.

Returns:

XML for the properties and values.

setXML

public boolean setXML(oracle.dss.util.xml.ObjectNode node,
                      java.lang.String version,
                      int reset,
                      java.util.HashMap map)

setXML

public boolean setXML(oracle.dss.util.xml.ObjectNode node,
                      java.lang.String version,
                      int reset)

Description copied from interface: MergeableXML

Specifies XML that represents properties and values. This method applies the values of the properties in the XML to this MergeableXML.

Specified by:

setXML in interface MergeableXML

Parameters:

node - ObjectNode that has the properties and their values.

version - The XML version.

reset - A constant that indicates how much to reset when XML is applied. Valid values are listed in the See Also section.

Returns:

true if XML is properly applied, false if the XML cannot be applied.

See Also:

Rule.RESET_NONE, Rule.RESET_XML_PROPERTIES, Rule.RESET_EVERYTHING

convertNumberTypeToInt

public static int convertNumberTypeToInt(java.lang.String value)

Returns:

convertPosNumFmtToInt

public static int convertPosNumFmtToInt(java.lang.String value)

convertPosCurFmtToInt

public static int convertPosCurFmtToInt(java.lang.String value)

convertNegCurFmtToInt

public static int convertNegCurFmtToInt(java.lang.String value)

convertNegNumFmtToInt

public static int convertNegNumFmtToInt(java.lang.String value)

convertScaleFactorToInt

public static int convertScaleFactorToInt(java.lang.String value)

isAnythingOverridden

public boolean isAnythingOverridden()

Indicates whether any of the property of this ViewFormat has been explicitly set.

Specified by:

isAnythingOverridden in interface Mergeable

Returns:

true if any property has been explicitly set, false if the properties have their original values.

clone

public java.lang.Object clone()

Clones this ViewFormat object.

Specified by:

clone in interface Mergeable

Overrides:

clone in class java.lang.Object

Returns:

The clone of this ViewFormat object.

merge

public void merge(Mergeable from)

Merges the specified ViewFormat object with this object. This method is called by the Rule classes.

Applications should not call this method to set properties of the ViewFormat, because the view is not refreshed when this method is called. Instead, call the normal access methods to set properties of the ViewFormat. For example, to set the currency symbol, call the setCurrencySymbol method.

Alternately, set a new ViewFormat on the view.

Specified by:

merge in interface Mergeable

Parameters:

from - The ViewFormat object that you want to merge.

See Also:

Rule

equals

public boolean equals(java.lang.Object o)

Indicates whether the specified object is equivalent to this ViewFormat object. Objects are equivalent if they have the same properties explicitly set and those properties have the same values.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object that you want to compare with this ViewFormat object.

Returns:

true if they are equal, false if not, or if o is not a ViewFormat object.

initWithString

public void initWithString(java.lang.String strNumberFormatString,
                           int nNumberFormatType)

Initializes this BaseViewFormat from a format String. This method updates the properties of this BaseViewFormat object according to the specified format string. Any property that is initialized by the strNumberFormatString is marked as being used.

Parameters:

strNumberFormatString - The number format mask that specifies property values for this BaseViewFormat object.

nNumberFormatType - A constant that represents the type of format String that strNumberFormatString represents. Valid constants are listed in the See Also section.

See Also:

OEO_PATTERN_STR, ORACLE_PATTERN_STR

validateFormatString

public boolean validateFormatString(java.lang.String strNumberFormatString,
                                    int nNumberFormatType)

Validates a format String before setting its values on this BaseViewFormat. This method updates the properties of this ViewFormat object according to the format string that is specified in this method. Any property that is initialized by the strNumberFormatString is marked as being used.

Parameters:

strNumberFormatString - The number format mask that specifies property values for this BaseViewFormat object.

nNumberFormatType - A constant that represents the type of format String that strNumberFormatString represents. Valid constants are listed in the See Also section.

Returns:

true if the format string is valid, false if it is not.

See Also:

OEO_PATTERN_STR, ORACLE_PATTERN_STR

clearUsedBits

public void clearUsedBits()

Sets all of the "used" ViewFormat properties to false. Immediately after you call this method, the IsAnythingOverridden method returns false.

toString

public java.lang.String toString()

Generates a String representation of this ViewFormat.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

BooleanToString

public java.lang.String BooleanToString(boolean bValue)

Generates a String representation of a Boolean value.

Parameters:

bValue - The Boolean value that you want to format as a String.

Returns:

A String representation of bValue.

DateToString

public java.lang.String DateToString(java.sql.Date dateValue)

Generates a String representation of a java.sql.Date value.

Parameters:

dateValue - The date value that you want to format as a String.

Returns:

A String representation of dateValue.

UtilDateToString

public java.lang.String UtilDateToString(java.util.Date dateValue)

Generates a String representation of a Date value.

Parameters:

dateValue - The date value that you want to format as a String.

Returns:

A String representation of dateValue.

DoubleToString

public java.lang.String DoubleToString(double dValue)

Generates a String representation of a double value.

Parameters:

dValue - The double value that you want to format as a String.

Returns:

A String representation of dValue.

FloatToString

public java.lang.String FloatToString(float fValue)

Generates a String representation of a float value.

Parameters:

fValue - The float value that you want to format as a String.

Returns:

A String representation of fValue.

TimeToString

public java.lang.String TimeToString(java.sql.Time timeValue)

Generates a String representation of a Time value.

Parameters:

timeValue - The time value that you want to format as a String.

Returns:

A String representation of timeValue.

TimestampToString

public java.lang.String TimestampToString(java.sql.Timestamp timeValue)

Generates a String representation of a Timestamp value.

Parameters:

timeValue - The time stamp value that you want to format as a String.

Returns:

A String representation of timeValue.

getCurrencySymbol

public java.lang.String getCurrencySymbol()

Retrieves the character or String that indicates a currency value. The default value is DEFAULT_CURRENCY_SYMBOL. The default value is used when no value has been specified.

Returns:

The character or String that indicates a currency value for this ViewFormat object.

See Also:

DEFAULT_CURRENCY_SYMBOL

getDecimalDigit

public int getDecimalDigit()

Retrieves the number of digits that appear to the right of the decimal in a number. When this property has not been specified, this method returns the minimum fraction digits from the locale.

Returns:

The number of digits that appear to the right of the decimal in a number.

getJavaDateFormat

public java.lang.String getJavaDateFormat()

Retrieves the Java date format for this ViewFormat. MM/dd/yyyy or dd/MM/yyyy. This method uses the Java date formatting mechanism. For information about valid format strings, see the documentation for the java.text.SimpleDateFormat class.

Returns:

The way in which the date is displayed.

See Also:

SimpleDateFormat

getOracleDateFormat

public java.lang.String getOracleDateFormat()

Retrieves the Oracle date format for this ViewFormat such as MM/DD/YYYY or DD/MM/YYYY. This method uses the Oracle date formatting mechanism. For information about valid format strings, consult your core Oracle documentation. Internal Oracle developers can find this information at http://www-st.us.oracle.com/webpages/dst/coredev/docs5/appc.html.

Returns:

The Oracle date format that this ViewFormat uses.

getDecimalSeparator

public char getDecimalSeparator()

Retrieves the character or String that separates the integer and decimal parts of numbers. The default is THOU_SEP_BY_LOCALE, which means the thousands separator is based on the locale.

Returns:

The character or String that separates the integer and decimal parts of numbers.

getDecimalSeparatorSymbol

public char getDecimalSeparatorSymbol()

isLeadingZero

public boolean isLeadingZero()

Indicates whether numbers that fall between 1.0 and -1.0 are displayed with leading zeros. The default return value for this method is true. The default value is used when no value has been explicitly set.

Returns:

true if the numbers that fall between 1.0 and -1.0 are displayed with leading zeros, false if they are not displayed with leading zeros.

getNegCurFmt

public int getNegCurFmt()

Retrieves the character or String that indicates a negative currency value. The default value is NEG_CURFMT_BY_LOCALE, which means that the negative currency format is based on locale.

Returns:

The constant that represents a negative currency format.

See Also:

NEG_CURFMT_BY_LOCALE, NEG_CURFMT_CUR_NEG_NUM, NEG_CURFMT_CUR_NUM_NEG, NEG_CURFMT_NEG_CUR_NUM, NEG_CURFMT_NEG_NUM_CUR, NEG_CURFMT_NUM_CUR_NEG, NEG_CURFMT_NUM_NEG_CUR, NEG_CURFMT_OP_CUR_NUM_CP, NEG_CURFMT_OP_NUM_CUR_CP, NEG_CURFMT_NEG_CUR_SPAC_NUM, NEG_CURFMT_NEG_NUM_SPAC_CUR, NEG_CURFMT_NUM_SPAC_CUR_NEG

getNegCurFmtValue

public int getNegCurFmtValue()

getNegNumFmt

public int getNegNumFmt()

Retrieves the character or String that indicates a negative number value. The default value is NEG_NUMFMT_BY_LOCALE, which means that the negative number format is based on locale.

Returns:

The constant that represents a negative number format.

See Also:

NEG_NUMFMT_BY_LOCALE, NEG_NUMFMT_NEG_NUM, NEG_NUMFMT_NUM_NEG, NEG_NUMFMT_OP_NUM_CP

getNegNumFmtValue

public int getNegNumFmtValue()

getNumberType

public int getNumberType()

Retrieves the type of the number, such as general, currency, or percent. The default type is a general number, DEFAULT_NUM_TYPE. The default value is used when no value has been specified.

Returns:

The constant that represents the type of the number, such as general, currency, or percent.

See Also:

DEFAULT_NUM_TYPE, NUMTYPE_GENERAL, NUMTYPE_CURRENCY, NUMTYPE_PERCENT

getPosCurFmt

public int getPosCurFmt()

Retrieves the character or String that indicates a positive currency value. The default value is POS_CURFMT_BY_LOCALE, which means that the positive currency format is based on locale.

Returns:

The constant that represents a positive currency format.

See Also:

POS_CURFMT_BY_LOCALE, POS_CURFMT_CUR_NUM, POS_CURFMT_CUR_NUM_POS, POS_CURFMT_CUR_SPAC_NUM, POS_CURFMT_NUM_CUR, POS_CURFMT_NUM_CUR_POS, POS_CURFMT_NUM_POS_CUR, POS_CURFMT_NUM_SPAC_CUR, POS_CURFMT_NUM_SPAC_CUR_POS, POS_CURFMT_POS_CUR_NUM, POS_CURFMT_POS_CUR_SPAC_NUM, POS_CURFMT_POS_NUM_CUR, POS_CURFMT_POS_NUM_SPAC_CUR

getPosCurFmtValue

public int getPosCurFmtValue()

getPosNumFmt

public int getPosNumFmt()

Retrieves the character or String that indicates a positive number value. The default value is POS_NUMFMT_BY_LOCALE, which means that the positive number format is based on locale.

Returns:

The constant that represents a positive number format.

See Also:

POS_NUMFMT_BY_LOCALE, POS_NUMFMT_NUM, POS_NUMFMT_NUM_POS, POS_NUMFMT_POS_NUM

getPosNumFmtValue

public int getPosNumFmtValue()

getScaleDownBillions

public java.lang.String getScaleDownBillions()

Retrieves the character or String that represents the abbreviation for billions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for billions is based on locale.

Returns:

The character or String that represents the abbreviation for billions.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownBillionsSymbol

public java.lang.String getScaleDownBillionsSymbol()

getScaleDownMillions

public java.lang.String getScaleDownMillions()

Retrieves the character or String that represents the abbreviation for millions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for millions is based on locale.

Returns:

The character or String that represents the abbreviation for millions.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownMillionsSymbol

public java.lang.String getScaleDownMillionsSymbol()

getScaleDownQuadrillions

public java.lang.String getScaleDownQuadrillions()

Retrieves the character or String that represents the abbreviation for quadrillions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for quadrillions is based on locale.

Returns:

The character or String that represents the abbreviation for quadrillions.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownQuadrillionsSymbol

public java.lang.String getScaleDownQuadrillionsSymbol()

getScaleDownThousands

public java.lang.String getScaleDownThousands()

Retrieves the character or String that represents the abbreviation for thousands. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for thousands is based on locale.

Returns:

The character or String that represents the abbreviation for thousands.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownThousandsSymbol

public java.lang.String getScaleDownThousandsSymbol()

getScaleDownTrillions

public java.lang.String getScaleDownTrillions()

Retrieves the character or String that represents the abbreviation for trillions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for trillions is based on locale.

Returns:

The character or String that represents the abbreviation for trillions.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownTrillionsSymbol

public java.lang.String getScaleDownTrillionsSymbol()

getScaleFactor

public int getScaleFactor()

Retrieves the amount that a number is abbreviated. For example, if the data is 153,000, but the view displays it as 153K, then the ScaleFactor property is set to SCALEFACTOR_THOUSANDS.

The default is DEFAULT_SCALE_FACTOR, which returns no scaling. The decimal point is not moved. The default value is used when no scale factor value has been specified.

Returns:

A constant that represents the scale by which to abbreviate a number. Constants are listed in the See Also section.

See Also:

DEFAULT_SCALE_FACTOR, SCALEFACTOR_NONE, SCALEFACTOR_THOUSANDS, SCALEFACTOR_MILLIONS, SCALEFACTOR_BILLIONS, SCALEFACTOR_TRILLIONS, SCALEFACTOR_QUADRILLIONS

convertScalingToScaleFactor

public int convertScalingToScaleFactor(java.lang.String scaling)

convertNonAutoScalingToScaleFactor

public static int convertNonAutoScalingToScaleFactor(java.lang.String scaling)

convertScaleFactorToScaling

public java.lang.String convertScaleFactorToScaling(boolean isScaleFactorUsed,
                                                    int scaleFactor)

getThousandSeparator

public char getThousandSeparator()

Retrieves the character or String that separates thousands in number values. The default is THOU_SEP_BY_LOCALE, which means that the thousands separator is based on the locale.

Returns:

The character or String that separates thousands in number values.

See Also:

THOU_SEP_BY_LOCALE

getThousandSeparatorUsed

public boolean getThousandSeparatorUsed()

getThousandSeparatorSymbol

public char getThousandSeparatorSymbol()

IntToString

public java.lang.String IntToString(int iValue)

Formats an integer value as a String.

Parameters:

iValue - The integer value that you want to format as a String.

Returns:

The integer value after it has been formatted as a String.

isCurrencySymbolUsed

public boolean isCurrencySymbolUsed()

Indicates whether the CurrencySymbol property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isDecimalDigitUsed

public boolean isDecimalDigitUsed()

Indicates whether the DecimalDigit property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isOracleDateFormatUsed

public boolean isOracleDateFormatUsed()

Indicates whether the OracleDateFormat property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isJavaDateFormatUsed

public boolean isJavaDateFormatUsed()

Indicates whether the JavaDateFormat property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isDecimalSeparatorUsed

public boolean isDecimalSeparatorUsed()

Indicates whether the DecimalSeparator property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isLeadingZeroUsed

public boolean isLeadingZeroUsed()

Indicates whether the LeadingZero property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isNegCurFmtUsed

public boolean isNegCurFmtUsed()

Indicates whether the NegCurFmt property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isNegNumFmtUsed

public boolean isNegNumFmtUsed()

Indicates whether the NegNumFmt property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isNumberTypeUsed

public boolean isNumberTypeUsed()

Indicates whether the NumberType property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isPosCurFmtUsed

public boolean isPosCurFmtUsed()

Indicates whether the PosCurFmt property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isPosNumFmtUsed

public boolean isPosNumFmtUsed()

Indicates whether the PosNumFmt property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isScaleDownBillionsUsed

public boolean isScaleDownBillionsUsed()

Indicates whether the ScaleDownBillions property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isScaleDownMillionsUsed

public boolean isScaleDownMillionsUsed()

Indicates whether the ScaleDownMillions property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isScaleDownQuadrillionsUsed

public boolean isScaleDownQuadrillionsUsed()

Indicates whether the ScaleDownQuadrillions property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isScaleDownThousandsUsed

public boolean isScaleDownThousandsUsed()

Indicates whether the ScaleDownThousands property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isScaleDownTrillionsUsed

public boolean isScaleDownTrillionsUsed()

Indicates whether the ScaleDownTrillions property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isScaleFactorUsed

public boolean isScaleFactorUsed()

Indicates whether the ScaleFactor property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

isThousandSeparatorUsed

public boolean isThousandSeparatorUsed()

Indicates whether the ThousandSeparator property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

LongToString

public java.lang.String LongToString(long lValue)

Generates a String representation of a long value.

Parameters:

lValue - The long value that you want to format as a String.

Returns:

A String representation of lValue.

ObjectToString

public java.lang.String ObjectToString(java.lang.Object objValue)

Generates a String representation of an object. If the object type is unknown, then the object's toString method will be called. If the parameter value of this method is null, then the return value of this method will be an empty String.

Parameters:

objValue - The object that you want to format as a String.

Returns:

A String representation of objValue.

setCurrencySymbol

public void setCurrencySymbol(java.lang.String sCurrencySymbol)

Specifies the character or String that indicates a currency value. The default value is DEFAULT_CURRENCY_SYMBOL. The default value is used when no value has been specified. This method also sets the CurrencySymbolUsed property to true.

Parameters:

String - The character or String that indicates a currency value, for this ViewFormat object.

See Also:

DEFAULT_CURRENCY_SYMBOL

setCurrencySymbolUsed

public void setCurrencySymbolUsed(boolean bValue)

Specifies whether the CurrencySymbol property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setCurrencySymbol method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setDecimalDigit

public void setDecimalDigit(int iDecimalDigit)

Specifies the number of digits that appear to the right of the decimal in a number. When this property has not been specified, the minimum fraction digits from the locale. This method also sets the DecimalDigitUsed property to true.

Parameters:

iDecimalDigit - The number of digits that appear to the right of the decimal in a number.

setDecimalDigitUsed

public void setDecimalDigitUsed(boolean bValue)

Specifies whether the DecimalDigit property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setDecimalDigit method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setJavaDateFormat

public void setJavaDateFormat(java.lang.String sDateFormat)

Specifies the way in which the date is displayed, such as MM/dd/yyyy, or dd/MM/yyyy. This method uses the Java date formatting mechanism. For information about valid format strings, see the documentation for the java.text.SimpleDateFormat class.

This method also sets the DateFormatUsed property to true.

Parameters:

sDateFormat - A Java date format pattern that specifies the format for dates.

setOracleDateFormat

public void setOracleDateFormat(java.lang.String sDateFormat)

Specifies the way in which the oracle date is displayed, such as MM/DD/YYYY, or DD/MM/YYYY. For information about valid format strings, consult your core Oracle documentation. Internal Oracle developers can find this information at http://www-st.us.oracle.com/webpages/dst/coredev/docs5/appc.html.

This method also sets the OracleDateFormatUsed property to true.

Parameters:

sDateFormat - A Oracle date format pattern that specifies the format for dates.

setJavaDateFormatUsed

public void setJavaDateFormatUsed(boolean bValue)

Specifies whether the JavaDateFormat property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setJavaDateFormat method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setOracleDateFormatUsed

public void setOracleDateFormatUsed(boolean bValue)

Specifies whether the OracleDateFormat property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setOracleDateFormat method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setDecimalSeparator

public void setDecimalSeparator(char cDecimalSeparator)

Specifies the character or String that separates the integer and decimal parts of numbers. The default is DEC_SEP_BY_LOCALE, which means that the decimal separator is based on the locale. This method also sets the DecimalSeparatorUsed property to true.

Parameters:

cDecimalSeparator - The character or String that separates the integer and decimal parts of numbers.

setDecimalSeparatorUsed

public void setDecimalSeparatorUsed(boolean bValue)

Specifies whether the DecimalSeparator property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setDecimalSeparator method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setLeadingZero

public void setLeadingZero(boolean bLeadingZero)

Specifies whether numbers that fall between 1.0 and -1.0 are displayed with leading zeros. The default return value for this method is true. The default value is used when no value has been explicitly set. This method also sets the LeadingZeroUsed property to true.

Parameters:

bLeadingZero - true to display leading zeros in front of the numbers that fall between 1.0 and -1.0, false to display them without leading zeros.

setLeadingZeroUsed

public void setLeadingZeroUsed(boolean bValue)

Specifies whether the LeadingZero property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setLeadingZero method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setNegCurFmt

public void setNegCurFmt(int iNegCurFmt)

Specifies the character or String that indicates a negative currency value. The default value is NEG_CURFMT_BY_LOCALE, which means that the negative currency format is based on locale. This method also sets the NegCurFmtUsed property to true.

Parameters:

iNegCurFmt - The constant that represents a negative currency format.

See Also:

NEG_CURFMT_BY_LOCALE, NEG_CURFMT_CUR_NEG_NUM, NEG_CURFMT_CUR_NUM_NEG, NEG_CURFMT_NEG_CUR_NUM, NEG_CURFMT_NEG_NUM_CUR, NEG_CURFMT_NUM_CUR_NEG, NEG_CURFMT_NUM_NEG_CUR, NEG_CURFMT_OP_CUR_NUM_CP, NEG_CURFMT_OP_NUM_CUR_CP, NEG_CURFMT_NEG_CUR_SPAC_NUM, NEG_CURFMT_NEG_NUM_SPAC_CUR, NEG_CURFMT_NUM_SPAC_CUR_NEG

setNegCurFmtUsed

public void setNegCurFmtUsed(boolean bValue)

Specifies whether the NegCurFmt property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setNegCurFmt method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setNegNumFmt

public void setNegNumFmt(int iNegNumFmt)

Specifies the character or String that indicates a negative number value. The default value is NEG_NUMFMT_BY_LOCALE, which means that the positive number format is based on locale. This method also sets the NegNumFmtUsed property to true.

Parameters:

iNegNumFmt - The constant that represents a negative number format. Valid constants are listed in the See Also section.

See Also:

NEG_NUMFMT_BY_LOCALE, NEG_NUMFMT_NEG_NUM, NEG_NUMFMT_NUM_NEG, NEG_NUMFMT_OP_NUM_CP

setNegNumFmtUsed

public void setNegNumFmtUsed(boolean bValue)

Specifies whether the NegNumFmt property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setNegNumFmt method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setNumberType

public void setNumberType(int iNumberType)

Specifies the type of the number, such as general, currency, or percent. The default type is a general number, DEFAULT_NUM_TYPE. The default value is used when no value has been specified. This method also sets the NumberTypeUsed property to true.

Parameters:

iNumberType - The constant that represents the type of the number, such as general, currency, or percent. Valid constants are listed in the See Also section.

See Also:

DEFAULT_NUM_TYPE, NUMTYPE_GENERAL, NUMTYPE_CURRENCY, NUMTYPE_PERCENT

setNumberTypeUsed

public void setNumberTypeUsed(boolean bValue)

Specifies whether the NumberType property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setNumberType method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setPosCurFmt

public void setPosCurFmt(int iPosCurFmt)

Specifies the character or String that indicates a positive currency value. The default value is POS_CURFMT_BY_LOCALE, which means that the positive currency format is based on locale. This method also sets the PosCurFmtUsed property to true.

Parameters:

iPosCurFmt - The constant that represents a positive currency format. Valid constants are listed in the See Also section.

See Also:

POS_CURFMT_BY_LOCALE, POS_CURFMT_CUR_NUM, POS_CURFMT_CUR_NUM_POS, POS_CURFMT_CUR_SPAC_NUM, POS_CURFMT_NUM_CUR, POS_CURFMT_NUM_CUR_POS, POS_CURFMT_NUM_POS_CUR, POS_CURFMT_NUM_SPAC_CUR, POS_CURFMT_NUM_SPAC_CUR_POS, POS_CURFMT_POS_CUR_NUM, POS_CURFMT_POS_CUR_SPAC_NUM, POS_CURFMT_POS_NUM_CUR, POS_CURFMT_POS_NUM_SPAC_CUR

setPosCurFmtUsed

public void setPosCurFmtUsed(boolean bValue)

Specifies whether the PosCurFmt property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setPosCurFmt method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setPosNumFmt

public void setPosNumFmt(int iPosNumFmt)

Specifies the character or String that indicates a positive number value. The default value is POS_NUMFMT_BY_LOCALE, which means that the positive number format is based on locale. This method also sets the PosNumFmtUsed property to true.

Parameters:

iPosNumFmt - The constant that represents a positive number format. Valid constants are listed in the See Also section.

See Also:

POS_NUMFMT_BY_LOCALE, POS_NUMFMT_NUM, POS_NUMFMT_NUM_POS, POS_NUMFMT_POS_NUM

setPosNumFmtUsed

public void setPosNumFmtUsed(boolean bValue)

Specifies whether the PosNumFmt property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setPosNumFmt method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setScaleDownBillions

public void setScaleDownBillions(java.lang.String sValue)

Specifies the character or String that represents the abbreviation for billions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for billions is based on locale. This method also sets the ScaleDownBillionsUsed property to true.

Parameters:

sValue - The the character or String that represents the abbreviation for billions.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

setScaleDownBillionsUsed

public void setScaleDownBillionsUsed(boolean bValue)

Specifies whether the ScaleDownBillions property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setScaleDownBillions method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setScaleDownMillions

public void setScaleDownMillions(java.lang.String sValue)

Specifies the character or String that represents the abbreviation for million. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for millions is based on locale. This method also sets the ScaleDownMillionsUsed property to true.

Parameters:

sValue - The the character or String that represents the abbreviation for millions.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

setScaleDownMillionsUsed

public void setScaleDownMillionsUsed(boolean bValue)

Specifies whether the ScaleDownMillions property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. The parameter value of this method is called by the setScaleDownMillions method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setScaleDownQuadrillions

public void setScaleDownQuadrillions(java.lang.String sValue)

Specifies the character or String that represents the abbreviation for quadrillions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for quadrillion is based on locale. This method also sets the ScaleDownQuadrillionsUsed property ' to true.

Parameters:

sValue - The the character or String that represents the abbreviation for quadrillions.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

setScaleDownQuadrillionsUsed

public void setScaleDownQuadrillionsUsed(boolean bValue)

Specifies whether the ScaleDownQuadrillions property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. This method is called by the setScaleDownQuadrillions method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setScaleDownThousands

public void setScaleDownThousands(java.lang.String sValue)

Specifies the character or String that represents the abbreviation for thousands. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for thousands is based on locale. This method also sets the ScaleDownThousandsUsed property to true.

Parameters:

sValue - The the character or String that represents the abbreviation for thousands.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

setScaleDownThousandsUsed

public void setScaleDownThousandsUsed(boolean bValue)

Specifies whether the ScaleDownThousands property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. This method is called by the setScaleDownThousands method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setScaleDownTrillions

public void setScaleDownTrillions(java.lang.String sValue)

Specifies the character or String that represents the abbreviation for trillions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for trillions is based on locale. This method also sets the ScaleDownTrillionsUsed property to true.

Parameters:

sValue - The the character or String that represents the abbreviation for trillions.

See Also:

SCALE_DOWN_SYMBOL_BY_LOCALE

setScaleDownTrillionsUsed

public void setScaleDownTrillionsUsed(boolean bValue)

Specifies whether the ScaleDownTrillions property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. This method is called by the setScaleDownTrillions method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setScaleFactor

public void setScaleFactor(int iScaleFactor)

Specifies how much to abbreviate a number. For example, if you set ScaleFactor to SCALEFACTOR_THOUSANDS, the view displays the number as thousands, and a number such as 153,000 appears as 153K (assuming the default value of the ScaleDownThousands property).

The default is DEFAULT_SCALE_FACTOR, which specifies no scaling. The default value is used when no scale factor value has been specified. This method also sets the ScaleFactorUsed property to true.

Parameters:

iScaleFactor - A constant that represents the scale by which to abbreviate a number. Valid constants are listed in the See Also section.

See Also:

DEFAULT_SCALE_FACTOR, SCALEFACTOR_NONE, SCALEFACTOR_THOUSANDS, SCALEFACTOR_MILLIONS, SCALEFACTOR_BILLIONS, SCALEFACTOR_TRILLIONS, SCALEFACTOR_QUADRILLIONS

setScaleFactorUsed

public void setScaleFactorUsed(boolean bValue)

Specifies whether the ScaleFactor property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. This method is called by the setScaleFactor method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

setThousandSeparator

public void setThousandSeparator(char cThousandSeparator)

Specifies the character or String that separates thousands in number values. The default is THOU_SEP_BY_LOCALE, which means that the thousands separator is based on the locale. This method also sets the ThousandsSeparatorUsed property to true.

Parameters:

cThousandSeparator - The character or String that separates thousands in number values.

setThousandSeparatorUsed

public void setThousandSeparatorUsed(boolean bValue)

Specifies whether the ThousandSeparator property has been explicitly set. When the parameter value of this method is true, the property's value will be used in the merging process. This method is called by the setThousandSeparator method.

Parameters:

bValue - true if the property has been explicitly set, false if the property has not been explicitly set.

ShortToString

public java.lang.String ShortToString(short sValue)

Generates a String representation of a short value.

Parameters:

sValue - The short value that you want to format as a String.

Returns:

A String representation of sValue.

StringToBoolean

public java.lang.Boolean StringToBoolean(java.lang.String sValue)

Converts a String into a Boolean object. The caller must ensure that the String is a valid Boolean.

Parameters:

sValue - The String that you want to convert into a Boolean object.

Returns:

A Boolean for sValue.

StringToDate

public java.sql.Date StringToDate(java.lang.String sValue)

Converts a String into a java.sql.Date object. The caller must ensure that the String is a valid java.sql.Date.

Parameters:

sValue - The String that you want to convert into a java.sql.Date object.

Returns:

A java.sql.Date for sValue.

StringToDate

public java.sql.Date StringToDate(java.lang.String sValue,
                                  boolean dynamic)

Parameters:

sValue - The String that you want to convert into a java.sql.Date object.

dynamic - Indicates whether any Date component not specified in the String should be defaulted dynamically based on the current Date or statically.

Returns:

A java.sql.Date for sValue.

StringToUtilDate

public java.util.Date StringToUtilDate(java.lang.String sValue)

Converts a String into a Date object. The caller must ensure that the String is a valid Date.

Parameters:

sValue - The String that you want to convert into a Date object.

dynamic - Indicates whether any Date component not specified in the String should be defaulted dynamically based on the current Date or statically.

Returns:

A Date for sValue.

StringToDouble

public double StringToDouble(java.lang.String sValue)
                      throws java.text.ParseException

Converts a String into a double value. The caller must ensure that the String is a valid double.

Parameters:

sValue - The String that you want to convert into a double value.

Returns:

A double for sValue.

Throws:

java.text.ParseException - If sValue does not represent a double value.

StringToFloat

public float StringToFloat(java.lang.String sValue)
                    throws java.text.ParseException

Converts a String into a float value. The caller must ensure that the String is a valid float.

Parameters:

sValue - The String that you want to convert into a float value.

Returns:

A float for sValue.

Throws:

java.text.ParseException - If sValue does not represent a float value.

StringToInt

public int StringToInt(java.lang.String sValue)
                throws java.text.ParseException

Converts a String into an integer. The caller must ensure that the String is a valid integer.

Parameters:

sValue - The String that you want to convert into an integer.

Returns:

An int for sValue.

Throws:

java.text.ParseException - If sValue does not represent an integer.

StringToLong

public long StringToLong(java.lang.String sValue)
                  throws java.text.ParseException

Converts a String into a long value. The caller must ensure that the String is a valid long.

Parameters:

sValue - The String that you want to convert into a long value.

Returns:

A long for sValue

Throws:

java.text.ParseException - If sValue does not represent a long value.

StringToObject

public java.lang.Object StringToObject(java.lang.String sValue,
                                       int iDataType)

Converts a String into an object. The caller must ensure that the String is valid for the specified data type.

Parameters:

sValue - The String that you want to convert into an object.

iDataType - A constant that identifies the data type that you want the returned object to have. Valid constants are listed in the See Also section.

Returns:

An object for sValue, or null if sValue cannot be converted into an object.

See Also:

DATATYPE_BOOLEAN, DATATYPE_DATE, DATATYPE_DOUBLE, DATATYPE_FLOAT, DATATYPE_INT, DATATYPE_LONG, DATATYPE_SHORT, DATATYPE_STRING, DATATYPE_TIME, DATATYPE_TIMESTAMP

StringToShort

public short StringToShort(java.lang.String sValue)
                    throws java.text.ParseException

Converts a String into a short value. The caller must ensure that the String is a valid short.

Parameters:

sValue - The String that you want to convert into a short value.

Returns:

A short value for sValue.

Throws:

java.text.ParseException - If sValue does not represent a short value.

StringToString

public java.lang.String StringToString(java.lang.String sValue)

Converts a String into a String object, through the Date class.

Parameters:

sValue - The String that you want to convert into a String object through the Date class.

Returns:

The String after it has been converted into a String object through the Date class.

StringToTime

public java.sql.Time StringToTime(java.lang.String sValue)

Converts a String into a Time object. The caller must ensure that the String is a valid Time.

Parameters:

sValue - The String that you want to convert into a Time object.

Returns:

A Time object for sValue.

StringToTimestamp

public java.sql.Timestamp StringToTimestamp(java.lang.String sValue)

Converts a String into a Timestamp object. The caller must ensure that the String is a valid Timestamp.

Parameters:

sValue - The String that you want to convert into a Timestamp object.

Returns:

A Timestamp object for sValue.

setViewFormatCallback

public void setViewFormatCallback(BaseViewFormatCallback vfc)

Parameters:

vfc - the ViewFormatCallback to notify when properties change

setLocale

public void setLocale(java.util.Locale loc)

setLocale

protected void setLocale(java.util.Locale loc,
                         boolean setAlways)

Parameters:

setAlways - boolean indicating whether to set even if the locale has not changed.

updateDefaultSymbols

public void updateDefaultSymbols()

updateDefaultCurrencySymbol

public void updateDefaultCurrencySymbol()

getExternalDefault

protected java.lang.Object getExternalDefault(java.lang.String attributeName)

For internal use only. Application developers should not use this

getLocale

public java.util.Locale getLocale()

setTimeZone

public void setTimeZone(java.util.TimeZone tz)

Parameters:

tz - the TimeZone object

getTimeZone

public java.util.TimeZone getTimeZone()

Returns:

the TimeZone object

setErrorHandler

public void setErrorHandler(ErrorHandler eh)

Specifies the error handler for this BaseViewFormat. Call this method specify an error handler for this BaseViewFormat if you want to be notified of errors before you set this BaseViewFormat on a view or calculation. When you use this BaseViewFormat in a view, the view uses its own error handler instead of the error handler that is specified for this BaseViewFormat.

Parameters:

eh - The error handler to use.

booleanToLocString

public java.lang.String booleanToLocString(java.lang.Boolean bValue)

locStringToBoolean

public java.lang.Boolean locStringToBoolean(java.lang.String sValue)

getNumberFormatString

public java.lang.String getNumberFormatString(int nNumberFormatType)

Parameters:

nNumberFormatType - A int value that represents the type of format String that strNumberFormatString represents.

Returns:

String value which represents the format string, or null.

See Also:

BIBEANS_PATTERN_STR, OEO_PATTERN_STR, ORACLE_PATTERN_STR

setNumberFormatType

public int setNumberFormatType(int nNumberFormatType)

Parameters:

nNumberFormatType - A int which contains the number format type of the ViewFormat.

Returns:

int value which represents the number format type.

See Also:

BIBEANS_PATTERN_STR, OEO_PATTERN_STR, ORACLE_PATTERN_STR

getNumberFormatType

public int getNumberFormatType()

Returns:

int value which represents the number format type.

See Also:

BIBEANS_PATTERN_STR, OEO_PATTERN_STR, ORACLE_PATTERN_STR

setNumberFormatString

public void setNumberFormatString(java.lang.String strNumberFormatString)

Parameters:

strNumberFormatString - A String which contains the number format string associated with the ViewFormat.

See Also:

setNumberFormatType(int)

getNumberFormatString

public java.lang.String getNumberFormatString()

Returns:

String value which represents the number format string.

setScaleFactorExponent

public void setScaleFactorExponent(int nScaleFactorExponent)

Parameters:

nScaleFactorExponent - A int which contains the scale factor exponent.

getScaleFactorExponent

public int getScaleFactorExponent()

Returns:

int which represents the scale factor exponent.

_getErrorHandler

protected ErrorHandler _getErrorHandler()

isScaleFactorExponentUsed

public boolean isScaleFactorExponentUsed()

Returns:

true if the property has been explicitly set, false if the property has not been explicitly set.

setNegativeAngleBracketsUsed

public void setNegativeAngleBracketsUsed(boolean bNegativeAngleBracketsUsed)

Parameters:

bNegativeAngleBracketsUsed - A boolean which is true when there should be angle brackets should be placed around negative numbers and false otherwise.

isNegativeAngleBracketsUsed

public boolean isNegativeAngleBracketsUsed()

Returns:

boolean which is true when there should be angle brackets should be placed around negative numbers and false otherwise.

setPercentUsed

public void setPercentUsed(boolean bPercentUsed)

Deprecated. As of 3.2.0.22, replaced by setNumberType(int)

Parameters:

bPercentUsed - A boolean which is true when there should be a percent placed after the number and false otherwise.

isPercentUsed

public boolean isPercentUsed()

Deprecated. As of 3.2.0.22, replaced by #getNumberType(int)

Returns:

boolean which is true when there should be percent placed after the number and false otherwise.

setDefaultThousandSeparator

public void setDefaultThousandSeparator(char thouSep)

Parameters:

thouSep -

setDefaultDecimalSeparator

public void setDefaultDecimalSeparator(char decSep)

Parameters:

decSep -

setDefaultCurrencySymbol

public void setDefaultCurrencySymbol(java.lang.String currSym)

Parameters:

currSym -

setNumberConverter

public void setNumberConverter(NumberConverter converter)

getNumberConverter

public NumberConverter getNumberConverter()

setISOCurrency

public void setISOCurrency(boolean bISOCurr)

Parameters:

bISOCurr - true if the currency symbol is the ISO currency symbol (e.g. "USD" for US dollars); false if not (e.g. "$")

isISOCurrency

public boolean isISOCurrency()

Returns:

true if the currency symbol is the ISO currency symbol (e.g. "USD" for US dollars); false if not (e.g. "$")

setISOCurrencyUsed

public void setISOCurrencyUsed(boolean bISOCurrUsed)

Parameters:

bISOCurrUsed - true if ISOCurrency property has been set, false if not

isISOCurrencyUsed

public boolean isISOCurrencyUsed()

Returns:

true if ISOCurrency property has been set, false if not

setNegPctFmt

public void setNegPctFmt(int format)

Parameters:

format - format for negative percents

getNegPctFmt

public int getNegPctFmt()

Returns:

constant indicating negative percent format

setNegPctFmtUsed

public void setNegPctFmtUsed(boolean bUsed)

Parameters:

bUsed - true if NegPctFmt property has been set, false if not

isNegPctFmtUsed

public boolean isNegPctFmtUsed()

Returns:

true if NegPctFmt property has been set, false if not

setNumberFormatStringUsed

public void setNumberFormatStringUsed(boolean used)

isNumberFormatStringUsed

public boolean isNumberFormatStringUsed()

getNumberFormat

public java.text.NumberFormat getNumberFormat()

This method is for internal use only and should only be called by GraphExportXMLWriter. This returns a numberFormat object from which we will get the various number formatting properties. We use the numberFormat to get locale specific formatting information.

Returns: