com.fasterxml.sort

Class SorterBase<T>

java.lang.Object

com.fasterxml.sort.SorterBase<T>

All Implemented Interfaces:

SortingState

Direct Known Subclasses:

IteratingSorter

public abstract class SorterBase<T>
extends Object
implements SortingState

Nested Class Summary

Nested classes/interfaces inherited from interface com.fasterxml.sort.SortingState

SortingState.Phase

Field Summary

Fields

Modifier and Type	Field and Description
protected Exception	_cancelForException
protected AtomicBoolean	_cancelRequest
protected Comparator<T>	_comparator Comparator to use for sorting entries; defaults to 'C
protected SortConfig	_config
protected int	_currentSortRound
protected SortingState.Phase	_phase
protected int	_presortFileCount
protected DataReaderFactory<T>	_readerFactory Factory used for reading intermediate sorted files.
protected int	_sortRoundCount
protected DataWriterFactory<T>	_writerFactory Factory used for writing intermediate sorted files.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SorterBase()
protected	SorterBase(SortConfig config)
protected	SorterBase(SortConfig config, DataReaderFactory<T> readerFactory, DataWriterFactory<T> writerFactory, Comparator<T> comparator)

Method Summary

Methods

Modifier and Type	Method and Description
protected static int	_calculateRoundCount(int files, int mergeFactor)
protected boolean	_checkForCancel()
protected boolean	_checkForCancel(Collection<File> tmpFilesToDelete)
protected DataReader<T>	_createMergeReader(List<File> inputs)
protected File	_merge(List<File> inputs)
protected void	_merge(List<File> inputs, DataWriter<T> writer)
protected void	_presort(DataReader<T> inputReader, SegmentedBuffer buffer, T nextValue, List<File> presorted)
protected Comparator<Object>	_rawComparator()
protected Object[]	_readMax(DataReader<T> inputReader, SegmentedBuffer buffer, long memoryToUse, T firstItem) Helper method that will fill given buffer with data read using given reader, obeying given memory usage constraints.
protected void	_writeAll(DataWriter<T> resultWriter, Object[] items)
protected File	_writePresorted(Object[] items)
void	cancel() Method that can be used to try to cancel executing sort operation.
void	cancel(IOException e) Method that can be used to try to cancel executing sort operation.
void	cancel(RuntimeException e) Method that can be used to try to cancel executing sort operation.
int	getNumberOfPreSortFiles() Accessor for checking how many pre-sort files were created during pre-sort phase.
int	getNumberOfSortRounds() Accessor for figuring out how many regular sorting rounds need to be taken to complete sorting, if known.
SortingState.Phase	getPhase()
int	getSortRound() Accessor for checking which sorting round sorter is doing: for pre-sort it basically means number of segment (0-based) that is being processed in-memory, for regular sort it is number of (0-based) sorting round.
boolean	isCompleted() Accessor for determining whether sorting has been successfully completed or not.
boolean	isPreSorting() Accessor for determining whether sorter is in its in-memory pre-sorting phase.
boolean	isSorting() Accessor for determining whether sorter is in regular merge-sort phase or not.
protected List<File>	merge(List<File> presorted) Main-level merge method that sorts the given input.
protected void	merge(List<File> presorted, DataWriter<T> resultWriter) Main-level merge method that sorts the given input and writes to final output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_config

protected final SortConfig _config

_readerFactory

protected DataReaderFactory<T> _readerFactory

Factory used for reading intermediate sorted files.

_writerFactory

protected DataWriterFactory<T> _writerFactory

Factory used for writing intermediate sorted files.

_comparator

protected Comparator<T> _comparator

Comparator to use for sorting entries; defaults to 'C

_phase

protected SortingState.Phase _phase

_presortFileCount

protected int _presortFileCount

_sortRoundCount

protected int _sortRoundCount

_currentSortRound

protected int _currentSortRound

_cancelRequest

protected final AtomicBoolean _cancelRequest

_cancelForException

protected Exception _cancelForException

Constructor Detail

SorterBase

protected SorterBase(SortConfig config,
          DataReaderFactory<T> readerFactory,
          DataWriterFactory<T> writerFactory,
          Comparator<T> comparator)

SorterBase

protected SorterBase()

SorterBase

protected SorterBase(SortConfig config)

Method Detail

cancel

public void cancel()

Description copied from interface: SortingState

Method that can be used to try to cancel executing sort operation. No exception will be thrown; sorting will just be stopped as soon as sorting thread notices request.

Specified by:

cancel in interface SortingState

cancel

public void cancel(RuntimeException e)

Description copied from interface: SortingState

Method that can be used to try to cancel executing sort operation. Exception object can be specified; if non-null instance is given, it will be thrown to indicate erroneous result, otherwise sorting is just interrupted but execution returns normally.

Specified by:

cancel in interface SortingState

cancel

public void cancel(IOException e)

Description copied from interface: SortingState

Method that can be used to try to cancel executing sort operation. Exception object can be specified; if non-null instance is given, it will be thrown to indicate erroneous result, otherwise sorting is just interrupted but execution returns normally.

Specified by:

cancel in interface SortingState

getPhase

public SortingState.Phase getPhase()

Specified by:

getPhase in interface SortingState

getNumberOfSortRounds

public int getNumberOfSortRounds()

Description copied from interface: SortingState

Accessor for figuring out how many regular sorting rounds need to be taken to complete sorting, if known. If information is not known, will return -1. This information generally becomes available after pre-sorting round.

Specified by:

getNumberOfSortRounds in interface SortingState

getNumberOfPreSortFiles

public int getNumberOfPreSortFiles()

Description copied from interface: SortingState

Accessor for checking how many pre-sort files were created during pre-sort phase. Can be zero if the whole data fit in memory during pre-sorting.

Specified by:

getNumberOfPreSortFiles in interface SortingState

getSortRound

public int getSortRound()

Description copied from interface: SortingState

Accessor for checking which sorting round sorter is doing: for pre-sort it basically means number of segment (0-based) that is being processed in-memory, for regular sort it is number of (0-based) sorting round.

Specified by:

getSortRound in interface SortingState

isCompleted

public boolean isCompleted()

Description copied from interface: SortingState

Accessor for determining whether sorting has been successfully completed or not.

Specified by:

isCompleted in interface SortingState

isPreSorting

public boolean isPreSorting()

Description copied from interface: SortingState

Accessor for determining whether sorter is in its in-memory pre-sorting phase.

Specified by:

isPreSorting in interface SortingState

isSorting

public boolean isSorting()

Description copied from interface: SortingState

Accessor for determining whether sorter is in regular merge-sort phase or not.

Specified by:

isSorting in interface SortingState

_readMax

protected Object[] _readMax(DataReader<T> inputReader,
                SegmentedBuffer buffer,
                long memoryToUse,
                T firstItem)
                     throws IOException

Helper method that will fill given buffer with data read using given reader, obeying given memory usage constraints.

Throws:

IOException

_presort

protected void _presort(DataReader<T> inputReader,
            SegmentedBuffer buffer,
            T nextValue,
            List<File> presorted)
                 throws IOException

Throws:

IOException

_writePresorted

protected File _writePresorted(Object[] items)
                        throws IOException

Throws:

IOException

merge

protected void merge(List<File> presorted,
         DataWriter<T> resultWriter)
              throws IOException

Main-level merge method that sorts the given input and writes to final output.

Throws:

IOException

merge

protected List<File> merge(List<File> presorted)
                    throws IOException

Main-level merge method that sorts the given input.

Returns:

List of files that are individually sorted and ready for final merge.

Throws:

IOException

_writeAll

protected void _writeAll(DataWriter<T> resultWriter,
             Object[] items)
                  throws IOException

Throws:

IOException

_merge

protected File _merge(List<File> inputs)
               throws IOException

Throws:

IOException

_merge

protected void _merge(List<File> inputs,
          DataWriter<T> writer)
               throws IOException

Throws:

IOException

_createMergeReader

protected DataReader<T> _createMergeReader(List<File> inputs)
                                    throws IOException

Throws:

IOException

_calculateRoundCount

protected static int _calculateRoundCount(int files,
                       int mergeFactor)

_checkForCancel

protected boolean _checkForCancel()
                           throws IOException

Throws:

IOException

_checkForCancel

protected boolean _checkForCancel(Collection<File> tmpFilesToDelete)
                           throws IOException

Throws:

IOException

_rawComparator

protected Comparator<Object> _rawComparator()