org.apache.hadoop.hbase.rest.serializer
Interface IRestSerializer

All Known Implementing Classes:

AbstractRestSerializer, JSONSerializer, SimpleXMLSerializer

public interface IRestSerializer

Interface that is implemented to return serialized objects back to the output stream.

Method Summary

void	serializeCell(Cell cell) serialize a cell object to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method
void	serializeCellArray(Cell[] cells) serialize a Cell array to the output stream
void	serializeColumnDescriptor(HColumnDescriptor column) serialize an HColumnDescriptor to the output stream.
void	serializeDatabaseMetadata(DatabaseModel.DatabaseMetadata databaseMetadata) serialize the database metadata Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method
void	serializeRegionData(TableModel.Regions regions) serialize the region data for a table to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method
void	serializeRowResult(RowResult rowResult) serialize a RowResult object to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method
void	serializeRowResultArray(RowResult[] rows) serialize a RowResult array to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method
void	serializeScannerIdentifier(ScannerIdentifier scannerIdentifier) serialize the ScannerIdentifier object to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method
void	serializeStatusMessage(Status.StatusMessage message) serialize the status message object to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method
void	serializeTableDescriptor(HTableDescriptor tableDescriptor) serialize the HTableDescriptor object Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method
void	serializeTimestamps(TimestampsDescriptor timestampsDescriptor) serialize a description of the timestamps available for a row to the output stream.
void	writeOutput(Object o) Serializes an object into the appropriate format and writes it to the output stream.

Method Detail

writeOutput

void writeOutput(Object o)
                 throws HBaseRestException

Serializes an object into the appropriate format and writes it to the output stream. This is the main point of entry when for an object to be serialized to the output stream.

Parameters:

o -

Throws:

HBaseRestException

serializeDatabaseMetadata

void serializeDatabaseMetadata(DatabaseModel.DatabaseMetadata databaseMetadata)
                               throws HBaseRestException

serialize the database metadata Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method

Parameters:

databaseMetadata -

Throws:

HBaseRestException

serializeTableDescriptor

void serializeTableDescriptor(HTableDescriptor tableDescriptor)
                              throws HBaseRestException

serialize the HTableDescriptor object Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method

Parameters:

tableDescriptor -

Throws:

HBaseRestException

serializeColumnDescriptor

void serializeColumnDescriptor(HColumnDescriptor column)
                               throws HBaseRestException

serialize an HColumnDescriptor to the output stream. Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method

Parameters:

column -

Throws:

HBaseRestException

serializeRegionData

void serializeRegionData(TableModel.Regions regions)
                         throws HBaseRestException

serialize the region data for a table to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method

Parameters:

regions -

Throws:

HBaseRestException

serializeStatusMessage

void serializeStatusMessage(Status.StatusMessage message)
                            throws HBaseRestException

serialize the status message object to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method

Parameters:

message -

Throws:

HBaseRestException

serializeScannerIdentifier

void serializeScannerIdentifier(ScannerIdentifier scannerIdentifier)
                                throws HBaseRestException

serialize the ScannerIdentifier object to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method

Parameters:

scannerIdentifier -

Throws:

HBaseRestException

serializeRowResult

void serializeRowResult(RowResult rowResult)
                        throws HBaseRestException

serialize a RowResult object to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method

Parameters:

rowResult -

Throws:

HBaseRestException

serializeRowResultArray

void serializeRowResultArray(RowResult[] rows)
                             throws HBaseRestException

serialize a RowResult array to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method

Parameters:

rows -

Throws:

HBaseRestException

serializeCell

void serializeCell(Cell cell)
                   throws HBaseRestException

serialize a cell object to the output stream Implementation of this method is optional, IF all the work is done in the writeOutput(Object o) method

Parameters:

cell -

Throws:

HBaseRestException

serializeCellArray

void serializeCellArray(Cell[] cells)
                        throws HBaseRestException

serialize a Cell array to the output stream

Parameters:

cells -

Throws:

HBaseRestException

serializeTimestamps

void serializeTimestamps(TimestampsDescriptor timestampsDescriptor)
                         throws HBaseRestException

serialize a description of the timestamps available for a row to the output stream.

Parameters:

timestampsDescriptor -

Throws:

HBaseRestException