oracle.dss.util.format
Class BaseViewFormat

java.lang.Object
  |
  +--oracle.dss.util.format.BaseViewFormat

All Implemented Interfaces:

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

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 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.
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: "($1)".
static int	DEFAULT_NEG_NUM_FMT Negative number format default: "(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: "$1".
static int	DEFAULT_POS_NUM_FMT Positive number format default: "1".
static java.lang.String	DEFAULT_SCALE_DOWN_BILLIONS_STRING Scale down to billions default: "B".
static java.lang.String	DEFAULT_SCALE_DOWN_MILLIONS_STRING Scale down to millions default: "M".
static java.lang.String	DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING Scale down to quadrillions default: "Q".
static java.lang.String	DEFAULT_SCALE_DOWN_THOUSANDS_STRING Scale down to thousands default: "K".
static java.lang.String	DEFAULT_SCALE_DOWN_TRILLIONS_STRING Scale down to trillions default: "T".
static int	DEFAULT_SCALE_FACTOR Scale factor default: none.
static int	NEG_CURFMT_CUR_NEG_NUM Negative currency format: "$-1".
static int	NEG_CURFMT_CUR_NUM_NEG Negative currency format: "$1-".
static int	NEG_CURFMT_NEG_CUR_NUM Negative currency format: "-$1".
static int	NEG_CURFMT_NEG_CUR_SPAC_NUM Negative currency format: "-$ 1".
static int	NEG_CURFMT_NEG_NUM_CUR Negative currency format: "(-1$)".
static int	NEG_CURFMT_NEG_NUM_SPAC_CUR Negative currency format: "-1 $".
static int	NEG_CURFMT_NUM_CUR_NEG Negative currency format: "1$-".
static int	NEG_CURFMT_NUM_NEG_CUR Negative currency format: "1-$".
static int	NEG_CURFMT_NUM_SPAC_CUR_NEG Negative currency format: "1 $-".
static int	NEG_CURFMT_OP_CUR_NUM_CP Negative currency format: "($1)".
static int	NEG_CURFMT_OP_NUM_CUR_CP Negative currency format: "(1$)".
static int	NEG_NUMFMT_NEG_NUM Negative number format: "-1".
static int	NEG_NUMFMT_NUM Negative number format: "1".
static int	NEG_NUMFMT_NUM_NEG Negative number format: "1-".
static int	NEG_NUMFMT_OP_NUM_CP Negative number format: "(1)".
static int	NUMTYPE_CURRENCY Number type: currency.
static int	NUMTYPE_GENERAL Number type: general.
static int	NUMTYPE_PERCENT Number type: percent.
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 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	POS_CURFMT_CUR_NUM Positive currency format: "$1".
static int	POS_CURFMT_CUR_NUM_POS Positive currency format: "$1+".
static int	POS_CURFMT_CUR_SPAC_NUM Positive currency format: "$ 1".
static int	POS_CURFMT_NUM_CUR Positive currency format: "1$".
static int	POS_CURFMT_NUM_CUR_POS Positive currency format: "1$+".
static int	POS_CURFMT_NUM_POS_CUR Positive currency format: "1+$".
static int	POS_CURFMT_NUM_SPAC_CUR Positive currency format: "1 $".
static int	POS_CURFMT_NUM_SPAC_CUR_POS Positive currency format: "1 $+".
static int	POS_CURFMT_POS_CUR_NUM Positive currency format: "+$1".
static int	POS_CURFMT_POS_CUR_SPAC_NUM Positive currency format: "+$ 1".
static int	POS_CURFMT_POS_NUM_CUR Positive currency format: "+1$".
static int	POS_CURFMT_POS_NUM_SPAC_CUR Positive currency format: "+1 $".
static int	POS_NUMFMT_NUM Positive number format: "1".
static int	POS_NUMFMT_NUM_POS Positive number format: "1+".
static int	POS_NUMFMT_POS_NUM Positive number format: "+1".
static int	SCALEFACTOR_BILLIONS Scale factor: billions.
static int	SCALEFACTOR_MILLIONS Scale factor: millions.
static int	SCALEFACTOR_NONE Scale factor: none.
static int	SCALEFACTOR_QUADRILLIONS Scale factor: quadrillions.
static int	SCALEFACTOR_THOUSANDS Scale factor: thousands.
static int	SCALEFACTOR_TRILLIONS Scale factor: trillions.
static int	UNKNOWN_PATTERN_STR Format String type: Unknown Number Format Mask.

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

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.
java.lang.String	DateToString(java.sql.Date dateValue) Generates a String representation of a 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.
java.lang.String	getJavaDateFormat() Retrieves the Java date format for this ViewFormat.
int	getNegCurFmt() Retrieves the character or String that indicates a negative currency value.
int	getNegNumFmt() Retrieves the character or String that indicates a negative number value.
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	getPosNumFmt() Retrieves the character or String that indicates a positive number value.
java.lang.String	getScaleDownBillions() Retrieves the character or String that represents the abbreviation for billion.
java.lang.String	getScaleDownMillions() Retrieves the character or String that represents the abbreviation for million.
java.lang.String	getScaleDownQuadrillions() Retrieves the character or String that represents the abbreviation for quadrillions.
java.lang.String	getScaleDownThousands() Retrieves the character or String that represents the abbreviation for thousand.
java.lang.String	getScaleDownTrillions() Retrieves the character or String that represents the abbreviation for trillion.
int	getScaleFactor() Retrieves the amount that a number is abbreviated.
char	getThousandSeparator() Retrieves the character or String that separates thousands in number values.
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	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	isNegCurFmtUsed() Indicates whether the NegCurFmt property has been explicitly set.
boolean	isNegNumFmtUsed() Indicates whether the NegNumFmt property has been explicitly set.
boolean	isNumberTypeUsed() Indicates whether the NumberType property has been explicitly set.
boolean	isOracleDateFormatUsed() Indicates whether the OracleDateFormat property has been explicitly set.
boolean	isPercentUsed()
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	isScaleFactorUsed() Indicates whether the ScaleFactor property has been explicitly set.
boolean	isThousandSeparatorUsed() Indicates whether the ThousandSeparator property has been explicitly set.
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	setErrorHandler(ErrorHandler eh) Specifies the error handler for this BaseViewFormat.
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	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	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	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 billion.
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 quadrillion.
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 thousand.
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 trillion.
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	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.
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 Date object.
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.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.
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

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

Methods inherited from interface oracle.dss.rules.MergeableXML

getXML, setXML

Field Detail

DEFAULT_NUM_TYPE

public static final int DEFAULT_NUM_TYPE

Number type default: a general number.

DEFAULT_CURRENCY_SYMBOL

public static final java.lang.String DEFAULT_CURRENCY_SYMBOL

Currency symbol default: "$".

DEFAULT_LEADING_ZERO

public static final boolean DEFAULT_LEADING_ZERO

Leading zero default: true.

DEFAULT_POS_NUM_FMT

public static final int DEFAULT_POS_NUM_FMT

Positive number format default: "1".

DEFAULT_NEG_NUM_FMT

public static final int DEFAULT_NEG_NUM_FMT

Negative number format default: "(1)".

DEFAULT_POS_CUR_FMT

public static final int DEFAULT_POS_CUR_FMT

Positive currency format default: "$1".

DEFAULT_NEG_CUR_FMT

public static final int DEFAULT_NEG_CUR_FMT

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

DEFAULT_SCALE_FACTOR

public static final int DEFAULT_SCALE_FACTOR

Scale factor default: none.

DEFAULT_SCALE_DOWN_THOUSANDS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_THOUSANDS_STRING

Scale down to thousands default: "K".

DEFAULT_SCALE_DOWN_MILLIONS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_MILLIONS_STRING

Scale down to millions default: "M".

DEFAULT_SCALE_DOWN_BILLIONS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_BILLIONS_STRING

Scale down to billions default: "B".

DEFAULT_SCALE_DOWN_TRILLIONS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_TRILLIONS_STRING

Scale down to trillions default: "T".

DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING

public static final java.lang.String DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING

Scale down to quadrillions default: "Q".

DEFAULT_NULL_STRING

public static final java.lang.String DEFAULT_NULL_STRING

Null string default: " ".

DATATYPE_BOOLEAN

public static final int DATATYPE_BOOLEAN

Data type: boolean.

DATATYPE_SHORT

public static final int DATATYPE_SHORT

Data type: short.

DATATYPE_INT

public static final int DATATYPE_INT

Data type: integer.

DATATYPE_LONG

public static final int DATATYPE_LONG

Data type: long.

DATATYPE_DOUBLE

public static final int DATATYPE_DOUBLE

Data type: double.

DATATYPE_FLOAT

public static final int DATATYPE_FLOAT

Data type: float.

DATATYPE_STRING

public static final int DATATYPE_STRING

Data type: String.

DATATYPE_DATE

public static final int DATATYPE_DATE

Data type: Date.

DATATYPE_TIME

public static final int DATATYPE_TIME

Data type: Time.

DATATYPE_TIMESTAMP

public static final int DATATYPE_TIMESTAMP

Data type: Timestamp.

NUMTYPE_GENERAL

public static final int NUMTYPE_GENERAL

Number type: general.

NUMTYPE_CURRENCY

public static final int NUMTYPE_CURRENCY

Number type: currency.

NUMTYPE_PERCENT

public static final int NUMTYPE_PERCENT

Number type: percent.

POS_NUMFMT_NUM

public static final int POS_NUMFMT_NUM

Positive number format: "1".

POS_NUMFMT_POS_NUM

public static final int POS_NUMFMT_POS_NUM

Positive number format: "+1".

POS_NUMFMT_NUM_POS

public static final int POS_NUMFMT_NUM_POS

Positive number format: "1+".

NEG_NUMFMT_OP_NUM_CP

public static final int NEG_NUMFMT_OP_NUM_CP

Negative number format: "(1)".

NEG_NUMFMT_NEG_NUM

public static final int NEG_NUMFMT_NEG_NUM

Negative number format: "-1".

NEG_NUMFMT_NUM_NEG

public static final int NEG_NUMFMT_NUM_NEG

Negative number format: "1-".

NEG_NUMFMT_NUM

public static final int NEG_NUMFMT_NUM

Negative number format: "1".

POS_CURFMT_CUR_NUM

public static final int POS_CURFMT_CUR_NUM

Positive currency format: "$1".

POS_CURFMT_NUM_CUR

public static final int POS_CURFMT_NUM_CUR

Positive currency format: "1$".

POS_CURFMT_CUR_SPAC_NUM

public static final int POS_CURFMT_CUR_SPAC_NUM

Positive currency format: "$ 1".

POS_CURFMT_NUM_SPAC_CUR

public static final int POS_CURFMT_NUM_SPAC_CUR

Positive currency format: "1 $".

POS_CURFMT_POS_CUR_NUM

public static final int POS_CURFMT_POS_CUR_NUM

Positive currency format: "+$1".

POS_CURFMT_CUR_NUM_POS

public static final int POS_CURFMT_CUR_NUM_POS

Positive currency format: "$1+".

POS_CURFMT_POS_NUM_CUR

public static final int POS_CURFMT_POS_NUM_CUR

Positive currency format: "+1$".

POS_CURFMT_NUM_POS_CUR

public static final int POS_CURFMT_NUM_POS_CUR

Positive currency format: "1+$".

POS_CURFMT_NUM_CUR_POS

public static final int POS_CURFMT_NUM_CUR_POS

Positive currency format: "1$+".

POS_CURFMT_POS_NUM_SPAC_CUR

public static final int POS_CURFMT_POS_NUM_SPAC_CUR

Positive currency format: "+1 $".

POS_CURFMT_POS_CUR_SPAC_NUM

public static final int POS_CURFMT_POS_CUR_SPAC_NUM

Positive currency format: "+$ 1".

POS_CURFMT_NUM_SPAC_CUR_POS

public static final int POS_CURFMT_NUM_SPAC_CUR_POS

Positive currency format: "1 $+".

NEG_CURFMT_OP_CUR_NUM_CP

public static final int NEG_CURFMT_OP_CUR_NUM_CP

Negative currency format: "($1)".

NEG_CURFMT_NEG_CUR_NUM

public static final int NEG_CURFMT_NEG_CUR_NUM

Negative currency format: "-$1".

NEG_CURFMT_CUR_NEG_NUM

public static final int NEG_CURFMT_CUR_NEG_NUM

Negative currency format: "$-1".

NEG_CURFMT_CUR_NUM_NEG

public static final int NEG_CURFMT_CUR_NUM_NEG

Negative currency format: "$1-".

NEG_CURFMT_OP_NUM_CUR_CP

public static final int NEG_CURFMT_OP_NUM_CUR_CP

Negative currency format: "(1$)".

NEG_CURFMT_NEG_NUM_CUR

public static final int NEG_CURFMT_NEG_NUM_CUR

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

NEG_CURFMT_NUM_NEG_CUR

public static final int NEG_CURFMT_NUM_NEG_CUR

Negative currency format: "1-$".

NEG_CURFMT_NUM_CUR_NEG

public static final int NEG_CURFMT_NUM_CUR_NEG

Negative currency format: "1$-".

NEG_CURFMT_NEG_NUM_SPAC_CUR

public static final int NEG_CURFMT_NEG_NUM_SPAC_CUR

Negative currency format: "-1 $".

NEG_CURFMT_NEG_CUR_SPAC_NUM

public static final int NEG_CURFMT_NEG_CUR_SPAC_NUM

Negative currency format: "-$ 1".

NEG_CURFMT_NUM_SPAC_CUR_NEG

public static final int NEG_CURFMT_NUM_SPAC_CUR_NEG

Negative currency format: "1 $-".

SCALEFACTOR_NONE

public static final int SCALEFACTOR_NONE

Scale factor: none.

SCALEFACTOR_THOUSANDS

public static final int SCALEFACTOR_THOUSANDS

Scale factor: thousands.

SCALEFACTOR_MILLIONS

public static final int SCALEFACTOR_MILLIONS

Scale factor: millions.

SCALEFACTOR_BILLIONS

public static final int SCALEFACTOR_BILLIONS

Scale factor: billions.

SCALEFACTOR_TRILLIONS

public static final int SCALEFACTOR_TRILLIONS

Scale factor: trillions.

SCALEFACTOR_QUADRILLIONS

public static final int SCALEFACTOR_QUADRILLIONS

Scale factor: quadrillions.

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.

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)

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)

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

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

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 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. When this property has not been specified, this method returns the minimum fraction digits from the locale.

Returns:

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

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 DEFAULT_NEG_CUR_FMT, which looks like this: ($1). The default value is used when no value has been specified. The constants begin with NEG_CURFMT_.

Returns:

The constant that represents a negative currency format.

See Also:

DEFAULT_NEG_CUR_FMT, 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

getNegNumFmt

public int getNegNumFmt()

Retrieves the character or String that indicates a negative number value. The default value is DEFAULT_NEG_NUM_FMT, which looks like this: (1). The default value is used when no value has been specified. The constants begin with NEG_NUMFMT_.

Returns:

The constant that represents a negative number format.

See Also:

DEFAULT_NEG_NUM_FMT, NEG_NUMFMT_NEG_NUM, NEG_NUMFMT_NUM_NEG, NEG_NUMFMT_OP_NUM_CP

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. The constants begin with NUMTYPE_.

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 DEFAULT_POS_CUR_FMT, which looks like this: $1. The default value is used when no value has been specified. The constants begin wiht POS_CURFMT_.

Returns:

The constant that represents a positive currency format.

See Also:

DEFAULT_POS_CUR_FMT, 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

getPosNumFmt

public int getPosNumFmt()

Retrieves the character or String that indicates a positive number value. The default value is DEFAULT_POS_NUM_FMT. The default value is used when no format value has been specified. The constants begin with POS_NUMFMT_.

Returns:

The constant that represents a positive number format.

See Also:

DEFAULT_POS_NUM_FMT, POS_NUMFMT_NUM, POS_NUMFMT_NUM_POS, POS_NUMFMT_POS_NUM

getScaleDownBillions

public java.lang.String getScaleDownBillions()

Retrieves the character or String that represents the abbreviation for billion. The default is DEFAULT_SCALE_DOWN_BILLIONS_STRING. The default value is used when no notation value has been specified.

Returns:

The character or String that represents the abbreviation for billion.

See Also:

DEFAULT_SCALE_DOWN_BILLIONS_STRING

getScaleDownMillions

public java.lang.String getScaleDownMillions()

Retrieves the character or String that represents the abbreviation for million. The default is DEFAULT_SCALE_DOWN_MILLIONS_STRING. The default value is used when no notation value has been specified.

Returns:

The character or String that represents the abbreviation for million.

See Also:

DEFAULT_SCALE_DOWN_MILLIONS_STRING

getScaleDownQuadrillions

public java.lang.String getScaleDownQuadrillions()

Retrieves the character or String that represents the abbreviation for quadrillions. The default is DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING. The default value is used when no notation value has been specified.

Returns:

The character or String that represents the abbreviation for quadrillions.

See Also:

DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING

getScaleDownThousands

public java.lang.String getScaleDownThousands()

Retrieves the character or String that represents the abbreviation for thousand. The default is DEFAULT_SCALE_DOWN_THOUSANDS_STRING. The default value is used when no notation value has been specified.

Returns:

The character or String that represents the abbreviation for thousand.

See Also:

DEFAULT_SCALE_DOWN_THOUSANDS_STRING

getScaleDownTrillions

public java.lang.String getScaleDownTrillions()

Retrieves the character or String that represents the abbreviation for trillion. The default is DEFAULT_SCALE_DOWN_TRILLIONS_STRING. The default value is used when no notation value has been specified.

Returns:

The character or String that represents the abbreviation for trillion.

See Also:

DEFAULT_SCALE_DOWN_TRILLIONS_STRING

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 defined in this class, and they generally begin with the prefix SCALEFACTOR_.

See Also:

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

getThousandSeparator

public char getThousandSeparator()

Retrieves the character or String that separates thousands in number values. When this property has not been explicitly set, this method returns the default group separator from the locale.

Returns:

The character or String that separates thousands in number values.

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. When this property has not been specified, this method returns the minimum fraction digits from 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 DEFAULT_NEG_CUR_FMT, which looks like this: ($1). The default value is used when no value has been specified. The constants begin with NEG_CURFMT_. This method also sets the NegCurFmtUsed property to true.

Parameters:

iNegCurFmt - The constant that represents a negative currency format.

See Also:

DEFAULT_NEG_CUR_FMT, 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 DEFAULT_NEG_NUM_FMT, which looks like this: (1). The default value is used when no value has been specified. The constants begin with NEG_NUMFMT_. This method also sets the NegNumFmtUsed property to true.

Parameters:

iNegNumFmt - The constant that represents a negative number format.

See Also:

DEFAULT_NEG_NUM_FMT, 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. The constants begin with NUMTYPE_. 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.

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 DEFAULT_POS_CUR_FMT, which looks like this: $1. The default value is used when no value has been specified. The constants begin with POS_CURFMT_. This method also sets the PosCurFmtUsed property to true.

Parameters:

iPosCurFmt - The constant that represents a positive currency format.

See Also:

DEFAULT_POS_CUR_FMT, 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 DEFAULT_POS_NUM_FMT. The default value is used when no format value has been specified. The constants begin with POS_NUMFMT_. This method also sets the PosNumFmtUsed property to true.

Parameters:

iPosNumFmt - The constant that represents a positive number format.

See Also:

DEFAULT_POS_NUM_FMT, 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 billion. The default is DEFAULT_SCALE_DOWN_BILLIONS_STRING. The default value is used when no notation value has been specified. This method also sets the ScaleDownBillionsUsed property to true.

Parameters:

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

See Also:

DEFAULT_SCALE_DOWN_BILLIONS_STRING

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 is DEFAULT_SCALE_DOWN_MILLIONS_STRING. The default value is used when no notation value has been specified. This method also sets the ScaleDownMillionsUsed property to true.

Parameters:

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

See Also:

DEFAULT_SCALE_DOWN_MILLIONS_STRING

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 quadrillion. The default is DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING. The default value is used when no notation value has been specified. This method also sets the ScaleDownQuadrillionsUsed property ' to true.

Parameters:

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

See Also:

DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING

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 thousand. The default is DEFAULT_SCALE_DOWN_THOUSANDS_STRING. The default value is used when no notation value has been specified. This method also sets the ScaleDownThousandsUsed property to true.

Parameters:

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

See Also:

DEFAULT_SCALE_DOWN_THOUSANDS_STRING

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 trillion. The default is DEFAULT_SCALE_DOWN_TRILLIONS_STRING. The default value is used when no notation value has been specified. This method also sets the ScaleDownTrillionsUsed property to true.

Parameters:

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

See Also:

DEFAULT_SCALE_DOWN_TRILLIONS_STRING

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. Constants are defined in this class, and they generally begin with the prefix SCALEFACTOR_.

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. When this property has not been explicitly set, this ViewFormat uses the default group separator from 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.

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 Date object.

Parameters:

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

Returns:

A Date for sValue.

StringToDouble

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

Converts a String into a double value.

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.

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.

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.

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.

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.

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.

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.

Parameters:

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

Returns:

A Timestamp object for sValue.

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.

isPercentUsed

public boolean isPercentUsed()