org.apache.pig.data

Class BinSedesTupleFactory

java.lang.Object

org.apache.pig.data.TupleFactory

org.apache.pig.data.BinSedesTupleFactory

All Implemented Interfaces:

TupleMaker<Tuple>

Direct Known Subclasses:

DefaultTupleFactory

@InterfaceAudience.Private
public class BinSedesTupleFactory
extends TupleFactory

Default implementation of TupleFactory.

Constructor Summary

Constructors

Constructor and Description
BinSedesTupleFactory()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isFixedSize() This method is used to inspect whether the Tuples created by this factory will be of a fixed size when they are created.
Tuple	newTuple() Create an empty tuple.
Tuple	newTuple(int size) Create a tuple with size fields.
Tuple	newTuple(java.util.List c) Create a tuple from the provided list of objects.
Tuple	newTuple(java.lang.Object datum) Create a tuple with a single element.
Tuple	newTupleNoCopy(java.util.List list) Create a tuple from a provided list of objects, keeping the provided list.
java.lang.Class<? extends Tuple>	tupleClass() Return the actual class representing a tuple that the implementing factory will be returning.
java.lang.Class<? extends TupleRawComparator>	tupleRawComparatorClass() Return the actual class implementing the raw comparator for tuples that the factory will be returning.

Methods inherited from class org.apache.pig.data.TupleFactory

getInstance, resetSelf

Methods inherited from class java.lang.Object

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

Constructor Detail

BinSedesTupleFactory

public BinSedesTupleFactory()

Method Detail

newTuple

public Tuple newTuple()

Description copied from class: TupleFactory

Create an empty tuple. This should be used as infrequently as possible, use newTuple(int) instead.

Specified by:

newTuple in interface TupleMaker<Tuple>

Specified by:

newTuple in class TupleFactory

Returns:

Empty new tuple.

newTuple

public Tuple newTuple(int size)

Description copied from class: TupleFactory

Create a tuple with size fields. Whenever possible this is preferred over the null constructor, as the constructor can preallocate the size of the container holding the fields. Once this is called, it is legal to call Tuple.set(x, object), where x < size.

Specified by:

newTuple in interface TupleMaker<Tuple>

Specified by:

newTuple in class TupleFactory

Parameters:

size - Number of fields in the tuple.

Returns:

Tuple with size fields

newTuple

public Tuple newTuple(java.util.List c)

Description copied from class: TupleFactory

Create a tuple from the provided list of objects. The underlying list will be copied.

Specified by:

newTuple in class TupleFactory

Parameters:

c - List of objects to use as the fields of the tuple.

Returns:

A tuple with the list objects as its fields

newTupleNoCopy

public Tuple newTupleNoCopy(java.util.List list)

Description copied from class: TupleFactory

Create a tuple from a provided list of objects, keeping the provided list. The new tuple will take over ownership of the provided list.

Specified by:

newTupleNoCopy in class TupleFactory

Parameters:

list - List of objects that will become the fields of the tuple.

Returns:

A tuple with the list objects as its fields

newTuple

public Tuple newTuple(java.lang.Object datum)

Description copied from class: TupleFactory

Create a tuple with a single element. This is useful because of the fact that bags (currently) only take tuples, we often end up sticking a single element in a tuple in order to put it in a bag.

Specified by:

newTuple in class TupleFactory

Parameters:

datum - Datum to put in the tuple.

Returns:

A tuple with one field

tupleClass

public java.lang.Class<? extends Tuple> tupleClass()

Description copied from class: TupleFactory

Return the actual class representing a tuple that the implementing factory will be returning. This is needed because Hadoop needs to know the exact class we will be using for input and output.

Specified by:

tupleClass in class TupleFactory

Returns:

Class that implements tuple.

tupleRawComparatorClass

public java.lang.Class<? extends TupleRawComparator> tupleRawComparatorClass()

Description copied from class: TupleFactory

Return the actual class implementing the raw comparator for tuples that the factory will be returning. Ovverride this to allow Hadoop to speed up tuple sorting. The actual returned class should know the serialization details for the tuple. The default implementation (PigTupleDefaultRawComparator) will serialize the data before comparison

Overrides:

tupleRawComparatorClass in class TupleFactory

Returns:

Class that implements tuple raw comparator.

isFixedSize

public boolean isFixedSize()

Description copied from class: TupleFactory

This method is used to inspect whether the Tuples created by this factory will be of a fixed size when they are created. In practical terms, this means whether they support append or not.

Specified by:

isFixedSize in class TupleFactory

Returns:

where the Tuple is fixed or not