SqlQuery (Oracle Fusion Middleware Java Substitution API Reference for Oracle Data Integrator)

java.lang.Object
- oracle.odi.mapping.generation.AbstractSyntaxTree
- - oracle.odi.mapping.generation.QueryClause
  - - oracle.odi.mapping.generation.SqlQuery

All Implemented Interfaces:

ITableFunctionParameter, SqlStatement

Direct Known Subclasses:

CorrelatedQuery, FileSqlQuery, NestedSqlQuery, OracleSqlQuery, PivotQuery, SetQuery
```
public class SqlQuery
extends QueryClause
implements SqlStatement, ITableFunctionParameter
```
The SqlQuery class models a SQL query in the ODI code generator. During code generation, each mapping component receives at least one SqlQuery as input.

Since:

12.1.2.0.0

Nested Class Summary
- Nested classes/interfaces inherited from class oracle.odi.mapping.generation.AbstractSyntaxTree
  AbstractSyntaxTree.LogCounter

Method Summary

doclet.All_Methods doclet.Instance_Methods doclet.Concrete_Methods
Modifier and Type	Method and Description
`SqlQuery`	`addJoin(MapPhysicalNode physicalNode, JoinTable.JoinType joinType, SqlQuery joinQuery, ArrayExpression[] joinConditionHolder, boolean addJoinCondition, boolean orderedJoin, SqlQuery.SelectMapContainer selectMapContainer, IMapComponent leftComponent, IMapComponent rightComponent, MapConnectorPoint leftPoint, MapConnectorPoint rightPoint, boolean inDataset, java.util.Set existingAliasSet, boolean optimizeLeftInlineViews, boolean isCombinedQuery)` Add a query to be joined to this query.
`java.util.List`	`getAliasList()` Get the list of aliases of the select items of this query.
`java.util.List`	`getChildren()` Get the list of child objects owned by this substitution API object.
`java.lang.String`	`getColumnAliasSeparator()` Gets the separator between column expression and alias, based on the source technology of this query.
`java.lang.String`	`getConstantFromClauseText()` Get the FROM clause text for a query with only constant select item expressions, and no real source.
`java.lang.String`	`getConstantFromClauseText(boolean includeFromKeyword)` Get the FROM clause text for a query with only constant select item expressions, and no real source.
`IColumn`	`getExpressionColumn(Expression expr)` Get the source column referenced by the expression of an select item.
`java.util.List`	`getExpressions()` Get a list of expressions owned by this substitution API object.
`java.util.List`	`getFromList()` Get the From clause list of the query.
`java.util.List`	`getGroupByList()` Get the GROUP BY expressions of this query.
`java.util.List`	`getHavingList()` Get the HAVING expressions of this query.
`SqlQuery`	`getInputQuery(int index)` Get the input queries that are used in a set query (e.g.
`int`	`getInputQueryCount()`
`MapPhysicalNode`	`getJournalizedSource()` Get the journalized source node for this query.
`java.util.List`	`getLateralViewList()` Gets the flattened complex columns that would result in a Hive lateral view, basically only those complex columns that comprise a collection.
`java.util.List`	`getNonOrderedComponents()` Get the list of components participating in the non-ANSI join of this query.
`java.util.List`	`getOrderByList()` Get the ORDER BY expressions of this query.
`IMapComponent`	`getQuerySourceComponent()` Get the source mapping component that acts as the main source for this query.
`java.util.List`	`getSelectHints()` Get the select hints associated with this query.
`java.util.List`	`getSelectList()` Get the list of select items of this query.
`SqlQuery`	`getSetOperand()` Gets the query that is linked with this query through a set operation.
`java.lang.String`	`getSetOperation()` Gets the set operation linking this query with another query.
`java.util.List`	`getSourceColumns()` Get the source columns referenced by the select items of this query.
`ILocation`	`getSourceLocation()` Get source location information for this AST, if any is defined, else return null.
`TableReference`	`getSourceTable(java.lang.String baseName)` Get the source table of this query
`java.util.Collection`	`getSourceTables()` Get all source tables involved in this query.
`java.util.List`	`getSourceTables(boolean includeSubqueries)` Get all source tables, including those referenced in subqueries.
`java.util.List`	`getSubqueries()`
`java.util.Map`	`getTemplateSubstitutionMap()` Get a hash map containing built-in template substitution variable names as the hash key, and the substitution variable value as values.
`java.lang.String`	`getText()` Get the expanded text of this query object which represents a SELECT statement.
`java.lang.String`	`getType()` Get a class type string for this substitution API object.
`java.util.List`	`getWhereList()` Get the where clause of the query.
`boolean`	`hasAggregation()` Returns true if this query has aggregation, otherwise false.
`boolean`	`hasFilterWithAggregation()`
`boolean`	`hasJournalizedSource()`
`boolean`	`hasNonOrderedJoin()` Check if this query is participating in an non-ANSI join.
`boolean`	`hasSourceReference()` Checks whether the select items of this query references a source object
`boolean`	`hasWindowFunction()` Returns true if this query has a window or analytical function, otherwise false.
`boolean`	`hasWindowFunction(ITechnology techno)` Returns true if this query has a window or analytical function, otherwise false.
`boolean`	`isANSI()`
`boolean`	`isConstantQuery()` Return true if the query has no real source, but is projecting a set of constants in the select list.
`boolean`	`isDistinct()` Check if the query has a distinct clause.
`boolean`	`isPassive()`
`boolean`	`isPivot()` Check if the query is created from a pivot component.
`boolean`	`isScalarTableFunctionWithAggregate()` Check if the query is created from a scalar table function component with aggregate as input.
`boolean`	`isStagingQuery()`
`boolean`	`isSubquery()`
`java.lang.String`	`toString()` Return a string representation of this query.

Methods inherited from class oracle.odi.mapping.generation.QueryClause
getParentQuery

Methods inherited from class oracle.odi.mapping.generation.AbstractSyntaxTree
getCodeGenerationTemplate, getCodeGenerationTemplateName, getCustomTemplate, getKMName, getLeafLevelChildren, getMapPhysicalNode, getOrder, getParentAST, getParentOfType, getPropertyValue, getSourceLanguage, getSourceTechnology, getSourceText, getTargetLanguage, getTargetLocation, getTargetTechnology, getTargetText, hasCustomTemplate, hasSourceAndTargetText, isLeafLevelNode, isPushFromSource

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.mapping.generation.ITableFunctionParameter
getParentAST

- Method Detail
  - getSelectList
```
public java.util.List getSelectList()
```
    Get the list of select items of this query.
    
    Returns:
    
    The list of select items.
  - getAliasList
```
public java.util.List getAliasList()
```
    Get the list of aliases of the select items of this query.
    
    Returns:
    
    The list of aliases.
  - isPassive
```
public boolean isPassive()
```
    Returns:
    
    True if this query represents a passive query, which means that the source columns are all simple constants and there is only one row. A passive query can be combined with another query by simply combining the select list, with no join.
  - isDistinct
```
public boolean isDistinct()
```
    Check if the query has a distinct clause.
    
    Returns:
    
    True if distinct, false otherwise.
  - isPivot
```
public boolean isPivot()
```
    Check if the query is created from a pivot component.
    
    Returns:
    
    True if pivot, false otherwise.
  - isScalarTableFunctionWithAggregate
```
public boolean isScalarTableFunctionWithAggregate()
```
    Check if the query is created from a scalar table function component with aggregate as input.
    
    Returns:
    
    True if scalar table function with aggregate as input, false otherwise.
  - getFromList
```
public java.util.List getFromList()
                           throws GenerationException
```
    Get the From clause list of the query.
    
    Returns:
    
    The From clause list.
    
    Throws:
    
    GenerationException
  - getWhereList
```
public java.util.List getWhereList()
```
    Get the where clause of the query.
    
    Returns:
    
    The where clause.
  - getText
```
public java.lang.String getText()
                         throws GenerationException
```
    Get the expanded text of this query object which represents a SELECT statement.
    
    Specified by:
    
    getText in interface ITableFunctionParameter
    
    Overrides:
    
    getText in class AbstractSyntaxTree
    
    Returns:
    
    The select statement.
    
    Throws:
    
    GenerationException
  - getTemplateSubstitutionMap
```
public java.util.Map getTemplateSubstitutionMap()
```
    Description copied from class: AbstractSyntaxTree
    
    Get a hash map containing built-in template substitution variable names as the hash key, and the substitution variable value as values.
    
    Specified by:
    
    getTemplateSubstitutionMap in class AbstractSyntaxTree
    
    Returns:
    
    The built-in template substitution hash map.
  - getChildren
```
public java.util.List getChildren()
```
    Description copied from class: AbstractSyntaxTree
    
    Get the list of child objects owned by this substitution API object.
    
    Specified by:
    
    getChildren in interface ITableFunctionParameter
    
    Specified by:
    
    getChildren in class AbstractSyntaxTree
    
    Returns:
    
    The list of child objects.
  - getType
```
public java.lang.String getType()
```
    Description copied from class: AbstractSyntaxTree
    
    Get a class type string for this substitution API object.
    
    Specified by:
    
    getType in class AbstractSyntaxTree
    
    Returns:
    
    A simple class type name for this object.
  - isANSI
```
public boolean isANSI()
```
    Returns:
    
    True if the query produced by this object is ANSI-compatible.
  - getGroupByList
```
public java.util.List getGroupByList()
```
    Get the GROUP BY expressions of this query.
    
    Returns:
    
    The group by expressions.
  - getHavingList
```
public java.util.List getHavingList()
```
    Get the HAVING expressions of this query.
    
    Returns:
    
    The having expressions.
  - getOrderByList
```
public java.util.List getOrderByList()
```
    Get the ORDER BY expressions of this query.
    
    Returns:
    
    The order by expressions.
  - addJoin
```
public SqlQuery addJoin(MapPhysicalNode physicalNode,
                        JoinTable.JoinType joinType,
                        SqlQuery joinQuery,
                        ArrayExpression[] joinConditionHolder,
                        boolean addJoinCondition,
                        boolean orderedJoin,
                        SqlQuery.SelectMapContainer selectMapContainer,
                        IMapComponent leftComponent,
                        IMapComponent rightComponent,
                        MapConnectorPoint leftPoint,
                        MapConnectorPoint rightPoint,
                        boolean inDataset,
                        java.util.Set existingAliasSet,
                        boolean optimizeLeftInlineViews,
                        boolean isCombinedQuery)
                 throws GenerationException
```
    Add a query to be joined to this query. A new query will be created representing the two joined queries. Inline view will be created for either of the queries under the following conditions: 1. ANSI join joined to non-ANSI join. 2. Query has aggregate function. 3. Query has correlated subquery.
    
    Parameters:
    
    physicalNode - the physical node of join.
    
    joinType - The join type of this join to be added. Can be one of the following: INNER, LEFT OUTER, RIGHT OUTER, FULl OUTER, NATURAL, CROSS.
    
    joinQuery - The query to be joined with this query.
    
    joinCondition - The join condition expression for this join.
    
    orderedJoin - The indicator whether this is an ANSI join.
    
    selectMapContainer - The select map hash table. The hash key is a select item, and the value is a list of redirected select items inside subqueries.
    
    leftComponent - The component that contributes to the left side of the join.
    
    rightComponent - The component that contributes to the right side of the join.
    
    leftPoint - The connector point that contributes to the left side of the join.
    
    rightPoint - The connector point that contributes to the right side of the join.
    
    inDataset - Indicate if this is a join within a dataset.
    
    existingAliasSet - set of existing aliases used in the query
    
    optimizeLeftInlineViews - specifies whether inline views created for the left side, or source, should be pruned to include only those attributes used downstream. This value should be true except for nth row lookup operations where all attributes from the source should be included in the select list.
    
    isCombinedQuery - indicate whether this sqlquery is a combined query. Suppose we have a join with 3 inputs. The first call to addJoin() would process INPUT1 and INPUT2, and create a combined query INPUT12. The next call will process INPUT12 and INPUT3. Here INPUT12 is a combined query.
    
    Returns:
    
    The new query.
    
    Throws:
    
    GenerationException
  - getSourceColumns
```
public java.util.List getSourceColumns()
                                throws AdapterException
```
    Get the source columns referenced by the select items of this query.
    
    Returns:
    
    The list of source columns.
    
    Throws:
    
    AdapterException
  - getExpressionColumn
```
public IColumn getExpressionColumn(Expression expr)
                            throws AdapterException
```
    Get the source column referenced by the expression of an select item.
    
    Returns:
    
    The source column.
    
    Throws:
    
    AdapterException
  - getSourceLocation
```
public ILocation getSourceLocation()
                            throws GenerationException
```
    Description copied from class: AbstractSyntaxTree
    
    Get source location information for this AST, if any is defined, else return null.
    
    Overrides:
    
    getSourceLocation in class AbstractSyntaxTree
    
    Throws:
    
    GenerationException
  - getExpressions
```
public java.util.List getExpressions()
```
    Description copied from class: AbstractSyntaxTree
    
    Get a list of expressions owned by this substitution API object.
    
    Specified by:
    
    getExpressions in class QueryClause
    
    Returns:
    
    The list of expressions.
  - getInputQuery
```
public SqlQuery getInputQuery(int index)
                       throws GenerationException
```
    Get the input queries that are used in a set query (e.g. UNION). Can be overridden by set query to provide multiple datasets.
    
    Parameters:
    
    index - The index of the query.
    
    Returns:
    
    This query.
    
    Throws:
    
    GenerationException
  - getInputQueryCount
```
public int getInputQueryCount()
```
    Returns:
    
    The number of input queries used to form the set query.
  - getSetOperation
```
public java.lang.String getSetOperation()
```
    Gets the set operation linking this query with another query.
    
    Returns:
    
    The set operation linking this query with another query.
  - getSetOperand
```
public SqlQuery getSetOperand()
```
    Gets the query that is linked with this query through a set operation.
    
    Returns:
    
    The query that is linked with this query through a set operation.
  - getSourceTable
```
public TableReference getSourceTable(java.lang.String baseName)
```
    Get the source table of this query
    
    Parameters:
    
    baseName - The base table name of the source table.
    
    Returns:
    
    The source table.
  - getSourceTables
```
public java.util.Collection getSourceTables()
```
    Get all source tables involved in this query.
    
    Returns:
    
    List of source tables.
  - toString
```
public java.lang.String toString()
```
    Return a string representation of this query. The returned string may look like an executable query, but is not guaranteed to be correct and executable.
    
    Overrides:
    
    toString in class java.lang.Object
  - getJournalizedSource
```
public MapPhysicalNode getJournalizedSource()
```
    Get the journalized source node for this query.
    
    Returns:
    
    The journalized source node.
  - hasJournalizedSource
```
public boolean hasJournalizedSource()
```
    Returns:
    
    True if this query contains a journalized source.
  - hasFilterWithAggregation
```
public boolean hasFilterWithAggregation()
```
    Returns:
    
    true if this query has a filter that contains an aggregation function in the filter condition.
  - hasAggregation
```
public boolean hasAggregation()
```
    Returns true if this query has aggregation, otherwise false. Aggregation is defined as having an expression which contains an aggregate function such as SUM, MIN, AVG. Downstream KMs may create an inline view for a query if it contains aggregation, since aggregate queries require a group-by clause and must be self contained.
    
    Returns:
    
    True if aggregation exists, false otherwise.
  - hasWindowFunction
```
public boolean hasWindowFunction(ITechnology techno)
```
    Returns true if this query has a window or analytical function, otherwise false. An analytical function reference is similar to an aggregation function except that the OVER keyward is used to describe the partitioning and grouping.
    
    Parameters:
    
    techno - technology used to get list of aggregation functions to check against.
    
    Returns:
    
    True if a reference to a window or analytical function exists, false otherwise.
  - getLateralViewList
```
public java.util.List getLateralViewList()
```
    Gets the flattened complex columns that would result in a Hive lateral view, basically only those complex columns that comprise a collection.
  - hasWindowFunction
```
public boolean hasWindowFunction()
                          throws GenerationException
```
    Returns true if this query has a window or analytical function, otherwise false. An analytical function reference is similar to an aggregation function except that the OVER keyword is used to describe the partitioning and grouping.
    
    Parameters:
    
    techno - technology used to get list of aggregation functions to check against.
    
    Returns:
    
    True if a reference to a window or analytical function exists, false otherwise.
    
    Throws:
    
    GenerationException
  - getSelectHints
```
public java.util.List getSelectHints()
```
    Get the select hints associated with this query.
    
    Returns:
    
    The list of select hint expressions.
  - hasNonOrderedJoin
```
public boolean hasNonOrderedJoin()
```
    Check if this query is participating in an non-ANSI join.
    
    Returns:
    
    True if non-ANSI, false otherwise.
  - getNonOrderedComponents
```
public java.util.List getNonOrderedComponents()
```
    Get the list of components participating in the non-ANSI join of this query.
    
    Returns:
    
    List of components.
  - isConstantQuery
```
public boolean isConstantQuery()
                        throws GenerationException
```
    Return true if the query has no real source, but is projecting a set of constants in the select list.
    
    Throws:
    
    GenerationException
  - getConstantFromClauseText
```
public java.lang.String getConstantFromClauseText()
                                           throws GenerationException
```
    Get the FROM clause text for a query with only constant select item expressions, and no real source.
    
    Returns:
    
    The FROM clause text.
    
    Throws:
    
    GenerationException
  - getConstantFromClauseText
```
public java.lang.String getConstantFromClauseText(boolean includeFromKeyword)
                                           throws GenerationException
```
    Get the FROM clause text for a query with only constant select item expressions, and no real source.
    
    Parameters:
    
    includeFromKeyword - If true, include the "FROM" keyword in the text, else just include the FROM table name.
    
    Returns:
    
    The FROM clause text.
    
    Throws:
    
    GenerationException
  - isStagingQuery
```
public boolean isStagingQuery()
```
    Returns:
    
    true if this query is a staging query. A staging query is a special query that is used to load a staging table for an LKM.
  - getQuerySourceComponent
```
public IMapComponent getQuerySourceComponent()
```
    Get the source mapping component that acts as the main source for this query.
    
    Returns:
    
    The source mapping component.
  - hasSourceReference
```
public boolean hasSourceReference()
```
    Checks whether the select items of this query references a source object
    
    Returns:
    
    True if query references a source; false otherwise
  - getColumnAliasSeparator
```
public java.lang.String getColumnAliasSeparator()
```
    Gets the separator between column expression and alias, based on the source technology of this query.
    
    Returns:
    
    the separator between column expression and alias
  - getSubqueries
```
public java.util.List getSubqueries()
                             throws GenerationException
```
    Throws:
    
    GenerationException
  - getSourceTables
```
public java.util.List getSourceTables(boolean includeSubqueries)
                               throws GenerationException
```
    Get all source tables, including those referenced in subqueries.
    
    Parameters:
    
    includeSubqueries - If true, include source tables referenced through subqueries.
    
    Returns:
    
    Throws:
    
    GenerationException
  - isSubquery
```
public boolean isSubquery()
```
    Returns:
    
    True if this query is acting as a subquery for a parent query.

Class SqlQuery

Nested Class Summary

Nested classes/interfaces inherited from class oracle.odi.mapping.generation.AbstractSyntaxTree

Method Summary

Methods inherited from class oracle.odi.mapping.generation.QueryClause

Methods inherited from class oracle.odi.mapping.generation.AbstractSyntaxTree

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.odi.mapping.generation.ITableFunctionParameter

Method Detail

getSelectList

getAliasList

isPassive

isDistinct

isPivot

isScalarTableFunctionWithAggregate

getFromList

getWhereList

getText

getTemplateSubstitutionMap

getChildren

getType

isANSI

getGroupByList

getHavingList

getOrderByList

addJoin

getSourceColumns

getExpressionColumn

getSourceLocation

getExpressions

getInputQuery

getInputQueryCount

getSetOperation

getSetOperand

getSourceTable

getSourceTables

toString

getJournalizedSource

hasJournalizedSource

hasFilterWithAggregation

hasAggregation

hasWindowFunction

getLateralViewList

hasWindowFunction

getSelectHints

hasNonOrderedJoin

getNonOrderedComponents

isConstantQuery

getConstantFromClauseText

getConstantFromClauseText

isStagingQuery

getQuerySourceComponent

hasSourceReference

getColumnAliasSeparator

getSubqueries

getSourceTables

isSubquery