Skip to content

Commit

Permalink
[DM-41493] Add an ObsCoreRegionConverter
Browse files Browse the repository at this point in the history
This will turn the s_region columns to the different pgsphere
columns that are stored in the backend database.
  • Loading branch information
cbanek committed Oct 31, 2023
1 parent 8830aec commit 53dda25
Show file tree
Hide file tree
Showing 2 changed files with 176 additions and 2 deletions.
3 changes: 1 addition & 2 deletions tap/src/main/java/ca/nrc/cadc/sample/AdqlQueryImpl.java
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@
import ca.nrc.cadc.tap.parser.navigator.FromItemNavigator;
import ca.nrc.cadc.tap.parser.navigator.ReferenceNavigator;
import ca.nrc.cadc.tap.parser.navigator.SelectNavigator;
import ca.nrc.cadc.tap.parser.region.pgsphere.PgsphereRegionConverter;
import org.apache.log4j.Logger;

/**
Expand Down Expand Up @@ -114,7 +113,7 @@ protected void init()
tnc.put("tap_schema.key_columns", "tap_schema.key_columns11");
TableNameReferenceConverter tnrc = new TableNameReferenceConverter(tnc.map);
super.navigatorList.add(new SelectNavigator(new ExpressionNavigator(), tnrc, tnc));
super.navigatorList.add(new PgsphereRegionConverter(new ExpressionNavigator(), new ReferenceNavigator(), new FromItemNavigator()));
super.navigatorList.add(new ObsCoreRegionConverter());

// TODO: add more custom query visitors here
}
Expand Down
175 changes: 175 additions & 0 deletions tap/src/main/java/ca/nrc/cadc/sample/ObsCoreRegionConverter.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
/*
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2019. (c) 2019.
* Government of Canada Gouvernement du Canada
* National Research Council Conseil national de recherches
* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
* All rights reserved Tous droits réservés
*
* NRC disclaims any warranties, Le CNRC dénie toute garantie
* expressed, implied, or énoncée, implicite ou légale,
* statutory, of any kind with de quelque nature que ce
* respect to the software, soit, concernant le logiciel,
* including without limitation y compris sans restriction
* any warranty of merchantability toute garantie de valeur
* or fitness for a particular marchande ou de pertinence
* purpose. NRC shall not be pour un usage particulier.
* liable in any event for any Le CNRC ne pourra en aucun cas
* damages, whether direct or être tenu responsable de tout
* indirect, special or general, dommage, direct ou indirect,
* consequential or incidental, particulier ou général,
* arising from the use of the accessoire ou fortuit, résultant
* software. Neither the name de l'utilisation du logiciel. Ni
* of the National Research le nom du Conseil National de
* Council of Canada nor the Recherches du Canada ni les noms
* names of its contributors may de ses participants ne peuvent
* be used to endorse or promote être utilisés pour approuver ou
* products derived from this promouvoir les produits dérivés
* software without specific prior de ce logiciel sans autorisation
* written permission. préalable et particulière
* par écrit.
*
* This file is part of the Ce fichier fait partie du projet
* OpenCADC project. OpenCADC.
*
* OpenCADC is free software: OpenCADC est un logiciel libre ;
* you can redistribute it and/or vous pouvez le redistribuer ou le
* modify it under the terms of modifier suivant les termes de
* the GNU Affero General Public la “GNU Affero General Public
* License as published by the License” telle que publiée
* Free Software Foundation, par la Free Software Foundation
* either version 3 of the : soit la version 3 de cette
* License, or (at your option) licence, soit (à votre gré)
* any later version. toute version ultérieure.
*
* OpenCADC is distributed in the OpenCADC est distribué
* hope that it will be useful, dans l’espoir qu’il vous
* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
* without even the implied GARANTIE : sans même la garantie
* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
* General Public License for Générale Publique GNU Affero
* more details. pour plus de détails.
*
* You should have received Vous devriez avoir reçu une
* a copy of the GNU Affero copie de la Licence Générale
* General Public License along Publique GNU Affero avec
* with OpenCADC. If not, see OpenCADC ; si ce n’est
* <http://www.gnu.org/licenses/>. pas le cas, consultez :
* <http://www.gnu.org/licenses/>.
*
* $Revision: 5 $
*
************************************************************************
*/

package ca.nrc.cadc.sample;

import ca.nrc.cadc.tap.parser.navigator.ExpressionNavigator;
import ca.nrc.cadc.tap.parser.navigator.FromItemNavigator;
import ca.nrc.cadc.tap.parser.navigator.ReferenceNavigator;
import ca.nrc.cadc.tap.parser.region.pgsphere.PgsphereRegionConverter;
import ca.nrc.cadc.tap.parser.region.pgsphere.function.Interval;
import ca.nrc.cadc.tap.schema.TapSchema;
import net.sf.jsqlparser.expression.DoubleValue;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.schema.Column;
import net.sf.jsqlparser.schema.Table;
import org.apache.log4j.Logger;

/**
* convert predicate functions into ObsCore implementation
*
* @author cbanek
*
*/
public class ObsCoreRegionConverter extends PgsphereRegionConverter
{
private static Logger log = Logger.getLogger(ObsCoreRegionConverter.class);

public ObsCoreRegionConverter()
{
super(new ExpressionNavigator(), new ReferenceNavigator(), new FromItemNavigator());
}

/**
* This method is called when a CONTAINS is found.
* This could occur if the query had CONTAINS(...) in the select list or as
* part of an arithmetic expression or aggregate function (since CONTAINS
* returns a numeric value).
*
* @param left
* @param right
* @return replacement expression
*/
@Override
protected Expression handleContains(Expression left, Expression right)
{
log.debug("handleContains: " + left + " " + right);
RewriteRegionColumns(left, right);

if (right instanceof Interval)
{
if (left instanceof Column || left instanceof Interval)
{
// OK
}
else if (left instanceof DoubleValue)
{
DoubleValue dv = (DoubleValue) left;
double d = dv.getValue();
double d1 = Double.longBitsToDouble(Double.doubleToLongBits(d) - 1L);
double d2 = Double.longBitsToDouble(Double.doubleToLongBits(d) + 1L);
Interval p = new Interval(new DoubleValue(Double.toString(d1)), new DoubleValue(Double.toString(d2)));
return super.handleIntersects(p, right);
}
else
throw new IllegalArgumentException("invalid argument type for contains: " + left.getClass().getSimpleName() + " Interval");
}
return super.handleContains(left, right);
}

/**
* This method is called when a INTERSECTS is found.
* This could occur if the query had INTERSECTS(...) in the select list or as
* part of an arithmetic expression or aggregate function (since INTERSECTS
* returns a numeric value).
*
* @param left
* @param right
*
* @return replacement expression
*/
@Override
protected Expression handleIntersects(Expression left, Expression right)
{
log.debug("handleIntersects: " + left + " " + right);
RewriteRegionColumns(left, right);
return super.handleIntersects(left, right);
}

@Override
protected Expression handleInterval(Expression lower, Expression upper)
{
return new Interval(lower, upper);
}

private void RewriteRegionColumns(Expression left, Expression right) {
// column renaming
RewriteRegionColumn(left);
RewriteRegionColumn(right);
}

private void RewriteRegionColumn(Expression e) {
if (e instanceof Column)
{
Column c = (Column) e;
if (c.getColumnName().equalsIgnoreCase("s_region"))
c.setColumnName("pgs_region");
}
}
}

0 comments on commit 53dda25

Please sign in to comment.