BIRT Data Analyzer API classes : Class actuate.xtabanalyzer.Driller

Class actuate.xtabanalyzer.Driller

Description

The Driller class enables an application to drill down or up on a member within a dimension.

Constructor

Syntax

actuate.xtabanalyzer.Driller( )

Creates a Driller object.

Function summary

Table 5-5 lists actuate.xtabanalyzer.Driller functions.

Table 5-5  actuate.xtabanalyzer.Driller functions 
Function
Description
addMember( )
Adds a member to the drill condition
getDimension( )
Retrieves the driller dimension.
getMembers( )
Retrieves the members used by the drill.
setDimension( )
Sets the driller dimension.
setMembers( )
Adds an array of members to the drill condition.

actuate.xtabanalyzer.Driller.addMember

Syntax

void Driller.addMember(actuate.xtabanalyzer.MemberValue member)

Adds a member to the drill condition.

Parameters

member

actuate.xtabanalyzer.MemberValue object.

Example

This example adds a member to a driller object.

function drillDownDimension( ){
  var driller = new actuate.xtabanalyzer.Driller( );
  driller.setDimension(actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);
// Create a member for the driller, based on level name and value.
  var memberValue = new actuate.xtabanalyzer.MemberValue("drillLevelName");
  memberValue.setValue("drillLevelValue");
  driller.addMember(memberValue);
  crosstab.drill( driller );
  crosstab.submit( );
}

actuate.xtabanalyzer.Driller.getDimension

Syntax

integer Driller.getDimension( )

Retrieves the dimension name for the drill condition.

Returns

Integer. The following values are legal dimension names:

n  
actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE
n  
actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE

Example

This example retrieves the dimension of the driller.

function getDrillerAxis(driller){
  if (driller){
    return driller.getDimension( );
  }
  return null;
}

actuate.xtabanalyzer.Driller.getMembers

Syntax

actuate.xtabanalyzer.MemberValue[ ] Driller.getMembers( )

Retrieves the list of members contained within the drill condition.

Returns

Array of actuate.xtabanalyzer.MemberValue.

Example

This example retrieves the members that a driller uses.

function getDrillerMembers(driller){
  if (driller){
    return driller.getMembers( );
  }
  return null;
}

actuate.xtabanalyzer.Driller.setDimension

Syntax

void Driller.setDimension(string dimension)

Sets the dimension’s name.

Parameters

dimension

String.

Example

This example sets the dimension name for the driller.

function setRowAxis(driller){
  if (driller)  {
    dimension.setDimension("Row");
  }
}

actuate.xtabanalyzer.Driller.setMembers

Syntax

void Driller.setMembers(actuate.xtabanalyzer.MemberValue[ ] member)

Adds an array of members to the drill condition.

Parameters

member

Array of actuate.xtabanalyzer.MemberValue objects.

Example

This example sets the axis type for the driller.

function setDrillerMembers(driller,members){
  if (driller && members){
    driller.setMembers(members);
  }
}
(c) Copyright Actuate Corporation 2011