org.cloudgraph.hbase.io

Class GraphRowWriter

java.lang.Object

org.cloudgraph.state.GraphRow

org.cloudgraph.hbase.io.DefaultRowOperation

org.cloudgraph.hbase.io.GraphRowWriter

All Implemented Interfaces:

RowOperation, RowWriter, RowState

public class GraphRowWriter
extends DefaultRowOperation
implements RowWriter

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 Put 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 inherited from class org.cloudgraph.state.GraphRow

columnKeyFactory, graphConfig, ROOT_TYPE_DELIM, rootDataObject, rowKey, sequenceMapping

Fields inherited from interface org.cloudgraph.hbase.io.RowWriter

ROW_ATTR_NAME_CONCURRENT_FAM_BYTES, ROW_ATTR_NAME_CONCURRENT_QUAL_BYTES, ROW_ATTR_NAME_CONCURRENT_VALUE_BYTES, ROW_ATTR_NAME_IS_CONCURRENT_BOOL

Constructor Summary

Constructors

Constructor and Description
GraphRowWriter(byte[] rowKey, commonj.sdo.DataObject rootDataObject, TableWriter tableWriter, StoreMappingContext mappingContext)

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.
protected SequenceGenerator	createSequenceMapping(byte[] rowKey, commonj.sdo.DataObject dataObject, commonj.sdo.ChangeSummary changeSummary) Initializes a graph state by querying for a row based on the given row key and either creating a new (empty) graph state for an entirely new graph, or otherwise initializing a graph state based on state or state and management columns in the existing returned row.
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)
static byte[]	encode(org.plasma.sdo.PlasmaType type)
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.
GraphStatefullColumnKeyFactory	getColumnKeyFactory()
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
StoreMappingContext	getMappingContext()
long	getSequence(commonj.sdo.DataObject dataObject) Returs the sequence number for the given data object if exists.
SequenceGenerator	getSequenceMapping()
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 name)
void	writeRowAttribute(String name, 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 class org.cloudgraph.state.GraphRow

addDataObject, addDataObject, contains, contains, contains, contains, getDataGraph, getDataObject, getDataObject, getHashCode, getHashCode, getHashCode, getHashCode, getHashCode, getHashCode, getRootDataObject, getRootType, getRowKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cloudgraph.state.RowState

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

Constructor Detail

GraphRowWriter

public GraphRowWriter(byte[] rowKey,
                      commonj.sdo.DataObject rootDataObject,
                      TableWriter tableWriter,
                      StoreMappingContext mappingContext)

Method Detail

getMappingContext

public StoreMappingContext getMappingContext()

Specified by:

getMappingContext in interface RowOperation

getSequenceMapping

public SequenceGenerator getSequenceMapping()
                                     throws IOException

Specified by:

getSequenceMapping in interface RowState

Overrides:

getSequenceMapping in class GraphRow

Throws:

IOException

getColumnKeyFactory

public GraphStatefullColumnKeyFactory getColumnKeyFactory()
                                                   throws IOException

Specified by:

getColumnKeyFactory in interface RowState

Overrides:

getColumnKeyFactory in class GraphRow

Throws:

IOException

deleteRow

public void deleteRow()

Description copied from interface: RowWriter

Creates a new row delete mutation, is not exists.

Specified by:

deleteRow in interface RowWriter

hasRowDelete

public boolean hasRowDelete()

Returns whether there is an existing row delete mutation.

Specified by:

hasRowDelete in interface RowWriter

Returns:

whether there is an existing row delete mutation.

fetchColumnValue

public 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.

Specified by:

fetchColumnValue in interface RowWriter

Parameters:

dataObject - the context data object

property - the context property

Returns:

the column value bytes

Throws:

IOException

See Also:

StatefullColumnKeyFactory

getTableWriter

public TableWriter getTableWriter()

Description copied from interface: RowWriter

Returns the container for this writer.

Specified by:

getTableWriter in interface RowWriter

Returns:

the container for this writer.

isRootCreated

public boolean isRootCreated()

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

Specified by:

isRootCreated in interface RowWriter

Returns:

whether the root data object for this writer is created.

isRootDeleted

public boolean isRootDeleted()

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

Specified by:

isRootDeleted in interface RowWriter

Returns:

whether the root data object for this writer is deleted.

getWriteOperations

public Mutations getWriteOperations()

Description copied from interface: RowWriter

Return the write operations for a row.

Specified by:

getWriteOperations in interface RowWriter

Returns:

the write operations for a row.

createSequenceMapping

protected SequenceGenerator createSequenceMapping(byte[] rowKey,
                                                  commonj.sdo.DataObject dataObject,
                                                  commonj.sdo.ChangeSummary changeSummary)
                                           throws IOException

Initializes a graph state by querying for a row based on the given row key and either creating a new (empty) graph state for an entirely new graph, or otherwise initializing a graph state based on state or state and management columns in the existing returned row.

Parameters:

rowKey - the row key

dataGraph - the data graph

changeSummary - the change summary

Returns:

the graph state

Throws:

IOException

DuplicateRowException - for a new graph if a row already exists for the given row key

GraphServiceException - where except for a new graph, if no row exists for the given row key

getEdgeWriter

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

Description copied from interface: RowWriter

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

Specified by:

getEdgeWriter in interface RowWriter

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

newSequence

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

Specified by:

newSequence in interface RowWriter

Throws:

IOException

writeRowEntityMetaData

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

Specified by:

writeRowEntityMetaData in interface RowWriter

Throws:

IOException

deleteRowEntityMetaData

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

Specified by:

deleteRowEntityMetaData in interface RowWriter

Throws:

IOException

writeRowData

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

Specified by:

writeRowData in interface RowWriter

Throws:

IOException

writeRowData

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

Specified by:

writeRowData in interface RowWriter

Throws:

IOException

writeRowAttribute

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

Specified by:

writeRowAttribute in interface RowWriter

Throws:

IOException

readRowAttribute

public byte[] readRowAttribute(String name)
                        throws IOException

Specified by:

readRowAttribute in interface RowWriter

Throws:

IOException

deleteRowData

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

Specified by:

deleteRowData in interface RowWriter

Throws:

IOException

deleteRowData

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

Specified by:

deleteRowData in interface RowWriter

Throws:

IOException

incrementRowData

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

Specified by:

incrementRowData in interface RowWriter

Throws:

IOException

addSequence

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

Description copied from interface: RowWriter

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

Specified by:

addSequence in interface RowWriter

containsSequence

public boolean containsSequence(commonj.sdo.DataObject dataObject)

Description copied from interface: RowWriter

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

Specified by:

containsSequence in interface RowWriter

Returns:

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

getSequence

public long getSequence(commonj.sdo.DataObject dataObject)

Description copied from interface: RowWriter

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

Specified by:

getSequence in interface RowWriter

encodeRootType

public byte[] encodeRootType()

Specified by:

encodeRootType in interface RowWriter

encodeType

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

Specified by:

encodeType in interface RowWriter

encode

public static byte[] encode(org.plasma.sdo.PlasmaType type)