com.businessobjects.dsws.reportengine
Interface DrillHierarchy

public interface DrillHierarchy

The DrillHierarchy interface provides access to the properties and functionalities of a Business Objects Universe hierarchy.
A hierarchy organizes objects that return data for related information. For example, a time period hierarchy would includes Year, Quarter, Month, Week and so on.
This means that when you return values for Year to the report and include two levels of analysis, you will be able to drill down from Year to Quarter and then drill down again from Quarter to Month.
A hierarchy is defined using Business Objects Designer and is composed of BO universe dimensions.

Example: Get the name of the Hierarchy associated with the document

 RetrieveDrillInfo boDrillInfo = RetrieveDrillInfo.Factory.newInstance();
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveDrillInfo(boDrillInfo);
 // In order to get the DrillInfo you must enter into the drill mode by
 // passing the drill action to getDocumentInformation
 Action[] actions = new Action[1];
 Drill objDrill = Drill.Factory.newInstance();
 objDrill.setActiveDrill(true);
 actions[0] = objDrill;
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,actions,null,retBOData);

 DrillInfo boDocDrill = docInfo.getDrillInfo();
 DrillHierarchy[] boDrHiers = boDocDrill.getDrillHierarchiesArray();
 for(int i=0;i< boDrHiers.length;i++)
 {
           DrillHierarchy boDrHier = boDrHiers[i];
           String strDrHier = boDrHier.getName();
           out.print(strDrHier);
 }
 

See Also:

DrillPath, DrillHierarchy, Action, DocumentInformation, RetrieveData

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

DrillDimension	addNewDrillDimensions() Internal Use Only.
DrillDimension[]	getDrillDimensionsArray() Returns the DrillDimensions that make up the DrillHierarchy.
DrillDimension	getDrillDimensionsArray(int i) Returns a single DrillDimension from the DrillHierarchy.
java.lang.String	getID() Returns the DrillHierarchy ID.
java.lang.String	getName() Returns the name of the DrillHierarchy.
DrillDimension	insertNewDrillDimensions(int i) Internal Use Only.
boolean	isNilDrillDimensionsArray(int i) Checks if the DrillDimensions element is nil, at the specified index position.
void	removeDrillDimensions(int i) Removes the DrillDimension element at the specified index position.
void	setDrillDimensionsArray(DrillDimension[] drillDimensionsArray) Internal Use Only.
void	setDrillDimensionsArray(int i, DrillDimension drillDimensions) Internal Use Only.
void	setID(java.lang.String id) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setNilDrillDimensionsArray(int i) Internal Use Only.
int	sizeOfDrillDimensionsArray() Returns the number of DrillDimensions element.
org.apache.xmlbeans.XmlString	xgetID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
void	xsetID(org.apache.xmlbeans.XmlString id) 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

getDrillDimensionsArray

DrillDimension[] getDrillDimensionsArray()

Returns the DrillDimensions that make up the DrillHierarchy.

Returns:

an array of DrillDimension.

getDrillDimensionsArray

DrillDimension getDrillDimensionsArray(int i)

Returns a single DrillDimension from the DrillHierarchy.

Parameters:

i - index of the DrillDimension to be retrieved.

Returns:

a DrillDimension in the DrillHierarchy

isNilDrillDimensionsArray

boolean isNilDrillDimensionsArray(int i)

Checks if the DrillDimensions element is nil, at the specified index position.

Returns:

true if the DrillDimension element is nil, otherwise false

sizeOfDrillDimensionsArray

int sizeOfDrillDimensionsArray()

Returns the number of DrillDimensions element.

Returns:

the size of the DrillDimension array.

setDrillDimensionsArray

void setDrillDimensionsArray(DrillDimension[] drillDimensionsArray)

Internal Use Only.

setDrillDimensionsArray

void setDrillDimensionsArray(int i,
                             DrillDimension drillDimensions)

Internal Use Only.

setNilDrillDimensionsArray

void setNilDrillDimensionsArray(int i)

Internal Use Only.

insertNewDrillDimensions

DrillDimension insertNewDrillDimensions(int i)

Internal Use Only.

addNewDrillDimensions

DrillDimension addNewDrillDimensions()

Internal Use Only.

removeDrillDimensions

void removeDrillDimensions(int i)

Removes the DrillDimension element at the specified index position.

Parameters:

i - the index of the DrillDimension element

getName

java.lang.String getName()

Returns the name of the DrillHierarchy.

Returns:

The name of the DrillHierarchy.

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.

getID

java.lang.String getID()

Returns the DrillHierarchy ID.

Returns:

The DrillHierarchy ID.

xgetID

org.apache.xmlbeans.XmlString xgetID()

Internal Use Only.

setID

void setID(java.lang.String id)

Internal Use Only.

xsetID

void xsetID(org.apache.xmlbeans.XmlString id)

Internal Use Only.