oracle.olapi.syntax
Class OrderByClause

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

public final class OrderByClause
extends DataObject

A DataObject that represents an ordering of the results of the evaluation of an Expression. An OrderByClause is similar to the ORDER BY clause of a SQL SELECT statement. The OrderByElement objects of an OrderByClause specify the order.

Constructor Summary

OrderByClause(java.util.List<OrderByElement> elements)

OrderByClause(OrderByElement[] elements)
Creates an OrderByClause with the specified OrderByElement objects.

Method Summary

OrderByElement[]	getElements() Gets the elements of this OrderByClause, which specify the ordering of the results.
boolean	isCompositeObject() Indicates whether this OrderByClause contains other SyntaxObject objects.
java.lang.Object	visit(SyntaxObjectVisitor visitor, java.lang.Object context) Calls the visitOrderByClause method of the SyntaxObjectVisitor and passes that method this OrderByClause 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

OrderByClause

public OrderByClause(OrderByElement[] elements)

Creates an OrderByClause with the specified OrderByElement objects.

Parameters:

elements - An array of OrderByElement objects that specify the ordering sequence.

OrderByClause

public OrderByClause(java.util.List<OrderByElement> elements)

Method Detail

visit

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

Calls the visitOrderByClause method of the SyntaxObjectVisitor and passes that method this OrderByClause and an Object.

Specified by:

visit in class SyntaxObject

Parameters:

visitor - A SyntaxObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitOrderByClause method.

getElements

public OrderByElement[] getElements()

Gets the elements of this OrderByClause, which specify the ordering of the results.

Returns:

An array of OrderByElement objects that specify the ordering sequence.

isCompositeObject

public boolean isCompositeObject()

Indicates whether this OrderByClause contains other SyntaxObject objects. Because an OrderByClause contains one or more OrderByElement objects, this method returns true.

Returns:

A boolean that is true.