adql.query

Class SelectAllColumns

java.lang.Object

adql.query.SelectItem

adql.query.SelectAllColumns

All Implemented Interfaces:

ADQLObject

public final class SelectAllColumns
extends SelectItem

In ADQL it corresponds to the '*' and '{tableName}.*' items in the SELECT clause. It means: 'select all columns'.

Version:

1.4 (06/2015)

Author:

Grégory Mantelet (CDS;ARI)

Constructor Summary

Constructors

Constructor and Description
SelectAllColumns(ADQLQuery query) Builds a SelectItem which selects all columns available in the given ADQL query.
SelectAllColumns(ADQLTable table) Builds a SelectItem which selects all columns available in the given table.
SelectAllColumns(SelectAllColumns toCopy) Builds a SelectAllColumns by copying the given one.

Method Summary

Modifier and Type	Method and Description
ADQLIterator	adqlIterator() Gets an iterator on the intern ADQL objects.
ADQLTable	getAdqlTable() Gets the table whose all columns must be selected.
ADQLObject	getCopy() Gets a (deep) copy of this ADQL object.
java.lang.String	getName() Gets the name of this object in ADQL.
ADQLQuery	getQuery() Gets the query whose all available columns must be selected.
void	setAdqlTable(ADQLTable table) Sets the table whose all columns must be selected.
void	setQuery(ADQLQuery query) Sets the query whose all available columns must be selected.
java.lang.String	toADQL() Gets the ADQL expression of this object.

Methods inherited from class adql.query.SelectItem

getAlias, getOperand, getPosition, hasAlias, isCaseSensitive, setAlias, setCaseSensitive, setPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectAllColumns

public SelectAllColumns(ADQLQuery query)

Builds a SelectItem which selects all columns available in the given ADQL query.

Parameters:

query - The query whose all available columns must be selected.

SelectAllColumns

public SelectAllColumns(ADQLTable table)

Builds a SelectItem which selects all columns available in the given table.

Parameters:

table - The table whose all available columns must be selected.

SelectAllColumns

public SelectAllColumns(SelectAllColumns toCopy)
                 throws java.lang.Exception

Builds a SelectAllColumns by copying the given one.

Parameters:

toCopy - The SelectAllColumns to copy.

Throws:

java.lang.Exception - If there is an error during the copy.

Method Detail

getQuery

public final ADQLQuery getQuery()

Gets the query whose all available columns must be selected.

Returns:

The ADQL query whose all available columns must be selected, or null if the selection does not concern an ADQLQuery but an ADQLTable.

setQuery

public final void setQuery(ADQLQuery query)

Sets the query whose all available columns must be selected.

Parameters:

query - An ADQLQuery (MUST NOT BE NULL).

getAdqlTable

public final ADQLTable getAdqlTable()

Gets the table whose all columns must be selected.

Returns:

The ADQL table whose all columns must be selected, or null if the selection does not concern an ADQLTable but an ADQLQuery.

setAdqlTable

public final void setAdqlTable(ADQLTable table)

Sets the table whose all columns must be selected.

Parameters:

table - An ADQLTable (MUST NOT BE NULL).

getCopy

public final ADQLObject getCopy()
                         throws java.lang.Exception

Description copied from interface: ADQLObject

Gets a (deep) copy of this ADQL object.

Specified by:

getCopy in interface ADQLObject

Overrides:

getCopy in class SelectItem

Returns:

The copy of this ADQL object.

Throws:

java.lang.Exception - If there is any error during the copy.

getName

public final java.lang.String getName()

Description copied from interface: ADQLObject

Gets the name of this object in ADQL.

Specified by:

getName in interface ADQLObject

Overrides:

getName in class SelectItem

Returns:

The name of this ADQL object.

adqlIterator

public final ADQLIterator adqlIterator()

Description copied from interface: ADQLObject

Gets an iterator on the intern ADQL objects.

Note:The returned iterator is particularly used by a ISearchHandler extension to browse a whole ADQL tree.

Specified by:

adqlIterator in interface ADQLObject

Overrides:

adqlIterator in class SelectItem

Returns:

An ADQL objects iterator.

See Also:

ADQLIterator, ISearchHandler

toADQL

public final java.lang.String toADQL()

Description copied from interface: ADQLObject

Gets the ADQL expression of this object.

Specified by:

toADQL in interface ADQLObject

Overrides:

toADQL in class SelectItem

Returns:

The corresponding ADQL expression.