com.twitter.scalding

RichPipe

class RichPipe extends Serializable with JoinAlgorithms

go to: companion
linear super types: JoinAlgorithms, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. RichPipe
  2. JoinAlgorithms
  3. Serializable
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new RichPipe (pipe: Pipe)

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def ++ (that: Pipe) : Merge

    Merge or Concatenate several pipes together with this one:

    Merge or Concatenate several pipes together with this one:

  7. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  8. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  9. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  10. def blockJoinWithSmaller (fs: (Fields, Fields), otherPipe: Pipe, rightReplication: Int =1, leftReplication: Int =1, joiner: Joiner = ..., reducers: Int =-1) : Pipe

    definition classes: JoinAlgorithms
  11. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  12. def coGroupBy (f: Fields, j: JoinMode = ...)(builder: (CoGroupBuilder) ⇒ GroupBuilder) : Pipe

    This method is used internally to implement all joins.

    This method is used internally to implement all joins. You can use this directly if you want to implement something like a star join, e.g., when joining a single pipe to multiple other pipes. Make sure that you call this method on the larger pipe to make the grouping as efficient as possible.

    If you are only joining two pipes, then you are better off using joinWithSmaller/joinWithLarger/joinWithTiny/leftJoinWithTiny.

    definition classes: JoinAlgorithms
  13. def crossWithTiny (tiny: Pipe) : Each

    definition classes: JoinAlgorithms
  14. def debug : Each

  15. def discard (f: Fields) : Each

  16. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  17. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  18. def filter [A] (f: Fields)(fn: (A) ⇒ Boolean)(implicit conv: TupleConverter[A]) : Pipe

  19. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  20. def flatMap [A, T] (fs: (Fields, Fields))(fn: (A) ⇒ Iterable[T])(implicit conv: TupleConverter[A], setter: TupleSetter[T]) : Pipe

  21. def flatMapTo [A, T] (fs: (Fields, Fields))(fn: (A) ⇒ Iterable[T])(implicit conv: TupleConverter[A], setter: TupleSetter[T]) : Pipe

  22. def flatten [T] (fs: (Fields, Fields))(implicit conv: TupleConverter[Iterable[T]], setter: TupleSetter[T]) : Pipe

  23. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  24. def groupAll (gs: (GroupBuilder) ⇒ GroupBuilder) : Each

  25. def groupAll : Pipe

  26. def groupBy (f: Fields)(builder: (GroupBuilder) ⇒ GroupBuilder) : Pipe

  27. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  28. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  29. def joinWithLarger (fs: (Fields, Fields), that: Pipe, joiner: Joiner = ..., reducers: Int =-1) : Pipe

    definition classes: JoinAlgorithms
  30. def joinWithSmaller (fs: (Fields, Fields), that: Pipe, joiner: Joiner = ..., reducers: Int =-1) : Pipe

    joins the first set of keys in the first pipe to the second set of keys in the second pipe.

    joins the first set of keys in the first pipe to the second set of keys in the second pipe. All keys must be unique UNLESS it is an inner join, then duplicated join keys are allowed, but the second copy is deleted (as cascading does not allow duplicated field names).

    Avoid going crazy adding more explicit join modes. Instead do for some other join mode with a larger pipe: .then { pipe => other. joinWithSmaller(('other1, 'other2)->('this1, 'this2), pipe, new FancyJoin) }

    definition classes: JoinAlgorithms
  31. def joinWithTiny (fs: (Fields, Fields), that: Pipe) : Pipe

    This does an assymmetric join, using cascading's "Join".

    This does an assymmetric join, using cascading's "Join". This only runs through this pipe once, and keeps the right hand side pipe in memory (but is spillable).

    joins the first set of keys in the first pipe to the second set of keys in the second pipe. All keys must be unique UNLESS it is an inner join, then duplicated join keys are allowed, but the second copy is deleted (as cascading does not allow duplicated field names).

    WARNING: this does not work with outer joins, or right joins, only inner and left join versions are given.

    definition classes: JoinAlgorithms
  32. def joinerToJoinModes (j: Joiner) : (Product with JoinMode, Product with JoinMode)

    definition classes: JoinAlgorithms
  33. def leftJoinWithLarger (fs: (Fields, Fields), that: Pipe, reducers: Int =-1) : Pipe

    definition classes: JoinAlgorithms
  34. def leftJoinWithSmaller (fs: (Fields, Fields), that: Pipe, reducers: Int =-1) : Pipe

    definition classes: JoinAlgorithms
  35. def leftJoinWithTiny (fs: (Fields, Fields), that: Pipe) : HashJoin

    definition classes: JoinAlgorithms
  36. def limit (n: Long) : Each

  37. def map [A, T] (fs: (Fields, Fields))(fn: (A) ⇒ T)(implicit conv: TupleConverter[A], setter: TupleSetter[T]) : Pipe

  38. def mapTo [A, T] (fs: (Fields, Fields))(fn: (A) ⇒ T)(implicit conv: TupleConverter[A], setter: TupleSetter[T]) : Pipe

  39. def name (s: String) : Pipe

  40. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  41. def normalize (f: Symbol) : Pipe

  42. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  43. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  44. def pack [T] (fs: (Fields, Fields))(implicit packer: TuplePacker[T], setter: TupleSetter[T]) : Pipe

    Maps the input fields into an output field of type T.

    Maps the input fields into an output field of type T. For example:

    pipe.pack[(Int, Int)] (('field1, 'field2) -> 'field3)

    will pack fields 'field1 and 'field2 to field 'field3, as long as 'field1 and 'field2 can be cast into integers. The output field 'field3 will be of tupe (Int, Int)

  45. def packTo [T] (fs: (Fields, Fields))(implicit packer: TuplePacker[T], setter: TupleSetter[T]) : Pipe

    Same as pack but only the to fields are preserved.

    Same as pack but only the to fields are preserved.

  46. val pipe : Pipe

    definition classes: RichPipeJoinAlgorithms
  47. def project (fields: Fields) : Each

  48. def rename (fields: (Fields, Fields)) : Pipe

    Rename some set of N fields as another set of N fields usage: rename('x -> 'z) rename(('x,'y) -> ('X,'Y)) WARNING: rename('x,'y) is interpreted by scala as rename(Tuple2('x,'y)) which then does rename('x -> 'y).

    Rename some set of N fields as another set of N fields usage: rename('x -> 'z) rename(('x,'y) -> ('X,'Y)) WARNING: rename('x,'y) is interpreted by scala as rename(Tuple2('x,'y)) which then does rename('x -> 'y). This is probably not what is intended but the compiler doesn't resolve the ambiguity. YOU MUST CALL THIS WITH A TUPLE2!!!!! If you don't, expect the unexpected.

  49. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  50. def then [T, U] (pfn: (T) ⇒ U)(implicit in: (RichPipe) ⇒ T, out: (U) ⇒ Pipe) : Pipe

  51. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  52. def unique (f: Fields) : Pipe

  53. def unpack [T] (fs: (Fields, Fields))(implicit unpacker: TupleUnpacker[T], conv: TupleConverter[T]) : Pipe

    The opposite of pack.

    The opposite of pack. Unpacks the input field of type T into the output fields. For example:

    pipe.unpack[(Int, Int)] ('field1 -> ('field2, 'field3))

    will unpack 'field1 into 'field2 and 'field3

  54. def unpackTo [T] (fs: (Fields, Fields))(implicit unpacker: TupleUnpacker[T], conv: TupleConverter[T]) : Pipe

    Same as unpack but only the to fields are preserved.

    Same as unpack but only the to fields are preserved.

  55. def unpivot (fieldDef: (Fields, Fields)) : Pipe

    This is an analog of the SQL/Excel unpivot function which converts columns of data into rows of data.

    This is an analog of the SQL/Excel unpivot function which converts columns of data into rows of data. Only the columns given as input fields are expanded in this way. For this operation to be reversible, you need to keep some unique key on each row. See GroupBuilder.pivot to reverse this operation assuming you leave behind a grouping key Example: pipe.unpivot(('w,'x,'y,'z) -> ('feature, 'value)) takes rows like: key, w, x, y, z 1, 2, 3, 4, 5 2, 8, 7, 6, 5 to: key, feature, value 1, w, 2 1, x, 3 1, y, 4 etc...

  56. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  57. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  58. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  59. def write (outsource: Source)(implicit flowDef: FlowDef, mode: Mode) : Pipe

Inherited from JoinAlgorithms

Inherited from Serializable

Inherited from AnyRef

Inherited from Any