package org.broadinstitute.sting.gatk.walkers;

import org.broadinstitute.sting.gatk.LocusContext;
import org.broadinstitute.sting.utils.GenomeLoc;

import java.util.List;

import net.sf.samtools.SAMRecord;

/**
 * Created by IntelliJ IDEA.
 * User: mdepristo
 * Date: Feb 22, 2009
 * Time: 2:52:28 PM
 * To change this template use File | Settings | File Templates.
 */
@Requires({DataSource.READS,DataSource.REFERENCE})
public abstract class DuplicateWalker<MapType, ReduceType> extends Walker<MapType, ReduceType> {
    // Do we actually want to operate on the context?
    public boolean filter(GenomeLoc loc, byte[] refBases, LocusContext context,
                          List<SAMRecord> uniqueReads,
                          List<SAMRecord> duplicateReads) {
        return true;    // We are keeping all the reads
    }

    /**
     * Called by the traversal engine to decide whether to send non-duplicates as lists of
     * singleton reads to the map function.  By default it's false.
     *
     * @return true if you want to see non duplicates during the traversal
     */
    public boolean mapUniqueReadsTooP() { return false; }

    public abstract MapType map(GenomeLoc loc, byte[] refBases, LocusContext context,
                                List<SAMRecord> uniqueReads,
                                List<SAMRecord> duplicateReads);

    // Given result of map function
    public abstract ReduceType reduceInit();
    public abstract ReduceType reduce(MapType value, ReduceType sum);
}