org.openstreetmap.osmosis.core.sort.v0_6
Class EntitySorter

java.lang.Object
  extended by org.openstreetmap.osmosis.core.sort.v0_6.EntitySorter
All Implemented Interfaces:
Completable, Releasable, Task, Sink, SinkSource, Source

public class EntitySorter
extends java.lang.Object
implements SinkSource

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

Author:
Brett Henderson

Constructor Summary
EntitySorter(java.util.Comparator<EntityContainer> comparator)
          Creates a new instance.
 
Method Summary
 void complete()
          Ensures that all information is fully persisted.
 void process(EntityContainer entityContainer)
          Process the entity.
 void release()
          Performs resource cleanup tasks such as closing files, or database connections.
 void setSink(Sink sink)
          Sets the osm 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

EntitySorter

public EntitySorter(java.util.Comparator<EntityContainer> comparator)
Creates a new instance.

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

process

public void process(EntityContainer entityContainer)
Process the entity.

Specified by:
process in interface Sink
Parameters:
entityContainer - The entity to be processed.

setSink

public void setSink(Sink sink)
Sets the osm sink to send data to.

Specified by:
setSink in interface Source
Parameters:
sink - 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