org.apache.hawq.pxf.service.io

Class GPDBWritable

java.lang.Object

org.apache.hawq.pxf.service.io.GPDBWritable

All Implemented Interfaces:

Writable

public class GPDBWritable
extends java.lang.Object
implements Writable

This class represents a GPDB record in the form of a Java object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GPDBWritable.TypeMismatchException An exception class for column type definition and set/get value mismatch.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	alignmentOfEightBytes
protected int[]	colType
protected java.lang.Object[]	colValue
protected byte	errorFlag
protected int	pktlen

Constructor Summary

Constructors

Constructor and Description
GPDBWritable() Empty Constructor
GPDBWritable(byte[] data) Constructor to build a db record from a serialized form.
GPDBWritable(int[] columnType) Constructor to build a db record.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getBoolean(int colIdx) Gets the column value of the record.
byte[]	getBytes(int colIdx) Gets the column value of the record.
int[]	getColType()
java.lang.Double	getDouble(int colIdx) Gets the column value of the record.
java.lang.Float	getFloat(int colIdx) Gets the column value of the record.
java.lang.Integer	getInt(int colIdx) Gets the column value of the record.
java.lang.Long	getLong(int colIdx) Gets the column value of the record.
java.lang.Short	getShort(int colIdx) Gets the column value of the record.
java.lang.String	getString(int colIdx) Gets the column value of the record.
static java.lang.String	getTypeName(int oid) Helper to get the type name.
boolean	isEmpty() Returns if the writable object is empty, based on the pkt len as read from stream.
void	readFields(java.io.DataInput in) Deserialize the fields of this object from in.
void	setBoolean(int colIdx, java.lang.Boolean val) Sets the column value of the record.
void	setBytes(int colIdx, byte[] val) Sets the column value of the record.
void	setDouble(int colIdx, java.lang.Double val) Sets the column value of the record.
void	setError(boolean errorVal) Sets the error field.
void	setFloat(int colIdx, java.lang.Float val) Sets the column value of the record.
void	setInt(int colIdx, java.lang.Integer val) Sets the column value of the record.
void	setLong(int colIdx, java.lang.Long val) Sets the column value of the record.
void	setShort(int colIdx, java.lang.Short val) Sets the column value of the record.
void	setString(int colIdx, java.lang.String val) Sets the column value of the record.
java.lang.String	toString() Returns a string representation of the object.
void	write(java.io.DataOutput out) Serialize the fields of this object to out.

Methods inherited from class java.lang.Object

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

Field Detail

colType

protected int[] colType

colValue

protected java.lang.Object[] colValue

alignmentOfEightBytes

protected int alignmentOfEightBytes

errorFlag

protected byte errorFlag

pktlen

protected int pktlen

Constructor Detail

GPDBWritable

public GPDBWritable()

Empty Constructor

GPDBWritable

public GPDBWritable(int[] columnType)

Constructor to build a db record. colType defines the schema

Parameters:

columnType - the table column types

GPDBWritable

public GPDBWritable(byte[] data)
             throws java.io.IOException

Constructor to build a db record from a serialized form.

Parameters:

data - a record in the serialized form

Throws:

java.io.IOException - if the data is malformatted.

Method Detail

getColType

public int[] getColType()

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Description copied from interface: Writable

Deserialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Parameters:

in - DataInput to deserialize this object from.

Throws:

java.io.IOException - if I/O error occurs

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Description copied from interface: Writable

Serialize the fields of this object to out.

Specified by:

write in interface Writable

Parameters:

out - DataOutput to serialize this object into.

Throws:

java.io.IOException - if I/O error occurs

setLong

public void setLong(int colIdx,
                    java.lang.Long val)
             throws GPDBWritable.TypeMismatchException

Sets the column value of the record.

Parameters:

colIdx - the column index

val - the value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

setBoolean

public void setBoolean(int colIdx,
                       java.lang.Boolean val)
                throws GPDBWritable.TypeMismatchException

Sets the column value of the record.

Parameters:

colIdx - the column index

val - the value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

setBytes

public void setBytes(int colIdx,
                     byte[] val)
              throws GPDBWritable.TypeMismatchException

Sets the column value of the record.

Parameters:

colIdx - the column index

val - the value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

setString

public void setString(int colIdx,
                      java.lang.String val)
               throws GPDBWritable.TypeMismatchException

Sets the column value of the record.

Parameters:

colIdx - the column index

val - the value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

setFloat

public void setFloat(int colIdx,
                     java.lang.Float val)
              throws GPDBWritable.TypeMismatchException

Sets the column value of the record.

Parameters:

colIdx - the column index

val - the value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

setDouble

public void setDouble(int colIdx,
                      java.lang.Double val)
               throws GPDBWritable.TypeMismatchException

Sets the column value of the record.

Parameters:

colIdx - the column index

val - the value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

setInt

public void setInt(int colIdx,
                   java.lang.Integer val)
            throws GPDBWritable.TypeMismatchException

Sets the column value of the record.

Parameters:

colIdx - the column index

val - the value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

setShort

public void setShort(int colIdx,
                     java.lang.Short val)
              throws GPDBWritable.TypeMismatchException

Sets the column value of the record.

Parameters:

colIdx - the column index

val - the value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

getLong

public java.lang.Long getLong(int colIdx)
                       throws GPDBWritable.TypeMismatchException

Gets the column value of the record.

Parameters:

colIdx - the column index

Returns:

column value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

getBoolean

public java.lang.Boolean getBoolean(int colIdx)
                             throws GPDBWritable.TypeMismatchException

Gets the column value of the record.

Parameters:

colIdx - the column index

Returns:

column value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

getBytes

public byte[] getBytes(int colIdx)
                throws GPDBWritable.TypeMismatchException

Gets the column value of the record.

Parameters:

colIdx - the column index

Returns:

column value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

getString

public java.lang.String getString(int colIdx)
                           throws GPDBWritable.TypeMismatchException

Gets the column value of the record.

Parameters:

colIdx - the column index

Returns:

column value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

getFloat

public java.lang.Float getFloat(int colIdx)
                         throws GPDBWritable.TypeMismatchException

Gets the column value of the record.

Parameters:

colIdx - the column index

Returns:

column value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

getDouble

public java.lang.Double getDouble(int colIdx)
                           throws GPDBWritable.TypeMismatchException

Gets the column value of the record.

Parameters:

colIdx - the column index

Returns:

column value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

getInt

public java.lang.Integer getInt(int colIdx)
                         throws GPDBWritable.TypeMismatchException

Gets the column value of the record.

Parameters:

colIdx - the column index

Returns:

column value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

getShort

public java.lang.Short getShort(int colIdx)
                         throws GPDBWritable.TypeMismatchException

Gets the column value of the record.

Parameters:

colIdx - the column index

Returns:

column value

Throws:

GPDBWritable.TypeMismatchException - the column type does not match

setError

public void setError(boolean errorVal)

Sets the error field.

Parameters:

errorVal - the error value

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

getTypeName

public static java.lang.String getTypeName(int oid)

Helper to get the type name. If a given oid is not in the commonly used list, we would expect a TEXT for it (for the error message).

Parameters:

oid - type OID

Returns:

type name

isEmpty

public boolean isEmpty()

Returns if the writable object is empty, based on the pkt len as read from stream. -1 means nothing was read (eof).

Returns:

whether the writable object is empty