From bfabd9bec67f2bca6fb3ebaf59cdbf441d541e6a Mon Sep 17 00:00:00 2001
From: gmantele <gmantele@ari.uni-heidelberg.de>
Date: Wed, 12 Oct 2016 15:05:36 +0200
Subject: [PATCH] [ADQL] Fix few Javadoc links.
---
src/adql/parser/ADQLQueryFactory.java | 6 +-
src/adql/query/from/SQLServer_InnerJoin.java | 20 ++--
src/adql/query/from/SQLServer_OuterJoin.java | 11 +-
src/adql/translator/SQLServerTranslator.java | 101 +++++++++----------
4 files changed, 66 insertions(+), 72 deletions(-)
diff --git a/src/adql/parser/ADQLQueryFactory.java b/src/adql/parser/ADQLQueryFactory.java
index b4fce00..c6b70b7 100644
--- a/src/adql/parser/ADQLQueryFactory.java
+++ b/src/adql/parser/ADQLQueryFactory.java
@@ -282,7 +282,7 @@ public class ADQLQueryFactory {
* <p><i><b>IMPORTANT:</b>
* The tests done to check whether a user defined function is allowed/managed in this implementation, is done later by the parser.
* Only declared UDF will pass the test of the parser. For that, you should give it a list of allowed UDFs (each UDF will be then
- * represented by a {@link FunctionDef} object).
+ * represented by a {@link FunctionDef} object).
* </i></p>
*
* @param name Name of the user defined function to create.
@@ -411,7 +411,7 @@ public class ADQLQueryFactory {
}
/**
- * @deprecated since 1.4 ; Former version's mistake: an ORDER BY item is either a regular/delimited column name or an integer, not a qualified column name ; Replaced by {@link #createOrder(IdentifierItem, boolean)} ; This function is no longer used by ADQLParser.
+ * @deprecated since 1.4 ; Former version's mistake: an ORDER BY item is either a regular/delimited column name or an integer, not a qualified column name ; Replaced by {@link #createOrder(adql.parser.IdentifierItems.IdentifierItem, boolean)} ; This function is no longer used by ADQLParser.
*/
@Deprecated
public ADQLOrder createOrder(final IdentifierItems idItems, final boolean desc) throws Exception{
@@ -431,7 +431,7 @@ public class ADQLQueryFactory {
}
/**
- * @deprecated since 1.4 ; Former version's mistake: a GROUP BY item is either a regular/delimited column name or an integer, not a qualified column name ; Replaced by {@link #createColRef(IdentifierItem)} ; This function is no longer used by ADQLParser.
+ * @deprecated since 1.4 ; Former version's mistake: a GROUP BY item is either a regular/delimited column name or an integer, not a qualified column name ; Replaced by {@link #createColRef(adql.parser.IdentifierItems.IdentifierItem)} ; This function is no longer used by ADQLParser.
*/
@Deprecated
public ColumnReference createColRef(final IdentifierItems idItems) throws Exception{
diff --git a/src/adql/query/from/SQLServer_InnerJoin.java b/src/adql/query/from/SQLServer_InnerJoin.java
index 432e1ff..b3d5fee 100644
--- a/src/adql/query/from/SQLServer_InnerJoin.java
+++ b/src/adql/query/from/SQLServer_InnerJoin.java
@@ -71,7 +71,7 @@ public class SQLServer_InnerJoin extends InnerJoin {
*
* @see InnerJoin#InnerJoin(FromContent, FromContent)
*/
- public SQLServer_InnerJoin(FromContent left, FromContent right) {
+ public SQLServer_InnerJoin(FromContent left, FromContent right){
super(left, right);
}
@@ -84,20 +84,20 @@ public class SQLServer_InnerJoin extends InnerJoin {
*
* @see InnerJoin#InnerJoin(FromContent, FromContent, ClauseConstraints)
*/
- public SQLServer_InnerJoin(FromContent left, FromContent right, ClauseConstraints condition) {
+ public SQLServer_InnerJoin(FromContent left, FromContent right, ClauseConstraints condition){
super(left, right, condition);
}
/**
* Builds an INNER JOIN between the two given "tables" with the given condition.
*
- * @param left Left "table".
- * @param right Right "table".
- * @param condition Join condition.
+ * @param left Left "table".
+ * @param right Right "table".
+ * @param lstColumns List of columns to join.
*
* @see InnerJoin#InnerJoin(FromContent, FromContent, Collection)
*/
- public SQLServer_InnerJoin(FromContent left, FromContent right, Collection<ADQLColumn> lstColumns) {
+ public SQLServer_InnerJoin(FromContent left, FromContent right, Collection<ADQLColumn> lstColumns){
super(left, right, lstColumns);
}
@@ -110,18 +110,18 @@ public class SQLServer_InnerJoin extends InnerJoin {
*
* @see InnerJoin#InnerJoin(InnerJoin)
*/
- public SQLServer_InnerJoin(InnerJoin toCopy) throws Exception {
+ public SQLServer_InnerJoin(InnerJoin toCopy) throws Exception{
super(toCopy);
}
@Override
- public SearchColumnList getDBColumns() throws UnresolvedJoinException {
+ public SearchColumnList getDBColumns() throws UnresolvedJoinException{
return getDBColumns(this);
}
/**
* <p>Gets the list of all columns (~ database metadata) available in this FROM part.
- * Columns implied in a NATURAL join or in a USING list, are not returned as a {@link DBCommonColumn} ;
+ * Columns implied in a NATURAL join or in a USING list, are not returned as a {@link DBCommonColumn} ;
* actually, just the corresponding {@link DBColumn} of the left table is returned.</p>
*
* @return All the available {@link DBColumn}s.
@@ -195,7 +195,7 @@ public class SQLServer_InnerJoin extends InnerJoin {
throw uje;
}
}
-
+
public final static void addAllExcept2(final SearchColumnList itemsToAdd, final SearchColumnList target, final Map<String,DBColumn> exception){
for(DBColumn col : itemsToAdd){
if (!exception.containsKey(col.getADQLName().toLowerCase()) && !exception.containsKey("\"" + col.getADQLName() + "\""))
diff --git a/src/adql/query/from/SQLServer_OuterJoin.java b/src/adql/query/from/SQLServer_OuterJoin.java
index 8f24e49..01e7be2 100644
--- a/src/adql/query/from/SQLServer_OuterJoin.java
+++ b/src/adql/query/from/SQLServer_OuterJoin.java
@@ -47,8 +47,7 @@ import adql.query.operand.ADQLColumn;
* Since this special behavior is also valid for {@link InnerJoin}, a special implementation
* of this class has been also created: {@link SQLServer_InnerJoin}. Both must have exactly the
* same behavior when {@link #getDBColumns()} is called. That's why the static function
- * {@link InnerJoin#getDBColumns(ADQLJoin)} has been created. It is called by {@link SQLServer_InnerJoin}
- * and {@link SQLServer_OuterJoin}.
+ * {@link SQLServer_InnerJoin#getDBColumns(ADQLJoin)} has been created.
* </p>
*
* @author Grégory Mantelet (ARI)
@@ -69,7 +68,7 @@ public class SQLServer_OuterJoin extends OuterJoin {
*
* @see OuterJoin#OuterJoin(FromContent, FromContent, OuterType)
*/
- public SQLServer_OuterJoin(FromContent left, FromContent right, OuterType type) {
+ public SQLServer_OuterJoin(FromContent left, FromContent right, OuterType type){
super(left, right, type);
}
@@ -83,7 +82,7 @@ public class SQLServer_OuterJoin extends OuterJoin {
*
* @see OuterJoin#OuterJoin(FromContent, FromContent, OuterType, ClauseConstraints)
*/
- public SQLServer_OuterJoin(FromContent left, FromContent right, OuterType type, ClauseConstraints condition) {
+ public SQLServer_OuterJoin(FromContent left, FromContent right, OuterType type, ClauseConstraints condition){
super(left, right, type, condition);
}
@@ -97,7 +96,7 @@ public class SQLServer_OuterJoin extends OuterJoin {
*
* @see OuterJoin#OuterJoin(FromContent, FromContent, OuterType, Collection)
*/
- public SQLServer_OuterJoin(FromContent left, FromContent right, OuterType type, Collection<ADQLColumn> lstColumns) {
+ public SQLServer_OuterJoin(FromContent left, FromContent right, OuterType type, Collection<ADQLColumn> lstColumns){
super(left, right, type, lstColumns);
}
@@ -110,7 +109,7 @@ public class SQLServer_OuterJoin extends OuterJoin {
*
* @see OuterJoin#OuterJoin(OuterJoin)
*/
- public SQLServer_OuterJoin(OuterJoin toCopy) throws Exception {
+ public SQLServer_OuterJoin(OuterJoin toCopy) throws Exception{
super(toCopy);
}
diff --git a/src/adql/translator/SQLServerTranslator.java b/src/adql/translator/SQLServerTranslator.java
index c81bb36..8eb7022 100644
--- a/src/adql/translator/SQLServerTranslator.java
+++ b/src/adql/translator/SQLServerTranslator.java
@@ -26,11 +26,11 @@ import adql.db.DBChecker;
import adql.db.DBColumn;
import adql.db.DBTable;
import adql.db.DBType;
+import adql.db.DBType.DBDatatype;
import adql.db.DefaultDBColumn;
import adql.db.DefaultDBTable;
-import adql.db.SearchColumnList;
-import adql.db.DBType.DBDatatype;
import adql.db.STCS.Region;
+import adql.db.SearchColumnList;
import adql.db.exception.UnresolvedJoinException;
import adql.parser.ADQLParser;
import adql.parser.ParseException;
@@ -40,10 +40,7 @@ import adql.query.ClauseSelect;
import adql.query.IdentifierField;
import adql.query.from.ADQLJoin;
import adql.query.operand.ADQLColumn;
-import adql.query.operand.ADQLOperand;
-import adql.query.operand.function.DefaultUDF;
import adql.query.operand.function.MathFunction;
-import adql.query.operand.function.UserDefinedFunction;
import adql.query.operand.function.geometry.AreaFunction;
import adql.query.operand.function.geometry.BoxFunction;
import adql.query.operand.function.geometry.CentroidFunction;
@@ -68,7 +65,7 @@ import adql.query.operand.function.geometry.RegionFunction;
* TODO See how case sensitivity is supported by MS SQL Server and modify this translator accordingly.
*
* TODO Extend this class for each MS SQL Server extension supporting geometry and particularly
- * {@link #translateGeometryFromDB(Object)}, {@link #translateGeometryToDB(Region)} and all this other
+ * {@link #translateGeometryFromDB(Object)}, {@link #translateGeometryToDB(adql.db.STCS.Region)} and all this other
* translate(...) functions for the ADQL's geometrical functions.
*
* TODO Check MS SQL Server datatypes (see {@link #convertTypeFromDB(int, String, String, String[])},
@@ -85,13 +82,13 @@ import adql.query.operand.function.geometry.RegionFunction;
* @see SQLServer_ADQLQueryFactory
*/
public class SQLServerTranslator extends JDBCTranslator {
-
+
/* TODO Temporary MAIN function.
* TO REMOVE for the release. */
- public final static void main(final String[] args) throws Exception {
+ public final static void main(final String[] args) throws Exception{
final String adqlquery = "SELECT id, name, aColumn, anotherColumn FROM aTable A NATURAL JOIN anotherTable B;";
- System.out.println("ADQL Query:\n"+adqlquery);
-
+ System.out.println("ADQL Query:\n" + adqlquery);
+
ArrayList<DBTable> tables = new ArrayList<DBTable>(2);
DefaultDBTable t = new DefaultDBTable("aTable");
t.addColumn(new DefaultDBColumn("id", t));
@@ -103,11 +100,11 @@ public class SQLServerTranslator extends JDBCTranslator {
t.addColumn(new DefaultDBColumn("name", t));
t.addColumn(new DefaultDBColumn("anotherColumn", t));
tables.add(t);
-
+
ADQLQuery query = (new ADQLParser(new DBChecker(tables), new SQLServer_ADQLQueryFactory())).parseQuery(adqlquery);
-
+
SQLServerTranslator translator = new SQLServerTranslator();
- System.out.println("\nIn MS SQL Server:\n"+translator.translate(query));
+ System.out.println("\nIn MS SQL Server:\n" + translator.translate(query));
}
/** <p>Indicate the case sensitivity to apply to each SQL identifier (only SCHEMA, TABLE and COLUMN).</p>
@@ -131,7 +128,7 @@ public class SQLServerTranslator extends JDBCTranslator {
* Builds an SQLServerTranslator which always translates in SQL all identifiers (schema, table and column) in the specified case sensitivity ;
* in other words, schema, table and column names will all be surrounded or not by double quotes in the SQL translation.
*
- * @param allCaseSensitive <i>true</i> to translate all identifiers in a case sensitive manner (surrounded by double quotes), <i>false</i> for case insensitivity.
+ * @param allCaseSensitive <i>true</i> to translate all identifiers in a case sensitive manner (surrounded by double quotes), <i>false</i> for case insensitivity.
*/
public SQLServerTranslator(final boolean allCaseSensitive){
caseSensitivity = allCaseSensitive ? (byte)0x0F : (byte)0x00;
@@ -153,10 +150,10 @@ public class SQLServerTranslator extends JDBCTranslator {
}
@Override
- public boolean isCaseSensitive(final IdentifierField field) {
+ public boolean isCaseSensitive(final IdentifierField field){
return field == null ? false : field.isCaseSensitive(caseSensitivity);
}
-
+
/* For SQL Server, translate(ADQLQuery) must be overridden for TOP/LIMIT handling.
* We must not add "LIMIT" at the end of the query, it must go in select.
* @see adql.translator.ADQLTranslator#translate(adql.query.ADQLQuery)
@@ -181,7 +178,7 @@ public class SQLServerTranslator extends JDBCTranslator {
return sql.toString();
}
-
+
/* For SQL Server, translate(ClauseSelect) must be overridden for TOP/LIMIT handling.
* We must not add "LIMIT" at the end of the query, it must go in select.
* @see adql.translator.ADQLTranslator#translate(adql.query.ClauseSelect)
@@ -189,12 +186,10 @@ public class SQLServerTranslator extends JDBCTranslator {
@Override
public String translate(ClauseSelect clause) throws TranslationException{
String sql = null;
-
+
for(int i = 0; i < clause.size(); i++){
if (i == 0){
- sql = clause.getName() +
- (clause.hasLimit() ? " TOP " + clause.getLimit() + " " : "") +
- (clause.distinctColumns() ? " DISTINCT" : "");
+ sql = clause.getName() + (clause.hasLimit() ? " TOP " + clause.getLimit() + " " : "") + (clause.distinctColumns() ? " DISTINCT" : "");
}else
sql += " " + clause.getSeparator(i);
@@ -205,7 +200,7 @@ public class SQLServerTranslator extends JDBCTranslator {
}
@Override
- public String translate(final ADQLJoin join) throws TranslationException {
+ public String translate(final ADQLJoin join) throws TranslationException{
StringBuffer sql = new StringBuffer(translate(join.getLeftTable()));
sql.append(' ').append(join.getJoinType()).append(' ').append(translate(join.getRightTable())).append(' ');
@@ -214,7 +209,7 @@ public class SQLServerTranslator extends JDBCTranslator {
if (join.isNatural()){
try{
StringBuffer buf = new StringBuffer();
-
+
// Find duplicated items between the two lists and translate them as ON conditions:
DBColumn rightCol;
SearchColumnList leftList = join.getLeftTable().getDBColumns();
@@ -236,17 +231,17 @@ public class SQLServerTranslator extends JDBCTranslator {
buf.append(getQualifiedTableName(rightCol.getTable())).append('.').append(getColumnName(rightCol));
}
}
-
+
sql.append("ON ").append(buf.toString());
}catch(UnresolvedJoinException uje){
- throw new TranslationException("Impossible to resolve the NATURAL JOIN between "+join.getLeftTable().toADQL()+" and "+join.getRightTable().toADQL()+"!", uje);
+ throw new TranslationException("Impossible to resolve the NATURAL JOIN between " + join.getLeftTable().toADQL() + " and " + join.getRightTable().toADQL() + "!", uje);
}
}
// CASE: USING
else if (join.hasJoinedColumns()){
try{
StringBuffer buf = new StringBuffer();
-
+
// For each columns of usingList, check there is in each list exactly one matching column, and then, translate it as ON condition:
DBColumn leftCol, rightCol;
ADQLColumn usingCol;
@@ -267,10 +262,10 @@ public class SQLServerTranslator extends JDBCTranslator {
buf.append("=");
buf.append(getQualifiedTableName(rightCol.getTable())).append('.').append(getColumnName(rightCol));
}
-
+
sql.append("ON ").append(buf.toString());
}catch(UnresolvedJoinException uje){
- throw new TranslationException("Impossible to resolve the JOIN USING between "+join.getLeftTable().toADQL()+" and "+join.getRightTable().toADQL()+"!", uje);
+ throw new TranslationException("Impossible to resolve the JOIN USING between " + join.getLeftTable().toADQL() + " and " + join.getRightTable().toADQL() + "!", uje);
}
}
// DEFAULT CASE:
@@ -279,80 +274,80 @@ public class SQLServerTranslator extends JDBCTranslator {
return sql.toString();
}
-
+
@Override
- public String translate(final ExtractCoord extractCoord) throws TranslationException {
+ public String translate(final ExtractCoord extractCoord) throws TranslationException{
return getDefaultADQLFunction(extractCoord);
}
@Override
- public String translate(final ExtractCoordSys extractCoordSys) throws TranslationException {
+ public String translate(final ExtractCoordSys extractCoordSys) throws TranslationException{
return getDefaultADQLFunction(extractCoordSys);
}
@Override
- public String translate(final AreaFunction areaFunction) throws TranslationException {
+ public String translate(final AreaFunction areaFunction) throws TranslationException{
return getDefaultADQLFunction(areaFunction);
}
@Override
- public String translate(final CentroidFunction centroidFunction) throws TranslationException {
+ public String translate(final CentroidFunction centroidFunction) throws TranslationException{
return getDefaultADQLFunction(centroidFunction);
}
@Override
- public String translate(final DistanceFunction fct) throws TranslationException {
+ public String translate(final DistanceFunction fct) throws TranslationException{
return getDefaultADQLFunction(fct);
}
@Override
- public String translate(final ContainsFunction fct) throws TranslationException {
+ public String translate(final ContainsFunction fct) throws TranslationException{
return getDefaultADQLFunction(fct);
}
@Override
- public String translate(final IntersectsFunction fct) throws TranslationException {
+ public String translate(final IntersectsFunction fct) throws TranslationException{
return getDefaultADQLFunction(fct);
}
@Override
- public String translate(final PointFunction point) throws TranslationException {
+ public String translate(final PointFunction point) throws TranslationException{
return getDefaultADQLFunction(point);
}
@Override
- public String translate(final CircleFunction circle) throws TranslationException {
+ public String translate(final CircleFunction circle) throws TranslationException{
return getDefaultADQLFunction(circle);
}
@Override
- public String translate(final BoxFunction box) throws TranslationException {
+ public String translate(final BoxFunction box) throws TranslationException{
return getDefaultADQLFunction(box);
}
@Override
- public String translate(final PolygonFunction polygon) throws TranslationException {
+ public String translate(final PolygonFunction polygon) throws TranslationException{
return getDefaultADQLFunction(polygon);
}
@Override
- public String translate(final RegionFunction region) throws TranslationException {
+ public String translate(final RegionFunction region) throws TranslationException{
return getDefaultADQLFunction(region);
}
-
+
@Override
public String translate(MathFunction fct) throws TranslationException{
- switch(fct.getType()){
- case TRUNCATE:
- // third argument to round nonzero means do a truncate
- return "round(" + ((fct.getNbParameters() >= 2) ? (translate(fct.getParameter(0)) + ", " + translate(fct.getParameter(1))) : "" ) + ",1)";
- case MOD:
- return ((fct.getNbParameters() >= 2) ? (translate(fct.getParameter(0)) + "% " + translate(fct.getParameter(1))) : "");
- default:
- return getDefaultADQLFunction(fct);
- }
- }
-
+ switch(fct.getType()){
+ case TRUNCATE:
+ // third argument to round nonzero means do a truncate
+ return "round(" + ((fct.getNbParameters() >= 2) ? (translate(fct.getParameter(0)) + ", " + translate(fct.getParameter(1))) : "") + ",1)";
+ case MOD:
+ return ((fct.getNbParameters() >= 2) ? (translate(fct.getParameter(0)) + "% " + translate(fct.getParameter(1))) : "");
+ default:
+ return getDefaultADQLFunction(fct);
+ }
+ }
+
@Override
public DBType convertTypeFromDB(final int dbmsType, final String rawDbmsTypeName, String dbmsTypeName, final String[] params){
// If no type is provided return VARCHAR:
--
GitLab