com.novartis.opensource.yada.format.ResultSetResultDelimitedConverter.java Source code

Introduction

Here is the source code for com.novartis.opensource.yada.format.ResultSetResultDelimitedConverter.java

Source

/**
 * Copyright 2016 Novartis Institutes for BioMedical Research Inc.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.novartis.opensource.yada.format;

import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;

import javax.sql.rowset.RowSetMetaDataImpl;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import com.novartis.opensource.yada.YADAQueryResult;
import com.novartis.opensource.yada.YADARequest;
import com.novartis.opensource.yada.adaptor.JDBCAdaptor;

/**
 * @author David Varon
 * @since 4.0.0
 */
public class ResultSetResultDelimitedConverter extends AbstractConverter {

    /**
     * Default constructor
     */
    public ResultSetResultDelimitedConverter() {
        // default constructor
    }

    /**
     * Constructor with {@link YADAQueryResult}
     * @param yqr the container for result processing artifacts
     */
    public ResultSetResultDelimitedConverter(YADAQueryResult yqr) {
        this.setYADAQueryResult(yqr);
    }

    /**
     * Creates a delimited result object using {@code newColSep} as a column
     * separator and {@code newRecSep} as a row separator.
     * 
     * @see com.novartis.opensource.yada.format.AbstractConverter#convert(java.lang.Object,
     *      java.lang.String, java.lang.String)
     */
    @Override
    public Object convert(Object o, String newColSep, String newRecSep) throws YADAConverterException {

        StringBuffer result = new StringBuffer();
        this.colsep = newColSep;
        this.recsep = newRecSep;

        try {
            getDelimitedRows((ResultSet) o);
        } catch (SQLException e) {
            String msg = "Unable to iterate over ResultSet";
            throw new YADAConverterException(msg, e);
        } catch (JSONException e) {
            String msg = "Unable to read Harmony Map";
            throw new YADAConverterException(msg, e);
        }
        return result;
    }

    /**
     * Parses global harmony map for duplicate values, and removes key/value pairs that
     * are not present in local harmony map.
     * @return the parsed global harmony map
     * @since 6.1.0
     */
    @Override
    public Object getHarmonyMap() {
        JSONObject globMap = (JSONObject) this.harmonyMap;
        JSONObject local = new JSONObject(getYADAQueryResult().getYADAQueryParamValue(YADARequest.PS_HARMONYMAP));
        JSONArray vals = local.toJSONArray(new JSONArray(JSONObject.getNames(local)));
        ArrayList<String> locVals = new ArrayList<>();
        for (int i = 0; i < vals.length(); i++) {
            locVals.add(vals.getString(i));
        }
        for (Object globalKey : globMap.keySet()) {
            String gk = (String) globalKey;
            String gv = globMap.getString(gk);
            if (locVals.contains(gv) && !local.has(gk)) // the value is associated to a different key in the local map
            {
                globMap.remove(gk);
            }
        }
        return globMap;
    }

    /**
     * Converts columns of data in a {@link java.sql.ResultSet} to collection
     * of {@link List} objects containing values and stored in the current
     * {@link YADAQueryResult#getConvertedResults()} structure.
     * 
     * @param rs
     *          the result set to convert
     * @throws SQLException
     *           when {@link ResultSet} or {@link ResultSetMetaData} iteration
     *           fails
     */
    protected void getDelimitedRows(ResultSet rs) throws SQLException {
        JSONObject h = (JSONObject) this.harmonyMap;
        ResultSetMetaData rsmd = rs.getMetaData();
        if (rsmd == null) // TODO What happens to headers when rsmd is null, or
                          // resultSet is empty?
            rsmd = new RowSetMetaDataImpl();
        int colCount = rsmd.getColumnCount();
        boolean hasYadaRnum = rsmd.getColumnName(colCount).toLowerCase().equals(JDBCAdaptor.ROWNUM_ALIAS);

        // handle headers
        // TODO How to suppress headers?
        for (int j = 1; j <= colCount; j++) {
            String colName = rsmd.getColumnName(j);
            if (!hasYadaRnum || !colName.toLowerCase().equals(JDBCAdaptor.ROWNUM_ALIAS)) {
                String col = colName;
                if (isHarmonized()) {
                    if (h.has(colName)) {
                        col = h.getString(colName);
                    }
                }
                getYADAQueryResult().addConvertedHeader(this.wrap(col));
            }
        }
        List<List<String>> convertedResult = new ArrayList<>();
        while (rs.next()) {
            List<String> resultsRow = new ArrayList<>();
            String colValue;
            for (int j = 1; j <= colCount; j++) {
                String colName = rsmd.getColumnName(j);
                if (!hasYadaRnum || !colName.toLowerCase().equals(JDBCAdaptor.ROWNUM_ALIAS)) {
                    if (null == rs.getString(colName) || "null".equals(rs.getString(colName))) {
                        colValue = NULL_REPLACEMENT;
                    } else {
                        colValue = this.wrap(rs.getString(colName));
                    }
                    resultsRow.add(colValue);
                }
            }
            convertedResult.add(resultsRow);
        }
        getYADAQueryResult().getConvertedResults().add(convertedResult);
    }
}