oracle.owb.intelligence
Interface QueryObject

All Superinterfaces:

Component, Extensible, IntelligenceObject, IODerivationTarget, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface QueryObject

extends Component, Extensible, ValidatableObject, IntelligenceObject, IODerivationTarget

A QueryObject is a component of an Intelligence Module that represents a set of related items that an end user can use to retrieve information.

Field Summary

static java.lang.String	COMPLEX Object type COMPLEX indicates that a Query Object is based on one or more other Query Objects.
static java.lang.String	SIMPLE Object type SIMPLE indicates that a Query Object corresponds to a single database object (table or view).

Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

DrillPath	createDrillPath(java.lang.String name) Creates a drill path for this query object.
ItemClass	createItemClass(java.lang.String name) Creates an item class owned by this query object.
Join	createJoin(java.lang.String name) Creates a join owned by this query object.
QueryItem	createQueryItem(java.lang.String name) Creates a query item as the last query item of this query object.
QueryItem	createQueryItem(java.lang.String name, int position) Creates a query item at the specified position.
DrillPath	findDrillPath(java.lang.String name) Search for a drill path by name in this query object.
ItemClass	findItemClass(java.lang.String name) Search for an item class by name owned by this query object.
Join	findJoin(java.lang.String name) Search for a join by name that is owned by this query object.
QueryItem	findQueryItem(java.lang.String name) Search for a query item by name in this query object.
BusinessAreaShortcut[]	getBusinessAreaShortcuts() Returns a list of Business Area Shortcuts that reference this query object.
DrillPath[]	getDrillPaths() Returns the list of drill paths for this query object.
java.lang.String	getExternalTableName() Returns the external name for the corresponding table or view.
IntelligenceModule	getIntelligenceModule() Returns the Intelligence Module this query object belongs to.
ItemClass[]	getItemClasses() Returns the list of item classes owned by this query object.
java.lang.String	getObjectType() Returns the type of query object.
Join[]	getOwnedJoins() Returns the list of joins owned by this query object.
java.lang.String	getPrefix() Returns the prefix for component items.
QueryItem[]	getQueryItems() Returns an ordered list of the query items of this query object.
Join[]	getReferencingJoins() Returns the list of joins that reference this query object.
OWBNamedObject[]	getSourceObjects() Gets a list of source objects that the Query Object depends on.
boolean	isHidden() Returns whether the query object should be hidden from the user.
void	moveQueryItem(QueryItem queryItem, int newPosition) Moves a query item to a new position.
void	setExternalTableName(java.lang.String externalTableName) Sets the external name for the corresponding table or view.
void	setHidden(boolean hidden) Sets whether the query object should be hidden from the user.
void	setObjectType(java.lang.String objectType) Sets the type of query object.
void	setPrefix(java.lang.String prefix) Sets the prefix for component items.

Methods inherited from interface oracle.owb.foundation.Component

getOwningFolder, isReloadNeeded, lock, reload, unlock

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.metadatamgmt.changemgmt.Snapshotable

compare, compare, compare, compare, createSnapshot, createSnapshot, createSnapshotWithDependeeComponents, createSnapshotWithDependeeComponents, getSnapshots

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

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

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

Field Detail

SIMPLE

public static final java.lang.String SIMPLE

Object type SIMPLE indicates that a Query Object corresponds to a single database object (table or view).

See Also:

Constant Field Values

COMPLEX

public static final java.lang.String COMPLEX

Object type COMPLEX indicates that a Query Object is based on one or more other Query Objects.

See Also:

Constant Field Values

Method Detail

getExternalTableName

public java.lang.String getExternalTableName()

Returns the external name for the corresponding table or view. (This is only relevant for a Query Object that corresponds to a database table or view.)

Returns:

a String representing the external name

See Also:

setExternalTableName(java.lang.String)

setExternalTableName

public void setExternalTableName(java.lang.String externalTableName)

Sets the external name for the corresponding table or view.

Parameters:

externalTableName - a String specifying the external name

See Also:

getExternalTableName()

isHidden

public boolean isHidden()

Returns whether the query object should be hidden from the user.

Returns:

true if this object should be hidden

See Also:

setHidden(boolean)

setHidden

public void setHidden(boolean hidden)

Sets whether the query object should be hidden from the user.

Parameters:

hidden - true to make this object hidden

See Also:

isHidden()

getObjectType

public java.lang.String getObjectType()

Returns the type of query object.

Returns:

a String representing the object type. Values are SIMPLE or COMPLEX

See Also:

setObjectType(java.lang.String)

setObjectType

public void setObjectType(java.lang.String objectType)

Sets the type of query object.

Parameters:

objectType - a String specifying the object type: SIMPLE - corresponds to a single database object (table or view) COMPLEX - based on one or more other query objects

See Also:

getObjectType()

getPrefix

public java.lang.String getPrefix()

Returns the prefix for component items.

Returns:

a String representing the prefix value

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 value

See Also:

getPrefix()

getIntelligenceModule

public IntelligenceModule getIntelligenceModule()

Returns the Intelligence Module this query object belongs to.

Returns:

the owning IntelligenceModule object

getQueryItems

public QueryItem[] getQueryItems()

Returns an ordered list of the query items of this query object.

Returns:

an array of query items in position order

createQueryItem

public QueryItem createQueryItem(java.lang.String name,
                                 int position)
                          throws NameSpaceException,
InvalidFormatException

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

Parameters:

name - the name of the query item

position - the position the query item should be placed at

Returns:

the newly created query item

Throws:

NameSpaceException

InvalidFormatException

createQueryItem

public QueryItem createQueryItem(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException

Creates a query item as the last query item of this query object.

Parameters:

name - the name of the query item

Returns:

the newly created query item

Throws:

NameSpaceException

InvalidFormatException

findQueryItem

public QueryItem findQueryItem(java.lang.String name)

Search for a query item by name in this query object.

Parameters:

name - the name of the query item to be found

Returns:

the Query Item object if found, null otherwise

moveQueryItem

public void moveQueryItem(QueryItem queryItem,
                          int newPosition)

Moves a query item to a new position.

Parameters:

queryItem - the Query Item to be moved

newPosition - the new position for the query item

getDrillPaths

public DrillPath[] getDrillPaths()

Returns the list of drill paths for this query object.

Returns:

an array of drill paths

createDrillPath

public DrillPath createDrillPath(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException

Creates a drill path for this query object.

Parameters:

name - the name of the drill path

Returns:

the newly created drill path

Throws:

NameSpaceException

InvalidFormatException

findDrillPath

public DrillPath findDrillPath(java.lang.String name)

Search for a drill path by name in this query object.

Parameters:

name - the name of the drill path to be found

Returns:

the Drill Path object if found, null otherwise

getReferencingJoins

public Join[] getReferencingJoins()

Returns the list of joins that reference this query object.

Returns:

an array of joins

getOwnedJoins

public Join[] getOwnedJoins()

Returns the list of joins owned by this query object.

Returns:

an array of joins

createJoin

public Join createJoin(java.lang.String name)
                throws NameSpaceException,
InvalidFormatException

Creates a join owned by this query object.

Parameters:

name - the name of the join

Returns:

the newly created join

Throws:

NameSpaceException

InvalidFormatException

findJoin

public Join findJoin(java.lang.String name)

Search for a join by name that is owned by this query object.

Parameters:

name - the name of the join to be found

Returns:

the Join object if found, null otherwise

getItemClasses

public ItemClass[] getItemClasses()

Returns the list of item classes owned by this query object.

Returns:

an array of item classes

createItemClass

public ItemClass createItemClass(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException

Creates an item class owned by this query object.

Parameters:

name - the name of the item class

Returns:

the newly created item class

Throws:

NameSpaceException

InvalidFormatException

findItemClass

public ItemClass findItemClass(java.lang.String name)

Search for an item class by name owned by this query object.

Parameters:

name - the name of the item class to be found

Returns:

the Item Class object if found, null otherwise

getSourceObjects

public OWBNamedObject[] getSourceObjects()

Gets a list of source objects that the Query Object depends on.

Returns:

an array of objects. (These objects may be of type Table, View, Dimension, Cube or Query Object)

getBusinessAreaShortcuts

public BusinessAreaShortcut[] getBusinessAreaShortcuts()

Returns a list of Business Area Shortcuts that reference this query object.

Returns:

an array of Business Area Shortcuts