com.businessobjects.rebean.wi
Interface DataSourceObject

All Superinterfaces:

TreeNode

public interface DataSourceObject
extends TreeNode

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

The DataSourceObject interface represents a object in the data source(universe).

A DataSourceObject can be of any ObjectQualification.

Some data source objects (classes, hierarchies and dimension objects) can have children. These are always DataSourceObject instances and can be accessed through the inherited TreeNode interface.

See Also:

DataSourceObjects, ObjectQualification, ObjectType

Method Summary

boolean	canUseAs(DataSourceObjectUsage usage) Allows for checking whether universe usage restrictions apply to this DataSourceObject.
AggregationFunction	getAggregationFunction() If this DataSourceObject is a measure (i.e.
DataSource	getDataSource() Returns the DataSource this DataSourceObject is part of.
java.lang.String	getDescription() Returns the description for this DataSourceObject.
java.lang.String	getID() Returns the the unique identifier (UID) of this DataSourceObject.
Lov	getLOV() Deprecated. should use DataSourceObject.getLOV(DataProvider) or DataSourceObject.getLOV(DataSourceParameterValues) instead.
Lov	getLOV(DataProvider dp) Retrieves the List of Values for this DataSourceObject, using data source parameter values coming from the specified DataProvider.
Lov	getLOV(DataSourceParameterValues values) Retrieves the List of Values for this DataSourceObject, using the specified data source parameter values.
java.lang.String	getName() Returns the DataSourceObject name.
java.util.Properties	getProperties() Returns the Properties for this DataSourceObject.
ObjectQualification	getQualification() Returns the ObjectQualification for this DataSourceObject.
ObjectType	getType() Returns the DataSourceObject type.
boolean	hasLOV() Returns true if this DataSourceObject contains a List of Values (Lov).
boolean	isRowIndexed() Returns true if this DataSourceObject has an index aware.
boolean	isStripped()

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

getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

getQualification

ObjectQualification getQualification()

Returns the ObjectQualification for this DataSourceObject.

Examples of possible ObjectQualification are:

• ObjectObjectQualification.CLASS
• ObjectQualification.DETAIL
• ObjectQualification.DIMENSION
• ...

Returns:

Returns the ObjectQualification for this DataSourceObject.

getType

ObjectType getType()

Returns the DataSourceObject type.

Examples of possible DataSourceObject types are:

• ObjectType.DATE
• ObjectType.NUMERIC
• ObjectType.TEXT

Returns:

Returns the DataSourceObject type.

getID

java.lang.String getID()

Returns the the unique identifier (UID) of this DataSourceObject.

Returns:

Returns the the unique identifier (UID) of this DataSourceObject.

getDescription

java.lang.String getDescription()

Returns the description for this DataSourceObject.

Returns:

Returns the description for this DataSourceObject.

getDataSource

DataSource getDataSource()

Returns the DataSource this DataSourceObject is part of.

Returns:

Returns the DataSource this DataSourceObject is part of.

getName

java.lang.String getName()

Returns the DataSourceObject name.

Examples of a DataSourceObject name are Year or Country in the Beach example universe.

Returns:

Returns the DataSourceObject name.

getLOV

@Deprecated
Lov getLOV()

Deprecated. should use DataSourceObject.getLOV(DataProvider) or DataSourceObject.getLOV(DataSourceParameterValues) instead.

Returns the List of Values (Lov) contained in this for this DataSourceObject.

Note: that this is only possible if DataSourceObject.hasLOV() returns true.

Returns:

The List of Values contained in this DataSourceObject or null when DataSourceObject.hasLOV() returns false.

hasLOV

boolean hasLOV()

Returns true if this DataSourceObject contains a List of Values (Lov).

A DataSourceObject with an ObjectQualification of either ObjectQualification.DIMENSION or ObjectQualification.DETAIL only can contain a Lov. This DataSourceObject must also be associated with a List of Values in Designer.

Returns:

Returns true if this DataSourceObject contains a List of Values (Lov).

getProperties

java.util.Properties getProperties()

Returns the Properties for this DataSourceObject. The property names are defined in DataSourceObjectPropertiesType.

If this object has no defined Properties, null is returned.

Returns:

The Properties for this DataSourceObject. Possible Properties for a DataSourceObject are:

• Technical description
• Mapping
• Lineage

Use DataSourceObjectPropertiesType to retrieve the required property from the Properties object returned by this method.

Note: These properties are set using Business Objects Designer.

Since:

11.5

See Also:

DataSourceObjectPropertiesType, Properties

isRowIndexed

boolean isRowIndexed()

Returns true if this DataSourceObject has an index aware.

Returns:

Returns true if this DataSourceObject has an index aware.

Since:

11.5

getLOV

Lov getLOV(DataProvider dp)

Retrieves the List of Values for this DataSourceObject, using data source parameter values coming from the specified DataProvider.

Parameters:

dp - the DataProvider instance holding the DataSourceParameterValues to use.

Returns:

The List of Values contained in this DataSourceObject or null when DataSourceObject.hasLOV() returns false.

Since:

12.0

See Also:

DataSourceObject.getLOV(DataSourceParameterValues)

getLOV

Lov getLOV(DataSourceParameterValues values)

Retrieves the List of Values for this DataSourceObject, using the specified data source parameter values.

Parameters:

values - the data source parameter values.

Returns:

The List of Values contained in this. DataSourceObject or null when DataSourceObject.hasLOV() returns false.

Since:

12.0

See Also:

DataSourceParameters.createValues()

getAggregationFunction

AggregationFunction getAggregationFunction()

If this DataSourceObject is a measure (i.e. DataSourceObject.getQualification() == ObjectQualification.MEASURE), this method will return the aggregation function as defined in the universe. If this object is not a measure or is not based on an object in a universe, this method will return AggregationFunction.NONE.

Returns:

the aggregation function for this object

Since:

12.0

See Also:

DPExpression.getAggregationFunction(), AggregationFunction, ObjectQualification

canUseAs

boolean canUseAs(DataSourceObjectUsage usage)

Allows for checking whether universe usage restrictions apply to this DataSourceObject.

Parameters:

usage - a value from the DataSourceObjectUsage enumerated type.

Returns:

true if this DataSourceObject has no universe restrictions for the specified usage, false otherwise.

See Also:

DataSourceObjectUsage

isStripped

boolean isStripped()

Returns:

A boolean.

Since:

12.2