| com.microstrategy.web.objects.WebDrillInstance |
This interface should be used to drill on a report. A drill instance can be used to access the drilling related
related functionalities corresponding to a WebReportInstance. A WebDrillInstance
can be obtained from a report instance using getDrillInstance().
Using a drill instance one can create drill actions(can be nested) and drill on a report (or just on a template unit within
the report) and execute the drill action on IServer. Alternatively, one can ask the drill instance to load drill actions
using a selected drill path and submit drill action on IServer corresponding to it.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract WebReportInstance |
drill()
Drills on the base report instance and returns the report instance thus generated.
| ||||||||||
| abstract WebReportInstance |
drill(String drillXML)
Drills on the base report instance using the drillXML and returns the report instance thus generated.
| ||||||||||
| abstract WebReportInstance |
getBaseInstance()
Returns the base report instance.
| ||||||||||
| abstract WebDrillActions |
getDrillActions()
Returns the collection of Drill Actions within this object as a
WebDrillActions object. | ||||||||||
| abstract WebDrillElements |
getDrillElements()
Returns a
WebDrillElements object that can be filled as a user filter | ||||||||||
| abstract WebDrillMap |
getDrillMap()
Returns the drill map (collection of
WebDrillPath objects) for the base report instance. | ||||||||||
| abstract WebTemplateUnit |
getDrillTemplateUnit()
Returns the template unit that has been set for this drill instance.
| ||||||||||
| abstract String |
getDrillXML()
Returns the drill XML represented by the current state of this object.
| ||||||||||
| abstract boolean |
getFilterOnPageBy()
Returns the filterOnPageBy property, which specifies whether during drilling, the user wants to filter on the page by elements too.
| ||||||||||
| abstract void |
loadActionsFromDrillPath(WebDrillPath drillPath)
Creates and populates drill actions for this drill instance, using the drill path object
passed.
| ||||||||||
| abstract void |
loadActionsFromDrillPath(int drillPathID)
Creates and populates drill actions for this drill instance using the drill path ID
passed.
| ||||||||||
| abstract void |
setDrillTemplateUnit(WebTemplateUnit wtu)
Sets the template unit from where to drill on the base report instance.
| ||||||||||
| abstract void |
setDrillTemplateUnit(int axis, int position)
Sets the template unit from where to drill on the base report instance.
| ||||||||||
| abstract void |
setFilterOnPageBy(boolean filterOnPageBy)
Sets the filterOnPageBy property, which specifies whether during drilling, the user wants to filter on the page by elements too.
| ||||||||||
Drills on the base report instance and returns the report instance thus generated.
WebReportInstance object| WebObjectsException | If the Intellingence Server encountered problems in drilling on the report using the properties set on this object. |
|---|
Drills on the base report instance using the drillXML and returns the report instance thus generated.
| drillXML | The XML to be used for drilling. |
|---|
WebReportInstance object.| WebObjectsException | If the Intellingence Server encountered problems in drilling on the report using the properties set on this object. |
|---|
Returns the base report instance.
WebReportInstance object that created this WebDrillInstance object.
Returns the collection of Drill Actions within this object as a WebDrillActions object.
WebDrillActions for this instance.
Returns a WebDrillElements object that can be filled as a user filter
WebDrillElements object.
Returns the drill map (collection of WebDrillPath objects) for the base report instance.
WebDrillMap object for the base report instance.| WebObjectsException | if the Intelligence Server encounters an error in getting the drill paths for the report. |
|---|
Returns the template unit that has been set for this drill instance.
WebTemplateUnit object set on this object.| WebObjectsException} if a template unit at the given position and axis does not exist. | |
| WebObjectsException |
Returns the drill XML represented by the current state of this object.
| WebObjectsException | thrown by some drill action classes if adequate arguments are not provided e.g. WebNewObjectDrillAction if the target object is not set. |
|---|
Returns the filterOnPageBy property, which specifies whether during drilling, the user wants to filter on the page by elements too.
Creates and populates drill actions for this drill instance, using the drill path object passed.
| drillPath | WebDrillPath object.
|
|---|
Creates and populates drill actions for this drill instance using the drill path ID passed. If a drill template unit is already set on the drill instance it will search across the drill paths corresponding to that template unit. If no template unit is set, it will search on the drill paths for the report(drill path for a report or report-level drill path uses the entire report as source template unit).
| drillPathID | the drill path ID. |
|---|
| WebObjectsException | if the Intelligence Server encounters an error in getting the drill paths. |
|---|---|
| IllegalArgumentException | if there is no drill path with ID passed. |
Sets the template unit from where to drill on the base report instance.
| wtu | The WebTemplateUnit from where to drill.
|
|---|
Sets the template unit from where to drill on the base report instance.
| axis | The Axis on which the WebTemplateUnit, from where to drill. lies. Possible
enumerations are listed in EnumDSSXMLAxisName |
|---|---|
| position | The position of the WebTemplateUnit, from where to drill.
|
Sets the filterOnPageBy property, which specifies whether during drilling, the user wants to filter on the page by elements too.
| filterOnPageBy | the boolean value for filterOnPageBy to be set. |
|---|