org.apache.pig.pen.util
Class ExampleTuple

java.lang.Object
  org.apache.pig.pen.util.ExampleTuple

All Implemented Interfaces:

Serializable, Comparable, org.apache.hadoop.io.Writable, org.apache.hadoop.io.WritableComparable, Tuple

public class ExampleTuple
extends Object
implements Tuple

See Also:

Serialized Form

Field Summary

boolean	omittable
boolean	synthetic

Fields inherited from interface org.apache.pig.data.Tuple

NOTNULL, NULL

Constructor Summary

ExampleTuple()

ExampleTuple(Object expr)

ExampleTuple(Tuple t)

Method Summary

void	append(Object val) Append a field to a tuple.
int	compareTo(Object o)
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.
long	getMemorySize() Determine the size of tuple in memory.
byte	getType(int fieldNum) Find the type of a given field.
boolean	isNull() Determine if this entire tuple (not any particular field) is null.
boolean	isNull(int fieldNum) Find out if a given field is null.
void	readFields(DataInput in)
void	reference(Tuple t) Make this tuple reference the contents of another.
void	set(int fieldNum, Object val) Set the value in a given field.
void	setNull(boolean isNull) Mark this entire tuple as null or not null.
int	size() Find the size of the tuple.
String	toDelimitedString(String delim) Write a tuple of atomic values into a string.
String	toString()
Tuple	toTuple()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

synthetic

public boolean synthetic

omittable

public boolean omittable

Constructor Detail

ExampleTuple

public ExampleTuple()

ExampleTuple

public ExampleTuple(Object expr)

ExampleTuple

public ExampleTuple(Tuple t)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

toTuple

public Tuple toTuple()

append

public void append(Object val)

Description copied from interface: Tuple

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 TupleFactory.newTuple(int) and then fill in the values with Tuple.set(int, Object), rather than construct it with TupleFactory.newTuple() and append values.

Specified by:

append in interface Tuple

Parameters:

val - Object to append to the tuple.

get

public Object get(int fieldNum)
           throws ExecException

Description copied from interface: Tuple

Get the value in a given field.

Specified by:

get in interface Tuple

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()

Description copied from interface: Tuple

Get all of the fields in the tuple as a list.

Specified by:

getAll in interface Tuple

Returns:

a list of objects containing the fields of the tuple in order.

getMemorySize

public long getMemorySize()

Description copied from interface: Tuple

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.

Specified by:

getMemorySize in interface Tuple

Returns:

estimated memory size, in bytes.

getType

public byte getType(int fieldNum)
             throws ExecException

Description copied from interface: Tuple

Find the type of a given field.

Specified by:

getType in interface Tuple

Parameters:

fieldNum - Number of field to get the type for.

Returns:

type, encoded as a byte value. The values are defined in DataType. If the field is null, then DataType.UNKNOWN will be returned.

Throws:

ExecException - if the field number is greater than or equal to the number of fields in the tuple.

isNull

public boolean isNull(int fieldNum)
               throws ExecException

Description copied from interface: Tuple

Find out if a given field is null.

Specified by:

isNull in interface Tuple

Parameters:

fieldNum - Number of field to check for null.

Returns:

true if the field is null, false otherwise.

Throws:

ExecException - if the field number given is greater than or equal to the number of fields in the tuple.

isNull

public boolean isNull()

Description copied from interface: Tuple

Determine if this entire tuple (not any particular field) is null.

Specified by:

isNull in interface Tuple

Returns:

true if this Tuple is null

reference

public void reference(Tuple t)

Description copied from interface: Tuple

Make this tuple reference the contents of another. This method does not copy the underlying data. It maintains references to the data from the original tuple (and possibly even to the data structure holding the data).

Specified by:

reference in interface Tuple

Parameters:

t - Tuple to reference.

set

public void set(int fieldNum,
                Object val)
         throws ExecException

Description copied from interface: Tuple

Set the value in a given field. This should not be called unless the tuple was constructed by TupleFactory.newTuple(int) with an argument greater than the fieldNum being passed here. This call will not automatically expand the tuple size. That is if you called TupleFactory.newTuple(int) with a 2, it is okay to call this function with a 1, but not with a 2 or greater.

Specified by:

set in interface Tuple

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.

setNull

public void setNull(boolean isNull)

Description copied from interface: Tuple

Mark this entire tuple as null or not null.

Specified by:

setNull in interface Tuple

Parameters:

isNull - boolean indicating whether this tuple is null

size

public int size()

Description copied from interface: Tuple

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

Specified by:

size in interface Tuple

Returns:

number of fields in the tuple.

toDelimitedString

public String toDelimitedString(String delim)
                         throws ExecException

Description copied from interface: Tuple

Write a tuple of atomic values into a string. All values in the tuple must be atomic (no bags, tuples, or maps).

Specified by:

toDelimitedString in interface Tuple

Parameters:

delim - Delimiter to use in the string.

Returns:

A string containing the tuple.

Throws:

ExecException - if a non-atomic value is found.

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable