/*
 * Copyright [1999-2014] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
 * 
 * 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 org.ensembl.healthcheck.testcase.compara;

import java.sql.Connection;

import org.ensembl.healthcheck.DatabaseRegistryEntry;
import org.ensembl.healthcheck.ReportManager;
import org.ensembl.healthcheck.Team;
import org.ensembl.healthcheck.testcase.SingleDatabaseTestCase;

/**
 * An EnsEMBL Healthcheck test case that looks for broken foreign-key
 * relationships.
 */

public class ForeignKeyDnafragId extends SingleDatabaseTestCase {

    /**
     * Create an ForeignKeyDnafragId that applies to a specific set of databases.
     */
    public ForeignKeyDnafragId() {

        addToGroup("compara_genomic");
        setDescription("Check for broken foreign-key relationships in ensembl_compara databases.");
        setTeamResponsible(Team.COMPARA);
    }

    /**
     * Run the test.
     * 
     * @param dbre
     *          The database to use.
     * @return true if the test passed.
     *  
     */
    public boolean run(DatabaseRegistryEntry dbre) {

        boolean result = true;

        Connection con = dbre.getConnection();

        if (tableHasRows(con, "dnafrag")) {

            result &= checkForOrphans(con, "dnafrag_region", "dnafrag_id", "dnafrag", "dnafrag_id");
            result &= checkForOrphans(con, "genomic_align", "dnafrag_id", "dnafrag", "dnafrag_id");
            result &= checkForOrphans(con, "constrained_element", "dnafrag_id", "dnafrag", "dnafrag_id");

        } else {
            ReportManager.correct(this, con, "NO ENTRIES in dnafrag table, so nothing to test IGNORED");
        }

        return result;

    }


} // ForeignKeyDnafragId

@@ -2071,16 +2071,211 @@
 ag_id%22);
+%0A            result &= checkForOrphans(con, %22gene_member%22, %22dnafrag_id%22, %22dnafrag%22, %22dnafrag_id%22);%0A            result &= checkForOrphans(con, %22seq_member%22, %22dnafrag_id%22, %22dnafrag%22, %22dnafrag_id%22);
 %0A%0A      

Check gene_member and seq_member dnafrag_id FKs