com.businessobjects.datasource
Interface DataSourceObject

All Known Subinterfaces:

Detail, Dimension, Measure, PreConditionObject

public interface DataSourceObject

The DataSourceObject represents an object in the universe. The DataSourceObject interface is the parent interface for Detail, Dimension, Measure, and PreConditionObject.

You obtain DataSourceObject instances (as instances of the child interfaces) from a DataSourceSpecification. After you obtain the DataSourceObject instances in the DataSourceSpecification, you can then reference their keys in building your query. (When building a query, the QueryObject interface is used to reference a DataSourceObject instance found in the universe. The key of a QueryObject is set to the key of the DataSourceObject that it represents.)

Example: Finding the keys for DataSourceObject instances in the universe.

  DataSourceClass[] boDataSourceClasses = boUniverseSpecification.getDataSourceClassArray();
  Hierarchy[] boHierarchy = boUniverseSpecification.getHierarchyArray();
  LinkedList detailKeys = new LinkedList();
  LinkedList dimensionKeys = new LinkedList();
  LinkedList measureKeys = new LinkedList();
  LinkedList preConditionObjectKeys = new LinkedList();
        for (int i=0; i<boDataSourceClasses.length; i++)
        {
                DataSourceObject[] boDataSourceObjects = boDataSourceClasses[i].getDataSourceObjectArray();
                for (int j=0; j<boDataSourceObjects.length; j++)
                {
                        // Dimension objects can be used for query results or query conditions.
                        if (boDataSourceObjects[j] instanceof Dimension)
                        {
                                dimensionKeys.add(boDataSourceObjects[j].getKey());
                                Dimension objDimension = (Dimension)boDataSourceObjects[j];
                                Detail[] objDetails = objDimension.getDetailArray();
                                if(objDetails != null)
                                {
                                        for(int n=0; n <objDetails.length; n++)
                                        {
                                                detailKeys.add(objDetails[n].getKey());
                                        }
                                }
                        }
                        // Measure objects can be used for query results or query conditions.
                        if (boDataSourceObjects[j] instanceof Measure)
                        {
                                measureKeys.add(boDataSourceObjects[j].getKey());
                        }
                }
        }
        LinkedList scopeKeys = new LinkedList();
        for (int k=0; k<boHierarchy.length; k++)
        {
                DataSourceObject[] boScopeObjects = boHierarchy[k].getDataSourceObjectArray();
                for (int m=0; m<boScopeObjects.length; m++)
                {
                        scopeKeys.add(boScopeObjects[m].getKey());
                }
        }
 

The keys that you have obtained for the objects in the Universe (data source), can be used at multiple places such as constructing a query and working on GetDataSourceObjectLOV(). For information about how to construct a query, see QuerySpecification.

See Also:

DataSourceSpecification, DataSourceClass, QuerySpecification, QueryObject

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

boolean	getAllowedInFilter() Returns true, if the DataSourceObject is allowed in filter panel.
boolean	getAllowedInResult() Returns true, if the DataSourceObject is allowed in result panel.
boolean	getAllowedInSort() Returns true, if the DataSourceObject is allowed for sorting.
java.lang.String	getDescription() Gets the description of the object in the universe represented by this DataSourceObject instance.
boolean	getHasDelegatedLov() Returns true, if the LOV has the Database-Search support.
java.lang.String	getKey() Gets the key of the object in the universe.
java.lang.String	getName() Gets the name of the object in the universe.
void	setAllowedInFilter(boolean allowedInFilter) Internal Use Only.
void	setAllowedInResult(boolean allowedInResult) Internal Use Only.
void	setAllowedInSort(boolean allowedInSort) Internal Use Only.
void	setDescription(java.lang.String description) Internal Use Only.
void	setHasDelegatedLov(boolean hasDelegatedLov) Internal Use Only.
void	setKey(java.lang.String key) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetAllowedInFilter() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetAllowedInResult() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetAllowedInSort() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDescription() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetHasDelegatedLov() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetKey() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
void	xsetAllowedInFilter(org.apache.xmlbeans.XmlBoolean allowedInFilter) Internal Use Only.
void	xsetAllowedInResult(org.apache.xmlbeans.XmlBoolean allowedInResult) Internal Use Only.
void	xsetAllowedInSort(org.apache.xmlbeans.XmlBoolean allowedInSort) Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) Internal Use Only.
void	xsetHasDelegatedLov(org.apache.xmlbeans.XmlBoolean hasDelegatedLov) Internal Use Only.
void	xsetKey(org.apache.xmlbeans.XmlString key) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getKey

java.lang.String getKey()

Gets the key of the object in the universe. The key is set to the key of an object found in the universe (data source). Then, you specify that a given object in the universe is part of the query by adding the DataSourceObject key to a QueryObject instance in the query.

Returns:

The key of the object in the universe represented by this DataSourceObject instance.

xgetKey

org.apache.xmlbeans.XmlString xgetKey()

Internal Use Only.

setKey

void setKey(java.lang.String key)

Internal Use Only.

xsetKey

void xsetKey(org.apache.xmlbeans.XmlString key)

Internal Use Only.

getName

java.lang.String getName()

Gets the name of the object in the universe. The name is set to the name of an object found in the universe (data source).

Returns:

The name of the object in the universe represented by this DataSourceObject instance.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

setName

void setName(java.lang.String name)

Internal Use Only.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

getDescription

java.lang.String getDescription()

Gets the description of the object in the universe represented by this DataSourceObject instance. The description is set to the description of an object found in the universe (data source).

Returns:

The description of the object in the universe represented by this DataSourceObject instance.

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Internal Use Only.

setDescription

void setDescription(java.lang.String description)

Internal Use Only.

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Internal Use Only.

getHasDelegatedLov

boolean getHasDelegatedLov()

Returns true, if the LOV has the Database-Search support.

Returns:

true, if the LOV has the Database-Search support, otherwise false.

xgetHasDelegatedLov

org.apache.xmlbeans.XmlBoolean xgetHasDelegatedLov()

Internal Use Only.

setHasDelegatedLov

void setHasDelegatedLov(boolean hasDelegatedLov)

Internal Use Only.

xsetHasDelegatedLov

void xsetHasDelegatedLov(org.apache.xmlbeans.XmlBoolean hasDelegatedLov)

Internal Use Only.

getAllowedInResult

boolean getAllowedInResult()

Returns true, if the DataSourceObject is allowed in result panel.

Returns:

true, if the DataSourceObject is allowed in result panel, otherwise false.

xgetAllowedInResult

org.apache.xmlbeans.XmlBoolean xgetAllowedInResult()

Internal Use Only.

setAllowedInResult

void setAllowedInResult(boolean allowedInResult)

Internal Use Only.

xsetAllowedInResult

void xsetAllowedInResult(org.apache.xmlbeans.XmlBoolean allowedInResult)

Internal Use Only.

getAllowedInFilter

boolean getAllowedInFilter()

Returns true, if the DataSourceObject is allowed in filter panel.

Returns:

true, if the DataSourceObject is allowed in filter panel, otherwise false.

xgetAllowedInFilter

org.apache.xmlbeans.XmlBoolean xgetAllowedInFilter()

Internal Use Only.

setAllowedInFilter

void setAllowedInFilter(boolean allowedInFilter)

Internal Use Only.

xsetAllowedInFilter

void xsetAllowedInFilter(org.apache.xmlbeans.XmlBoolean allowedInFilter)

Internal Use Only.

getAllowedInSort

boolean getAllowedInSort()

Returns true, if the DataSourceObject is allowed for sorting.

Returns:

true, if the DataSourceObject is allowed for sorting, otherwise false.

xgetAllowedInSort

org.apache.xmlbeans.XmlBoolean xgetAllowedInSort()

Internal Use Only.

setAllowedInSort

void setAllowedInSort(boolean allowedInSort)

Internal Use Only.

xsetAllowedInSort

void xsetAllowedInSort(org.apache.xmlbeans.XmlBoolean allowedInSort)

Internal Use Only.