org.teiid.connector.language
Interface IOrderByItem

All Superinterfaces:

ILanguageObject

public interface IOrderByItem
extends ILanguageObject

Represents a single item in the ORDER BY clause.

Field Summary

static boolean	ASC
static boolean	DESC

Method Summary

boolean	getDirection() Get direction of whether to sort ascending or descending.
IElement	getElement() Get the element referred to by this item
java.lang.String	getName() Get name of the output column to order by
void	setDirection(boolean direction) Set direction of whether to sort ascending or descending.
void	setElement(IElement element) Set the new element for this order by
void	setName(java.lang.String name) Set name of the output column to order by

Methods inherited from interface org.teiid.connector.language.ILanguageObject

acceptVisitor

Field Detail

ASC

static final boolean ASC

See Also:

Constant Field Values

DESC

static final boolean DESC

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Get name of the output column to order by

Returns:

Name of output column, as specified in ISelectSymbol.getOutputName().

getDirection

boolean getDirection()

Get direction of whether to sort ascending or descending.

Returns:

ASC for ascending or DESC for descending

setName

void setName(java.lang.String name)

Set name of the output column to order by

Parameters:

name - Name of output column, as specified in ISelectSymbol.getOutputName().

setDirection

void setDirection(boolean direction)

Set direction of whether to sort ascending or descending.

Parameters:

direction - ASC for ascending or DESC for descending

getElement

IElement getElement()

Get the element referred to by this item

Returns:

The element, may be null

setElement

void setElement(IElement element)

Set the new element for this order by

Parameters:

element - New element