org.apache.pig.data
Class DefaultTuple

java.lang.Object
  extended by org.apache.pig.data.AbstractTuple
      extended by org.apache.pig.data.DefaultTuple
All Implemented Interfaces:
Serializable, Comparable, Iterable<Object>, org.apache.hadoop.io.Writable, org.apache.hadoop.io.WritableComparable, Tuple
Direct Known Subclasses:
AmendableTuple, BinSedesTuple, DefaultAbstractBag.BagDelimiterTuple, TimestampedTuple

public class DefaultTuple
extends AbstractTuple

A default implementation of Tuple. This class will be created by the DefaultTupleFactory.

See Also:
Serialized Form

Nested Class Summary
static class DefaultTuple.DefaultTupleRawComparator
           
 
Field Summary
protected  boolean isNull
           
protected  List<Object> mFields
           
 
Fields inherited from interface org.apache.pig.data.Tuple
NOTNULL, NULL
 
Constructor Summary
DefaultTuple()
          Default constructor.
 
Method Summary
 void append(Object val)
          Append a field to a tuple.
 int compareTo(Object other)
           
 Object get(int fieldNum)
          Get the value in a given field.
 List<Object> getAll()
          Get all of the fields in the tuple as a list.
static Class<? extends TupleRawComparator> getComparatorClass()
           
 long getMemorySize()
          Determine the size of tuple in memory.
 int hashCode()
           
 void readFields(DataInput in)
           
 void set(int fieldNum, Object val)
          Set the value in a given field.
 int size()
          Find the size of the tuple.
 void write(DataOutput out)
           
 
Methods inherited from class org.apache.pig.data.AbstractTuple
equals, getType, isNull, iterator, reference, toDelimitedString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

isNull

protected boolean isNull

mFields

protected List<Object> mFields
Constructor Detail

DefaultTuple

public DefaultTuple()
Default constructor. This constructor is public so that hadoop can call it directly. However, inside pig you should never be calling this function. Use TupleFactory instead.
Time complexity: O(1), after allocation

Method Detail

size

public int size()
Find the size of the tuple. Used to be called arity().

Returns:
number of fields in the tuple.

get

public Object get(int fieldNum)
           throws ExecException
Get the value in a given field.

Parameters:
fieldNum - Number of the field to get the value for.
Returns:
value, as an Object.
Throws:
ExecException - if the field number is greater than or equal to the number of fields in the tuple.

getAll

public List<Object> getAll()
Get all of the fields in the tuple as a list.

Returns:
List<Object> containing the fields of the tuple in order.

set

public void set(int fieldNum,
                Object val)
         throws ExecException
Set the value in a given field.

Parameters:
fieldNum - Number of the field to set the value for.
val - Object to put in the indicated field.
Throws:
ExecException - if the field number is greater than or equal to the number of fields in the tuple.

append

public void append(Object val)
Append a field to a tuple. This method is not efficient as it may force copying of existing data in order to grow the data structure. Whenever possible you should construct your Tuple with the newTuple(int) method and then fill in the values with set(), rather than construct it with newTuple() and append values.

Parameters:
val - Object to append to the tuple.

getMemorySize

public long getMemorySize()
Determine the size of tuple in memory. This is used by data bags to determine their memory size. This need not be exact, but it should be a decent estimation.

Returns:
estimated memory size.

compareTo

public int compareTo(Object other)

hashCode

public int hashCode()
Overrides:
hashCode in class Object

write

public void write(DataOutput out)
           throws IOException
Throws:
IOException

readFields

public void readFields(DataInput in)
                throws IOException
Throws:
IOException

getComparatorClass

public static Class<? extends TupleRawComparator> getComparatorClass()


Copyright © 2007-2012 The Apache Software Foundation