oracle.owb.intelligence
Interface DrillPath

All Superinterfaces:

Extensible, OWBNamedObject, PropertyOwner

public interface DrillPath

extends OWBNamedObject, Extensible

A DrillPath represents a drill path between Query Items within a Query Object.

Method Summary

DrillLevel	createDrillLevel(java.lang.String name) Creates a drill level as the last (lowest) drill level for this drill path.
DrillLevel	createDrillLevel(java.lang.String name, int position) Creates a drill level at the specified position.
DrillLevel	findDrillLevel(java.lang.String name) Search for a drill level by name in this drill path.
DrillLevel[]	getDrillLevels() Returns the ordered list of Drill Levels for this drill path (starting with the topmost parent).
java.lang.String	getExternalName() Returns the external name for the drill path.
java.lang.String	getPrefix() Returns the prefix for component items.
QueryObject	getQueryObject() Returns the owning query object.
Hierarchy	getRelatedHierarchy() Returns the corresponding dimensional Hierarchy.
void	moveDrillLevel(DrillLevel drillLevel, int newPosition) Moves a drill level to a new position in the drill path.
void	setExternalName(java.lang.String externalName) Sets the external name for the drill path.
void	setPrefix(java.lang.String prefix) Sets the prefix for component items.
void	setRelatedHierarchy(Hierarchy hierarchy) Sets the dimensional Hierarchy corresponding to the Drill Path.

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Method Detail

getExternalName

public java.lang.String getExternalName()

Returns the external name for the drill path.

Returns:

a String containing the external name for the drill path.

See Also:

setExternalName(java.lang.String)

setExternalName

public void setExternalName(java.lang.String externalName)

Sets the external name for the drill path.

Parameters:

externalName - a String specifying the external name.

See Also:

getExternalName()

getPrefix

public java.lang.String getPrefix()

Returns the prefix for component items.

Returns:

a String containing the prefix.

See Also:

setPrefix(java.lang.String)

setPrefix

public void setPrefix(java.lang.String prefix)

Sets the prefix for component items.

Parameters:

prefix - a String specifying the prefix.

See Also:

getPrefix()

getQueryObject

public QueryObject getQueryObject()

Returns the owning query object.

Returns:

the QueryObject that owns the Drill Path.

getDrillLevels

public DrillLevel[] getDrillLevels()

Returns the ordered list of Drill Levels for this drill path (starting with the topmost parent).

Returns:

an array of DrillLevels in parent/child order.

createDrillLevel

public DrillLevel createDrillLevel(java.lang.String name,
                                   int position)
                            throws NameSpaceException,
                                   InvalidFormatException

Creates a drill level at the specified position. Valid positions start with 1 (insert at the beginning) and end with the previous number of drill levels plus 1 (insert at the end).

Parameters:

name - the name for the new drill level

position - the position the drill level should be placed at

Returns:

the newly created DrillLevel

Throws:

NameSpaceException -

InvalidFormatException -

createDrillLevel

public DrillLevel createDrillLevel(java.lang.String name)
                            throws NameSpaceException,
                                   InvalidFormatException

Creates a drill level as the last (lowest) drill level for this drill path.

Parameters:

name - the name for the new drill level

Returns:

the newly created DrillLevel

Throws:

NameSpaceException -

InvalidFormatException -

findDrillLevel

public DrillLevel findDrillLevel(java.lang.String name)

Search for a drill level by name in this drill path.

Parameters:

name - the name of the drill level to be found

Returns:

the DrillLevel object if found, null otherwise

moveDrillLevel

public void moveDrillLevel(DrillLevel drillLevel,
                           int newPosition)

Moves a drill level to a new position in the drill path.

Parameters:

drillLevel - the DrillLevel to be moved

newPosition - the new position for the drill level

setRelatedHierarchy

public void setRelatedHierarchy(Hierarchy hierarchy)

Sets the dimensional Hierarchy corresponding to the Drill Path.

Parameters:

hierarchy - a Hierarchy object specifying the related hierarchy. (A null hierarchy value leaves the related hierarchy unset.)

See Also:

getRelatedHierarchy()

getRelatedHierarchy

public Hierarchy getRelatedHierarchy()

Returns the corresponding dimensional Hierarchy.

Returns:

a Hierarchy object representing the related hierarchy, or null if none

See Also:

setRelatedHierarchy(oracle.owb.dimensional.Hierarchy)