com.businessobjects.dsws.reportengine
Interface DrillBar

public interface DrillBar

Represents a collection of drill bar objects.

The drill bar can be customized by developer by adding or removing data source objects. By default, DrillBar is initialized with report filters. This means that the filtered objects are automatically added to the drill bar.

You can add or remove objects from drill bar.

Example: Getting the DrillBar objects

        RetrieveDrillInfo boDrillInfo = RetrieveDrillInfo.Factory.newInstance();

        boDrillInfo.setDrillLOVRetrievalMode(DrillLOVRetrievalMode.ALL);
        retBOData.setRetrieveDrillInfo(boDrillInfo);
        retBOData.setRetrieveView(retBOView);

        Drill objDrill = Drill.Factory.newInstance();
        objDrill.setActiveDrill(true);

        DrillPath objDrillPath = DrillPath.Factory.newInstance();
  // "DP0.DH1" is the Hierarchy ID
        String[] astrHierarchyIDs = new String[]{"DP0.DH1"};
  // "DP0.DO2" is the From object ID
        String[] astrFromObjectIDs = new String[]{"DP0.DO2"}; // Resort
  // "French Riviera" is the filter object
        String[] astrFilters = new String[]{"French Riviera"};
  // "DP0.DO4" is the To object ID
        String[] astrToObjectIDs = new String[]{"DP0.DO4"}; // Service Line
        String strDrillBlockID = "5";

        objDrillPath.setBlockID(strDrillBlockID);
        objDrillPath.setDrillOperationType(DrillOperationType.DOWN);

        objDrillPath.setHierarchyIDArray(astrHierarchyIDs);
        objDrillPath.setFromObjectIDArray(astrFromObjectIDs);
        objDrillPath.setFilterArray(astrFilters);
        objDrillPath.setToObjectIDArray(astrToObjectIDs);

        objDrill.setDrillPath(objDrillPath);

        Action[] actions = new Action[1];
        actions[0] = objDrill;
        DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,actions,null,retBOData);
        //Retrieve the drill information from the document
        DrillInfo boDocDrill = docInfo.getDrillInfo();
        DrillBar objDrillBar = boDocDrill.getDrillBar();
        DrillBarObject[] objDrillBarObject = objDrillBar.getDrillBarObjectArray();
        for(int i=0;i<objDrillBarObject.length;i++)
        {
           String strName = objDrillBarObject[i].getName();
           out.println(strName);
        }
 

Since:

12.0

See Also:

DrillInfo.getDrillBar(), DrillInfo.setDrillBar(DrillBar), Drill.setModifyDrillBar(ModifyDrillBar), ModifyDrillBar

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal use only

Method Summary

DrillBarObject	addNewDrillBarObject() Internal Use Only.
DrillBarObject[]	getDrillBarObjectArray() Gets an array of all DrillBarObject objects from the current drill operation.
DrillBarObject	getDrillBarObjectArray(int i) Gets the DrillBarObject object at the specified index position, from the current drill operation.
DrillBarObject	insertNewDrillBarObject(int i) Internal Use Only.
boolean	isNilDrillBarObjectArray(int i) Checks if the DrillBarObject object is nil at the specified index position.
void	removeDrillBarObject(int i) Internal Use Only.
void	setDrillBarObjectArray(DrillBarObject[] drillBarObjectArray) Internal Use Only.
void	setDrillBarObjectArray(int i, DrillBarObject drillBarObject) Internal Use Only.
void	setNilDrillBarObjectArray(int i) Internal Use Only.
int	sizeOfDrillBarObjectArray() Returns the number of DrillBarObject element.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal use only

Method Detail

getDrillBarObjectArray

DrillBarObject[] getDrillBarObjectArray()

Gets an array of all DrillBarObject objects from the current drill operation.

Returns:

the array of DrillBarObject instances.

getDrillBarObjectArray

DrillBarObject getDrillBarObjectArray(int i)

Gets the DrillBarObject object at the specified index position, from the current drill operation.

Parameters:

i - the index of the DrillBarObject element.

Returns:

the DrillbarObject instance

isNilDrillBarObjectArray

boolean isNilDrillBarObjectArray(int i)

Checks if the DrillBarObject object is nil at the specified index position.

Parameters:

i - the index of the DrillbarObject element.

Returns:

true if the DrillBarObject element is nil, otherwise false.

sizeOfDrillBarObjectArray

int sizeOfDrillBarObjectArray()

Returns the number of DrillBarObject element.

Returns:

the size of the DrillbarObject array.

setDrillBarObjectArray

void setDrillBarObjectArray(DrillBarObject[] drillBarObjectArray)

Internal Use Only.

setDrillBarObjectArray

void setDrillBarObjectArray(int i,
                            DrillBarObject drillBarObject)

Internal Use Only.

setNilDrillBarObjectArray

void setNilDrillBarObjectArray(int i)

Internal Use Only.

insertNewDrillBarObject

DrillBarObject insertNewDrillBarObject(int i)

Internal Use Only.

addNewDrillBarObject

DrillBarObject addNewDrillBarObject()

Internal Use Only.

removeDrillBarObject

void removeDrillBarObject(int i)

Internal Use Only.