|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public static final java.lang.String SIMPLE
public static final java.lang.String COMPLEX
Method Detail |
public java.lang.String getExternalTableName()
setExternalTableName(java.lang.String)
public void setExternalTableName(java.lang.String externalTableName)
externalTableName
- a String specifying the external namegetExternalTableName()
public boolean isHidden()
setHidden(boolean)
public void setHidden(boolean hidden)
hidden
- true to make this object hiddenisHidden()
public java.lang.String getObjectType()
setObjectType(java.lang.String)
public void setObjectType(java.lang.String objectType)
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 objectsgetObjectType()
public java.lang.String getPrefix()
setPrefix(java.lang.String)
public void setPrefix(java.lang.String prefix)
prefix
- a String specifying the prefix valuegetPrefix()
public IntelligenceModule getIntelligenceModule()
public QueryItem[] getQueryItems()
public QueryItem createQueryItem(java.lang.String name, int position) throws NameSpaceException, InvalidFormatException
name
- the name of the query itemposition
- the position the query item should be placed atNameSpaceException
InvalidFormatException
public QueryItem createQueryItem(java.lang.String name) throws NameSpaceException, InvalidFormatException
name
- the name of the query itemNameSpaceException
InvalidFormatException
public QueryItem findQueryItem(java.lang.String name)
name
- the name of the query item to be foundnull
otherwisepublic void moveQueryItem(QueryItem queryItem, int newPosition)
queryItem
- the Query Item to be movednewPosition
- the new position for the query itempublic DrillPath[] getDrillPaths()
public DrillPath createDrillPath(java.lang.String name) throws NameSpaceException, InvalidFormatException
name
- the name of the drill pathNameSpaceException
InvalidFormatException
public DrillPath findDrillPath(java.lang.String name)
name
- the name of the drill path to be foundnull
otherwisepublic Join[] getReferencingJoins()
public Join[] getOwnedJoins()
public Join createJoin(java.lang.String name) throws NameSpaceException, InvalidFormatException
name
- the name of the joinNameSpaceException
InvalidFormatException
public Join findJoin(java.lang.String name)
name
- the name of the join to be foundnull
otherwisepublic ItemClass[] getItemClasses()
public ItemClass createItemClass(java.lang.String name) throws NameSpaceException, InvalidFormatException
name
- the name of the item classNameSpaceException
InvalidFormatException
public ItemClass findItemClass(java.lang.String name)
name
- the name of the item class to be foundnull
otherwisepublic OWBNamedObject[] getSourceObjects()
public BusinessAreaShortcut[] getBusinessAreaShortcuts()
|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |