org.openstreetmap.osmosis.core.sort.v0_5
Class ChangeSorter

java.lang.Object
  extended by org.openstreetmap.osmosis.core.sort.v0_5.ChangeSorter
All Implemented Interfaces:
Completable, Releasable, Task, ChangeSink, ChangeSinkChangeSource, ChangeSource

public class ChangeSorter
extends java.lang.Object
implements ChangeSinkChangeSource

A change stream filter that sorts changes. The sort order is specified by comparator provided during instantiation.

Author:
Brett Henderson

Constructor Summary
ChangeSorter(java.util.Comparator<ChangeContainer> comparator)
          Creates a new instance.
 
Method Summary
 void complete()
          Ensures that all information is fully persisted.
 void process(ChangeContainer change)
          Process the change.
 void release()
          Performs resource cleanup tasks such as closing files, or database connections.
 void setChangeSink(ChangeSink changeSink)
          Sets the change sink to send data to.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChangeSorter

public ChangeSorter(java.util.Comparator<ChangeContainer> comparator)
Creates a new instance.

Parameters:
comparator - The comparator to use for sorting.
Method Detail

process

public void process(ChangeContainer change)
Process the change.

Specified by:
process in interface ChangeSink
Parameters:
change - The change to be processed.

setChangeSink

public void setChangeSink(ChangeSink changeSink)
Sets the change sink to send data to.

Specified by:
setChangeSink in interface ChangeSource
Parameters:
changeSink - The sink for receiving all produced data.

complete

public void complete()
Ensures that all information is fully persisted. This includes database commits, file buffer flushes, etc. Implementations must call complete on any nested Completable objects. Where the releasable method of a Releasable class should be called within a finally block, this method should typically be the final statement within the try block.

Specified by:
complete in interface Completable

release

public void release()
Performs resource cleanup tasks such as closing files, or database connections. This must be called after all processing is complete and may be called multiple times. Implementations must call release on any nested Releasable objects. It should be called within a finally block to ensure it is called in exception scenarios.

Specified by:
release in interface Releasable