com.businessobjects.datasource
Interface Dimension

All Superinterfaces:

DataSourceObject

public interface Dimension
extends DataSourceObject

The Dimension interface represents a dimension object in the universe. You can use a dimension object as a query result,query condition, or query scope object in a query.

The DataSourceSpecification for a universe contains zero or more DataSourceClass instances. Each of these DataSourceClass instances contains zero or more instances of objects that inherit from the DataSourceObject interface. Essentially, this means that the DataSourceClass instances in a given DataSourceSpecification contain Detail, Dimension, Measure, and PreConditionObject instances that can be used in a query.

See DataSourceObject for information about how to find Dimension instances in a DataSourceSpecification.

After you obtain the keys for the Dimension instances in a DataSourceSpecification, add the keys for the objects that you want to include in your query to QueryObject instances. See QueryObject for details about how to include a Dimension object in a query.

Note: The QuerySpecification interface is the root interface for a query. It contains CombinedQuery instances which, in turn, contain Query instances (which then contain QueryObject instances).

See Also:

DataSourceObject, DataSourceSpecification, QueryObject, Query

Nested Class Summary

static class

Dimension.Factory A class with methods for creating instances of the Dimension type

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

Detail	addNewDetail() Internal Use Only.
Detail[]	getDetailArray() Gets an array of Detail instances contained in this Dimension.
Detail	getDetailArray(int i) Gets the Detail instance located at array index i of the Detail array contained in this Dimension.
boolean	getHasLov() Returns "true", if the Dimension instance has a list of values, otherwise false.
ObjectType.Enum	getType() Gets the type of the Dimension instance as an ObjectType (such as a date, numeric, text...).
Detail	insertNewDetail(int i) Internal Use Only.
void	removeDetail(int i) Internal Use Only.
void	setDetailArray(Detail[] detailArray) Internal Use Only.
void	setDetailArray(int i, Detail detail) Internal Use Only.
void	setHasLov(boolean hasLov) Internal Use Only.
void	setType(ObjectType.Enum type) Internal Use Only.
int	sizeOfDetailArray() Returns the number of Detail element.
org.apache.xmlbeans.XmlBoolean	xgetHasLov() Internal Use Only.
ObjectType	xgetType() Internal Use Only.
void	xsetHasLov(org.apache.xmlbeans.XmlBoolean hasLov) Internal Use Only.
void	xsetType(ObjectType type) Internal Use Only.

Methods inherited from interface com.businessobjects.datasource.DataSourceObject

getAllowedInFilter, getAllowedInResult, getAllowedInSort, getDescription, getHasDelegatedLov, getKey, getName, setAllowedInFilter, setAllowedInResult, setAllowedInSort, setDescription, setHasDelegatedLov, setKey, setName, xgetAllowedInFilter, xgetAllowedInResult, xgetAllowedInSort, xgetDescription, xgetHasDelegatedLov, xgetKey, xgetName, xsetAllowedInFilter, xsetAllowedInResult, xsetAllowedInSort, xsetDescription, xsetHasDelegatedLov, xsetKey, xsetName

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getDetailArray

Detail[] getDetailArray()

Gets an array of Detail instances contained in this Dimension.

Returns:

The array of Detail instances contained in this Dimension

getDetailArray

Detail getDetailArray(int i)

Gets the Detail instance located at array index i of the Detail array contained in this Dimension.

Parameters:

i - the index of the Detail instance in the array

Returns:

the Detail instance located at array index i of the Detail array contained in this Dimension

sizeOfDetailArray

int sizeOfDetailArray()

Returns the number of Detail element.

Returns:

the size of the Detail array.

setDetailArray

void setDetailArray(Detail[] detailArray)

Internal Use Only.

setDetailArray

void setDetailArray(int i,
                    Detail detail)

Internal Use Only.

insertNewDetail

Detail insertNewDetail(int i)

Internal Use Only.

addNewDetail

Detail addNewDetail()

Internal Use Only.

removeDetail

void removeDetail(int i)

Internal Use Only.

getType

ObjectType.Enum getType()

Gets the type of the Dimension instance as an ObjectType (such as a date, numeric, text...).

Returns:

The type of the Dimension instance as an ObjectType

xgetType

ObjectType xgetType()

Internal Use Only.

setType

void setType(ObjectType.Enum type)

Internal Use Only.

xsetType

void xsetType(ObjectType type)

Internal Use Only.

getHasLov

boolean getHasLov()

Returns "true", if the Dimension instance has a list of values, otherwise false.

Returns:

true if the Dimension instance has a list of values, otherwise false

xgetHasLov

org.apache.xmlbeans.XmlBoolean xgetHasLov()

Internal Use Only.

setHasLov

void setHasLov(boolean hasLov)

Internal Use Only.

xsetHasLov

void xsetHasLov(org.apache.xmlbeans.XmlBoolean hasLov)

Internal Use Only.