com.businessobjects.datasource
Interface Hierarchy

public interface Hierarchy

The Hierarchy array in a DataSourceSpecification instance contains objects in the universe that can be used as query scope objects.

Example: Finding query scope objects in the universe

 
 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());
        }
 }
 
 

Once you have obtained the keys for the query scope objects in a DataSourceSpecification you then add the keys for the objects that you want to include in your query to QueryObject instances. These QueryObject instances are then added to a Query instance using the Query.setQueryScope method.

See Also:

DataSourceObject, DataSourceSpecification, QueryObject

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

DataSourceObject	addNewDataSourceObject() Internal Use Only.
DataSourceObject[]	getDataSourceObjectArray() Gets the array of DataSourceObject instances contained in this Hierarchy.
DataSourceObject	getDataSourceObjectArray(int i) Gets the DataSourceObject instance located at index iof the DataSourceObject array contained in this Hierarchy.
java.lang.String	getDescription() Gets the description for this Hierarchy instance.
java.lang.String	getKey() Gets the key of this Hierarchy instance.
java.lang.String	getName() Gets the name of this Hierarchy instance.
DataSourceObject	insertNewDataSourceObject(int i) Internal Use Only.
void	removeDataSourceObject(int i) Internal Use Only.
void	setDataSourceObjectArray(DataSourceObject[] dataSourceObjectArray) Internal Use Only.
void	setDataSourceObjectArray(int i, DataSourceObject dataSourceObject) Internal Use Only.
void	setDescription(java.lang.String description) Internal Use Only.
void	setKey(java.lang.String key) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
int	sizeOfDataSourceObjectArray() Returns the number of DataSourceObject element.
org.apache.xmlbeans.XmlString	xgetDescription() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetKey() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) 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

getDataSourceObjectArray

DataSourceObject[] getDataSourceObjectArray()

Gets the array of DataSourceObject instances contained in this Hierarchy. These DataSourceObject instances can be used to define the scope of your query.

Returns:

the array of DataSourceObject instances contained in this Hierarchy

getDataSourceObjectArray

DataSourceObject getDataSourceObjectArray(int i)

Gets the DataSourceObject instance located at index iof the DataSourceObject array contained in this Hierarchy. This DataSourceObject instance can be used to define the scope of your query.

Parameters:

i - the index of the DataSourceObject in the array.

Returns:

the DataSourceObject instance located at index iof the DataSourceObject array contained in this Hierarchy.

sizeOfDataSourceObjectArray

int sizeOfDataSourceObjectArray()

Returns the number of DataSourceObject element.

Returns:

the size of the DataSourceObjectArray.

setDataSourceObjectArray

void setDataSourceObjectArray(DataSourceObject[] dataSourceObjectArray)

Internal Use Only.

setDataSourceObjectArray

void setDataSourceObjectArray(int i,
                              DataSourceObject dataSourceObject)

Internal Use Only.

insertNewDataSourceObject

DataSourceObject insertNewDataSourceObject(int i)

Internal Use Only.

addNewDataSourceObject

DataSourceObject addNewDataSourceObject()

Internal Use Only.

removeDataSourceObject

void removeDataSourceObject(int i)

Internal Use Only.

getKey

java.lang.String getKey()

Gets the key of this Hierarchy instance.

Returns:

the key of this Hierarchy 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 this Hierarchy instance.

Returns:

the name of this Hierarchy 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 for this Hierarchy instance.

Returns:

the description for this Hierarchy 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.