com.tinkerpop.pipes.transform

Class OrderPipe<S>

java.lang.Object

com.tinkerpop.pipes.AbstractPipe<S,S>

com.tinkerpop.pipes.transform.OrderPipe<S>

All Implemented Interfaces:

Pipe<S,S>, TransformPipe<S,S>, Iterable<S>, Iterator<S>

public class OrderPipe<S>
extends AbstractPipe<S,S>
implements TransformPipe<S,S>

OrderPipe supports in-stream sorting of objects. If no provided sorting function is provided, then a default sort order is assumed. Moreover, when no sorting function is provided, the object S is assumed to be comparable. If a sorting function is provided, then sort is determined by the comparison computed by the function.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.pipes.transform.TransformPipe

TransformPipe.Order

Field Summary

Fields inherited from class com.tinkerpop.pipes.AbstractPipe

currentEnd, pathEnabled, starts

Fields inherited from interface com.tinkerpop.pipes.Pipe

NO_PATH_MESSAGE

Constructor Summary

Constructors

Constructor and Description
OrderPipe()
OrderPipe(PipeFunction<Pair<S,S>,Integer> compareFunction)
OrderPipe(TransformPipe.Order order)

Method Summary

Methods

Modifier and Type	Method and Description
void	enablePath(boolean enablePath) Calculating paths can be an expensive operation for some pipes.
List	getCurrentPath() Returns the transformation path to arrive at the current object of the pipe.
S	processNextStart()

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

getPathToHere, hasNext, iterator, next, remove, reset, setStarts, setStarts, setStarts, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.pipes.Pipe

reset, setStarts, setStarts

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

OrderPipe

public OrderPipe(PipeFunction<Pair<S,S>,Integer> compareFunction)

OrderPipe

public OrderPipe()

OrderPipe

public OrderPipe(TransformPipe.Order order)

Method Detail

enablePath

public void enablePath(boolean enablePath)

Description copied from interface: Pipe

Calculating paths can be an expensive operation for some pipes. This method is used to activate or deactivate the calculation of paths. The default state of a newly constructed pipe should have its path calculations disabled. An implementation of this method should be recursive whereby the starts (if a Pipe) should have this method called on it.

Specified by:

enablePath in interface Pipe<S,S>

Overrides:

enablePath in class AbstractPipe<S,S>

Parameters:

enablePath - enable path calculations

processNextStart

public S processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,S>

getCurrentPath

public List getCurrentPath()

Description copied from interface: Pipe

Returns the transformation path to arrive at the current object of the pipe.

Specified by:

getCurrentPath in interface Pipe<S,S>

Overrides:

getCurrentPath in class AbstractPipe<S,S>

Returns:

a List of all of the objects traversed for the current iterator position of the pipe.