org.cloudgraph.hbase.io

Interface RowWriter

All Superinterfaces:

RowOperation, RowState

All Known Implementing Classes:

GraphRowWriter

public interface RowWriter
extends RowOperation

Provides access to the operational, configuration and other state information required for write operations on a single graph row.

Acts as a single component within a TableWriter container and encapsulates the HBase client Put and Delete operations for use in write operations across multiple logical entities within a graph row.

Since:

0.5.1

Author:

Scott Cinnamond

See Also:

TableWriter

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROW_ATTR_NAME_CONCURRENT_FAM_BYTES
static String	ROW_ATTR_NAME_CONCURRENT_QUAL_BYTES
static String	ROW_ATTR_NAME_CONCURRENT_VALUE_BYTES
static String	ROW_ATTR_NAME_IS_CONCURRENT_BOOL

Method Summary

Modifier and Type	Method and Description
void	addSequence(commonj.sdo.DataObject dataObject, long sequence) Maps an edge sequence within the writer for the given data object
boolean	containsSequence(commonj.sdo.DataObject dataObject) Returns whether the writer has a mapping the the given data object.
void	deleteRow() Creates a new row delete mutation, is not exists.
void	deleteRowData(byte[] fam, byte[] qualifier)
void	deleteRowData(org.plasma.sdo.PlasmaDataObject dataObject, long sequence, org.plasma.sdo.PlasmaProperty property)
void	deleteRowEntityMetaData(org.plasma.sdo.PlasmaDataObject dataObject, long sequence)
byte[]	encodeRootType()
byte[]	encodeType(org.plasma.sdo.PlasmaType type)
byte[]	fetchColumnValue(org.plasma.sdo.PlasmaDataObject dataObject, org.plasma.sdo.PlasmaProperty property) Returns a single column value for this row given a context data object and property.
EdgeWriter	getEdgeWriter(org.plasma.sdo.PlasmaDataObject dataObject, org.plasma.sdo.PlasmaProperty property, long sequence) Returns an existing or new edge writer for the given data object, sequence and source edge property
long	getSequence(commonj.sdo.DataObject dataObject) Returs the sequence number for the given data object if exists.
TableWriter	getTableWriter() Returns the container for this writer.
Mutations	getWriteOperations() Return the write operations for a row.
boolean	hasRowDelete() Returns whether there is an existing row delete mutation.
void	incrementRowData(org.plasma.sdo.PlasmaDataObject dataObject, long sequence, org.plasma.sdo.PlasmaProperty property, long value)
boolean	isRootCreated() Returns whether the root data object for this writer is created.
boolean	isRootDeleted() Returns whether the root data object for this writer is deleted.
long	newSequence(org.plasma.sdo.PlasmaDataObject dataObject)
byte[]	readRowAttribute(String key)
void	writeRowAttribute(String key, byte[] value)
void	writeRowData(byte[] fam, byte[] qualifier, byte[] value)
void	writeRowData(org.plasma.sdo.PlasmaDataObject dataObject, long sequence, org.plasma.sdo.PlasmaProperty property, byte[] value)
void	writeRowEntityMetaData(org.plasma.sdo.PlasmaDataObject dataObject, long sequence)

Methods inherited from interface org.cloudgraph.hbase.io.RowOperation

getMappingContext

Methods inherited from interface org.cloudgraph.state.RowState

addDataObject, addDataObject, contains, contains, contains, contains, getColumnKeyFactory, getDataGraph, getDataObject, getDataObject, getRootDataObject, getRootType, getRowKey, getSequenceMapping

Field Detail

ROW_ATTR_NAME_IS_CONCURRENT_BOOL

static final String ROW_ATTR_NAME_IS_CONCURRENT_BOOL

See Also:

Constant Field Values

ROW_ATTR_NAME_CONCURRENT_FAM_BYTES

static final String ROW_ATTR_NAME_CONCURRENT_FAM_BYTES

See Also:

Constant Field Values

ROW_ATTR_NAME_CONCURRENT_QUAL_BYTES

static final String ROW_ATTR_NAME_CONCURRENT_QUAL_BYTES

See Also:

Constant Field Values

ROW_ATTR_NAME_CONCURRENT_VALUE_BYTES

static final String ROW_ATTR_NAME_CONCURRENT_VALUE_BYTES

See Also:

Constant Field Values

Method Detail

deleteRow

void deleteRow()

Creates a new row delete mutation, is not exists.

hasRowDelete

boolean hasRowDelete()

Returns whether there is an existing row delete mutation.

Returns:

whether there is an existing row delete mutation.

getWriteOperations

Mutations getWriteOperations()

Return the write operations for a row.

Returns:

the write operations for a row.

fetchColumnValue

byte[] fetchColumnValue(org.plasma.sdo.PlasmaDataObject dataObject,
                        org.plasma.sdo.PlasmaProperty property)
                 throws IOException

Returns a single column value for this row given a context data object and property. Uses a statefull column key factory to generate a column key based on the given context data object and property.

Parameters:

dataObject - the context data object

property - the context property

Returns:

the column value bytes

Throws:

IOException

See Also:

StatefullColumnKeyFactory

getTableWriter

TableWriter getTableWriter()

Returns the container for this writer.

Returns:

the container for this writer.

isRootCreated

boolean isRootCreated()

Returns whether the root data object for this writer is created.

Returns:

whether the root data object for this writer is created.

isRootDeleted

boolean isRootDeleted()

Returns whether the root data object for this writer is deleted.

Returns:

whether the root data object for this writer is deleted.

newSequence

long newSequence(org.plasma.sdo.PlasmaDataObject dataObject)
          throws IOException

Throws:

IOException

writeRowEntityMetaData

void writeRowEntityMetaData(org.plasma.sdo.PlasmaDataObject dataObject,
                            long sequence)
                     throws IOException

Throws:

IOException

deleteRowEntityMetaData

void deleteRowEntityMetaData(org.plasma.sdo.PlasmaDataObject dataObject,
                             long sequence)
                      throws IOException

Throws:

IOException

writeRowData

void writeRowData(org.plasma.sdo.PlasmaDataObject dataObject,
                  long sequence,
                  org.plasma.sdo.PlasmaProperty property,
                  byte[] value)
           throws IOException

Throws:

IOException

writeRowData

void writeRowData(byte[] fam,
                  byte[] qualifier,
                  byte[] value)
           throws IOException

Throws:

IOException

writeRowAttribute

void writeRowAttribute(String key,
                       byte[] value)
                throws IOException

Throws:

IOException

readRowAttribute

byte[] readRowAttribute(String key)
                 throws IOException

Throws:

IOException

deleteRowData

void deleteRowData(org.plasma.sdo.PlasmaDataObject dataObject,
                   long sequence,
                   org.plasma.sdo.PlasmaProperty property)
            throws IOException

Throws:

IOException

deleteRowData

void deleteRowData(byte[] fam,
                   byte[] qualifier)
            throws IOException

Throws:

IOException

incrementRowData

void incrementRowData(org.plasma.sdo.PlasmaDataObject dataObject,
                      long sequence,
                      org.plasma.sdo.PlasmaProperty property,
                      long value)
               throws IOException

Throws:

IOException

getEdgeWriter

EdgeWriter getEdgeWriter(org.plasma.sdo.PlasmaDataObject dataObject,
                         org.plasma.sdo.PlasmaProperty property,
                         long sequence)
                  throws IOException

Returns an existing or new edge writer for the given data object, sequence and source edge property

Parameters:

dataObject - the data object

property - the source edge property

sequence - the sequence for the given data object type, unique within the graph/row

Returns:

an existing or new edge writer for the given data object, sequence and source edge property

Throws:

IOException

addSequence

void addSequence(commonj.sdo.DataObject dataObject,
                 long sequence)

Maps an edge sequence within the writer for the given data object

Parameters:

dataObject -

sequence -

containsSequence

boolean containsSequence(commonj.sdo.DataObject dataObject)

Returns whether the writer has a mapping the the given data object.

Parameters:

dataObject -

Returns:

whether the writer has a mapping the the given data object.

getSequence

long getSequence(commonj.sdo.DataObject dataObject)

Returs the sequence number for the given data object if exists.

encodeRootType

byte[] encodeRootType()

encodeType

byte[] encodeType(org.plasma.sdo.PlasmaType type)