org.cloudgraph.hbase.io.TableReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudgraph-hbase Show documentation

CloudGraph(tm) is a suite of Service Data Object (SDO) 2.1 services designed for relational and big-table style "cloud" databases, such as HBase and others.

There is a newer version: 2.0.4

Show newest version

/**
 *        CloudGraph Community Edition (CE) License
 * 
 * This is a community release of CloudGraph, a dual-license suite of
 * Service Data Object (SDO) 2.1 services designed for relational and 
 * big-table style "cloud" databases, such as HBase and others. 
 * This particular copy of the software is released under the 
 * version 2 of the GNU General Public License. CloudGraph was developed by 
 * TerraMeta Software, Inc.
 * 
 * Copyright (c) 2013, TerraMeta Software, Inc. All rights reserved.
 * 
 * General License information can be found below.
 * 
 * This distribution may include materials developed by third
 * parties. For license and attribution notices for these
 * materials, please refer to the documentation that accompanies
 * this distribution (see the "Licenses for Third-Party Components"
 * appendix) or view the online documentation at 
 * . 
 */
package org.cloudgraph.hbase.io;

import java.io.IOException;
import java.util.List;
import java.util.UUID;

import org.apache.hadoop.hbase.client.Result;

import commonj.sdo.DataObject;


/**
 * Provides access to the operational, configuration and other state information
 * required for read operations on a single graph table. 
 * 
 * Acts as a container for one or more {@link RowReader} elements
 * and encapsulates the HBase client Get 
 * operations for use in read operations across one or more graph rows. 
 * 
 * 
 * @see org.cloudgraph.hbase.io.RowReader
 * @author Scott Cinnamond
 * @since 0.5.1
 */
public interface TableReader extends TableOperation {

	/**
	 * Returns the table name associated with this reader. 
	 * @return the table name associated with this reader. 
	 */
	public String getTableName();
		
	/**
	 * Returns the row reader context for the given UUID or null
	 * if null exists
	 * @param uuid the UUID 
	 * @return the row reader context for the given UUID  or null
	 * if null exists
	 */
	public RowReader getRowReader(UUID uuid);
	
	/**
	 * Returns the row reader context for the given row key or null
	 * if null exists 
	 * @param rowKey the row key bytes
	 * @return the row reader context for the given row key or null
	 * if null exists 
	 */
	public RowReader getRowReader(byte[] rowKey);
	
	/**
	 * Returns the row reader context for the given data object or null
	 * if null exists
	 * @param dataObject the data object
	 * @return the row reader context for the given data object or null
	 * if null exists
	 */
	public RowReader getRowReader(DataObject dataObject);
	
	/**
	 * Adds the given row reader context mapping it to the
	 * given UUID.
	 * @param uuid the UUID 
	 * @param rowContext the row reader context
	 * @throws IllegalArgumentException if an existing row reader is already mapped
	 * for the given UUID 
	 */
	public void addRowReader(UUID uuid, 
			RowReader rowContext) throws IllegalArgumentException;

	/**
	 * Creates and adds a row reader based on the given
	 * data object and result row. 
	 * @param dataObject the data object
	 * @return the row reader
	 * @throws IllegalArgumentException if an existing row reader is already mapped
	 * for the given data object UUID 
	 */
	public RowReader createRowReader(DataObject dataObject,
			Result resultRow) throws IllegalArgumentException;
	
	/**
	 * Returns all row reader context values for this table context.
	 * @return all row reader context values for this table context.
	 */
	public List getAllRowReaders();

	
	/**
     * Frees resources associated with this reader and any
     * component readers. 
     */
    public void clear();
    
	/**
     * Closes tables and connections. 
     */
    public void close() throws IOException;
}