com.crystaldecisions.reports.common.value
Class FormulaValueType

java.lang.Object
  extended by com.crystaldecisions.reports.common.value.FormulaValueType

public class FormulaValueType
extends java.lang.Object

Provides methods for working with value types in user defined functions.


Field Summary
static FormulaValueType bool
           A FormulaValueType that represents a boolean.
static FormulaValueType booleanArray
           A FormulaValueType that represents a boolean array.
static FormulaValueType currency
           A FormulaValueType that represents currency.
static FormulaValueType currencyArray
           A FormulaValueType that represents a currency array.
static FormulaValueType currencyRange
           A FormulaValueType that represents a currency range.
static FormulaValueType currencyRangeArray
           A FormulaValueType that represents a currency range array.
static FormulaValueType date
           A FormulaValueType that represents a date.
static FormulaValueType dateArray
           A FormulaValueType that represents a date array.
static FormulaValueType dateRange
           A FormulaValueType that represents a date range.
static FormulaValueType dateRangeArray
           A FormulaValueType that represents a date range array.
static FormulaValueType dateTime
           A FormulaValueType that represents a date-time.
static FormulaValueType dateTimeArray
           A FormulaValueType that represents a date-time array.
static FormulaValueType dateTimeRange
           A FormulaValueType that represents a date-time range.
static FormulaValueType dateTimeRangeArray
           A FormulaValueType that represents a date-time range array.
static FormulaValueType number
           A FormulaValueType that represents a number.
static FormulaValueType numberArray
           A FormulaValueType that represents a number array.
static FormulaValueType numberRange
           A FormulaValueType that represents a number range.
static FormulaValueType numberRangeArray
           A FormulaValueType that represents a number range array.
static FormulaValueType string
           A FormulaValueType that represents a string.
static FormulaValueType stringArray
           A FormulaValueType that represents a string array.
static FormulaValueType stringRange
           A FormulaValueType that represents a string range.
static FormulaValueType stringRangeArray
           A FormulaValueType that represents a string range array.
static FormulaValueType time
           A FormulaValueType that represents a time.
static FormulaValueType timeArray
           A FormulaValueType that represents a time array.
static FormulaValueType timeRange
           A FormulaValueType that represents a time range.
static FormulaValueType timeRangeArray
           A FormulaValueType that represents a time range array.
static FormulaValueType unknown
           A FormulaValueType that represents an unknown.
static FormulaValueType unknownArray
           A FormulaValueType that represents an unknown array.
static FormulaValueType unknownRange
           A FormulaValueType that represents an unknown range.
static FormulaValueType unknownRangeArray
           A FormulaValueType that represents an unknown range array.
 
Method Summary
static FormulaValueType fromInt(int i)
           Internal use only.
static FormulaValueType fromValueType(ValueType valueType)
           Internal use only.
 FormulaValueType getArrayFormulaValueType()
           Returns the array formula value type representation of this FormulaValueType as a FormulaValueType.
 FormulaValueType getBaseFormulaValueType()
           Returns the base formula value type of this FormulaValueType as a FormulaValueType.
static FormulaValueType getMostAppropriateFormulaValueType(ValueType valueType)
          Finds the most appropriate FormulaValueType for the given ValueType.
 FormulaValueType getNonArrayFormulaValueType()
           Returns the non-array formula value type representation of this FormulaValueType as a FormulaValueType.
 FormulaValueType getNonRangeFormulaValueType()
           Returns the non-range formula value type representation of this FormulaValueType as a FormulaValueType.
 FormulaValueType getRangeArrayFormulaValueType()
           Returns the range array formula value type representation of this FormulaValueType as a FormulaValueType.
 FormulaValueType getRangeFormulaValueType()
           Returns the range formula value type representation of this FormulaValueType as a FormulaValueType.
 boolean isArray()
           Checks if this FormulaValueType is an array.
 boolean isNumeric()
           Checks if this FormulaValueType is a numeric value.
 boolean isRange()
           Checks if this FormulaValueType is a range value.
 boolean isRangeArray()
           Checks if this FormulaValueType is a range array.
 boolean isScalar()
           Checks if this FormulaValueType is a scalar value.
static boolean isValidValue(int i)
           Checks if the argument passed in is a valid value type.
 boolean isValidValueType()
           
 java.lang.String toString()
           
 ValueType toValueType()
           Internal use only.
 int value()
           Gets the integer value of this FormulaValueType object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

number

public static final FormulaValueType number

A FormulaValueType that represents a number.


currency

public static final FormulaValueType currency

A FormulaValueType that represents currency.


bool

public static final FormulaValueType bool

A FormulaValueType that represents a boolean.


date

public static final FormulaValueType date

A FormulaValueType that represents a date.


time

public static final FormulaValueType time

A FormulaValueType that represents a time.


dateTime

public static final FormulaValueType dateTime

A FormulaValueType that represents a date-time.


string

public static final FormulaValueType string

A FormulaValueType that represents a string.


unknown

public static final FormulaValueType unknown

A FormulaValueType that represents an unknown.


numberRange

public static final FormulaValueType numberRange

A FormulaValueType that represents a number range.


currencyRange

public static final FormulaValueType currencyRange

A FormulaValueType that represents a currency range.


dateRange

public static final FormulaValueType dateRange

A FormulaValueType that represents a date range.


timeRange

public static final FormulaValueType timeRange

A FormulaValueType that represents a time range.


dateTimeRange

public static final FormulaValueType dateTimeRange

A FormulaValueType that represents a date-time range.


stringRange

public static final FormulaValueType stringRange

A FormulaValueType that represents a string range.


unknownRange

public static final FormulaValueType unknownRange

A FormulaValueType that represents an unknown range.


numberArray

public static final FormulaValueType numberArray

A FormulaValueType that represents a number array.


currencyArray

public static final FormulaValueType currencyArray

A FormulaValueType that represents a currency array.


booleanArray

public static final FormulaValueType booleanArray

A FormulaValueType that represents a boolean array.


dateArray

public static final FormulaValueType dateArray

A FormulaValueType that represents a date array.


timeArray

public static final FormulaValueType timeArray

A FormulaValueType that represents a time array.


dateTimeArray

public static final FormulaValueType dateTimeArray

A FormulaValueType that represents a date-time array.


stringArray

public static final FormulaValueType stringArray

A FormulaValueType that represents a string array.


unknownArray

public static final FormulaValueType unknownArray

A FormulaValueType that represents an unknown array.


numberRangeArray

public static final FormulaValueType numberRangeArray

A FormulaValueType that represents a number range array.


currencyRangeArray

public static final FormulaValueType currencyRangeArray

A FormulaValueType that represents a currency range array.


dateRangeArray

public static final FormulaValueType dateRangeArray

A FormulaValueType that represents a date range array.


timeRangeArray

public static final FormulaValueType timeRangeArray

A FormulaValueType that represents a time range array.


dateTimeRangeArray

public static final FormulaValueType dateTimeRangeArray

A FormulaValueType that represents a date-time range array.


stringRangeArray

public static final FormulaValueType stringRangeArray

A FormulaValueType that represents a string range array.


unknownRangeArray

public static final FormulaValueType unknownRangeArray

A FormulaValueType that represents an unknown range array.

Method Detail

isValidValue

public static boolean isValidValue(int i)

Checks if the argument passed in is a valid value type.

Parameters:
i - an int that represents a value type
Returns:
true if the argument is a valid value type, otherwise false

fromInt

public static FormulaValueType fromInt(int i)

Internal use only.


getMostAppropriateFormulaValueType

public static FormulaValueType getMostAppropriateFormulaValueType(ValueType valueType)
Finds the most appropriate FormulaValueType for the given ValueType.

Parameters:
valueType - the given ValueType
Returns:
the most appropriate FormulaValueType

fromValueType

public static FormulaValueType fromValueType(ValueType valueType)

Internal use only.


value

public int value()

Gets the integer value of this FormulaValueType object.

Returns:
the integer value of this FormulaValueType

isValidValueType

public boolean isValidValueType()

toValueType

public ValueType toValueType()

Internal use only.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

isNumeric

public boolean isNumeric()

Checks if this FormulaValueType is a numeric value.

Returns:
true if this FormulaValueType is a numeric value, otherwise false

getBaseFormulaValueType

public FormulaValueType getBaseFormulaValueType()

Returns the base formula value type of this FormulaValueType as a FormulaValueType.

Returns:
the base formula value type of this FormulaValueType as a FormulaValueType

isScalar

public boolean isScalar()

Checks if this FormulaValueType is a scalar value.

Returns:
true if this FormulaValueType is a scalar value, otherwise false

isRange

public boolean isRange()

Checks if this FormulaValueType is a range value.

Returns:
true if this FormulaValueType is a range value, otherwise false

isArray

public boolean isArray()

Checks if this FormulaValueType is an array.

Returns:
true if this FormulaValueType is an array, otherwise false

isRangeArray

public boolean isRangeArray()

Checks if this FormulaValueType is a range array.

Returns:
true if this FormulaValueType is a range array, otherwise false

getRangeFormulaValueType

public FormulaValueType getRangeFormulaValueType()

Returns the range formula value type representation of this FormulaValueType as a FormulaValueType.

Returns:
the range formula value type representation of this FormulaValueType as a FormulaValueType

getNonRangeFormulaValueType

public FormulaValueType getNonRangeFormulaValueType()

Returns the non-range formula value type representation of this FormulaValueType as a FormulaValueType.

Returns:
the non-range formula value type representation of this FormulaValueType as a FormulaValueType

getArrayFormulaValueType

public FormulaValueType getArrayFormulaValueType()

Returns the array formula value type representation of this FormulaValueType as a FormulaValueType.

Returns:
the array formula value type representation of this FormulaValueType as a FormulaValueType

getNonArrayFormulaValueType

public FormulaValueType getNonArrayFormulaValueType()

Returns the non-array formula value type representation of this FormulaValueType as a FormulaValueType.

Returns:
the non-array formula value type representation of this FormulaValueType as a FormulaValueType

getRangeArrayFormulaValueType

public FormulaValueType getRangeArrayFormulaValueType()

Returns the range array formula value type representation of this FormulaValueType as a FormulaValueType.

Returns:
the range array formula value type representation of this FormulaValueType as a FormulaValueType