cascading.pipe.joiner
Class RightJoin

java.lang.Object
  cascading.pipe.joiner.BaseJoiner
      cascading.pipe.joiner.RightJoin

All Implemented Interfaces:

DeclaresResults, Joiner, Serializable

public class RightJoin
extends BaseJoiner

Class RightJoin will return an RightJoin.JoinIterator that will iterate over a given Joiner and return tuples that represent a left outer, right inner join of the CoGrouper internal grouped tuple collections.

Note only the farthest left tuple stream will be used as the outer join. All following joins to the right will be inner joins. See MixedJoin for more flexibility.

Joins perform based on the equality of the join keys. In the case of null values, Java treats two null values as equivalent. SQL does not treat null values as equal. To produce SQL like results in a given join, a new Comparator will need to be used on the joined values to prevent null from equaling null. As a convenience, see the NullNotEquivalentComparator class.

See Also:

MixedJoin, Serialized Form

Nested Class Summary

static class

RightJoin.JoinIterator

Constructor Summary

RightJoin()

RightJoin(Fields fieldDeclaration)

Method Summary

Iterator<Tuple>	getIterator(JoinerClosure closure) Returns an iterator that joins the given CoGroupClosure co-groups.
int	numJoins() Returns the number of joins this instance can handle.

Methods inherited from class cascading.pipe.joiner.BaseJoiner

getFieldDeclaration

Methods inherited from class java.lang.Object

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

Constructor Detail

RightJoin

public RightJoin()

RightJoin

@ConstructorProperties(value="fieldDeclaration")
public RightJoin(Fields fieldDeclaration)

Method Detail

getIterator

public Iterator<Tuple> getIterator(JoinerClosure closure)

Description copied from interface: Joiner

Returns an iterator that joins the given CoGroupClosure co-groups.

Parameters:

closure - of type GroupClosure

Returns:

an iterator

numJoins

public int numJoins()

Description copied from interface: Joiner

Returns the number of joins this instance can handle. A value of -1 denotes there is no limit.

Returns:

an int