com.crystaldecisions.sdk.occa.report.data
Interface IDataConditionFormula

All Known Implementing Classes:

DataConditionFormula

public interface IDataConditionFormula

This interface enables you to set the condition formula for each of the attributes for a selected area, section, or report object, thus offering you full conditional control over the appearance of the report object and its area and section. A condition formula enables you to dynamically alter the appearance or content of a ReportObject when the report is viewed.

Each ReportObject only has a finite number of conditional formulas that can be edited. For each object, use the appropriate ConditionFormulas modifier and modify the Text property of a certain ConditionFormula object in the collection to modify the condition of some attribute.

Method Summary

FormulaNullTreatment	getFormulaNullTreatment() Returns how to treat null values in the evaluation of a formula.
FormulaSyntax	getSyntax() Returns the syntax used to write the formula.
java.lang.String	getText() Returns the formula string.
void	setFormulaNullTreatment(FormulaNullTreatment treatment) Sets how to treat null values in the evaluation of a formula.
void	setSyntax(FormulaSyntax syntax) Sets the syntax used to write the formula.
void	setText(java.lang.String text) Sets the formula string.

Method Detail

getSyntax

FormulaSyntax getSyntax()

Returns the syntax used to write the formula.

Returns:

The FormulaSyntax object.

getText

java.lang.String getText()

Returns the formula string.

Returns:

The formula as a String.

getFormulaNullTreatment

FormulaNullTreatment getFormulaNullTreatment()

Returns how to treat null values in the evaluation of a formula.

By default, null values are treated as exceptions, which means that as soon as RAS encounters a null valued field in a formula, it immediately stops evaluating the formula and produces no value.

If you want to handle null field values in your formula, you must explicitly do so by adding a test function such as IsNull(). You also have the option to treat nulls as default values. The following are the default values for different types used in a formula.

• Number: 0
• Currency: $0
• Boolean: False
• Date: NullDate
• Time: NullTime
• DateTime: (NullDate, NullTime)
• String: ""
• Array: 0-length array
• Range: Upper and lower bounds are both default values.

Returns:

The FormulaNullTreatment object that specifies how to treat null values in the evaluation of a formula.

setSyntax

void setSyntax(FormulaSyntax syntax)

Sets the syntax used to write the formula.

Parameters:

syntax - The FormulaSyntax object.

setText

void setText(java.lang.String text)

Sets the formula string.

Parameters:

text - The formula as a String.

setFormulaNullTreatment

void setFormulaNullTreatment(FormulaNullTreatment treatment)

Sets how to treat null values in the evaluation of a formula.

By default, null values are treated as exceptions, which means that as soon as RAS encounters a null valued field in a formula, it immediately stops evaluating the formula and produces no value.

If you want to handle null field values in your formula, you must explicitly do so by adding a test function such as IsNull(). You also have the option to treat nulls as default values. The following are the default values for different types used in a formula.

• Number: 0
• Currency: $0
• Boolean: False
• Date: NullDate
• Time: NullTime
• DateTime: (NullDate, NullTime)
• String: ""
• Array: 0-length array
• Range: Upper and lower bounds are both default values.

Parameters:

treatment - the FormulaNullTreatment object that specifies how to treat null values. in the evaluation of a formula.