oracle.owb.intelligence
Interface IntelligenceModule

All Superinterfaces:

Component, Extensible, Folder, Module, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface IntelligenceModule

extends Module

An IntelligenceModule is a specialized Module, which represents a collection of intelligence objects that define an instance of an EUL. It can contain Query Objects, IO Functions and Business Area definitions.

Field Summary

Fields inherited from interface oracle.owb.data.Module

MODULE_FLATFILE, MODULE_GATEWAY_DB2, MODULE_GATEWAY_DRDA, MODULE_GATEWAY_INFORMIX, MODULE_GATEWAY_ODBC, MODULE_GATEWAY_OTHER, MODULE_GATEWAY_RDB, MODULE_GATEWAY_SQLSERVER, MODULE_GATEWAY_SYBASE, MODULE_GATEWAY_TERRADATA, MODULE_ORACLE, MODULE_ORACLE_APPS, MODULE_PROCESS_FLOW, MODULE_SAP

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

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

void	addDerivationListener(DerivationListener l) addDerivationListener register DerivationListener.
BusinessArea	createBusinessArea(java.lang.String name) Creates a Business Area with the supplied name.
IOFunction	createFunction(java.lang.String name) Creates an IO Function with the supplied name.
QueryObject	createQueryObject(java.lang.String name) Creates a Query Object with the supplied name.
IODerivationTarget[]	deriveIntelligenceObject(IODerivationSource sourceObj) Carries out an Intelligence Object derivation from a single source object into this Intelligence Module.
IODerivationTarget[]	deriveIntelligenceObjects(IODerivationSource[] sources) Carries out an Intelligence Object derivation from multiple source objects into this Intelligence Module.
BusinessArea	findBusinessArea(java.lang.String name) Finds a Business Area with the supplied name.
IOFunction	findFunction(java.lang.String name) Finds an IO Function with the supplied name.
QueryObject	findQueryObject(java.lang.String name) Finds a Query Object with the supplied name.
java.lang.String[]	getBusinessAreaNames() Returns the names of the Business Areas in the Intelligence Module.
java.lang.String[]	getFunctionNames() Returns the names of the IO Functions in the Intelligence Module.
java.lang.String[]	getQueryObjectNames() Returns the names of the Query Objects in the Intelligence Module.
void	removeDerivationListener(DerivationListener l) removeDerivationListener de-register DerivationListener.

Methods inherited from interface oracle.owb.data.Module

getDatatypeSet, getLocation, getProject, setLocation

Methods inherited from interface oracle.owb.foundation.Folder

findChild, getContentTypes, getFolderContents, getFolderContentsOfType, isCascadeForSnapshot, lockShared, lockWithContents, reloadWithContents, setCascadeForSnapshot

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.compile.ValidatableObject

validate

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

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

Method Detail

deriveIntelligenceObject

public IODerivationTarget[] deriveIntelligenceObject(IODerivationSource sourceObj)

Carries out an Intelligence Object derivation from a single source object into this Intelligence Module.

Parameters:

sourceObj - the individual or collective Derivation Source object that is to be the source of the derivation.

Returns:

an array of objects that are the result of the derivation

deriveIntelligenceObjects

public IODerivationTarget[] deriveIntelligenceObjects(IODerivationSource[] sources)

Carries out an Intelligence Object derivation from multiple source objects into this Intelligence Module.

Parameters:

sources - an array of individual or collective Derivation Source objects that are to be the source of the derivation.

Returns:

an array of objects that are the result of the derivation

getBusinessAreaNames

public java.lang.String[] getBusinessAreaNames()

Returns the names of the Business Areas in the Intelligence Module.

Returns:

an array of Strings containing the Business Area names.

createBusinessArea

public BusinessArea createBusinessArea(java.lang.String name)
                                throws NameSpaceException,
InvalidFormatException

Creates a Business Area with the supplied name.

Parameters:

name - a String containing the name for the new Business Area.

Returns:

a BusinessArea object representing the new business area.

Throws:

NameSpaceException

InvalidFormatException

findBusinessArea

public BusinessArea findBusinessArea(java.lang.String name)

Finds a Business Area with the supplied name.

Parameters:

name - a String containing the name of the Business Area.

Returns:

the BusinessArea object, or null if not found.

getQueryObjectNames

public java.lang.String[] getQueryObjectNames()

Returns the names of the Query Objects in the Intelligence Module.

Returns:

an array of Strings containing the Query Object names.

createQueryObject

public QueryObject createQueryObject(java.lang.String name)
                              throws NameSpaceException,
InvalidFormatException

Creates a Query Object with the supplied name.

Parameters:

name - a String containing the name for the new Query Object.

Returns:

a QueryObject object representing the new query object.

Throws:

NameSpaceException

InvalidFormatException

findQueryObject

public QueryObject findQueryObject(java.lang.String name)

Finds a Query Object with the supplied name.

Parameters:

name - a String containing the name of the Query Object.

Returns:

the QueryObject, or null if not found.

getFunctionNames

public java.lang.String[] getFunctionNames()

Returns the names of the IO Functions in the Intelligence Module.

Returns:

an array of Strings containing the IO Function names.

createFunction

public IOFunction createFunction(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException

Creates an IO Function with the supplied name.

Parameters:

name - a String containing the name for the new IO Function.

Returns:

the new IO Function.

Throws:

NameSpaceException

InvalidFormatException

findFunction

public IOFunction findFunction(java.lang.String name)

Finds an IO Function with the supplied name.

Parameters:

name - a String containing the name of the IO Function.

Returns:

the IO Function, or null if not found.

addDerivationListener

public void addDerivationListener(DerivationListener l)

addDerivationListener register DerivationListener.

Parameters:

l - Object implementing the DerivationListener interface

See Also:

removeDerivationListener(oracle.owb.intelligence.DerivationListener)

removeDerivationListener

public void removeDerivationListener(DerivationListener l)

removeDerivationListener de-register DerivationListener.

Parameters:

l - listener to remove

See Also:

addDerivationListener(oracle.owb.intelligence.DerivationListener)