com.businessobjects.dsws.reportengine
Interface DrillDimension

public interface DrillDimension

The DrillDimension interface provides access to the properties and functionality of a BusinessObjects Universe dimension.

Example: Gets the name of the dimensions in the Hierarchy.

 RetrieveDrillInfo boDrillInfo = new RetrieveDrillInfo();
 RetrieveData retBOData = new RetrieveData();
 retBOData.setRetrieveDrillInfo(boDrillInfo);
 Action[] actions = new Action[1];
 Drill objDrill = new Drill();
 objDrill.setActiveDrill(true);
 actions[0] = objDrill;
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,actions,null,retBOData);

 DrillInfo boDocDrill = docInfo.getDrillInfo();
 DrillHierarchy[] boDrHiers = boDocDrill.getDrillHierarchies();
 DrillHierarchy boDrHier = boDrHiers[0];
 DrillDimension[] boDrDims = boDrHier.getDrillDimensions();
 for(int i=0; i< boDrDims.length; i++)
  {
      DrillDimension boDrDim = boDrDims[i];
      String strDrDim = boDrDim.getName();
      out.println(strDrDim);
  }
 

See Also:

DrillPath, DrillHierarchy, Action, Refresh, RetrieveData

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

LOV	addNewLOV() Internal Use Only.
boolean	getAmbiguous() Returns true if the dimension belongs to more than one DrillHierarchy.
java.lang.String	getDescription() Gets the description of the DrillDimension.
java.lang.String	getFilter() Returns the member on which the current Drill is being filtered.
java.lang.String	getID() Returns the DrillDimension unique ID.
boolean	getInScope() Returns true if the dimension is in the scope of analysis.
LOV	getLOV() Returns a List Of Values (LOV) included in the DrillDimension.
java.lang.String	getName() Returns the DrillDimension name.
boolean	isNilDescription() Checks if the Description element is nil.
boolean	isNilLOV() Checks if the LOV element is nil.
boolean	isSetDescription() Checks if the Description element is set.
boolean	isSetFilter() Checks if the Filter attribute is set.
boolean	isSetLOV() Checks if the LOV element is set.
void	setAmbiguous(boolean ambiguous) Internal Use Only.
void	setDescription(java.lang.String description) Internal Use Only.
void	setFilter(java.lang.String filter) Internal Use Only.
void	setID(java.lang.String id) Internal Use Only.
void	setInScope(boolean inScope) Internal Use Only.
void	setLOV(LOV lov) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setNilDescription() Internal Use Only.
void	setNilLOV() Internal Use Only.
void	unsetDescription() Internal Use Only.
void	unsetFilter() Internal Use Only.
void	unsetLOV() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetAmbiguous() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDescription() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFilter() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetID() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetInScope() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
void	xsetAmbiguous(org.apache.xmlbeans.XmlBoolean ambiguous) Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) Internal Use Only.
void	xsetFilter(org.apache.xmlbeans.XmlString filter) Internal Use Only.
void	xsetID(org.apache.xmlbeans.XmlString id) Internal Use Only.
void	xsetInScope(org.apache.xmlbeans.XmlBoolean inScope) 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

getLOV

LOV getLOV()

Returns a List Of Values (LOV) included in the DrillDimension.
Note: LOV will be retrieved only if the DrillDimension is in the scope of analysis.

Returns:

a List Of Values.

See Also:

LOV

isNilLOV

boolean isNilLOV()

Checks if the LOV element is nil.

Returns:

true if the LOV element is nil, otherwise false

isSetLOV

boolean isSetLOV()

Checks if the LOV element is set.

Returns:

true if the LOV element is set, otherwise false

setLOV

void setLOV(LOV lov)

Internal Use Only.

addNewLOV

LOV addNewLOV()

Internal Use Only.

setNilLOV

void setNilLOV()

Internal Use Only.

unsetLOV

void unsetLOV()

Internal Use Only.

getDescription

java.lang.String getDescription()

Gets the description of the DrillDimension.

Returns:

a string containing a description of the dimension.

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Internal Use Only.

isNilDescription

boolean isNilDescription()

Checks if the Description element is nil.

Returns:

true if the description element is nil, otherwise false

isSetDescription

boolean isSetDescription()

Checks if the Description element is set.

Returns:

true if the description element is set, otherwise false

setDescription

void setDescription(java.lang.String description)

Internal Use Only.

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Internal Use Only.

setNilDescription

void setNilDescription()

Internal Use Only.

unsetDescription

void unsetDescription()

Internal Use Only.

getName

java.lang.String getName()

Returns the DrillDimension name.

Returns:

a string containing the name of the DrillDimension.

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 DrillDimension unique ID.

Returns:

a String containing the DrillDimension unique 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.

getFilter

java.lang.String getFilter()

Returns the member on which the current Drill is being filtered.

When a user analyzes report results in Drill mode, filters can be applied as the user drills 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.

Returns:

the member on which the current Drill is being filtered.

xgetFilter

org.apache.xmlbeans.XmlString xgetFilter()

Internal Use Only.

isSetFilter

boolean isSetFilter()

Checks if the Filter attribute is set.

Returns:

true if the filter element is set, otherwise false.

setFilter

void setFilter(java.lang.String filter)

Internal Use Only.

xsetFilter

void xsetFilter(org.apache.xmlbeans.XmlString filter)

Internal Use Only.

unsetFilter

void unsetFilter()

Internal Use Only.

getInScope

boolean getInScope()

Returns true if the dimension is in the scope of analysis.

Returns:

true if the dimension is in the scope of analysis.

xgetInScope

org.apache.xmlbeans.XmlBoolean xgetInScope()

Internal Use Only.

setInScope

void setInScope(boolean inScope)

Internal Use Only.

xsetInScope

void xsetInScope(org.apache.xmlbeans.XmlBoolean inScope)

Internal Use Only.

getAmbiguous

boolean getAmbiguous()

Returns true if the dimension belongs to more than one DrillHierarchy.

Returns:

true if the dimension belongs to more than one DrillHierarchy.

See Also:

DrillHierarchy

xgetAmbiguous

org.apache.xmlbeans.XmlBoolean xgetAmbiguous()

Internal Use Only.

setAmbiguous

void setAmbiguous(boolean ambiguous)

Internal Use Only.

xsetAmbiguous

void xsetAmbiguous(org.apache.xmlbeans.XmlBoolean ambiguous)

Internal Use Only.