htsjdk.samtools

Interface SAMRecordComparator

All Superinterfaces:

java.util.Comparator<SAMRecord>

All Known Implementing Classes:

SAMRecordCoordinateComparator, SAMRecordDuplicateComparator, SAMRecordQueryNameComparator

public interface SAMRecordComparator
extends java.util.Comparator<SAMRecord>

Interface for comparators that define the various SAM sort orders.

Method Summary

Methods

Modifier and Type	Method and Description
int	fileOrderCompare(SAMRecord samRecord1, SAMRecord samRecord2) Less stringent compare method than the regular compare.

Methods inherited from interface java.util.Comparator

compare, equals

Method Detail

fileOrderCompare

int fileOrderCompare(SAMRecord samRecord1,
                   SAMRecord samRecord2)

Less stringent compare method than the regular compare. If the two records are equal enough that their ordering in a sorted SAM file would be arbitrary, this method returns 0.

Returns:

negative if samRecord1 < samRecord2, 0 if equal, else positive