org.cloudgraph.hbase.io

Class DistributedGraphWriter

java.lang.Object

org.cloudgraph.hbase.io.WriterSupport

org.cloudgraph.hbase.io.DistributedGraphWriter

All Implemented Interfaces:

DistributedGraphOperation, DistributedWriter

public class DistributedGraphWriter
extends WriterSupport
implements DistributedWriter

Encapsulates one or more graph table writer components for federation across multiple physical tables and/or physical table rows. Maps physical configured table names to respective table writers. In most usage scenarios, a "root" table writer is typically added initially, then other writers are incrementally added as association target types are detected and found configured as graph roots within another distinct table context.

Acts as a container for one or more TableWriter elements encapsulating a set of component table write operations for federation across multiple tables, or a single table in the most simple (degenerate) case.

Since:

0.5.1

Author:

Scott Cinnamond

See Also:

GraphTableWriter, GraphTable

Field Summary

Fields inherited from class org.cloudgraph.hbase.io.WriterSupport

mappingContext, rowWriterMap

Constructor Summary

Constructors

Constructor and Description
DistributedGraphWriter(commonj.sdo.DataGraph dataGraph, TableWriterCollector collector, Connection connection, StoreMappingContext mappingContext)

Method Summary

Modifier and Type	Method and Description
void	addTableWriter(TableWriter writer) Adds the given table writer to the container
void	close() Closes tables and connections.
RowWriter	createRowWriter(commonj.sdo.DataObject dataObject) Creates and returns a new row writer associated with the given data object.
RowWriter	findRowWriter(commonj.sdo.DataObject dataObject) Returns the row writer associated with the given data object or null if no row writer is associated.
Connection	getConnection() returns the shared connection for the operation
StoreMappingContext	getMappingContext()
TableWriter	getRootTableWriter() Returns the table writer associated with the data graph root.
RowWriter	getRowWriter(commonj.sdo.DataObject dataObject) Returns the row writer associated with the given data object
TableWriter	getTableWriter(String tableName) Returns the table writer for the given configured table name, or null of not exists.
int	getTableWriterCount() Returns the count of table writers for this container.
List<TableWriter>	getTableWriters() Returns all table writers for the this container
List<commonj.sdo.Type>	getTypes(TableWriter operation) Returns a list of types associated with the given table operation.
boolean	hasSingleRootType() Returns true if only one table operation exists with only one associated (root) type for this operation.
void	setRootTableWriter(TableWriter writer) Sets the table writer associated with the data graph root.

Methods inherited from class org.cloudgraph.hbase.io.WriterSupport

addRowWriter, createRowWriter, createRowWriter, findContainerRowWriter, getContainerAncestry, getContainerRowWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedGraphWriter

public DistributedGraphWriter(commonj.sdo.DataGraph dataGraph,
                              TableWriterCollector collector,
                              Connection connection,
                              StoreMappingContext mappingContext)
                       throws IOException

Throws:

IOException

Method Detail

getTableWriter

public TableWriter getTableWriter(String tableName)

Returns the table writer for the given configured table name, or null of not exists.

Specified by:

getTableWriter in interface DistributedWriter

Parameters:

tableName - the name of the configured table.

Returns:

the table writer for the given configured table name, or null of not exists.

addTableWriter

public void addTableWriter(TableWriter writer)

Adds the given table writer to the container

Specified by:

addTableWriter in interface DistributedWriter

Parameters:

writer - the table writer.

getTableWriterCount

public int getTableWriterCount()

Returns the count of table writers for this container.

Specified by:

getTableWriterCount in interface DistributedWriter

Returns:

the count of table writers for this container

getTableWriters

public List<TableWriter> getTableWriters()

Returns all table writers for the this container

Specified by:

getTableWriters in interface DistributedWriter

Returns:

all table writers for the this container

getRootTableWriter

public TableWriter getRootTableWriter()

Returns the table writer associated with the data graph root.

Specified by:

getRootTableWriter in interface DistributedWriter

Returns:

the table writer associated with the data graph root.

setRootTableWriter

public void setRootTableWriter(TableWriter writer)

Sets the table writer associated with the data graph root.

Specified by:

setRootTableWriter in interface DistributedWriter

Parameters:

writer - the table writer

getRowWriter

public RowWriter getRowWriter(commonj.sdo.DataObject dataObject)

Returns the row writer associated with the given data object

Specified by:

getRowWriter in interface DistributedWriter

Parameters:

dataObject - the data object

Returns:

the row writer associated with the given data object

Throws:

IllegalArgumentException - if the given data object is not associated with any row writer.

findRowWriter

public RowWriter findRowWriter(commonj.sdo.DataObject dataObject)

Returns the row writer associated with the given data object or null if no row writer is associated.

Specified by:

findRowWriter in interface DistributedWriter

Parameters:

dataObject - the data object

Returns:

the row writer associated with the given data object or null if no row writer is associated.

createRowWriter

public RowWriter createRowWriter(commonj.sdo.DataObject dataObject)
                          throws IOException

Creates and returns a new row writer associated with the given data object.

Specified by:

createRowWriter in interface DistributedWriter

Parameters:

dataObject - the data object

Returns:

a new row writer associated with the given data object.

Throws:

IOException

IllegalArgumentException - if the given data object is already associated with a row writer.

hasSingleRootType

public boolean hasSingleRootType()

Returns true if only one table operation exists with only one associated (root) type for this operation.

Specified by:

hasSingleRootType in interface DistributedGraphOperation

Returns:

true if only one table operation exists with only one associated (root) type for this operation.

getTypes

public List<commonj.sdo.Type> getTypes(TableWriter operation)

Returns a list of types associated with the given table operation.

Specified by:

getTypes in interface DistributedWriter

Parameters:

reader - the table operation

Returns:

a list of types associated with the given table operation.

getConnection

public Connection getConnection()

Description copied from interface: DistributedGraphOperation

returns the shared connection for the operation

Specified by:

getConnection in interface DistributedGraphOperation

close

public void close()

Description copied from interface: DistributedGraphOperation

Closes tables and connections.

Specified by:

close in interface DistributedGraphOperation

getMappingContext

public StoreMappingContext getMappingContext()

Specified by:

getMappingContext in interface DistributedGraphOperation