org.galagosearch.tupleflow.execution
Enum ConnectionAssignmentType

java.lang.Object
  java.lang.Enum<ConnectionAssignmentType>
      org.galagosearch.tupleflow.execution.ConnectionAssignmentType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConnectionAssignmentType>

public enum ConnectionAssignmentType
extends java.lang.Enum<ConnectionAssignmentType>

This specifies how input data should be assigned to outputs in a TupleFlow connection.

If a connection output has the "Combined" assignment, that means that each stage instance reading that output will recieve all of the input data. This is the right kind of assignment to use when writing out a single index file, for instance, where you want all the data that was genereated by lots of parsing stage instances.

The "Each" mode means that every output stage instance gets exactly one of the output streams. Notice that a connection can be hashed, so this doesn't necessarily imply a 1-to-1 mapping between inputs and outputs. This is what you want to use when you're trying to distribute data broadly across a cluster of machines.

The "One" mode is not yet supported. The "One" mode, when implemented, will allow each different named output to recieve exactly one share of the input data. The main use case for this is to support building document-distributed indexes.

Author:

trevor

See Also:

Connection, Job

Enum Constant Summary

Combined

Each

One

Method Summary

static ConnectionAssignmentType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConnectionAssignmentType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

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

Enum Constant Detail

Each

public static final ConnectionAssignmentType Each

One

public static final ConnectionAssignmentType One

Combined

public static final ConnectionAssignmentType Combined

Method Detail

values

public static final ConnectionAssignmentType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(ConnectionAssignmentType c : ConnectionAssignmentType.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static ConnectionAssignmentType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name