SampleComparator 5.6.3 API

All Implemented Interfaces:


public interface SampleComparator

Defines a comparator for Sample instances

Since:: 3.0

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract long`	`compare(Sample s1, Sample s2)`	Compares to sample Must return an long integer that define the relational order of the 2 compared samples: Negative long integer : s1 is lower than s2 Zero long integer : s1 is strictly equal to s2 Positive long integer : s1 is greater than s2
`abstract void`	`initialize(SampleMetadata metadata)`	Initializes the comparator with the SampleMetadata of the samples to be compared.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - compare
```
 abstract long compare(Sample s1, Sample s2)
```
    Compares to sample
    Must return an long integer that define the relational order of the 2 compared samples:
    Negative long integer : s1 is lower than s2
    Zero long integer : s1 is strictly equal to s2
    Positive long integer : s1 is greater than s2
    Parameters:
    
    s1 - The first sample to be compared
    
    s2 - The second sample to compared
    
    Returns:
    
    A negative is s1 < s2, 0 if s1 = s2, a positive integer if s1 > s2
  - initialize
```
 abstract void initialize(SampleMetadata metadata)
```
    Initializes the comparator with the SampleMetadata of the samples to be compared.
    This function is invoked before any call to thecompare service.
    Not that this function is the place to get sample column indexes for better performance
    
    Parameters:
    
    metadata - The metadata of the sample to be compared by this instance