oracle.olapi.syntax
Class FromClauseElement

java.lang.Object
  oracle.olapi.syntax.SyntaxObject
      oracle.olapi.syntax.DataObject
          oracle.olapi.syntax.FromClauseElement

public final class FromClauseElement
extends DataObject

A DataObject that contains a Query and is an element of a FromClause. You use the getQuery method of an MdmTable to get the Query for a FromClauseElement.

Constructor Summary

FromClauseElement(Query query)
Creates a FromClauseElement that has the specified Query.

FromClauseElement(Query query, java.lang.String alias)
Creates a FromClauseElement that has the specified Query and alias.

FromClauseElement(Query query, java.lang.String alias, boolean hasAS)
Creates a FromClauseElement that has the specified Query and alias and that specifies whether or not to insert the string AS between the syntax of the Query and the alias.

Method Summary

java.lang.String	getAlias() Gets the alias for the Query of the FromClauseElement.
boolean	getHasAS() Indicates whether or not this FromClauseElement includes an AS between the Query syntax and the alias.
Query	getQuery() Gets the Query of the FromClauseElement.
java.lang.Object	visit(SyntaxObjectVisitor visitor, java.lang.Object context) Calls the visitFromClauseElement method of the SyntaxObjectVisitor and passes that method this FromClauseElement and an Object.

Methods inherited from class oracle.olapi.syntax.SyntaxObject

equals, equals, fromSyntax, fromSyntax, fromSyntax, fromSyntax, fromSyntax, isValid, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FromClauseElement

public FromClauseElement(Query query,
                         java.lang.String alias,
                         boolean hasAS)

Creates a FromClauseElement that has the specified Query and alias and that specifies whether or not to insert the string AS between the syntax of the Query and the alias.

Parameters:

query - A Query for the element.

alias - An String that contains an optional alias for the Query.

hasAS - A boolean that is true to include an AS between the Query syntax and the alias or false to not include it.

FromClauseElement

public FromClauseElement(Query query,
                         java.lang.String alias)

Creates a FromClauseElement that has the specified Query and alias.

Parameters:

query - A Query for the element.

alias - An String that contains an optional alias for the Query.

FromClauseElement

public FromClauseElement(Query query)

Creates a FromClauseElement that has the specified Query.

Parameters:

query - A Query for the element.

Method Detail

getAlias

public java.lang.String getAlias()

Gets the alias for the Query of the FromClauseElement.

Returns:

A String that contains the alias for the Query of the FromClauseElement.

getQuery

public Query getQuery()

Gets the Query of the FromClauseElement.

Returns:

The Query of the FromClauseElement.

getHasAS

public boolean getHasAS()

Indicates whether or not this FromClauseElement includes an AS between the Query syntax and the alias.

Returns:

A boolean that is true if this FromClauseElement includes an AS between the Query syntax and the alias or false if it does not.

visit

public java.lang.Object visit(SyntaxObjectVisitor visitor,
                              java.lang.Object context)

Calls the visitFromClauseElement method of the SyntaxObjectVisitor and passes that method this FromClauseElement and an Object.

Specified by:

visit in class SyntaxObject

Parameters:

visitor - A SyntaxObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitFromClause method.