Package adql.query.constraint
Class Exists
- java.lang.Object
-
- adql.query.constraint.Exists
-
- All Implemented Interfaces:
ADQLObject,ADQLConstraint
public class Exists extends java.lang.Object implements ADQLConstraint
Represents the predicate EXISTS of SQL and ADQL.
This function returns true if the sub-query given in parameter returns at least one result, else it returns false.
- Version:
- 1.4 (06/2015)
- Author:
- Grégory Mantelet (CDS;ARI)
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ADQLIteratoradqlIterator()Gets an iterator on the intern ADQL objects.ADQLObjectgetCopy()Gets a (deep) copy of this ADQL object.java.lang.StringgetName()Gets the name of this object in ADQL.TextPositiongetPosition()Gets the position of this object/token in the ADQL query.ADQLQuerygetSubQuery()Gets the sub-query of this EXISTS constraint.voidsetPosition(TextPosition position)Set the position of thisExistsin the given ADQL query string.voidsetSubQuery(ADQLQuery query)Replaces the sub-query of this EXISTS constraint by the given one.java.lang.StringtoADQL()Gets the ADQL expression of this object.
-
-
-
Constructor Detail
-
Exists
public Exists(ADQLQuery query)
Builds an Exists constraint instance.- Parameters:
query- Its sub-query.
-
Exists
public Exists(Exists toCopy) throws java.lang.Exception
Builds an Exists constraint by copying the given one.- Parameters:
toCopy- The Exists constraint to copy.- Throws:
java.lang.Exception- If there is an error during the copy.
-
-
Method Detail
-
getSubQuery
public final ADQLQuery getSubQuery()
Gets the sub-query of this EXISTS constraint.- Returns:
- Its sub-query.
-
setSubQuery
public void setSubQuery(ADQLQuery query) throws java.lang.NullPointerException
Replaces the sub-query of this EXISTS constraint by the given one.- Parameters:
query- Its new sub-query.- Throws:
java.lang.NullPointerException- If the given query is null.
-
getPosition
public final TextPosition getPosition()
Description copied from interface:ADQLObjectGets the position of this object/token in the ADQL query.
By default, no position should be set.
- Specified by:
getPositionin 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
public final void setPosition(TextPosition position)
Set the position of thisExistsin the given ADQL query string.- Parameters:
position- New position of thisExists.- Since:
- 1.4
-
getCopy
public ADQLObject getCopy() throws java.lang.Exception
Description copied from interface:ADQLObjectGets a (deep) copy of this ADQL object.- Specified by:
getCopyin interfaceADQLObject- Returns:
- The copy of this ADQL object.
- Throws:
java.lang.Exception- If there is any error during the copy.
-
getName
public java.lang.String getName()
Description copied from interface:ADQLObjectGets the name of this object in ADQL.- Specified by:
getNamein interfaceADQLObject- Returns:
- The name of this ADQL object.
-
adqlIterator
public ADQLIterator adqlIterator()
Description copied from interface:ADQLObjectGets an iterator on the intern ADQL objects.
Note:The returned iterator is particularly used by a
ISearchHandlerextension to browse a whole ADQL tree.- Specified by:
adqlIteratorin interfaceADQLObject- Returns:
- An ADQL objects iterator.
- See Also:
ADQLIterator,ISearchHandler
-
toADQL
public java.lang.String toADQL()
Description copied from interface:ADQLObjectGets the ADQL expression of this object.- Specified by:
toADQLin interfaceADQLObject- Returns:
- The corresponding ADQL expression.
-
-