oracle.dss.dataView.managers
Class ViewFormat

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

All Implemented Interfaces:

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

public class ViewFormat

extends BaseViewFormat

Contains format properties for numbers.

See Also:

Serialized Form

Fields inherited from class oracle.dss.util.format.BaseViewFormat

DATATYPE_BOOLEAN, DATATYPE_DATE, DATATYPE_DOUBLE, DATATYPE_FLOAT, DATATYPE_INT, DATATYPE_LONG, DATATYPE_SHORT, DATATYPE_STRING, DATATYPE_TIME, DATATYPE_TIMESTAMP, DEFAULT_CURRENCY_SYMBOL, DEFAULT_LEADING_ZERO, DEFAULT_NEG_CUR_FMT, DEFAULT_NEG_NUM_FMT, DEFAULT_NULL_STRING, DEFAULT_NUM_TYPE, DEFAULT_POS_CUR_FMT, DEFAULT_POS_NUM_FMT, DEFAULT_SCALE_DOWN_BILLIONS_STRING, DEFAULT_SCALE_DOWN_MILLIONS_STRING, DEFAULT_SCALE_DOWN_QUADRILLIONS_STRING, DEFAULT_SCALE_DOWN_THOUSANDS_STRING, DEFAULT_SCALE_DOWN_TRILLIONS_STRING, DEFAULT_SCALE_FACTOR, NEG_CURFMT_CUR_NEG_NUM, NEG_CURFMT_CUR_NUM_NEG, NEG_CURFMT_NEG_CUR_NUM, NEG_CURFMT_NEG_CUR_SPAC_NUM, NEG_CURFMT_NEG_NUM_CUR, NEG_CURFMT_NEG_NUM_SPAC_CUR, NEG_CURFMT_NUM_CUR_NEG, NEG_CURFMT_NUM_NEG_CUR, NEG_CURFMT_NUM_SPAC_CUR_NEG, NEG_CURFMT_OP_CUR_NUM_CP, NEG_CURFMT_OP_NUM_CUR_CP, NEG_NUMFMT_NEG_NUM, NEG_NUMFMT_NUM, NEG_NUMFMT_NUM_NEG, NEG_NUMFMT_OP_NUM_CP, NUMTYPE_CURRENCY, NUMTYPE_GENERAL, NUMTYPE_PERCENT, OEO_PATTERN_STR, ORACLE_PATTERN_STR, 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, POS_NUMFMT_NUM, POS_NUMFMT_NUM_POS, POS_NUMFMT_POS_NUM, SCALEFACTOR_BILLIONS, SCALEFACTOR_MILLIONS, SCALEFACTOR_NONE, SCALEFACTOR_QUADRILLIONS, SCALEFACTOR_THOUSANDS, SCALEFACTOR_TRILLIONS, UNKNOWN_PATTERN_STR

Constructor Summary

ViewFormat()
Constructor that uses default ViewFormat values.

ViewFormat(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.

ViewFormat(java.lang.String numberFormatString, int fmtStrType)
Constructor that uses a String to specify property values.

Method Summary

java.lang.Object	clone() Clones this ViewFormat object.
java.lang.String	getDateFormat() Deprecated. As of 1.6.0.24, replaced by BaseViewFormat.getJavaDateFormat().
boolean	isDateFormatUsed() Deprecated. As of 1.6.0.24, replaced by BaseViewFormat.isJavaDateFormatUsed()
void	setDateFormat(java.lang.String sDateFormat) Deprecated. As of 1.6.0.24, replaced by BaseViewFormat.setJavaDateFormat(java.lang.String).
void	setDateFormatUsed(boolean bValue) Deprecated. As of 1.6.0.24, replaced by BaseViewFormat.setJavaDateFormatUsed(boolean)

Methods inherited from class oracle.dss.util.format.BaseViewFormat

BooleanToString, clearUsedBits, DateToString, DoubleToString, equals, FloatToString, getCurrencySymbol, getDecimalDigit, getDecimalSeparator, getJavaDateFormat, getNegCurFmt, getNegNumFmt, getNumberType, getOracleDateFormat, getPosCurFmt, getPosNumFmt, getScaleDownBillions, getScaleDownMillions, getScaleDownQuadrillions, getScaleDownThousands, getScaleDownTrillions, getScaleFactor, getThousandSeparator, initWithString, IntToString, isAnythingOverridden, isCurrencySymbolUsed, isDecimalDigitUsed, isDecimalSeparatorUsed, isJavaDateFormatUsed, isLeadingZero, isLeadingZeroUsed, isNegCurFmtUsed, isNegNumFmtUsed, isNumberTypeUsed, isOracleDateFormatUsed, isPercentUsed, isPosCurFmtUsed, isPosNumFmtUsed, isScaleDownBillionsUsed, isScaleDownMillionsUsed, isScaleDownQuadrillionsUsed, isScaleDownThousandsUsed, isScaleDownTrillionsUsed, isScaleFactorUsed, isThousandSeparatorUsed, LongToString, merge, ObjectToString, setCurrencySymbol, setCurrencySymbolUsed, setDecimalDigit, setDecimalDigitUsed, setDecimalSeparator, setDecimalSeparatorUsed, setErrorHandler, setJavaDateFormat, setJavaDateFormatUsed, setLeadingZero, setLeadingZeroUsed, setNegCurFmt, setNegCurFmtUsed, setNegNumFmt, setNegNumFmtUsed, setNumberType, setNumberTypeUsed, setOracleDateFormat, setOracleDateFormatUsed, setPosCurFmt, setPosCurFmtUsed, setPosNumFmt, setPosNumFmtUsed, setScaleDownBillions, setScaleDownBillionsUsed, setScaleDownMillions, setScaleDownMillionsUsed, setScaleDownQuadrillions, setScaleDownQuadrillionsUsed, setScaleDownThousands, setScaleDownThousandsUsed, setScaleDownTrillions, setScaleDownTrillionsUsed, setScaleFactor, setScaleFactorUsed, setThousandSeparator, setThousandSeparatorUsed, ShortToString, StringToBoolean, StringToDate, StringToDouble, StringToFloat, StringToInt, StringToLong, StringToObject, StringToShort, StringToString, StringToTime, StringToTimestamp, TimestampToString, TimeToString, toString, validateFormatString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.rules.MergeableXML

getXML, setXML

Constructor Detail

ViewFormat

public ViewFormat()

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

ViewFormat

public ViewFormat(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.

saleDownMillions - 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.

ViewFormat

public ViewFormat(java.lang.String numberFormatString,
                  int fmtStrType)

Constructor that uses a String to specify property values. Any property that is initialized by the numberFormatString is marked as being used.

Parameters:

numberFormatString - A number format String that sets property values for this ViewFormat object.

fmtStrType - A constant that represents the type of format for the numberFormatString that is passed in this method.

See Also:

BaseViewFormat.OEO_PATTERN_STR, BaseViewFormat.ORACLE_PATTERN_STR

Method Detail

clone

public java.lang.Object clone()

Clones this ViewFormat object.

Overrides:

clone in class BaseViewFormat

Returns:

The clone of this ViewFormat object.

getDateFormat

public java.lang.String getDateFormat()

Deprecated. As of 1.6.0.24, replaced by BaseViewFormat.getJavaDateFormat().

The ViewFormat now uses Java date formats.

isDateFormatUsed

public boolean isDateFormatUsed()

Deprecated. As of 1.6.0.24, replaced by BaseViewFormat.isJavaDateFormatUsed()

The ViewFormat now uses Java date formats.

setDateFormat

public void setDateFormat(java.lang.String sDateFormat)

Deprecated. As of 1.6.0.24, replaced by BaseViewFormat.setJavaDateFormat(java.lang.String).

The ViewFormat now uses the Java date format.

setDateFormatUsed

public void setDateFormatUsed(boolean bValue)

Deprecated. As of 1.6.0.24, replaced by BaseViewFormat.setJavaDateFormatUsed(boolean)

The ViewFormat now uses the Java date format.