Number (Oracle9i Business Components for Java Oracle Domains API Reference)

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle9i Business Components for Java Oracle Domains API Reference
Oracle9i Jdeveloper (9.0.4)
B10392-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.jbo.domain
Class Number

java.lang.Object
  |
  +--oracle.sql.NUMBER
        |
        +--oracle.jbo.domain.Number

All Implemented Interfaces:: java.io.Serializable

public class Number
extends NUMBER
implements java.io.Serializable

This class extends oracle.sql.NUMBER, Oracle's Java representation of the NUMBER database type. This class allows an instance of the oracle.sql.NUMBER to be used as a domain object. The intent of many of the methods in this class is to wrap the corresponding method in the oracle.sql.NUMBER class such that it returns an instance of an oracle.jbo.domain.Number object.

The oracle.jbo.domain.Number domain class is the Java representation of the underlying database type that you must use if you want to exploit the domain feature of Business Components for Java.

Since:: JDeveloper 3.0
See Also:: Serialized Form

Constructor Summary
`Number()` Creates a `Number` Domain object representing zero.
`Number(java.math.BigDecimal value)` Creates a `Number` Domain object from a `BigDecimal`.
`Number(java.math.BigInteger value)` Creates a `Number` Domain object from a `BigInteger`.
`Number(boolean value)` Creates a `Number` Domain object from a `Boolean`.
`Number(byte value)` Creates a `Number` Domain object from a `byte`.
`Number(byte[] value)` Internal: Applications should not invoke this method.
`Number(double value)` Creates a `Number` Domain object from an `double`.
`Number(java.lang.Double value)` Creates a `Number` Domain object from an `Double` object.
`Number(float value)` Creates a `Number` Domain object from an `float`.
`Number(int value)` Creates a `Number` Domain object from an `int`.
`Number(long value)` Creates a `Number` Domain object from an `long`.
`Number(java.lang.Long value)` Creates a `Number` Domain object from an `Long` object.
`Number(Number value)` Creates a `Number` identical to an existing `Number`.
`Number(java.lang.Object value)` Creates a `Number` Domain object from an arbitrary `Object`.
`Number(short value)` Creates a `Number` Domain object from an `short`.
`Number(java.lang.String value)` Creates a `Number` Domain object from a Java `String`.
`Number(java.lang.String value, int precision)` Creates a `Number` Domain object from a Java `String`.

Method Summary
`NUMBER`	`abs()` Finds the absolute value of `this`.
`NUMBER`	`acos()` Calculates the arc cosine of `this`.
`Number`	`add(double n)` Adds another number to `this`.
`Number`	`add(int n)` Adds another number to `this`.
`Number`	`add(Number n)` Adds another number to `this`.
`NUMBER`	`asin()` Calculates the arc sine of `this`.
`NUMBER`	`atan()` Calculates the arc tangent of `this`.
`Number`	`atan2(Number x)` Calculates `atan(this, x)`.
`java.math.BigDecimal`	`bigDecimalValue()` Calls NUMBER.bigDecimalValue() to convert internal Oracle Number into a Java BigDecimal.
`java.math.BigInteger`	`bigIntegerValue()` Calls NUMBER.bigIntegerValue() to convert internal Oracle Number to a Java BigInteger.
`byte`	`byteValue()` Calls NUMBER.byteValue() to convert internal Oracle Number to a Java byte.
`NUMBER`	`ceil()` Finds the ceiling of `this`.
`int`	`compareTo(double n)` Returns -1 if NUMBER is less than n, 0 if NUMBER and n are equal (==), 1 if NUMBER is greater than n.
`int`	`compareTo(int n)` Returns -1 if NUMBER is less than n, 0 if NUMBER and n are equal (==), 1 if NUMBER is greater than n.
`NUMBER`	`cos()` Calculates the cosine of `this`.
`NUMBER`	`cosh()` Calculates the hyperbolic cosine of `this`.
`NUMBER`	`decrement()` Subtracts `1` from `this`.
`NUMBER`	`div(NUMBER n)` Divides `this` by another number.
`Number`	`divide(double n)` Divides `this` by another number.
`Number`	`divide(int n)` Divides `this` by another number.
`Number`	`divide(Number n)` Divides `this` by another number.
`boolean`	`equals(java.lang.Object other)` Tests `this` for equality with another object.
`NUMBER`	`exp()` Raises `e` to the power of `this`.
`NUMBER`	`floatingPointRound(int precision)` Rounds `this` to a specified precision.
`NUMBER`	`floor()` Finds the floor of `this`.
`static NUMBER`	`formattedTextToNumber(java.lang.String num, java.lang.String fmt, java.lang.String lang)` Interprets a string as a number.
`static CustomDatumFactory`	`getCustomDatumFactory()` Internal: Applications should not invoke this method.
`java.lang.Object`	`getData()` Internal: Applications should not invoke this method. Converts `this` to a JDBC object.
`int`	`hashCode()` Computes the hash code.
`NUMBER`	`increment()` Adds `1` to `this`.
`int`	`intValue()` Calls NUMBER.intValue() to convert internal Oracle Number to a Java int.
`NUMBER`	`ln()` Calculates the natural logarithm of `this`.
`Number`	`log(double base)` Calculates the log of `this` to the specified `base`.
`Number`	`log(int base)` Calculates the log of `this` to the specified `base`.
`Number`	`log(Number base)` Calculates the log of `this` to the specified `base`.
`long`	`longValue()` Calls NUMBER.longValue() to convert internal Oracle Number to a Java long.
`static void`	`main(java.lang.String[] argv)` Internal: Applications should not invoke this method.
`Number`	`mod(double n)` Calculates the remainder of `this/n`.
`Number`	`mod(int n)` Calculates the remainder of `this/n`.
`Number`	`mod(Number n)` Calculates the remainder of `this/n`.
`NUMBER`	`mul(NUMBER n)` Multiplies `this` by another number.
`Number`	`multiply(double n)` Multiplies `this` by another number.
`Number`	`multiply(int n)` Multiplies `this` by another number.
`Number`	`multiply(Number n)` Multiplies `this` by another number.
`NUMBER`	`negate()` Calculates `0 - this`.
`NUMBER`	`pow(int exp)` Raises `this` to the power of `exp`.
`Number`	`pow(Number exp)` Raises `this` to the power of `exp`.
`NUMBER`	`round(int decimal_place)` Rounds `this` to a specified precision.
`NUMBER`	`scale(int left, int right, boolean[] big)` Rounds `this` to a specified precision, and tests for excessive magnitude.
`void`	`setContext(DomainOwnerInterface owner, Transaction trans, java.lang.Object ctx)` Internal: Applications should not invoke this method.
`NUMBER`	`shift(int digits)` Shift `this` a specified number of decimal places.
`short`	`shortValue()` Calls NUMBER.shortValue() to convert internal Oracle Number to a Java short.
`NUMBER`	`sin()` Calculates the sine of `this`.
`NUMBER`	`sinh()` Calculates the hyperbolic sine of `this`.
`NUMBER`	`sqroot()` Calculates the square root of `this`.
`NUMBER`	`sub(NUMBER n)` Subtracts another number from `this`.
`Number`	`subtract(double n)` Subtracts another number from `this`.
`Number`	`subtract(int n)` Subtracts another number from `this`.
`Number`	`subtract(Number n)` Subtracts another number from `this`.
`NUMBER`	`tan()` Calculates the tangent of `this`.
`NUMBER`	`tanh()` Calculates the hyperbolic tangent of `this`.
`static NUMBER`	`textToPrecisionNumber(java.lang.String num, boolean precflag, int preclen, boolean scaleflag, int scalelen, java.lang.String lang)` Converts a string to a number with specified precision.
`Datum`	`toDatum(oracle.jdbc.driver.OracleConnection conn)` Internal: Applications should not invoke this method.
`java.lang.String`	`toString()` For testing purposes only: converts `this` to a fixed-point number presented as a string.
`NUMBER`	`truncate(int decimal_place)` Truncates `this`.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Number

public Number()

Creates a Number Domain object representing zero. Use one of the NullValue() constructors to create a null Number object.

Number

public Number(byte[] value)

Internal: Applications should not invoke this method.
Creates a Number Domain object from the given byte array.
Parameters:: value - a value returned by a previous call to getBytes() on an SQL object compatable with Number.

Number

public Number(byte value)

Creates a Number Domain object from a byte.
Parameters:: value - an 8-bit signed integer.

Number

public Number(int value)

Creates a Number Domain object from an int.
Parameters:: value - a 32-bit signed integer.

Number

public Number(java.lang.Long value)

Creates a Number Domain object from an Long object.
Parameters:: value - a 32-bit floating-point value.

Number

public Number(long value)

Creates a Number Domain object from an long.
Parameters:: value - a 64-bit signed integer.

Number

public Number(short value)

Creates a Number Domain object from an short.
Parameters:: value - a 16-bit signed integer.

Number

public Number(float value)

Creates a Number Domain object from an float.
Parameters:: value - a 32-bit floating-point value.

Number

public Number(double value)
       throws java.sql.SQLException

Creates a Number Domain object from an double.
Parameters:: value - a 64-bit floating-point value.
Throws:: SQLException - on over/underflow of the exponent or on overflow of the mantissa.; java.sql.SQLException

Number

public Number(java.lang.Double value)
       throws java.sql.SQLException

Creates a Number Domain object from an Double object.
Parameters:: value - a 64-bit floating-point value.
Throws:: SQLException - on over/underflow of the exponent or on overflow of the mantissa.; java.sql.SQLException

Number

public Number(java.math.BigDecimal value)
       throws java.sql.SQLException

Creates a Number Domain object from a BigDecimal.

Limitations:

This method may not preserve the scaling of the argument.
A BigDecimal distinguishes between 0 and -0. This information will be lost in the conversion.
At present, this method does not round. If the argument's mantissa has two many digits an exception is thrown.

Parameters:

value - an arbitrarily precise floating-point value.

Throws:

SQLException - on over/underflow of the exponent or on overflow of the mantissa.

java.sql.SQLException

Number

public Number(java.math.BigInteger value)
       throws java.sql.SQLException

Creates a Number Domain object from a BigInteger.
Parameters:: value - an arbitrarily integer.
Throws:: SQLException - on overflow.; java.sql.SQLException

Number

public Number(java.lang.String value,
              int precision)
       throws java.sql.SQLException

Creates a Number Domain object from a Java String.
Parameters:: value - a textual representation of a fixed-point number.; precision - the maximum length of the string.
Throws:: SQLException - on overflow.; java.sql.SQLException

Number

public Number(java.lang.String value)
       throws java.sql.SQLException

Creates a Number Domain object from a Java String.
Parameters:: value - a textual representation of a BigDecimal.
Throws:: java.sql.SQLException - on over/underflow of the exponent or on overflow of the mantissa, or if the string does not represent a valid number.

Number

public Number(boolean value)

Creates a Number Domain object from a Boolean.
Parameters:: value - true or false.

Number

public Number(java.lang.Object value)
       throws java.sql.SQLException

Creates a Number Domain object from an arbitrary Object. One of the other constructors for Number is invoked, depending on the type of the argument.
Parameters:: value - an arbitrary object.
Throws:: SQLException - if the called method fails, or if the argument's type is not recognized.; java.sql.SQLException

Number

public Number(Number value)

Creates a Number identical to an existing Number.
Parameters:: value - a Number Domain object.
Throws:: SQLException - never.

Method Detail

getCustomDatumFactory

public static CustomDatumFactory getCustomDatumFactory()

Internal: Applications should not invoke this method.

Initializes the Number Domain. This method is invoked when JBO is initialized.

Returns:: the CustomDatumFactory for the Number Domain.

toDatum

public Datum toDatum(oracle.jdbc.driver.OracleConnection conn)
              throws java.sql.SQLException

Internal: Applications should not invoke this method.

Converts this Number Domain object back into an SQL NUMBER object.

Returns:: A Datum containing NUMBER object.
Throws:: SQLException - Never.; java.sql.SQLException

getData

public java.lang.Object getData()

Internal: Applications should not invoke this method. Converts this to a JDBC object.

setContext

public void setContext(DomainOwnerInterface owner,
                       Transaction trans,
                       java.lang.Object ctx)

Internal: Applications should not invoke this method.

toString

public java.lang.String toString()

For testing purposes only: converts this to a fixed-point number presented as a string.

equals

public boolean equals(java.lang.Object other)

Tests this for equality with another object. The argument is converted to a Number object, if necessary.

Parameters:: other - an arbitrary Object.
Returns:: true if conversion was successful and the converted argument is identical to this.

hashCode

public int hashCode()

Computes the hash code.

Returns:: the hash code of this.

longValue

public long longValue()

Calls NUMBER.longValue() to convert internal Oracle Number to a Java long.

Returns:: a Java long value

intValue

public int intValue()

Calls NUMBER.intValue() to convert internal Oracle Number to a Java int.

Returns:: a Java int value

shortValue

public short shortValue()

Calls NUMBER.shortValue() to convert internal Oracle Number to a Java short.

Returns:: a Java short value

byteValue

public byte byteValue()

Calls NUMBER.byteValue() to convert internal Oracle Number to a Java byte.

Returns:: a Java byte value

bigIntegerValue

public java.math.BigInteger bigIntegerValue()

Calls NUMBER.bigIntegerValue() to convert internal Oracle Number to a Java BigInteger.

Returns:: a Java BigInteger value

bigDecimalValue

public java.math.BigDecimal bigDecimalValue()

Calls NUMBER.bigDecimalValue() to convert internal Oracle Number into a Java BigDecimal.

Returns:: a Java BigDecimal value

add

public Number add(Number n)

Adds another number to this.

Parameters:: n - an SQL number.
Returns:: a new Number object.

add

public Number add(double n)

Adds another number to this.

Parameters:: n - an SQL number.
Returns:: a new Number object.

add

public Number add(int n)

Adds another number to this.

Parameters:: n - an SQL number.
Returns:: a new Number object.

subtract

public Number subtract(Number n)

Subtracts another number from this.

Parameters:: n - an SQL number.
Returns:: a new Number object.

subtract

public Number subtract(double n)

Subtracts another number from this.

Parameters:: n - a double number
Returns:: a new Number object.

subtract

public Number subtract(int n)

Subtracts another number from this.

Parameters:: n - a int number
Returns:: a new Number object.

multiply

public Number multiply(Number n)

Multiplies this by another number.

Parameters:: n - an SQL number.
Returns:: a new Number object.

multiply

public Number multiply(double n)

Multiplies this by another number.

Parameters:: n - an SQL number.
Returns:: a new Number object.

multiply

public Number multiply(int n)

Multiplies this by another number.

Parameters:: n - an SQL number.
Returns:: a new Number object.

divide

public Number divide(Number n)

Divides this by another number.

Parameters:: n - an SQL number.
Returns:: a new Number object.

divide

public Number divide(double n)

Divides this by another number.

Parameters:: n - an SQL number.
Returns:: a new Number object.

divide

public Number divide(int n)

Divides this by another number.

Parameters:: n - an SQL number.
Returns:: a new Number object.

abs

public NUMBER abs()

Finds the absolute value of this.

Returns:: a new Number object.
Throws:: SQLException - if the Java implementation is not available.

acos

public NUMBER acos()

Calculates the arc cosine of this.

Returns:: a new Number object.

asin

public NUMBER asin()

Calculates the arc sine of this.

Returns:: a new Number object.

atan

public NUMBER atan()

Calculates the arc tangent of this.

Returns:: a new Number object.

atan2

public Number atan2(Number x)

Calculates atan(this, x).

Parameters:: x - an SQL number.
Returns:: a new Number object.

ceil

public NUMBER ceil()

Finds the ceiling of this.

Returns:: a new Number object.

compareTo

public int compareTo(int n)

Returns -1 if NUMBER is less than n, 0 if NUMBER and n are equal (==), 1 if NUMBER is greater than n.

Parameters:: n - input Oracle Number
Returns:: integer result of comparison

compareTo

public int compareTo(double n)

Returns -1 if NUMBER is less than n, 0 if NUMBER and n are equal (==), 1 if NUMBER is greater than n.

Parameters:: n - input Oracle Number
Returns:: integer result of comparison

cos

public NUMBER cos()

Calculates the cosine of this.

Returns:: a new Number object.

cosh

public NUMBER cosh()

Calculates the hyperbolic cosine of this.

Returns:: a new Number object.

decrement

public NUMBER decrement()

Subtracts 1 from this.

Returns:: a new Number object.

div

public NUMBER div(NUMBER n)

Divides this by another number.

Parameters:: n - an SQL number.
Returns:: a new Number object.

exp

public NUMBER exp()

Raises e to the power of this.

Returns:: a new Number object.

floatingPointRound

public NUMBER floatingPointRound(int precision)

Rounds this to a specified precision.

Parameters:: precision - the number of significant decimal places.
Returns:: a new Number object.

floor

public NUMBER floor()

Finds the floor of this.

Returns:: a new Number object.

increment

public NUMBER increment()

Adds 1 to this.

Returns:: a new Number object.

ln

public NUMBER ln()

Calculates the natural logarithm of this.

Returns:: a new Number object.

log

public Number log(Number base)

Calculates the log of this to the specified base.

Parameters:: base - an SQL number.
Returns:: a new Number object.

log

public Number log(double base)

Calculates the log of this to the specified base.

Parameters:: base - an SQL number.
Returns:: a new Number object.

log

public Number log(int base)

Calculates the log of this to the specified base.

Parameters:: base - an SQL number.
Returns:: a new Number object.

mod

public Number mod(Number n)

Calculates the remainder of this/n.

Returns:: a new Number object.

mod

public Number mod(double n)

Calculates the remainder of this/n.

Returns:: a new Number object.

mod

public Number mod(int n)

Calculates the remainder of this/n.

Returns:: a new Number object.

mul

public NUMBER mul(NUMBER n)

Multiplies this by another number.

Parameters:: n - an SQL number.
Returns:: a new Number object.

negate

public NUMBER negate()

Calculates 0 - this.

Returns:: a new Number object.

pow

public Number pow(Number exp)

Raises this to the power of exp.

Parameters:: exp - an SQL number.
Returns:: a new Number object.

pow

public NUMBER pow(int exp)

Raises this to the power of exp.

Parameters:: exp - a Java 32-bit integer.
Returns:: a new Number object.

round

public NUMBER round(int decimal_place)

Rounds this to a specified precision.

Parameters:: decimal_place - the number of significant decimal places.
Returns:: a Java int.

scale

public NUMBER scale(int left,
                    int right,
                    boolean[] big)

Rounds this to a specified precision, and tests for excessive magnitude.

Parameters:: left - the maximum number of decimal digits allowed to the left of the decimal point. If this limit is exceeded big is set, but digits are not truncated.; right - the maximum number of decimal digits allowed to the right of the decimal point. The result is rounded to this precision. When this parameter is negative digits to the right of the decimal are forced to zero.; big - a flag set to true only if the number of digits left of the decimal exceeds left.
Returns:: a new Number object
Throws:: SQLException - if the Java implementation is not available.

shift

public NUMBER shift(int digits)

Shift this a specified number of decimal places. Positive values shift right, negative values shift left.

Parameters:: digits - a Java int.
Returns:: a Java int.

sin

public NUMBER sin()

Calculates the sine of this.

Returns:: a new Number object.

sinh

public NUMBER sinh()

Calculates the hyperbolic sine of this.

Returns:: a new Number object.

sqroot

public NUMBER sqroot()

Calculates the square root of this.

Returns:: a new Number object.

sub

public NUMBER sub(NUMBER n)

Subtracts another number from this.

Parameters:: n - an SQL number.
Returns:: a new Number object.

tan

public NUMBER tan()

Calculates the tangent of this.

Returns:: a new Number object.

tanh

public NUMBER tanh()

Calculates the hyperbolic tangent of this.

Returns:: a new Number object.

truncate

public NUMBER truncate(int decimal_place)

Truncates this.

Parameters:: decimal_place - a Java integer.
Returns:: a new Number object.

formattedTextToNumber

public static NUMBER formattedTextToNumber(java.lang.String num,
                                           java.lang.String fmt,
                                           java.lang.String lang)

Interprets a string as a number.

Parameters:: num - a string representing a numeric value.; fmt - a format string [see "Oracle 8 Server Concepts Manual" or "CORE User's Guide Appendix D"]; lang - the NLS language the conversion is to be performed in. If null the default language is used.
Returns:: a new Number object.

textToPrecisionNumber

public static NUMBER textToPrecisionNumber(java.lang.String num,
                                           boolean precflag,
                                           int preclen,
                                           boolean scaleflag,
                                           int scalelen,
                                           java.lang.String lang)

Converts a string to a number with specified precision.

Parameters:: num - a string representing a numeric value.; precflag - a flag indicating that precision restriction should be applied.; preclen - the maximum number of the decimal digits the result may have, subject to the scale requirement. This argument is ignored if precflag is false. If the number of digits would otherwise exceed preclen the number will be rounded.; scaleflag - a flag indicating that the scale restriction should be applied.; scalelen - the maximum number of decimal places allowed to the right of the decimal point. Negative values are allowed. This argument is ignored if scaleflag is false. This argument takes precedence over preclen. If precision is specified but scale is not, the scale is assumed to be 0.; lang - the NLS language the conversion is to be performed in. If null the default language is used.
Returns:: a new Number object.

main

public static void main(java.lang.String[] argv)
                 throws java.sql.SQLException

Internal: Applications should not invoke this method.

java.sql.SQLException

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle9i Business Components for Java Oracle Domains API Reference
Oracle9i Jdeveloper (9.0.4)
B10392-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.jbo.domain Class Number

Number

Number

Number

Number

Number

Number

Number

Number

Number

Number

Number

Number

Number

Number

Number

Number

Number

getCustomDatumFactory

toDatum

getData

setContext

toString

equals

hashCode

longValue

intValue

shortValue

byteValue

bigIntegerValue

bigDecimalValue

add

add

add

subtract

subtract

subtract

multiply

multiply

multiply

divide

divide

divide

abs

acos

asin

atan

atan2

ceil

compareTo

compareTo

cos

cosh

decrement

div

exp

floatingPointRound

floor

increment

ln

log

log

log

mod

mod

mod

mul

negate

pow

pow

round

scale

shift

sin

sinh

sqroot

sub

tan

tanh

truncate

oracle.jbo.domain
Class Number