oracle.owb.intelligence
Interface DrillLevel

All Superinterfaces:

Extensible, OWBNamedObject, PropertyOwner

public interface DrillLevel

extends OWBNamedObject, Extensible

A DrillLevel represents a group of query items that can be drilled to or from within a drill path.

Method Summary

DrillItem	createDrillItem(java.lang.String name) Creates a drill item as the last drill item of this drill level.
DrillItem	createDrillItem(java.lang.String name, int position) Creates a drill item at the specified position.
DrillItem	findDrillItem(java.lang.String name) Search for a drill item by name in this drill path.
DrillLevel	getChildDrillLevel() Returns the child Drill Level for this Drill Level.
DrillItem[]	getDrillItems() Returns the ordered list of drill items for this drill level.
DrillPath	getDrillPath() Returns the owning Drill Path.
java.lang.String	getExternalName() Returns the external name for the drill level.
DrillLevel	getParentDrillLevel() Returns the parent Drill Level for this Drill Level.
java.lang.String	getPrefix() Returns the prefix for component items.
Level	getRelatedLevel() Returns the corresponding dimensional Level.
void	moveDrillItem(DrillItem drillItem, int newPosition) Moves a drill item to a new position.
void	setExternalName(java.lang.String externalName) Sets the external name for the drill level.
void	setPrefix(java.lang.String prefix) Sets the prefix for component items.
void	setRelatedLevel(Level level) Sets the dimensional Level corresponding to the Drill Level.

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 level.

Returns:

a String containing the external name for the drill level.

See Also:

setExternalName(java.lang.String)

setExternalName

public void setExternalName(java.lang.String externalName)

Sets the external name for the drill level.

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()

getDrillPath

public DrillPath getDrillPath()

Returns the owning Drill Path.

Returns:

the DrillPath that owns this drill level.

getParentDrillLevel

public DrillLevel getParentDrillLevel()

Returns the parent Drill Level for this Drill Level.

Returns:

a DrillLevel object representing the parent drill level, or null if none.

getChildDrillLevel

public DrillLevel getChildDrillLevel()

Returns the child Drill Level for this Drill Level.

Returns:

a DrillLevel object representing the child drill level, or null if none.

getDrillItems

public DrillItem[] getDrillItems()

Returns the ordered list of drill items for this drill level.

Returns:

an array of DrillItems in position order

createDrillItem

public DrillItem createDrillItem(java.lang.String name,
                                 int position)
                          throws NameSpaceException,
InvalidFormatException

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

Parameters:

name - the name for the new drill item

position - the position the drill item should be placed at

Returns:

the new DrillItem

Throws:

NameSpaceException

InvalidFormatException

createDrillItem

public DrillItem createDrillItem(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException

Creates a drill item as the last drill item of this drill level.

Parameters:

name - the name for the new drill item

Returns:

the new DrillItem

Throws:

NameSpaceException

InvalidFormatException

findDrillItem

public DrillItem findDrillItem(java.lang.String name)

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

Parameters:

name - the name of the drill item to be found

Returns:

the DrillItem object if found, null otherwise

moveDrillItem

public void moveDrillItem(DrillItem drillItem,
                          int newPosition)

Moves a drill item to a new position.

Parameters:

drillItem - the DrillItem to be moved

newPosition - the new position for the drill item

setRelatedLevel

public void setRelatedLevel(Level level)

Sets the dimensional Level corresponding to the Drill Level.

Parameters:

level - a Level object specifying the related level. (A null level value leaves the related level unset.)

See Also:

getRelatedLevel()

getRelatedLevel

public Level getRelatedLevel()

Returns the corresponding dimensional Level.

Returns:

a Level object representing the related level, or null if none

See Also:

setRelatedLevel(oracle.owb.dimensional.Level)