org.protempa.backend.dsb.relationaldb.RefResultProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protempa-dsb-relationaldb Show documentation
Implements support for retrieving data from relational databases.
The newest version!
/*
 * #%L
 * Protempa Commons Backend Provider
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * 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.
 * #L%
 */
package org.protempa.backend.dsb.relationaldb;

import java.io.IOException;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Arrays;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.arp.javautil.log.Logging;
import org.protempa.proposition.Proposition;
import org.protempa.proposition.UniqueId;

abstract class RefResultProcessor extends AbstractResultProcessor {

    private static final int FLUSH_SIZE = 2000000;
    private ReferenceSpec referenceSpec;
    private ResultCache
 cache;

    protected RefResultProcessor(ResultCache results, 
            ReferenceSpec referenceSpec, EntitySpec entitySpec, 
            String dataSourceBackendId) {
        super(entitySpec, dataSourceBackendId);
        assert results != null : "results cannot be null";
        assert referenceSpec != null : "referenceSpec cannot be null";
        this.cache = results;
        this.referenceSpec = referenceSpec;
    }

    @Override
    public final void process(ResultSet resultSet) throws SQLException {
        EntitySpec entitySpec = getEntitySpec();
        int count = 0;
        String[] uniqueIds = new String[entitySpec.getUniqueIdSpecs().length];
        String[] refUniqueIds =
                new String[this.referenceSpec.getUniqueIdSpecs().length];
        UniqueId uniqueIdentifier = null;
        String[] uniqueIdsCopy = new String[uniqueIds.length];
        String entitySpecName = entitySpec.getName();
        String refSpecEntityName = this.referenceSpec.getEntityName();
        Logger logger = SQLGenUtil.logger();
        
        while (resultSet.next()) {
            int i = 1;

            i = readUniqueIds(uniqueIds, resultSet, i);
            if (org.arp.javautil.arrays.Arrays.contains(uniqueIds, null)) {
                /**
                 * We skip records with null values in the unique id field, and
                 * fail if appropriate in 
                 * Event/Constant/PrimitiveParameterResultProcessor. We need to
                 * do this because it is okay to include a potentially null
                 * column as part of the unique id when the column is the
                 * keyid.
                 */
                continue;
            }
            if (uniqueIdentifier == null ||
                    !Arrays.equals(uniqueIds, uniqueIdsCopy)) {
                uniqueIdentifier = generateUniqueId(
                        entitySpecName, uniqueIds);
                System.arraycopy(uniqueIds, 0, uniqueIdsCopy, 0,
                        uniqueIds.length);
            }

            i = readUniqueIds(refUniqueIds, resultSet, i);
            if (org.arp.javautil.arrays.Arrays.contains(refUniqueIds, null)) {
                /**
                 * We skip records with null values in the unique id field, and
                 * fail if appropriate in 
                 * Event/Constant/PrimitiveParameterResultProcessor. We need to
                 * do this because it is okay to include a potentially null
                 * column as part of the unique id when the column is the
                 * keyid.
                 */
                continue;
            }
            UniqueId refUniqueIdentifier = generateUniqueId(
                    refSpecEntityName, refUniqueIds);
            this.cache.addReference(uniqueIdentifier, refUniqueIdentifier);
            if (++count % FLUSH_SIZE == 0) {
                try {
                    this.cache.flushReferences(this);
                } catch (IOException ex) {
                    throw new QueryResultsCacheException("Flushing references to cache failed", ex);
                }
                if (logger.isLoggable(Level.FINE)) {
                    Logging.logCount(logger, Level.FINE, count, 
                            "Retrieved {0} reference",
                            "Retrieved {0} references");
                }
            }
        }
        try {
            this.cache.flushReferences(this);
        } catch (IOException ex) {
            throw new QueryResultsCacheException("Flushing references to cache failed", ex);
        }
        //this.cache.flushReferencesFull(this);
        if (logger.isLoggable(Level.FINE)) {
            Logging.logCount(logger, Level.FINE, count, 
                            "Retrieved {0} reference total",
                            "Retrieved {0} references total");
        }
        
    }

    abstract void addReferences(P proposition, List uids);

    final ReferenceSpec getReferenceSpec() {
        return this.referenceSpec;
    }

    final void setReferenceSpec(ReferenceSpec referenceSpec) {
        assert referenceSpec != null : "referenceSpec cannot be null";
        this.referenceSpec = referenceSpec;
    }
}