org.apache.hadoop.hive.serde2.thrift
Class TCTLSeparatedProtocol

java.lang.Object
  org.apache.thrift.protocol.TProtocol
      org.apache.hadoop.hive.serde2.thrift.TCTLSeparatedProtocol

All Implemented Interfaces:

ConfigurableTProtocol, SkippableTProtocol, WriteNullsProtocol

public class TCTLSeparatedProtocol
extends org.apache.thrift.protocol.TProtocol
implements ConfigurableTProtocol, WriteNullsProtocol, SkippableTProtocol

An implementation of the Thrift Protocol for ctl separated records. This is not thrift compliant in that it doesn't write out field ids so things cannot actually be versioned.

Nested Class Summary

static class

TCTLSeparatedProtocol.Factory Factory for JSON protocol objects.

Field Summary

static String	BufferSizeKey
static String	ReturnNullsKey Strings used to lookup the various configurable paramaters of this protocol.

Constructor Summary

TCTLSeparatedProtocol(org.apache.thrift.transport.TTransport trans)
The simple constructor which assumes ctl-a, ctl-b and '\n' separators and to return empty strings for empty fields.

TCTLSeparatedProtocol(org.apache.thrift.transport.TTransport trans, int buffer_size)

TCTLSeparatedProtocol(org.apache.thrift.transport.TTransport trans, String primarySeparator, String secondarySeparator, String mapSeparator, String rowSeparator, boolean returnNulls, int bufferSize)

Method Summary

String	getMapSeparator()
String	getPrimarySeparator() Inspect the separators this instance is configured with.
String	getRowSeparator()
String	getSecondarySeparator()
void	initialize(org.apache.hadoop.conf.Configuration conf, Properties tbl) Initialize the TProtocol.
void	internalWriteString(String str)
boolean	lastPrimitiveWasNull() Was the last primitive read really a NULL.
ByteBuffer	readBinary()
boolean	readBool()
byte	readByte()
double	readDouble()
org.apache.thrift.protocol.TField	readFieldBegin()
void	readFieldEnd()
short	readI16()
int	readI32()
long	readI64()
org.apache.thrift.protocol.TList	readListBegin()
void	readListEnd()
org.apache.thrift.protocol.TMap	readMapBegin()
void	readMapEnd()
org.apache.thrift.protocol.TMessage	readMessageBegin()
void	readMessageEnd()
org.apache.thrift.protocol.TSet	readSetBegin()
void	readSetEnd()
String	readString()
org.apache.thrift.protocol.TStruct	readStructBegin()
void	readStructEnd()
void	skip(byte type) Skip past the current field Just increments the field index counter.
void	writeBinary(ByteBuffer bin)
void	writeBool(boolean b)
void	writeByte(byte b)
void	writeDouble(double dub)
void	writeFieldBegin(org.apache.thrift.protocol.TField field)
void	writeFieldEnd()
void	writeFieldStop()
void	writeI16(short i16)
void	writeI32(int i32)
void	writeI64(long i64)
void	writeListBegin(org.apache.thrift.protocol.TList list)
void	writeListEnd()
void	writeMapBegin(org.apache.thrift.protocol.TMap map)
void	writeMapEnd()
void	writeMessageBegin(org.apache.thrift.protocol.TMessage message)
void	writeMessageEnd()
void	writeNull() Write a null.
void	writeSetBegin(org.apache.thrift.protocol.TSet set)
void	writeSetEnd()
void	writeString(String str)
void	writeStructBegin(org.apache.thrift.protocol.TStruct struct)
void	writeStructEnd()

Methods inherited from class org.apache.thrift.protocol.TProtocol

getScheme, getTransport, reset

Methods inherited from class java.lang.Object

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

Field Detail

ReturnNullsKey

public static final String ReturnNullsKey

Strings used to lookup the various configurable paramaters of this protocol.

See Also:

Constant Field Values

BufferSizeKey

public static final String BufferSizeKey

See Also:

Constant Field Values

Constructor Detail

TCTLSeparatedProtocol

public TCTLSeparatedProtocol(org.apache.thrift.transport.TTransport trans)

The simple constructor which assumes ctl-a, ctl-b and '\n' separators and to return empty strings for empty fields.

Parameters:

trans - - the ttransport to use as input or output

TCTLSeparatedProtocol

public TCTLSeparatedProtocol(org.apache.thrift.transport.TTransport trans,
                             int buffer_size)

TCTLSeparatedProtocol

public TCTLSeparatedProtocol(org.apache.thrift.transport.TTransport trans,
                             String primarySeparator,
                             String secondarySeparator,
                             String mapSeparator,
                             String rowSeparator,
                             boolean returnNulls,
                             int bufferSize)

Parameters:

trans - - the ttransport to use as input or output

primarySeparator - the separator between columns (aka fields)

secondarySeparator - the separator within a field for things like sets and maps and lists

mapSeparator - - the key/value separator

rowSeparator - - the record separator

returnNulls - - whether to return a null or an empty string for fields that seem empty (ie two primary separators back to back)

Method Detail

getPrimarySeparator

public String getPrimarySeparator()

Inspect the separators this instance is configured with.

getSecondarySeparator

public String getSecondarySeparator()

getRowSeparator

public String getRowSeparator()

getMapSeparator

public String getMapSeparator()

initialize

public void initialize(org.apache.hadoop.conf.Configuration conf,
                       Properties tbl)
                throws org.apache.thrift.TException

Initialize the TProtocol.

Specified by:

initialize in interface ConfigurableTProtocol

Parameters:

conf - System properties

tbl - table properties

Throws:

org.apache.thrift.TException

writeMessageBegin

public void writeMessageBegin(org.apache.thrift.protocol.TMessage message)
                       throws org.apache.thrift.TException

Specified by:

writeMessageBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeMessageEnd

public void writeMessageEnd()
                     throws org.apache.thrift.TException

Specified by:

writeMessageEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeStructBegin

public void writeStructBegin(org.apache.thrift.protocol.TStruct struct)
                      throws org.apache.thrift.TException

Specified by:

writeStructBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeStructEnd

public void writeStructEnd()
                    throws org.apache.thrift.TException

Specified by:

writeStructEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeFieldBegin

public void writeFieldBegin(org.apache.thrift.protocol.TField field)
                     throws org.apache.thrift.TException

Specified by:

writeFieldBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeFieldEnd

public void writeFieldEnd()
                   throws org.apache.thrift.TException

Specified by:

writeFieldEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeFieldStop

public void writeFieldStop()

Specified by:

writeFieldStop in class org.apache.thrift.protocol.TProtocol

writeMapBegin

public void writeMapBegin(org.apache.thrift.protocol.TMap map)
                   throws org.apache.thrift.TException

Specified by:

writeMapBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeMapEnd

public void writeMapEnd()
                 throws org.apache.thrift.TException

Specified by:

writeMapEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeListBegin

public void writeListBegin(org.apache.thrift.protocol.TList list)
                    throws org.apache.thrift.TException

Specified by:

writeListBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeListEnd

public void writeListEnd()
                  throws org.apache.thrift.TException

Specified by:

writeListEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeSetBegin

public void writeSetBegin(org.apache.thrift.protocol.TSet set)
                   throws org.apache.thrift.TException

Specified by:

writeSetBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeSetEnd

public void writeSetEnd()
                 throws org.apache.thrift.TException

Specified by:

writeSetEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeBool

public void writeBool(boolean b)
               throws org.apache.thrift.TException

Specified by:

writeBool in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeByte

public void writeByte(byte b)
               throws org.apache.thrift.TException

Specified by:

writeByte in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeI16

public void writeI16(short i16)
              throws org.apache.thrift.TException

Specified by:

writeI16 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeI32

public void writeI32(int i32)
              throws org.apache.thrift.TException

Specified by:

writeI32 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeI64

public void writeI64(long i64)
              throws org.apache.thrift.TException

Specified by:

writeI64 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeDouble

public void writeDouble(double dub)
                 throws org.apache.thrift.TException

Specified by:

writeDouble in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

internalWriteString

public void internalWriteString(String str)
                         throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

writeString

public void writeString(String str)
                 throws org.apache.thrift.TException

Specified by:

writeString in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeBinary

public void writeBinary(ByteBuffer bin)
                 throws org.apache.thrift.TException

Specified by:

writeBinary in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readMessageBegin

public org.apache.thrift.protocol.TMessage readMessageBegin()
                                                     throws org.apache.thrift.TException

Specified by:

readMessageBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readMessageEnd

public void readMessageEnd()
                    throws org.apache.thrift.TException

Specified by:

readMessageEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readStructBegin

public org.apache.thrift.protocol.TStruct readStructBegin()
                                                   throws org.apache.thrift.TException

Specified by:

readStructBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readStructEnd

public void readStructEnd()
                   throws org.apache.thrift.TException

Specified by:

readStructEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

skip

public void skip(byte type)

Skip past the current field Just increments the field index counter.

Specified by:

skip in interface SkippableTProtocol

readFieldBegin

public org.apache.thrift.protocol.TField readFieldBegin()
                                                 throws org.apache.thrift.TException

Specified by:

readFieldBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readFieldEnd

public void readFieldEnd()
                  throws org.apache.thrift.TException

Specified by:

readFieldEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readMapBegin

public org.apache.thrift.protocol.TMap readMapBegin()
                                             throws org.apache.thrift.TException

Specified by:

readMapBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readMapEnd

public void readMapEnd()
                throws org.apache.thrift.TException

Specified by:

readMapEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readListBegin

public org.apache.thrift.protocol.TList readListBegin()
                                               throws org.apache.thrift.TException

Specified by:

readListBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readListEnd

public void readListEnd()
                 throws org.apache.thrift.TException

Specified by:

readListEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readSetBegin

public org.apache.thrift.protocol.TSet readSetBegin()
                                             throws org.apache.thrift.TException

Specified by:

readSetBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

lastPrimitiveWasNull

public boolean lastPrimitiveWasNull()
                             throws org.apache.thrift.TException

Description copied from interface: WriteNullsProtocol

Was the last primitive read really a NULL. Need only be called when the value of the primitive was 0. ie the protocol should return 0 on nulls and the caller will then check if it was actually null For boolean this is false.

Specified by:

lastPrimitiveWasNull in interface WriteNullsProtocol

Throws:

org.apache.thrift.TException

writeNull

public void writeNull()
               throws org.apache.thrift.TException

Description copied from interface: WriteNullsProtocol

Write a null.

Specified by:

writeNull in interface WriteNullsProtocol

Throws:

org.apache.thrift.TException

readSetEnd

public void readSetEnd()
                throws org.apache.thrift.TException

Specified by:

readSetEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readBool

public boolean readBool()
                 throws org.apache.thrift.TException

Specified by:

readBool in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readByte

public byte readByte()
              throws org.apache.thrift.TException

Specified by:

readByte in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readI16

public short readI16()
              throws org.apache.thrift.TException

Specified by:

readI16 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readI32

public int readI32()
            throws org.apache.thrift.TException

Specified by:

readI32 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readI64

public long readI64()
             throws org.apache.thrift.TException

Specified by:

readI64 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readDouble

public double readDouble()
                  throws org.apache.thrift.TException

Specified by:

readDouble in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readString

public String readString()
                  throws org.apache.thrift.TException

Specified by:

readString in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readBinary

public ByteBuffer readBinary()
                      throws org.apache.thrift.TException

Specified by:

readBinary in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException