Package adql.query
Class SelectItem
java.lang.Object
adql.query.SelectItem
- All Implemented Interfaces:
ADQLObject
- Direct Known Subclasses:
SelectAllColumns
Represents an item of a SELECT clause.
It merely encapsulates an operand and allows to associate to it an alias (according to the following syntax: "SELECT operand AS alias").
- Version:
- 1.4 (03/2016)
- Author:
- Grégory Mantelet (CDS;ARI)
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionSelectItem
(ADQLOperand operand) Builds a SELECT item just with an operand.SelectItem
(ADQLOperand operand, String alias) Builds a SELECT item with an operand and its alias.SelectItem
(SelectItem toCopy) Builds a SELECT item by copying the given one. -
Method Summary
Modifier and TypeMethodDescriptionGets an iterator on the intern ADQL objects.final String
getAlias()
Gets the alias of the corresponding operand.getCopy()
Gets a (deep) copy of this ADQL object.getName()
Gets the name of this object in ADQL.final ADQLOperand
Gets the corresponding operand.final TextPosition
Gets the position of this object/token in the ADQL query.final boolean
hasAlias()
Indicates whether the corresponding operand has an alias.final boolean
Tells whether the alias is case sensitive.final void
Changes the alias of the corresponding operand.final void
setCaseSensitive
(boolean sensitive) Sets the case sensitivity on the alias.final void
setPosition
(TextPosition position) Set the position of thisSelectItem
in the given ADQL query string.toADQL()
Gets the ADQL expression of this object.
-
Constructor Details
-
SelectItem
Builds a SELECT item just with an operand.- Parameters:
operand
- Corresponding operand.
-
SelectItem
Builds a SELECT item with an operand and its alias.- Parameters:
operand
- Corresponding operand.alias
- Operand alias.
-
SelectItem
Builds a SELECT item by copying the given one.- Parameters:
toCopy
- The SELECT item to copy.- Throws:
Exception
- If there is an error during the copy.
-
-
Method Details
-
getOperand
Gets the corresponding operand.- Returns:
- The corresponding operand.
-
hasAlias
public final boolean hasAlias()Indicates whether the corresponding operand has an alias.- Returns:
- true if there is an alias, false otherwise.
-
getAlias
Gets the alias of the corresponding operand.- Returns:
- Alias of the operand.
-
setAlias
Changes the alias of the corresponding operand.- Parameters:
newAlias
- The new alias of the operand.
-
isCaseSensitive
public final boolean isCaseSensitive()Tells whether the alias is case sensitive.- Returns:
- true if the alias is case sensitive, false otherwise.
-
setCaseSensitive
public final void setCaseSensitive(boolean sensitive) Sets the case sensitivity on the alias.- Parameters:
sensitive
- true to make case sensitive the alias, false otherwise.
-
getPosition
Description copied from interface:ADQLObject
Gets the position of this object/token in the ADQL query.
By default, no position should be set.
- Specified by:
getPosition
in interfaceADQLObject
- Returns:
- Position of this ADQL item in the ADQL query, or NULL if not written originally in the query (for example, if added afterwards.
-
setPosition
Set the position of thisSelectItem
in the given ADQL query string.- Parameters:
position
- New position of thisSelectItem
.- Since:
- 1.4
-
getCopy
Description copied from interface:ADQLObject
Gets a (deep) copy of this ADQL object.- Specified by:
getCopy
in interfaceADQLObject
- Returns:
- The copy of this ADQL object.
- Throws:
Exception
- If there is any error during the copy.
-
getName
Description copied from interface:ADQLObject
Gets the name of this object in ADQL.- Specified by:
getName
in interfaceADQLObject
- Returns:
- The name of this ADQL object.
-
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 interfaceADQLObject
- Returns:
- An ADQL objects iterator.
- See Also:
-
toADQL
Description copied from interface:ADQLObject
Gets the ADQL expression of this object.- Specified by:
toADQL
in interfaceADQLObject
- Returns:
- The corresponding ADQL expression.
-