com.businessobjects.rebean.wi
Interface ReportExpression

All Superinterfaces:

TreeNode

All Known Subinterfaces:

DPExpression, FormulaExpression, Link, VariableExpression

public interface ReportExpression
extends TreeNode

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

A ReportExpression represents the data generated by a Query for an individual ResultObject in the ReportDictionary.

See ReportDictionary for an example of how to obtain the ReportExpression instances contained in a DocumentInstance when a DataProvider has run the Query generated by a Web Intelligence user.

For an example of how to obtain instances of this type, see ReportDictionary.

See Also:

ReportDictionary

Method Summary

DataSource	getDataSource() Gets the data source this report expression is based on.
DataSourceObject	getDataSourceObject() Gets the data source object that was used to create this report expression.
java.lang.String	getFormulaLanguageID() Gets the Report Expression's identifier used in formula language.
java.lang.String	getID() Gets the unique identifier.
java.lang.String	getName() Gets the name.
ObjectQualification	getQualification() Gets the qualification of this expression.
ObjectType	getType() Gets the type of this expression.

Methods inherited from interface com.businessobjects.rebean.wi.TreeNode

getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

getName

java.lang.String getName()

Gets the name. The name returned will not in all cases be the same as the result of getDataSourceObject().getName() and therefore the name returned by this function should be the only one used in the document.

Returns:

the name

getID

java.lang.String getID()

Gets the unique identifier. Note that the ID of a report expression has no relation to getDataSourceObject().getID().

Returns:

the ID

getDataSourceObject

DataSourceObject getDataSourceObject()

Gets the data source object that was used to create this report expression.

Returns:

the data source object

getDataSource

DataSource getDataSource()

Gets the data source this report expression is based on.

Returns:

the data source

getQualification

ObjectQualification getQualification()

Gets the qualification of this expression.

Returns:

the qualification

getType

ObjectType getType()

Gets the type of this expression.

Returns:

the type

getFormulaLanguageID

java.lang.String getFormulaLanguageID()

Gets the Report Expression's identifier used in formula language. For example : [Query 1].[Country] identifie Country report expression from data provider DP1. [Query 2].[Country] identifie Country report expression from data provider DP2. This ID is null for FormulaExpression.

This identifier is unique for each report expression of ReportDictionary.

// dict is an instance of ReportDictionary // rExpr0 is an instance of ReportExpression // create MyVar1=NameOf([Country]) VariableExpression var0 = dict.createVariable("MyVar1", ObjectQualification.DIMENSION, "=NameOf("+rExpr0.getFormulaLanguageID()+")"); //create MyVar2="Country: "+[MyVar1]; VariableExpression var1 = dict.createVariable("MyVar2", ObjectQualification.DIMENSION, "=\"Country: \"+"+var0.getFormulaLanguageID()); // link1 is an instance of Link // create MyVar3 = [MyVar1]+ " + "+[CountryLink] VariableExpression var2 = dict.createVariable("MyVar3", ObjectQualification.DIMENSION, "="+var0.getFormulaLanguageID()+" + "+ link1.getFormulaLanguageID());

Returns:

the formula language identifier

Since:

11.5