cascading.pipe
Class CoGroup

java.lang.Object
  cascading.pipe.Pipe
      cascading.pipe.Group
          cascading.pipe.CoGroup

All Implemented Interfaces:

FlowElement, Serializable

public class CoGroup
extends Group

The CoGroup pipe allows for two or more tuple streams to join into a single stream.

For every incoming Pipe instance, a Fields instance must be specified that denotes the field names or positions that should be co-grouped with the other given Pipe instances. If the incoming Pipe instances declare one or more field with the same name, the declaredFields must be given to name the outgoing Tuple stream fields to overcome field name collisions.

By default CoGroup performs an inner join via the InnerJoin Joiner class.

See Also:

InnerJoin, OuterJoin, LeftJoin, RightJoin, MixedJoin, Serialized Form

Field Summary

Fields inherited from class cascading.pipe.Group

declaredFields, groupFieldsMap, sortFieldsMap

Fields inherited from class cascading.pipe.Pipe

previous

Constructor Summary

CoGroup(Pipe... pipes)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(Pipe[] pipes, Fields[] groupFields)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(Pipe[] pipes, Fields[] groupFields, Fields declaredFields, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(Pipe pipe, Fields groupFields, int repeat)
Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

CoGroup(Pipe pipe, Fields groupFields, int repeat, Fields declaredFields)
Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

CoGroup(Pipe pipe, Fields groupFields, int repeat, Fields declaredFields, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

CoGroup(Pipe pipe, Fields groupFields, int repeat, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

CoGroup(Pipe lhs, Fields lhsGroupFields, Pipe rhs, Fields rhsGroupFields)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(Pipe lhs, Fields lhsGroupFields, Pipe rhs, Fields rhsGroupFields, Fields declaredFields)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(Pipe lhs, Fields lhsGroupFields, Pipe rhs, Fields rhsGroupFields, Fields declaredFields, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(Pipe lhs, Fields lhsGroupFields, Pipe rhs, Fields rhsGroupFields, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(String groupName, Pipe... pipes)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(String groupName, Pipe[] pipes, Fields[] groupFields)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(String groupName, Pipe[] pipes, Fields[] groupFields, Fields declaredFields)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(String groupName, Pipe[] pipes, Fields[] groupFields, Fields declaredFields, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(String groupName, Pipe pipe, Fields groupFields, int repeat)
Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

CoGroup(String groupName, Pipe pipe, Fields groupFields, int repeat, Fields declaredFields)
Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

CoGroup(String groupName, Pipe pipe, Fields groupFields, int repeat, Fields declaredFields, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

CoGroup(String groupName, Pipe pipe, Fields groupFields, int repeat, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

CoGroup(String groupName, Pipe lhs, Fields lhsGroupFields, Pipe rhs, Fields rhsGroupFields)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(String groupName, Pipe lhs, Fields lhsGroupFields, Pipe rhs, Fields rhsGroupFields, Fields declaredFields)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(String groupName, Pipe lhs, Fields lhsGroupFields, Pipe rhs, Fields rhsGroupFields, Fields declaredFields, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance.

CoGroup(String groupName, Pipe lhs, Fields lhsGroupFields, Pipe rhs, Fields rhsGroupFields, Joiner joiner)
Constructor CoGroup creates a new CoGroup instance.

Method Summary

Methods inherited from class cascading.pipe.Group

collectReduceGrouping, equals, getDeclaredFields, getGroupingSelectors, getName, getPrevious, getSortingSelectors, hashCode, isGroupBy, isSorted, isSortReversed, iterateReduceValues, outgoingScopeFor, printInternal, resolveFields, toString, unwrapGrouping

Methods inherited from class cascading.pipe.Pipe

getHeads, getTrace, pipes, print, resolveIncomingOperationFields

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CoGroup

public CoGroup(Pipe lhs,
               Fields lhsGroupFields,
               Pipe rhs,
               Fields rhsGroupFields,
               Fields declaredFields)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

lhs - of type Pipe

lhsGroupFields - of type Fields

rhs - of type Pipe

rhsGroupFields - of type Fields

declaredFields - of type Fields

CoGroup

public CoGroup(Pipe lhs,
               Fields lhsGroupFields,
               Pipe rhs,
               Fields rhsGroupFields,
               Fields declaredFields,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

lhs - of type Pipe

lhsGroupFields - of type Fields

rhs - of type Pipe

rhsGroupFields - of type Fields

declaredFields - of type Fields

joiner - of type CoGrouper

CoGroup

public CoGroup(Pipe lhs,
               Fields lhsGroupFields,
               Pipe rhs,
               Fields rhsGroupFields,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

lhs - of type Pipe

lhsGroupFields - of type Fields

rhs - of type Pipe

rhsGroupFields - of type Fields

joiner - of type CoGrouper

CoGroup

public CoGroup(Pipe lhs,
               Fields lhsGroupFields,
               Pipe rhs,
               Fields rhsGroupFields)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

lhs - of type Pipe

lhsGroupFields - of type Fields

rhs - of type Pipe

rhsGroupFields - of type Fields

CoGroup

public CoGroup(Pipe... pipes)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

pipes - of type Pipe...

CoGroup

public CoGroup(Pipe[] pipes,
               Fields[] groupFields)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

pipes - of type Pipe[]

groupFields - of type Fields[]

CoGroup

public CoGroup(Pipe[] pipes,
               Fields[] groupFields,
               Fields declaredFields,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

pipes - of type Pipe[]

groupFields - of type Fields[]

declaredFields - of type Fields

joiner - of type CoGrouper

CoGroup

public CoGroup(String groupName,
               Pipe[] pipes,
               Fields[] groupFields)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

groupName - of type String

pipes - of type Pipe[]

groupFields - of type Fields[]

CoGroup

public CoGroup(String groupName,
               Pipe[] pipes,
               Fields[] groupFields,
               Fields declaredFields)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

groupName - of type String

pipes - of type Pipe[]

groupFields - of type Fields[]

declaredFields - of type Fields

CoGroup

public CoGroup(String groupName,
               Pipe[] pipes,
               Fields[] groupFields,
               Fields declaredFields,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

groupName - of type String

pipes - of type Pipe[]

groupFields - of type Fields[]

declaredFields - of type Fields

joiner - of type CoGrouper

CoGroup

public CoGroup(String groupName,
               Pipe lhs,
               Fields lhsGroupFields,
               Pipe rhs,
               Fields rhsGroupFields,
               Fields declaredFields)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

groupName - of type String

lhs - of type Pipe

lhsGroupFields - of type Fields

rhs - of type Pipe

rhsGroupFields - of type Fields

declaredFields - of type Fields

CoGroup

public CoGroup(String groupName,
               Pipe lhs,
               Fields lhsGroupFields,
               Pipe rhs,
               Fields rhsGroupFields,
               Fields declaredFields,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

groupName - of type String

lhs - of type Pipe

lhsGroupFields - of type Fields

rhs - of type Pipe

rhsGroupFields - of type Fields

declaredFields - of type Fields

joiner - of type CoGrouper

CoGroup

public CoGroup(String groupName,
               Pipe lhs,
               Fields lhsGroupFields,
               Pipe rhs,
               Fields rhsGroupFields,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

groupName - of type String

lhs - of type Pipe

lhsGroupFields - of type Fields

rhs - of type Pipe

rhsGroupFields - of type Fields

joiner - of type CoGrouper

CoGroup

public CoGroup(String groupName,
               Pipe lhs,
               Fields lhsGroupFields,
               Pipe rhs,
               Fields rhsGroupFields)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

groupName - of type String

lhs - of type Pipe

lhsGroupFields - of type Fields

rhs - of type Pipe

rhsGroupFields - of type Fields

CoGroup

public CoGroup(String groupName,
               Pipe... pipes)

Constructor CoGroup creates a new CoGroup instance.

Parameters:

groupName - of type String

pipes - of type Pipe...

CoGroup

public CoGroup(Pipe pipe,
               Fields groupFields,
               int repeat,
               Fields declaredFields)

Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

Parameters:

pipe - of type Pipe

groupFields - of type Fields

repeat - of type int

declaredFields - of type Fields

CoGroup

public CoGroup(Pipe pipe,
               Fields groupFields,
               int repeat,
               Fields declaredFields,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

Parameters:

pipe - of type Pipe

groupFields - of type Fields

repeat - of type int

declaredFields - of type Fields

joiner - of type CoGrouper

CoGroup

public CoGroup(Pipe pipe,
               Fields groupFields,
               int repeat,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

Parameters:

pipe - of type Pipe

groupFields - of type Fields

repeat - of type int

joiner - of type CoGrouper

CoGroup

public CoGroup(Pipe pipe,
               Fields groupFields,
               int repeat)

Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

Parameters:

pipe - of type Pipe

groupFields - of type Fields

repeat - of type int

CoGroup

public CoGroup(String groupName,
               Pipe pipe,
               Fields groupFields,
               int repeat,
               Fields declaredFields)

Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

Parameters:

groupName - of type String

pipe - of type Pipe

groupFields - of type Fields

repeat - of type int

declaredFields - of type Fields

CoGroup

public CoGroup(String groupName,
               Pipe pipe,
               Fields groupFields,
               int repeat,
               Fields declaredFields,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

Parameters:

groupName - of type String

pipe - of type Pipe

groupFields - of type Fields

repeat - of type int

declaredFields - of type Fields

joiner - of type CoGrouper

CoGroup

public CoGroup(String groupName,
               Pipe pipe,
               Fields groupFields,
               int repeat,
               Joiner joiner)

Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

Parameters:

groupName - of type String

pipe - of type Pipe

groupFields - of type Fields

repeat - of type int

joiner - of type CoGrouper

CoGroup

public CoGroup(String groupName,
               Pipe pipe,
               Fields groupFields,
               int repeat)

Constructor CoGroup creates a new CoGroup instance that performs repeat number of self joins on the given Pipe instance.

Parameters:

groupName - of type String

pipe - of type Pipe

groupFields - of type Fields

repeat - of type int