com.businessobjects.dsws.reportengine
Interface DrillPath

public interface DrillPath

You can use the DrillPath interface to perform the different drill operations such as drillup, drilldown, drillslice, and drillby.
Note This interface can be used only when drill mode is activated.

Example: Setting the drill parameters to drill path and perform drilling.

 String Block=request.getParameter("block");
 String[] From=request.getParameterValues("from");
 String action=request.getParameter("action");
 String[] Filter=request.getParameterValues("filter");
 String[] To=request.getParameterValues("to");
 String[] Hier=request.getParameterValues("hierarchy");
 String reference=request.getParameter("referenceHolder");

 // Set up the query string parameters used for drilling.

 DrillOption objDrillOption = DrillOption.Factory.newInstance();
 objDrillOption.setCallbackFrame("view");
 objDrillOption.setCallbackScript("manageDrill.jsp");
 objDrillOption.setAmbiguousDrillCallbackScript("ambiguous.jsp");
 objDrillOption.setBlockHolder("block");
 objDrillOption.setFromHolder("from");
 objDrillOption.setDrillActionHolder("action");
 objDrillOption.setFilterHolder("filter");
 objDrillOption.setToHolder("to");
 objDrillOption.setHierarchyHolder("hierarchy");
 objDrillOption.setDocumentReferenceHolder("referenceHolder");

 CallbackOption[] aobjCallbackOptions = new CallbackOption[1];
 aobjCallbackOptions[0] = objDrillOption;
 DrillPath boDrillPath = DrillPath.Factory.newInstance();
 //block is a report element e.g a table, chart etc.
 boDrillPath.setBlockID(Block);

 //Drill down in the document
 if(action.equals("down"))
            boDrillPath.setDrillOperationType( DrillOperationType.DOWN );
 else if(action.equals("up"))
     boDrillPath.setDrillOperationType( DrillOperationType.UP);
 else if(action.equals("by"))
            boDrillPath.setDrillOperationType( DrillOperationType.BY);
 else if(action.equals("slice"))
        boDrillPath.setDrillOperationType( DrillOperationType.SLICE);

 boDrillPath.setHierarchyIDArray(Hier);
 boDrillPath.setFromObjectIDArray(From);
 boDrillPath.setToObjectIDArray(To);
 boDrillPath.setFilterArray(Filter);
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOView.setCallbackOptionArray(aobjCallbackOptions);
 retBOData.setRetrieveView(retBOView);
 Action[] aobjActions = new Action[1];
 Drill objDrill = Drill.Factory.newInstance();
 objDrill.setActiveDrill(true);
 aobjActions[0] = objDrill;
 objDrill.setDrillPath(boDrillPath);

 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,aobjActions,null,retBOData);
 CharacterView myBOView = (CharacterView)docInfo.getView();
 String docContents = myBOView.getContent();
 out.print(docContents);
 

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action, BICatalog, Document, ReportEngine, DocumentInformation, RetrieveMustFillInfo, Refresh, FillPrompts, FillPassword, EmbeddedAction, FillDBLogons, FillQueryContext, Navigate, RetrieveData

Nested Class Summary

static class

DrillPath.Factory A factory class with static methods for creating instances of this type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

void	addFilter(java.lang.String filter) Appends the value as the last "Filter" element
void	addFromObjectID(java.lang.String fromObjectID) Appends the value as the last FromObjectID element.
void	addHierarchyID(java.lang.String hierarchyID) Appends the value as the last "HierarchyID" element
org.apache.xmlbeans.XmlString	addNewFilter() Appends and returns a new empty value (as xml) as the last "Filter" element
org.apache.xmlbeans.XmlString	addNewFromObjectID() Appends and returns a new empty value (as xml) as the last FromObjectID element
org.apache.xmlbeans.XmlString	addNewHierarchyID() Appends and returns a new empty value (as xml) as the last "HierarchyID" element
org.apache.xmlbeans.XmlString	addNewToObjectID() Appends and returns a new empty value (as xml) as the last "ToObjectID" element
void	addToObjectID(java.lang.String toObjectID) Appends the value as the last "ToObjectID" element
java.lang.String	getBlockID() Internal Use Only.
DrillOperationType.Enum	getDrillOperationType() Return the DrillOperationType to be performed on the next drill operation.
java.lang.String[]	getFilterArray() Internal Use Only.
java.lang.String	getFilterArray(int i) Internal Use Only.
java.lang.String[]	getFromObjectIDArray() Internal Use Only.
java.lang.String	getFromObjectIDArray(int i) Internal Use Only.
java.lang.String[]	getHierarchyIDArray() Internal Use Only.
java.lang.String	getHierarchyIDArray(int i) Internal Use Only.
java.lang.String[]	getToObjectIDArray() Internal Use Only.
java.lang.String	getToObjectIDArray(int i) Internal Use Only.
void	insertFilter(int i, java.lang.String filter) Inserts the value as the ith "Filter" element
void	insertFromObjectID(int i, java.lang.String fromObjectID) Inserts the the FromObjectID element at the specified index position.
void	insertHierarchyID(int i, java.lang.String hierarchyID) Inserts the value as the ith "HierarchyID" element
org.apache.xmlbeans.XmlString	insertNewFilter(int i) Inserts and returns a new empty value (as xml) as the ith "Filter" element
org.apache.xmlbeans.XmlString	insertNewFromObjectID(int i) Inserts and returns a new empty FromObjectID value at the specified index position.
org.apache.xmlbeans.XmlString	insertNewHierarchyID(int i) Inserts and returns a new empty value (as xml) as the ith "HierarchyID" element
org.apache.xmlbeans.XmlString	insertNewToObjectID(int i) Inserts and returns a new empty value (as xml) as the ith "ToObjectID" element
void	insertToObjectID(int i, java.lang.String toObjectID) Inserts the value as the ith "ToObjectID" element
boolean	isNilFilterArray(int i) Tests for nil ith "Filter" element
boolean	isNilFromObjectIDArray(int i) Checks if the FromObjectID element is nil.
boolean	isNilHierarchyIDArray(int i) Tests for nil ith "HierarchyID" element
boolean	isNilToObjectIDArray(int i) Tests for nil ith "ToObjectID" element
void	removeFilter(int i) Removes the ith "Filter" element
void	removeFromObjectID(int i) Removes the FromObjectID element from the specified index position.
void	removeHierarchyID(int i) Removes the ith "HierarchyID" element
void	removeToObjectID(int i) Removes the ith "ToObjectID" element
void	setBlockID(java.lang.String blockID) Set the ID of the report block the user is drilling into.
void	setDrillOperationType(DrillOperationType.Enum drillOperationType) Set the DrillOperationType to be performed on the next drill operation.
void	setFilterArray(int i, java.lang.String filter) Set a single filter to be applied on the next drill operation.
void	setFilterArray(java.lang.String[] filterArray) Set the filters to be applied on the next drill operation.
void	setFromObjectIDArray(int i, java.lang.String fromObjectID) Sets the ID of an object the user has drilled from.
void	setFromObjectIDArray(java.lang.String[] fromObjectIDArray) Sets the IDs of the objects the user has drilled from.
void	setHierarchyIDArray(int i, java.lang.String hierarchyID) Set a single ID in the DrillHierarchy the user can drill to.
void	setHierarchyIDArray(java.lang.String[] hierarchyIDArray) Set an array of ID's in the DrillHierarchy the user can drill to.
void	setNilFilterArray(int i) Nils the ith "Filter" element
void	setNilFromObjectIDArray(int i) Checks if the FromObjectID element is set.
void	setNilHierarchyIDArray(int i) Nils the ith "HierarchyID" element
void	setNilToObjectIDArray(int i) Nils the ith "ToObjectID" element
void	setToObjectIDArray(int i, java.lang.String toObjectID) Set a single object ID the user can drill to.
void	setToObjectIDArray(java.lang.String[] toObjectIDArray) Set the IDs of the objects the user can drill to
int	sizeOfFilterArray() Returns number of "Filter" element
int	sizeOfFromObjectIDArray() Returns the number of FromObjectID element.
int	sizeOfHierarchyIDArray() Returns number of "HierarchyID" element
int	sizeOfToObjectIDArray() Returns number of "ToObjectID" element
org.apache.xmlbeans.XmlString	xgetBlockID() Internal Use Only.
DrillOperationType	xgetDrillOperationType() Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetFilterArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFilterArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetFromObjectIDArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFromObjectIDArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetHierarchyIDArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetHierarchyIDArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlString[]	xgetToObjectIDArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetToObjectIDArray(int i) Internal Use Only.
void	xsetBlockID(org.apache.xmlbeans.XmlString blockID) Internal Use Only.
void	xsetDrillOperationType(DrillOperationType drillOperationType) Internal Use Only.
void	xsetFilterArray(int i, org.apache.xmlbeans.XmlString filter) Internal Use Only.
void	xsetFilterArray(org.apache.xmlbeans.XmlString[] filterArray) Internal Use Only.
void	xsetFromObjectIDArray(int i, org.apache.xmlbeans.XmlString fromObjectID) Internal Use Only.
void	xsetFromObjectIDArray(org.apache.xmlbeans.XmlString[] fromObjectIDArray) Internal Use Only.
void	xsetHierarchyIDArray(int i, org.apache.xmlbeans.XmlString hierarchyID) Internal Use Only.
void	xsetHierarchyIDArray(org.apache.xmlbeans.XmlString[] hierarchyIDArray) Internal Use Only.
void	xsetToObjectIDArray(int i, org.apache.xmlbeans.XmlString toObjectID) Internal Use Only.
void	xsetToObjectIDArray(org.apache.xmlbeans.XmlString[] toObjectIDArray) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getFromObjectIDArray

java.lang.String[] getFromObjectIDArray()

Internal Use Only.

getFromObjectIDArray

java.lang.String getFromObjectIDArray(int i)

Internal Use Only.

xgetFromObjectIDArray

org.apache.xmlbeans.XmlString[] xgetFromObjectIDArray()

Internal Use Only.

xgetFromObjectIDArray

org.apache.xmlbeans.XmlString xgetFromObjectIDArray(int i)

Internal Use Only.

isNilFromObjectIDArray

boolean isNilFromObjectIDArray(int i)

Checks if the FromObjectID element is nil.

Returns:

true if the FromObjectID element is set, otherwise false

sizeOfFromObjectIDArray

int sizeOfFromObjectIDArray()

Returns the number of FromObjectID element.

Returns:

the size of the FromObjectID array

setFromObjectIDArray

void setFromObjectIDArray(java.lang.String[] fromObjectIDArray)

Sets the IDs of the objects the user has drilled from.

Parameters:

fromObjectIDArray - the ID of the object the user has drilled from.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

setFromObjectIDArray

void setFromObjectIDArray(int i,
                          java.lang.String fromObjectID)

Sets the ID of an object the user has drilled from.

Note: Before using this function, #setToObjectID(java.lang.String[] toObjectID) has to be called to initialize the array.

Parameters:

i - The index of the object ID to be set.

fromObjectID - the ID of an object the user has drilled from

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

xsetFromObjectIDArray

void xsetFromObjectIDArray(org.apache.xmlbeans.XmlString[] fromObjectIDArray)

Internal Use Only.

xsetFromObjectIDArray

void xsetFromObjectIDArray(int i,
                           org.apache.xmlbeans.XmlString fromObjectID)

Internal Use Only.

setNilFromObjectIDArray

void setNilFromObjectIDArray(int i)

Checks if the FromObjectID element is set.

Parameters:

i - the index of the FromObjectID element

insertFromObjectID

void insertFromObjectID(int i,
                        java.lang.String fromObjectID)

Inserts the the FromObjectID element at the specified index position.

Parameters:

i - the index of the FromObjectID element

fromObjectID - the String value of the FromObjectID

addFromObjectID

void addFromObjectID(java.lang.String fromObjectID)

Appends the value as the last FromObjectID element.

Parameters:

fromObjectID - the String value of the FromObjectID

insertNewFromObjectID

org.apache.xmlbeans.XmlString insertNewFromObjectID(int i)

Inserts and returns a new empty FromObjectID value at the specified index position.

Parameters:

i - the index of the FromObjectID element

Returns:

a new empty value (as xml) as the ith FromObjectID element

addNewFromObjectID

org.apache.xmlbeans.XmlString addNewFromObjectID()

Appends and returns a new empty value (as xml) as the last FromObjectID element

Returns:

a new empty value (as xml) as the last FromObjectID element

removeFromObjectID

void removeFromObjectID(int i)

Removes the FromObjectID element from the specified index position.

Parameters:

i - the index of the FromObjectID element

getToObjectIDArray

java.lang.String[] getToObjectIDArray()

Internal Use Only.

getToObjectIDArray

java.lang.String getToObjectIDArray(int i)

Internal Use Only.

xgetToObjectIDArray

org.apache.xmlbeans.XmlString[] xgetToObjectIDArray()

Internal Use Only.

xgetToObjectIDArray

org.apache.xmlbeans.XmlString xgetToObjectIDArray(int i)

Internal Use Only.

isNilToObjectIDArray

boolean isNilToObjectIDArray(int i)

Tests for nil ith "ToObjectID" element

Parameters:

i - the index of the ToObjectID element

Returns:

true if the ToObjectID element is nil, otherwise false

sizeOfToObjectIDArray

int sizeOfToObjectIDArray()

Returns number of "ToObjectID" element

Returns:

the size of the ToObjectID array

setToObjectIDArray

void setToObjectIDArray(java.lang.String[] toObjectIDArray)

Set the IDs of the objects the user can drill to

Parameters:

toObjectID - an array of objects ID's the user can drill to.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

setToObjectIDArray

void setToObjectIDArray(int i,
                        java.lang.String toObjectID)

Set a single object ID the user can drill to.

Note: Before using this function, #setToObjectID(java.lang.String[] toObjectID) has to be called to initialize the array.

Parameters:

i - The index of the object ID to be set.

value - a single object ID the user can drill to.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

xsetToObjectIDArray

void xsetToObjectIDArray(org.apache.xmlbeans.XmlString[] toObjectIDArray)

Internal Use Only.

xsetToObjectIDArray

void xsetToObjectIDArray(int i,
                         org.apache.xmlbeans.XmlString toObjectID)

Internal Use Only.

setNilToObjectIDArray

void setNilToObjectIDArray(int i)

Nils the ith "ToObjectID" element

Parameters:

i - the index of the ToObjectID element

insertToObjectID

void insertToObjectID(int i,
                      java.lang.String toObjectID)

Inserts the value as the ith "ToObjectID" element

Parameters:

i - the index of the ToObjectID element

toObjectID - the String value of ToObjectID

addToObjectID

void addToObjectID(java.lang.String toObjectID)

Appends the value as the last "ToObjectID" element

Parameters:

toObjectID - the String value of ToObjectID

insertNewToObjectID

org.apache.xmlbeans.XmlString insertNewToObjectID(int i)

Inserts and returns a new empty value (as xml) as the ith "ToObjectID" element

Parameters:

i - the index of the ToObjectID element

Returns:

a new empty value (as xml) as the ith "ToObjectID" element

addNewToObjectID

org.apache.xmlbeans.XmlString addNewToObjectID()

Appends and returns a new empty value (as xml) as the last "ToObjectID" element

Returns:

a new empty value (as xml) as the last "ToObjectID" element

removeToObjectID

void removeToObjectID(int i)

Removes the ith "ToObjectID" element

Parameters:

i - the index of the ToObjectID element

getHierarchyIDArray

java.lang.String[] getHierarchyIDArray()

Internal Use Only.

getHierarchyIDArray

java.lang.String getHierarchyIDArray(int i)

Internal Use Only.

xgetHierarchyIDArray

org.apache.xmlbeans.XmlString[] xgetHierarchyIDArray()

Internal Use Only.

xgetHierarchyIDArray

org.apache.xmlbeans.XmlString xgetHierarchyIDArray(int i)

Internal Use Only.

isNilHierarchyIDArray

boolean isNilHierarchyIDArray(int i)

Tests for nil ith "HierarchyID" element

Parameters:

i - the index of the HierarchyID element

Returns:

true if the HierarchyID element is nil, otherwise false

sizeOfHierarchyIDArray

int sizeOfHierarchyIDArray()

Returns number of "HierarchyID" element

Returns:

the size of the HierarchyID array

setHierarchyIDArray

void setHierarchyIDArray(java.lang.String[] hierarchyIDArray)

Set an array of ID's in the DrillHierarchy the user can drill to.

Parameters:

hierarchyID - an array of DrillHierarchy ID's.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

setHierarchyIDArray

void setHierarchyIDArray(int i,
                         java.lang.String hierarchyID)

Set a single ID in the DrillHierarchy the user can drill to.

Note: Before using this function, #setHierarchyID(java.lang.String[] hierarchyID) has to be called to initialize the array.

Parameters:

i - The index of the Hierarchy ID to be set.

value - a single Hierarchy ID.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

xsetHierarchyIDArray

void xsetHierarchyIDArray(org.apache.xmlbeans.XmlString[] hierarchyIDArray)

Internal Use Only.

xsetHierarchyIDArray

void xsetHierarchyIDArray(int i,
                          org.apache.xmlbeans.XmlString hierarchyID)

Internal Use Only.

setNilHierarchyIDArray

void setNilHierarchyIDArray(int i)

Nils the ith "HierarchyID" element

Parameters:

i - the index of the HierarchyID element

insertHierarchyID

void insertHierarchyID(int i,
                       java.lang.String hierarchyID)

Inserts the value as the ith "HierarchyID" element

Parameters:

i - the index of the HierarchyID element

hierarchyID - the String value of HierarchyID element

addHierarchyID

void addHierarchyID(java.lang.String hierarchyID)

Appends the value as the last "HierarchyID" element

Parameters:

hierarchyID - the String value of HierarchyID element

insertNewHierarchyID

org.apache.xmlbeans.XmlString insertNewHierarchyID(int i)

Inserts and returns a new empty value (as xml) as the ith "HierarchyID" element

Parameters:

i - the index of the HierarchyID element

Returns:

a new empty value (as xml) as the ith "HierarchyID" element

addNewHierarchyID

org.apache.xmlbeans.XmlString addNewHierarchyID()

Appends and returns a new empty value (as xml) as the last "HierarchyID" element

Returns:

a new empty value (as xml) as the last "HierarchyID" element

removeHierarchyID

void removeHierarchyID(int i)

Removes the ith "HierarchyID" element

Parameters:

i - the index of the HierarchyID element

getFilterArray

java.lang.String[] getFilterArray()

Internal Use Only.

getFilterArray

java.lang.String getFilterArray(int i)

Internal Use Only.

xgetFilterArray

org.apache.xmlbeans.XmlString[] xgetFilterArray()

Internal Use Only.

xgetFilterArray

org.apache.xmlbeans.XmlString xgetFilterArray(int i)

Internal Use Only.

isNilFilterArray

boolean isNilFilterArray(int i)

Tests for nil ith "Filter" element

Parameters:

i - the index of the Filter element

Returns:

true if the Filter element is nil, otherwise false

sizeOfFilterArray

int sizeOfFilterArray()

Returns number of "Filter" element

Returns:

the size of the filter array

setFilterArray

void setFilterArray(java.lang.String[] filterArray)

Set the filters to be applied on the next drill operation.

When you analyze report results in Drill mode, filters can be applied as you drill on selected values. For example, if you drill on the value January on a table cell to view more detailed results for each week, the values displayed should correspond to the weeks in January.

Parameters:

filter - an array of filters.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

setFilterArray

void setFilterArray(int i,
                    java.lang.String filter)

Set a single filter to be applied on the next drill operation.

Note: Before using this function, #setFilter(java.lang.String[] filter) has to be called to initialize the array.

Parameters:

i - The index of the filter to be retrieved.

value - a single filter.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

xsetFilterArray

void xsetFilterArray(org.apache.xmlbeans.XmlString[] filterArray)

Internal Use Only.

xsetFilterArray

void xsetFilterArray(int i,
                     org.apache.xmlbeans.XmlString filter)

Internal Use Only.

setNilFilterArray

void setNilFilterArray(int i)

Nils the ith "Filter" element

Parameters:

the - index of the filter element

insertFilter

void insertFilter(int i,
                  java.lang.String filter)

Inserts the value as the ith "Filter" element

Parameters:

i - the index of the fileter element

filter - the String value of the Filter element

addFilter

void addFilter(java.lang.String filter)

Appends the value as the last "Filter" element

Parameters:

filter - the String value of the Filter element

insertNewFilter

org.apache.xmlbeans.XmlString insertNewFilter(int i)

Inserts and returns a new empty value (as xml) as the ith "Filter" element

Parameters:

i - the index of the filter element

Returns:

a new empty value (as xml) as the ith "Filter" element

addNewFilter

org.apache.xmlbeans.XmlString addNewFilter()

Appends and returns a new empty value (as xml) as the last "Filter" element

Returns:

a new empty value (as xml) as the last "Filter" element

removeFilter

void removeFilter(int i)

Removes the ith "Filter" element

Parameters:

i - the index of the filter element

getBlockID

java.lang.String getBlockID()

Internal Use Only.

xgetBlockID

org.apache.xmlbeans.XmlString xgetBlockID()

Internal Use Only.

setBlockID

void setBlockID(java.lang.String blockID)

Set the ID of the report block the user is drilling into.

Parameters:

blockID - the ID of the report block.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

xsetBlockID

void xsetBlockID(org.apache.xmlbeans.XmlString blockID)

Internal Use Only.

getDrillOperationType

DrillOperationType.Enum getDrillOperationType()

Return the DrillOperationType to be performed on the next drill operation.

Returns:

a DrillOperationType.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

xgetDrillOperationType

DrillOperationType xgetDrillOperationType()

Internal Use Only.

setDrillOperationType

void setDrillOperationType(DrillOperationType.Enum drillOperationType)

Set the DrillOperationType to be performed on the next drill operation.

Parameters:

drillOperationType - a DrillOperationType.

See Also:

Drill, DrillPath, DrillHierarchy, DrillInfo, DrillOperationType, Action

xsetDrillOperationType

void xsetDrillOperationType(DrillOperationType drillOperationType)

Internal Use Only.