net.maizegenetics.analysis.data.SeparatePlugin Maven / Gradle / Ivy

/*
 * SeparatePlugin.java
 *
 * Created on July 31, 2010
 *
 */
package net.maizegenetics.analysis.data;

import net.maizegenetics.dna.snp.GenotypeTable;
import net.maizegenetics.dna.snp.FilterGenotypeTable;
import net.maizegenetics.phenotype.GenotypePhenotype;
import net.maizegenetics.phenotype.Phenotype;
import net.maizegenetics.dna.map.Chromosome;
import net.maizegenetics.plugindef.AbstractPlugin;
import net.maizegenetics.plugindef.DataSet;
import net.maizegenetics.plugindef.Datum;
import net.maizegenetics.plugindef.PluginEvent;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import javax.swing.*;
import java.awt.*;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;

/**
 *
 * @author Terry Casstevens
 */
public class SeparatePlugin extends AbstractPlugin {

    private static final Logger myLogger = LogManager.getLogger(SeparatePlugin.class);
    private String[] myChromosomesToSeparate = null;

    /**
     * Creates a new instance of SeparatePlugin
     */
    public SeparatePlugin(Frame parentFrame, boolean isInteractive) {
        super(parentFrame, isInteractive);
    }

    public DataSet performFunction(DataSet input) {

        try {
            List result = new ArrayList<>();

            for (Datum current : (List) input.getDataSet()) {
                Object currentValue = current.getData();
                if (currentValue instanceof GenotypePhenotype) {

                    GenotypePhenotype mp = (GenotypePhenotype) currentValue;
                    Phenotype pheno = mp.phenotype();
                    String phenoName = current.getName() + "_pheno";
                    Datum phenoDatum = new Datum(phenoName, pheno, null);

                    GenotypeTable align = mp.genotypeTable();
                    String alignName = current.getName() + "_align";
                    Datum alignDatum = new Datum(alignName, align, null);

                    DataSet tds = new DataSet(new Datum[]{phenoDatum, alignDatum}, this);
                    result.add(tds);

                } else if (currentValue instanceof GenotypeTable) {

                    List alignments = separateAlignmentIntoLoci((GenotypeTable) currentValue, current.getName(), myChromosomesToSeparate);
                    if (alignments.size() > 0) {
                        DataSet tds = new DataSet(alignments, this);
                        result.add(tds);
                    }

                }
            }

            if (result.isEmpty()) {
                if (isInteractive()) {
                    JOptionPane.showMessageDialog(getParentFrame(), "Nothing to Separate");
                } else {
                    myLogger.warn("performFunction: Nothing to Separate.");
                }
                return null;
            } else {
                DataSet resultDataSet = DataSet.getDataSet(result, this);
                fireDataSetReturned(new PluginEvent(resultDataSet, SeparatePlugin.class));
                return resultDataSet;
            }
        } finally {
            fireProgress(100);
        }

    }

    public static List separateAlignmentIntoLoci(GenotypeTable alignment, String dataSetName) {
        return separateAlignmentIntoLoci(alignment, dataSetName, null);
    }

    public static List separateAlignmentIntoLoci(GenotypeTable alignment, String dataSetName, String[] chromosomesToSeparate) {

        List result = new ArrayList<>();
        GenotypeTable[] alignments = alignment.compositeAlignments();
        for (int i = 0; i < alignments.length; i++) {
            int[] offsets = alignments[i].chromosomesOffsets();
            if (offsets.length > 1) {
                Chromosome[] loci = alignments[i].chromosomes();
                for (int j = 0; j < offsets.length; j++) {
                    if (alignmentInList(loci[j], chromosomesToSeparate)) {
                        String name;
                        if (dataSetName == null) {
                            name = "Alignment_chrom" + loci[j];
                        } else {
                            name = dataSetName + "_chrom" + loci[j];
                        }
                        int endSite;
                        try {
                            endSite = offsets[j + 1] - 1;
                        } catch (Exception e) {
                            endSite = alignments[i].numberOfSites() - 1;
                        }
                        Datum td = new Datum(name, FilterGenotypeTable.getInstance(alignments[i], offsets[j], endSite), null);
                        result.add(td);
                    }
                }
            } else {
                if ((alignments.length > 1) && (alignmentInList(alignments[i].chromosomes()[0], chromosomesToSeparate))) {
                    String name;
                    if (dataSetName == null) {
                        name = "Alignment_chrom" + alignments[i].chromosome(0);
                    } else {
                        name = dataSetName + "_chrom" + alignments[i].chromosome(0);
                    }
                    Datum td = new Datum(name, alignments[i], null);
                    result.add(td);
                }
            }
        }

        return result;

    }

    private static boolean alignmentInList(Chromosome locus, String[] chromosomesToSeparate) {

        if (chromosomesToSeparate == null) {
            return true;
        }

        String currentChr = locus.getName();
        for (int i = 0; i < chromosomesToSeparate.length; i++) {
            if (currentChr.equalsIgnoreCase(chromosomesToSeparate[i])) {
                return true;
            }
        }

        return false;
    }

    public void setChromosomesToSeparate(String[] chrs) {
        myChromosomesToSeparate = new String[chrs.length];
        for (int i = 0; i < chrs.length; i++) {
            myChromosomesToSeparate[i] = chrs[i].trim();
        }
    }

    /**
     * Icon for this plugin to be used in buttons, etc.
     *
     * @return ImageIcon
     */
    @Override
    public ImageIcon getIcon() {
        URL imageURL = SeparatePlugin.class.getResource("/net/maizegenetics/analysis/images/Separate.gif");
        if (imageURL == null) {
            return null;
        } else {
            return new ImageIcon(imageURL);
        }
    }

    /**
     * Button name for this plugin to be used in buttons, etc.
     *
     * @return String
     */
    @Override
    public String getButtonName() {
        return "Separate";
    }

    /**
     * Tool Tip Text for this plugin
     *
     * @return String
     */
    @Override
    public String getToolTipText() {
        return "Separate Data (i.e. into Chromosomes)";
    }
}