public interface

WebDrillMap

com.microstrategy.web.objects.WebDrillMap

Class Overview

This interface holds a collection of WebDrillPath objects. The drill paths thus stored can be enumerated, traversed and searched using this interface. The collection held by an object of this interface is read only. In other words, one cannot add a drill path to this collection.

Summary

Public Methods
abstract Enumeration elements()
Returns an enumeration for the collection of WebDrillPath objects stored in this drill map.
abstract WebDrillMap filterBySetName(String setName)
Returns a drill map for with only those drill paths from the current drill map that belong to a given set.
abstract WebDrillPath get(int index)
Returns the WebDrillPath object at a desired index.
abstract int getAxis()
Gets the axis of the drill map.
abstract WebDrillMap getDrillPathsWithHighImportance()
Returns the WebDrillMap with Highest Importance.
abstract int getPosition()
Gets the position of the drill map.
abstract String[] getSetNames()
Returns an ordered array of set names contained in this drill map.
abstract WebDrillMap getUniqueDrillPaths()
Returns a drill map containing unique drill paths from this drill map.
abstract boolean hasDrillPaths()
Returns a boolean true if the current drillMap could have atleast one drillpath for the current axis and position.
abstract boolean isEmpty()
Returns true if there are no WebDrillPath objects in the collection.
abstract WebDrillPath itemByID(int drillPathID)
Returns a drill path with the ID passed as argument within the collection of WebDrillPath objects stored by this object.
abstract int size()
Returns the size of the collection of WebDrillPath objects.
abstract void sort(Comparator comparator)
Sorts the drill paths in this drill map.

Public Methods

public abstract Enumeration elements ()

Returns an enumeration for the collection of WebDrillPath objects stored in this drill map.

Returns

public abstract WebDrillMap filterBySetName (String setName)

Returns a drill map for with only those drill paths from the current drill map that belong to a given set.

Parameters
setName the name of the Set for which the drill paths are to be retrieved
Returns
  • the WebDrillMap for this instance with drill paths belonging to the Set passed as argument.

public abstract WebDrillPath get (int index)

Returns the WebDrillPath object at a desired index.

Parameters
index index for retrieving the WebDrillPath object.
Returns
Throws
IndexOutOfBoundsException if the index passed is negative or greater than the size of the collection.

public abstract int getAxis ()

Gets the axis of the drill map. If the drill map does not have a valid axis, it returns a 0.

Returns
  • a axis value for this drill map.

public abstract WebDrillMap getDrillPathsWithHighImportance ()

Returns the WebDrillMap with Highest Importance.

Returns

public abstract int getPosition ()

Gets the position of the drill map. If the drill map does not have a valid position, it returns a 0.

Returns
  • a position value for this drill map.

public abstract String[] getSetNames ()

Returns an ordered array of set names contained in this drill map.

Returns
  • the ordered array of set names contained in this drill map.

public abstract WebDrillMap getUniqueDrillPaths ()

Returns a drill map containing unique drill paths from this drill map. Drill paths are compared by name. If there are two (or more) drill paths with different importance levels in the current drill map, only the one with highest importance level is included in the returned drill map.

Returns
  • the WebDrillMap containing unique drill paths from this drill map.

public abstract boolean hasDrillPaths ()

Returns a boolean true if the current drillMap could have atleast one drillpath for the current axis and position. It may be possible that the method returns true and still the current WebDrillMap object does not have any drillpaths (isEmpty returns true). However, If the method returns false, then the current WebDrillMap object should not have any drillPaths. Scenario: When one asks for high and medium importance drillpaths and for a template unit only low drillpaths exist, this method will return true, even though isEmpty returns true. This method should not be used to check the existence of any drillpaths in the current drillMap. Use #isEmpty method.

Returns
  • a boolean representing whether there are drillpaths possible for this drillmap

public abstract boolean isEmpty ()

Returns true if there are no WebDrillPath objects in the collection.

Returns
  • whether this object has an empty collection of WebDrillPath objects.

public abstract WebDrillPath itemByID (int drillPathID)

Returns a drill path with the ID passed as argument within the collection of WebDrillPath objects stored by this object.

Parameters
drillPathID The ID of the drill path searched.
Returns
Throws
WebObjectsException if the drillPath ID is not found in the collection.

public abstract int size ()

Returns the size of the collection of WebDrillPath objects.

Returns
  • The size of the collection.

public abstract void sort (Comparator comparator)

Sorts the drill paths in this drill map. Caller must pass in a comparator object to be able to sort. The object passed to the compare methods of Comparator can be type casted to WebDrillPath.