com.crystaldecisions.reports.common.value
Class FormulaValue

java.lang.Object
  CrystalValue
      com.crystaldecisions.reports.common.value.FormulaValue

Direct Known Subclasses:

ArrayValue, BooleanValue, DateTimeValue, DateValue, NumericValue, RangeValue, StringValue, TimeValue

public abstract class FormulaValue

extends CrystalValue

The base class for all values used by the Formula Language. All Java user defined functions must return a FormulaValue object.

See Also:

Serialized Form

Constructor Summary

FormulaValue()

Method Summary

static FormulaValue	coerce(FormulaValue value, FormulaValueType type) Internal use only.
FormulaValue	coerceToArray() Internal use only.
static FormulaValue	coerceToArray(FormulaValue value) Internal use only.
FormulaValue	coerceToBoolean() Internal use only.
static FormulaValue	coerceToBoolean(FormulaValue value) Internal use only.
FormulaValue	coerceToCurrency() Internal use only.
static FormulaValue	coerceToCurrency(FormulaValue value) Internal use only.
FormulaValue	coerceToDate() Internal use only.
static FormulaValue	coerceToDate(FormulaValue value) Internal use only.
FormulaValue	coerceToDateTime() Internal use only.
static FormulaValue	coerceToDateTime(FormulaValue value) Internal use only.
FormulaValue	coerceToNumber() Internal use only.
static FormulaValue	coerceToNumber(FormulaValue value) Internal use only.
FormulaValue	coerceToRange() Internal use only.
static FormulaValue	coerceToRange(FormulaValue value) Internal use only.
FormulaValue	coerceToRangeArray() Internal use only.
static FormulaValue	coerceToRangeArray(FormulaValue value) Internal use only.
FormulaValue	coerceToString() Internal use only.
static FormulaValue	coerceToString(FormulaValue value) Internal use only.
FormulaValue	coerceToTime() Internal use only.
static FormulaValue	coerceToTime(FormulaValue value) Internal use only.
FormulaValueType	getFormulaValueType() Gets the FormulaValueType of this FormulaValue object.
static FormulaValue	makeZeroValue(FormulaValueType type) Returns a FormulaValue object represents the given type and is set to zero (or false or empty if the type is a boolean or a String, respectively).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormulaValue

public FormulaValue()

Method Detail

getFormulaValueType

public final FormulaValueType getFormulaValueType()

Gets the FormulaValueType of this FormulaValue object.

Returns:

the FormulaValueType of this FormulaValue object

coerceToNumber

public static FormulaValue coerceToNumber(FormulaValue value)

Internal use only.

coerceToNumber

public FormulaValue coerceToNumber()

Internal use only.

coerceToCurrency

public static FormulaValue coerceToCurrency(FormulaValue value)

Internal use only.

coerceToCurrency

public FormulaValue coerceToCurrency()

Internal use only.

coerceToBoolean

public static FormulaValue coerceToBoolean(FormulaValue value)

Internal use only.

coerceToBoolean

public FormulaValue coerceToBoolean()

Internal use only.

coerceToDate

public static FormulaValue coerceToDate(FormulaValue value)

Internal use only.

coerceToDate

public FormulaValue coerceToDate()

Internal use only.

coerceToTime

public static FormulaValue coerceToTime(FormulaValue value)

Internal use only.

coerceToTime

public FormulaValue coerceToTime()

Internal use only.

coerceToDateTime

public static FormulaValue coerceToDateTime(FormulaValue value)

Internal use only.

coerceToDateTime

public FormulaValue coerceToDateTime()

Internal use only.

coerceToString

public static FormulaValue coerceToString(FormulaValue value)

Internal use only.

coerceToString

public FormulaValue coerceToString()

Internal use only.

coerceToRange

public static FormulaValue coerceToRange(FormulaValue value)

Internal use only.

coerceToRange

public FormulaValue coerceToRange()

Internal use only.

coerceToArray

public static FormulaValue coerceToArray(FormulaValue value)

Internal use only.

coerceToArray

public FormulaValue coerceToArray()

Internal use only.

coerceToRangeArray

public static FormulaValue coerceToRangeArray(FormulaValue value)

Internal use only.

coerceToRangeArray

public FormulaValue coerceToRangeArray()

Internal use only.

coerce

public static FormulaValue coerce(FormulaValue value,
                                  FormulaValueType type)

Internal use only.

makeZeroValue

public static FormulaValue makeZeroValue(FormulaValueType type)

Returns a FormulaValue object represents the given type and is set to zero (or false or empty if the type is a boolean or a String, respectively).

Parameters:

type - determines the type of FormulaValue returned

Returns:

a FormulaValue object represents the given type and is set to zero