Package adql.query.constraint
Class Between
java.lang.Object
adql.query.constraint.Between
- All Implemented Interfaces:
ADQLObject
,ADQLConstraint
It represents the BETWEEN predicate of SQL and ADQL.
This predicate returns true
if the value of the left operand is
between the value of the two other operands, else it returns
false
.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionBuilds a BETWEEN constraint by copying the given one.Between
(ADQLOperand operand, ADQLOperand min, ADQLOperand max) Builds a BETWEEN constraints.Between
(ADQLOperand operand, ADQLOperand min, ADQLOperand max, boolean notBetween) Builds a BETWEEN constraints. -
Method Summary
Modifier and TypeMethodDescriptionGets an iterator on the intern ADQL objects.getCopy()
Gets a (deep) copy of this ADQL object.final LanguageFeature
Get the description of this ADQL's Language Feature.final ADQLOperand
Gets the left operand of this BETWEEN constraint.final ADQLOperand
Gets the operand which represents the maximum value.final ADQLOperand
Gets the operand which represents the minimum value.getName()
Gets the name of this object in ADQL.final TextPosition
Gets the position of this object/token in the ADQL query.final boolean
Tells whether the predicate is BETWEEN or NOT BETWEEN.void
setLeftOperand
(ADQLOperand leftOperand) Replaces the left operand of this BETWEEN constraint.void
setMaxOperand
(ADQLOperand maxOperand) Replaces the operand which represents the maximum value.void
setMinOperand
(ADQLOperand minOperand) Replaces the operand which represents the minimum value.void
setNotBetween
(boolean notBetween) Lets indicating the predicate to use (BETWEEN or NOT BETWEEN).final void
setPosition
(TextPosition position) Set the position of thisBetween
in the given ADQL query string.toADQL()
Gets the ADQL expression of this object.
-
Field Details
-
FEATURE
Description of this ADQL Feature.- Since:
- 2.0
-
-
Constructor Details
-
Between
Builds a BETWEEN constraints.- Parameters:
operand
- The left operand (left part of the BETWEEN predicate).min
- The operand which represents the minimum value.max
- The operand which represents the maximum value.- Throws:
NullPointerException
- If one of the given parameters is NULL.
-
Between
public Between(ADQLOperand operand, ADQLOperand min, ADQLOperand max, boolean notBetween) throws NullPointerException Builds a BETWEEN constraints.- Parameters:
operand
- The left operand (left part of the BETWEEN predicate).min
- The operand which represents the minimum value.max
- The operand which represents the maximum value.notBetween
-true
if the predicate NOT BETWEEN must be used orfalse
for BETWEEN.- Throws:
NullPointerException
- If one of the given parameters is NULL.
-
Between
Builds a BETWEEN constraint by copying the given one.- Parameters:
toCopy
- The BETWEEN constraint to copy.- Throws:
Exception
- If there is an error during the copy.
-
-
Method Details
-
getFeatureDescription
Description copied from interface:ADQLObject
Get the description of this ADQL's Language Feature.Note: Getting this description is generally only useful when discovery optional features so that determining if they are allowed to be used in ADQL queries.
- Specified by:
getFeatureDescription
in interfaceADQLObject
- Returns:
- Description of this ADQL object as an ADQL's feature.
-
getLeftOperand
Gets the left operand of this BETWEEN constraint.- Returns:
- Its left operand.
-
setLeftOperand
Replaces the left operand of this BETWEEN constraint.- Parameters:
leftOperand
- Its new left operand.- Throws:
NullPointerException
- If the given operand is NULL.
-
getMinOperand
Gets the operand which represents the minimum value.- Returns:
- Its minimum value.
-
setMinOperand
Replaces the operand which represents the minimum value.- Parameters:
minOperand
- Its new minimum value.- Throws:
NullPointerException
- If the given operand is NULL.
-
getMaxOperand
Gets the operand which represents the maximum value.- Returns:
- Its maximum value.
-
setMaxOperand
Replaces the operand which represents the maximum value.- Parameters:
maxOperand
- Its new maximum value.- Throws:
NullPointerException
- If the given operand is NULL.
-
isNotBetween
public final boolean isNotBetween()Tells whether the predicate is BETWEEN or NOT BETWEEN.- Returns:
true
for NOT BETWEEN,false
for BETWEEN.
-
setNotBetween
public void setNotBetween(boolean notBetween) Lets indicating the predicate to use (BETWEEN or NOT BETWEEN).- Parameters:
notBetween
-true
for NOT BETWEEN,false
for BETWEEN.
-
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 thisBetween
in the given ADQL query string.- Parameters:
position
- New position of thisBetween
.- 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.
-