Package uk.ac.starlink.vo
Class AdqlValidator
java.lang.Object
uk.ac.starlink.vo.AdqlValidator
Handles validation of ADQL queries.
In the current implementation the heavy lifting is done by
Gregory Mantelet's ADQL parser.
- Since:
- 3 Oct 2011
- Author:
- Mark Taylor
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
Defines table metadata for tables known to the validator. -
Constructor Summary
ConstructorsConstructorDescriptionAdqlValidator
(AdqlValidator.ValidatorTable[] vtables, adql.db.FunctionDef[] udfs, String[] geoFuncs) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionstatic AdqlValidator
createValidator
(AdqlValidator.ValidatorTable[] vtables, TapLanguage lang) Creates an instance given a set of table metadata and a TapLanguage description object.Attempts to fix common errors in a submitted query.static void
Tests parser.void
Validates an ADQL string.
-
Constructor Details
-
AdqlValidator
public AdqlValidator(AdqlValidator.ValidatorTable[] vtables, adql.db.FunctionDef[] udfs, String[] geoFuncs) Constructor. Note empty arrays restrict possibilities (to none), but null values allow anything.- Parameters:
vtables
- table metadata for database to be checked againstudfs
- array of permitted user-defined-functions, or null to permit all (but ignored if vtables is null)geoFuncs
- array of permitted ADQL geometry function names, or null to permit all those defined by ADQL (sec 2.4) (but ignored if vtables is null)
-
-
Method Details
-
validate
Validates an ADQL string. Any throwable returned hopefully includes useful information about the location and nature of the parse error, but that depends on the implementation.- Parameters:
query
- ADQL query string- Throws:
Throwable
- if the string is not valid ADQL
-
fixup
Attempts to fix common errors in a submitted query. If some changes can be made that would make the query more correct, the fixed query is returned. If no such changes can be made for whatever reason, null is returned.- Parameters:
query
- input ADQL- Returns:
- EITHER ADQL which resembles, but is not identical to, the input but which has a better chance of being correct; OR null
-
createValidator
public static AdqlValidator createValidator(AdqlValidator.ValidatorTable[] vtables, TapLanguage lang) Creates an instance given a set of table metadata and a TapLanguage description object. The language object's TapLanguageFeature map is examined to determine what UDFs and ADQL geometry functions are supported. In the case of no description of UDFs and geom functions, no restrictions are imposed.- Parameters:
vtables
- table metadatalang
- language specifics
-
main
Tests parser. Use-h
for usage.- Throws:
Throwable
IOException
SAXException
-