SherpaClient.html
No OneTemporary
Actions

Subscribers

None

File Metadata

Created: Sun, Mar 2, 21:21

SherpaClient.html
View Options

	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!--NewPage-->
	<HTML>
	<HEAD>
	<!-- Generated by javadoc (build 1.6.0_03) on Fri Jan 22 13:42:46 PST 2010 -->
	<TITLE>
	SherpaClient
	</TITLE>

	<META NAME="date" CONTENT="2010-01-22">

	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

	<SCRIPT type="text/javascript">
	function windowTitle()
	{
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="SherpaClient";
	}
	}
	</SCRIPT>
	<NOSCRIPT>
	</NOSCRIPT>

	</HEAD>

	<BODY BGCOLOR="white" onload="windowTitle();">
	<HR>


	<!-- ========= START OF TOP NAVBAR ======= -->
	<A NAME="navbar_top"><!-- --></A>
	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_top_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../com/yahoo/ycsb/db/ShardClient.html" title="class in com.yahoo.ycsb.db"><B>PREV CLASS</B></A>
	NEXT CLASS</FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../index.html?com/yahoo/ycsb/db/SherpaClient.html" target="_top"><B>FRAMES</B></A>
	<A HREF="SherpaClient.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_top"></A>
	<!-- ========= END OF TOP NAVBAR ========= -->

	<HR>
	<!-- ======== START OF CLASS DATA ======== -->
	<H2>
	<FONT SIZE="-1">
	com.yahoo.ycsb.db</FONT>
	<BR>
	Class SherpaClient</H2>
	<PRE>
	java.lang.Object
	<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">com.yahoo.ycsb.DB</A>
	<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.yahoo.ycsb.db.SherpaClient</B>
	</PRE>
	<HR>
	<DL>
	<DT><PRE>public class <B>SherpaClient</B><DT>extends <A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">DB</A></DL>
	</PRE>

	<P>
	This is a Java Sherpa client to be used for the Benchmark app. Since Sherpa
	is a RESful service, this class will make use of Apache's HttpClient 4.x to
	make the web service calls.
	<P>

	<P>
	<HR>

	<P>
	<!-- =========== FIELD SUMMARY =========== -->

	<A NAME="field_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Field Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#ADDITIONAL_FIELD">ADDITIONAL_FIELD</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#CODE">CODE</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#CONTINUATION">CONTINUATION</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#DELETE">DELETE</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#END_HASH_KEY">END_HASH_KEY</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#END_HASH_KEY_VALUE">END_HASH_KEY_VALUE</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#FIELDS">FIELDS</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#FIRST_FIELD">FIRST_FIELD</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#GET">GET</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#HASH_SCAN">HASH_SCAN</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#HOSTS">HOSTS</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#HTTP">HTTP</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#HTTP_ERROR">HTTP_ERROR</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#JSON_ERROR">JSON_ERROR</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#NAMESPACE">NAMESPACE</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#OK">OK</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#ORDERED_SCAN">ORDERED_SCAN</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#PREDICATE">PREDICATE</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#RECORD_LIMIT">RECORD_LIMIT</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#RECORDS">RECORDS</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#SCAN_COMPLETED">SCAN_COMPLETED</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#SCANTYPE">SCANTYPE</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#SET">SET</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#START_HASH_KEY">START_HASH_KEY</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#START_HASH_KEY_HEADER">START_HASH_KEY_HEADER</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#START_HASH_KEY_VALUE">START_HASH_KEY_VALUE</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#START_KEY_ADDITIONAL">START_KEY_ADDITIONAL</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#START_KEY_FIRST">START_KEY_FIRST</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#STATUS">STATUS</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#URI_PATH">URI_PATH</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#UTF8">UTF8</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#VALUE">VALUE</A></B></CODE>

	<BR>
	</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>protected static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#YDHT">YDHT</A></B></CODE>

	<BR>
	</TD>
	</TR>
	</TABLE>

	<!-- ======== CONSTRUCTOR SUMMARY ======== -->

	<A NAME="constructor_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Constructor Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#SherpaClient()">SherpaClient</A></B>()</CODE>

	<BR>
	</TD>
	</TR>
	</TABLE>

	<!-- ========== METHOD SUMMARY =========== -->

	<A NAME="method_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Method Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#cleanup()">cleanup</A></B>()</CODE>

	<BR>
	Cleanup any state for this DB.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#createRecordBody(java.util.HashMap)">createRecordBody</A></B>(java.util.HashMap<java.lang.String,java.lang.String> values)</CODE>

	<BR>
	Method to create the Sherpa JSON record body from an input HashMap of
	key/values.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#delete(java.lang.String, java.lang.String)">delete</A></B>(java.lang.String table,
	java.lang.String key)</CODE>

	<BR>
	Delete a record from the database.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#encodeFields(java.util.Set)">encodeFields</A></B>(java.util.Set<java.lang.String> fields)</CODE>

	<BR>
	Method to encode a set of fields to retrieve from a Sherpa Get or Scan
	request.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#encodeString(java.lang.String)">encodeString</A></B>(java.lang.String key)</CODE>

	<BR>
	Method to encode a String to UTF8.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#getHashKey(java.lang.String)">getHashKey</A></B>(java.lang.String key)</CODE>

	<BR>
	Method to return the hex string representation of a 32-bit unsigned key
	value used for doing Sherpa scans.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#getResponseCode(JSONObject)">getResponseCode</A></B>(JSONObject jsonObject)</CODE>

	<BR>
	Helper method to retrieve the response status code from a JSON Response
	to determine if it was successful or not.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#init()">init</A></B>()</CODE>

	<BR>
	Initialize any state for this DB.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#insert(java.lang.String, java.lang.String, java.util.HashMap)">insert</A></B>(java.lang.String table,
	java.lang.String key,
	java.util.HashMap<java.lang.String,java.lang.String> values)</CODE>

	<BR>
	Insert a record in the database.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#populateHashScanRecords(JSONObject, java.util.Vector)">populateHashScanRecords</A></B>(JSONObject curResult,
	java.util.Vector<java.util.HashMap<java.lang.String,java.lang.String>> result)</CODE>

	<BR>
	Method to parse and store a JSON response from a hash scan request.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#populateOrderedScanRecords(JSONObject, java.util.Vector)">populateOrderedScanRecords</A></B>(JSONObject curResult,
	java.util.Vector<java.util.HashMap<java.lang.String,java.lang.String>> result)</CODE>

	<BR>
	Method to parse and store a JSON response from an ordered scan request.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static void</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#populateReadRecord(JSONObject, java.util.HashMap)">populateReadRecord</A></B>(JSONObject response,
	java.util.HashMap<java.lang.String,java.lang.String> result)</CODE>

	<BR>
	Method to parse and store a JSON response from reading a single Sherpa
	record into the corresponding HashMap key/value pairs.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#read(java.lang.String, java.lang.String, java.util.Set, java.util.HashMap)">read</A></B>(java.lang.String table,
	java.lang.String key,
	java.util.Set<java.lang.String> fields,
	java.util.HashMap<java.lang.String,java.lang.String> result)</CODE>

	<BR>
	Read a record from the database.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#scan(java.lang.String, java.lang.String, int, java.util.Set, java.util.Vector)">scan</A></B>(java.lang.String table,
	java.lang.String startkey,
	int recordcount,
	java.util.Set<java.lang.String> fields,
	java.util.Vector<java.util.HashMap<java.lang.String,java.lang.String>> result)</CODE>

	<BR>
	Perform a range scan for a set of records in the database.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../com/yahoo/ycsb/db/SherpaClient.html#update(java.lang.String, java.lang.String, java.util.HashMap)">update</A></B>(java.lang.String table,
	java.lang.String key,
	java.util.HashMap<java.lang.String,java.lang.String> values)</CODE>

	<BR>
	Update a record in the database.</TD>
	</TR>
	</TABLE>
	<A NAME="methods_inherited_from_class_com.yahoo.ycsb.DB"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
	<TH ALIGN="left"><B>Methods inherited from class com.yahoo.ycsb.<A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">DB</A></B></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD><CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#getProperties()">getProperties</A>, <A HREF="../../../../com/yahoo/ycsb/DB.html#setProperties(java.util.Properties)">setProperties</A></CODE></TD>
	</TR>
	</TABLE>
	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
	</TR>
	</TABLE>

	<P>

	<!-- ============ FIELD DETAIL =========== -->

	<A NAME="field_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Field Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="GET"><!-- --></A><H3>
	GET</H3>
	<PRE>
	protected static final java.lang.String <B>GET</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.GET">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="SET"><!-- --></A><H3>
	SET</H3>
	<PRE>
	protected static final java.lang.String <B>SET</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.SET">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="DELETE"><!-- --></A><H3>
	DELETE</H3>
	<PRE>
	protected static final java.lang.String <B>DELETE</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.DELETE">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="HASH_SCAN"><!-- --></A><H3>
	HASH_SCAN</H3>
	<PRE>
	protected static final java.lang.String <B>HASH_SCAN</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.HASH_SCAN">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="ORDERED_SCAN"><!-- --></A><H3>
	ORDERED_SCAN</H3>
	<PRE>
	protected static final java.lang.String <B>ORDERED_SCAN</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.ORDERED_SCAN">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="FIRST_FIELD"><!-- --></A><H3>
	FIRST_FIELD</H3>
	<PRE>
	protected static final java.lang.String <B>FIRST_FIELD</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.FIRST_FIELD">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="ADDITIONAL_FIELD"><!-- --></A><H3>
	ADDITIONAL_FIELD</H3>
	<PRE>
	protected static final java.lang.String <B>ADDITIONAL_FIELD</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.ADDITIONAL_FIELD">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="START_KEY_FIRST"><!-- --></A><H3>
	START_KEY_FIRST</H3>
	<PRE>
	protected static final java.lang.String <B>START_KEY_FIRST</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.START_KEY_FIRST">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="START_KEY_ADDITIONAL"><!-- --></A><H3>
	START_KEY_ADDITIONAL</H3>
	<PRE>
	protected static final java.lang.String <B>START_KEY_ADDITIONAL</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.START_KEY_ADDITIONAL">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="UTF8"><!-- --></A><H3>
	UTF8</H3>
	<PRE>
	protected static final java.lang.String <B>UTF8</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.UTF8">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="START_HASH_KEY_HEADER"><!-- --></A><H3>
	START_HASH_KEY_HEADER</H3>
	<PRE>
	protected static final java.lang.String <B>START_HASH_KEY_HEADER</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.START_HASH_KEY_HEADER">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="CONTINUATION"><!-- --></A><H3>
	CONTINUATION</H3>
	<PRE>
	protected static final java.lang.String <B>CONTINUATION</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.CONTINUATION">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="START_HASH_KEY"><!-- --></A><H3>
	START_HASH_KEY</H3>
	<PRE>
	protected static final java.lang.String <B>START_HASH_KEY</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.START_HASH_KEY">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="END_HASH_KEY"><!-- --></A><H3>
	END_HASH_KEY</H3>
	<PRE>
	protected static final java.lang.String <B>END_HASH_KEY</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.END_HASH_KEY">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="START_HASH_KEY_VALUE"><!-- --></A><H3>
	START_HASH_KEY_VALUE</H3>
	<PRE>
	protected static final java.lang.String <B>START_HASH_KEY_VALUE</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.START_HASH_KEY_VALUE">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="END_HASH_KEY_VALUE"><!-- --></A><H3>
	END_HASH_KEY_VALUE</H3>
	<PRE>
	protected static final java.lang.String <B>END_HASH_KEY_VALUE</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.END_HASH_KEY_VALUE">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="RECORD_LIMIT"><!-- --></A><H3>
	RECORD_LIMIT</H3>
	<PRE>
	protected static final java.lang.String <B>RECORD_LIMIT</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.RECORD_LIMIT">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="PREDICATE"><!-- --></A><H3>
	PREDICATE</H3>
	<PRE>
	protected static final java.lang.String <B>PREDICATE</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.PREDICATE">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="SCAN_COMPLETED"><!-- --></A><H3>
	SCAN_COMPLETED</H3>
	<PRE>
	protected static final java.lang.String <B>SCAN_COMPLETED</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.SCAN_COMPLETED">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="RECORDS"><!-- --></A><H3>
	RECORDS</H3>
	<PRE>
	protected static final java.lang.String <B>RECORDS</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.RECORDS">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="URI_PATH"><!-- --></A><H3>
	URI_PATH</H3>
	<PRE>
	protected static final java.lang.String <B>URI_PATH</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.URI_PATH">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="YDHT"><!-- --></A><H3>
	YDHT</H3>
	<PRE>
	protected static final java.lang.String <B>YDHT</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.YDHT">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="STATUS"><!-- --></A><H3>
	STATUS</H3>
	<PRE>
	protected static final java.lang.String <B>STATUS</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.STATUS">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="CODE"><!-- --></A><H3>
	CODE</H3>
	<PRE>
	protected static final java.lang.String <B>CODE</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.CODE">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="FIELDS"><!-- --></A><H3>
	FIELDS</H3>
	<PRE>
	protected static final java.lang.String <B>FIELDS</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.FIELDS">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="VALUE"><!-- --></A><H3>
	VALUE</H3>
	<PRE>
	protected static final java.lang.String <B>VALUE</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.VALUE">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="OK"><!-- --></A><H3>
	OK</H3>
	<PRE>
	protected static final int <B>OK</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.OK">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="JSON_ERROR"><!-- --></A><H3>
	JSON_ERROR</H3>
	<PRE>
	protected static final int <B>JSON_ERROR</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.JSON_ERROR">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="HTTP_ERROR"><!-- --></A><H3>
	HTTP_ERROR</H3>
	<PRE>
	protected static final int <B>HTTP_ERROR</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.HTTP_ERROR">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="HOSTS"><!-- --></A><H3>
	HOSTS</H3>
	<PRE>
	protected static final java.lang.String <B>HOSTS</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.HOSTS">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="HTTP"><!-- --></A><H3>
	HTTP</H3>
	<PRE>
	protected static final java.lang.String <B>HTTP</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.HTTP">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="NAMESPACE"><!-- --></A><H3>
	NAMESPACE</H3>
	<PRE>
	protected static final java.lang.String <B>NAMESPACE</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.NAMESPACE">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="SCANTYPE"><!-- --></A><H3>
	SCANTYPE</H3>
	<PRE>
	protected static final java.lang.String <B>SCANTYPE</B></PRE>
	<DL>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.yahoo.ycsb.db.SherpaClient.SCANTYPE">Constant Field Values</A></DL>
	</DL>

	<!-- ========= CONSTRUCTOR DETAIL ======== -->

	<A NAME="constructor_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Constructor Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="SherpaClient()"><!-- --></A><H3>
	SherpaClient</H3>
	<PRE>
	public <B>SherpaClient</B>()</PRE>
	<DL>
	</DL>

	<!-- ============ METHOD DETAIL ========== -->

	<A NAME="method_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Method Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="init()"><!-- --></A><H3>
	init</H3>
	<PRE>
	public void <B>init</B>()
	throws <A HREF="../../../../com/yahoo/ycsb/DBException.html" title="class in com.yahoo.ycsb">DBException</A></PRE>
	<DL>
	<DD>Initialize any state for this DB. Called once per DB instance; there is
	one DB instance per client thread.
	<P>
	<DD><DL>
	<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#init()">init</A></CODE> in class <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">DB</A></CODE></DL>
	</DD>
	<DD><DL>

	<DT><B>Throws:</B>
	<DD><CODE><A HREF="../../../../com/yahoo/ycsb/DBException.html" title="class in com.yahoo.ycsb">DBException</A></CODE></DL>
	</DD>
	</DL>
	<HR>

	<A NAME="cleanup()"><!-- --></A><H3>
	cleanup</H3>
	<PRE>
	public void <B>cleanup</B>()
	throws <A HREF="../../../../com/yahoo/ycsb/DBException.html" title="class in com.yahoo.ycsb">DBException</A></PRE>
	<DL>
	<DD>Cleanup any state for this DB. Called once per DB instance; there is one
	DB instance per client thread.
	<P>
	<DD><DL>
	<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#cleanup()">cleanup</A></CODE> in class <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">DB</A></CODE></DL>
	</DD>
	<DD><DL>

	<DT><B>Throws:</B>
	<DD><CODE><A HREF="../../../../com/yahoo/ycsb/DBException.html" title="class in com.yahoo.ycsb">DBException</A></CODE></DL>
	</DD>
	</DL>
	<HR>

	<A NAME="encodeString(java.lang.String)"><!-- --></A><H3>
	encodeString</H3>
	<PRE>
	public static java.lang.String <B>encodeString</B>(java.lang.String key)</PRE>
	<DL>
	<DD>Method to encode a String to UTF8. All Sherpa table/record/field and
	record body data must be UTF8 since access is done via HTTP REST calls.
	<P>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>key</CODE> - Key string we want to encode to UTF8
	<DT><B>Returns:</B><DD>UTF8 encoding of the input string</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="encodeFields(java.util.Set)"><!-- --></A><H3>
	encodeFields</H3>
	<PRE>
	public static java.lang.String <B>encodeFields</B>(java.util.Set<java.lang.String> fields)</PRE>
	<DL>
	<DD>Method to encode a set of fields to retrieve from a Sherpa Get or Scan
	request.
	<P>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>fields</CODE> - Set of String fields to retrieve from a Sherpa Get or Scan
	request
	<DT><B>Returns:</B><DD>String encoding of the set of fields to retrieve from a Sherpa
	request. This has the format of ?field=<field1>&field=<field2>...</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="getHashKey(java.lang.String)"><!-- --></A><H3>
	getHashKey</H3>
	<PRE>
	public static java.lang.String <B>getHashKey</B>(java.lang.String key)</PRE>
	<DL>
	<DD>Method to return the hex string representation of a 32-bit unsigned key
	value used for doing Sherpa scans. This needs to match how Sherpa in the
	backend is hashing the keys to determine which tablet it is stored in.
	<P>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>key</CODE> - Key string to be hashed
	<DT><B>Returns:</B><DD>String hex representation of the hashing of the input key</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="getResponseCode(JSONObject)"><!-- --></A><H3>
	getResponseCode</H3>
	<PRE>
	public static int <B>getResponseCode</B>(JSONObject jsonObject)</PRE>
	<DL>
	<DD>Helper method to retrieve the response status code from a JSON Response
	to determine if it was successful or not.
	<P>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>jsonObject</CODE> - JSONObject response from Sherpa
	<DT><B>Returns:</B><DD>int Response status code indicating if the request was successful
	or not</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="createRecordBody(java.util.HashMap)"><!-- --></A><H3>
	createRecordBody</H3>
	<PRE>
	public static java.lang.String <B>createRecordBody</B>(java.util.HashMap<java.lang.String,java.lang.String> values)</PRE>
	<DL>
	<DD>Method to create the Sherpa JSON record body from an input HashMap of
	key/values.
	<P>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>values</CODE> - HashMap of key/values to be stored in a Sherpa record
	<DT><B>Returns:</B><DD>Sherpa JSON record representation of the input key/values HashMap</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="populateReadRecord(JSONObject, java.util.HashMap)"><!-- --></A><H3>
	populateReadRecord</H3>
	<PRE>
	public static void <B>populateReadRecord</B>(JSONObject response,
	java.util.HashMap<java.lang.String,java.lang.String> result)
	throws JSONException</PRE>
	<DL>
	<DD>Method to parse and store a JSON response from reading a single Sherpa
	record into the corresponding HashMap key/value pairs.
	<P>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>response</CODE> - JSONObject response from reading a single Sherpa record<DD><CODE>result</CODE> - HashMap key/value pairs for the record's field/values
	<DT><B>Throws:</B>
	<DD><CODE>JSONException</CODE> - If there is an error parsing the JSON response</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="populateHashScanRecords(JSONObject, java.util.Vector)"><!-- --></A><H3>
	populateHashScanRecords</H3>
	<PRE>
	public static void <B>populateHashScanRecords</B>(JSONObject curResult,
	java.util.Vector<java.util.HashMap<java.lang.String,java.lang.String>> result)
	throws JSONException</PRE>
	<DL>
	<DD>Method to parse and store a JSON response from a hash scan request. This
	consists of multiple records each of which will be stored in the input
	result Vector as a HashMap of key/value pairs.
	<P>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>curResult</CODE> - JSONObject response from a Sherpa hash scan request<DD><CODE>result</CODE> - Vector of Sherpa records each stored as a HashMap of
	key/values for the record's field/values
	<DT><B>Throws:</B>
	<DD><CODE>JSONException</CODE> - If there is an error parsing the JSON response</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="populateOrderedScanRecords(JSONObject, java.util.Vector)"><!-- --></A><H3>
	populateOrderedScanRecords</H3>
	<PRE>
	public static void <B>populateOrderedScanRecords</B>(JSONObject curResult,
	java.util.Vector<java.util.HashMap<java.lang.String,java.lang.String>> result)
	throws JSONException</PRE>
	<DL>
	<DD>Method to parse and store a JSON response from an ordered scan request.
	This consists of multiple records each of which will be stored in the
	input result Vector as a HashMap of key/value pairs.
	<P>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>curResult</CODE> - JSONObject response from a Sherpa ordered scan request<DD><CODE>result</CODE> - Vector of Sherpa records each stored as a HashMap of
	key/values for the record's field/values
	<DT><B>Throws:</B>
	<DD><CODE>JSONException</CODE> - If there is an error parsing the JSON response</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="delete(java.lang.String, java.lang.String)"><!-- --></A><H3>
	delete</H3>
	<PRE>
	public int <B>delete</B>(java.lang.String table,
	java.lang.String key)</PRE>
	<DL>
	<DD><B>Description copied from class: <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#delete(java.lang.String, java.lang.String)">DB</A></CODE></B></DD>
	<DD>Delete a record from the database.
	<P>
	<DD><DL>
	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#delete(java.lang.String, java.lang.String)">delete</A></CODE> in class <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">DB</A></CODE></DL>
	</DD>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>table</CODE> - The name of the table<DD><CODE>key</CODE> - The record key of the record to delete.
	<DT><B>Returns:</B><DD>Zero on success, a non-zero error code on error</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="insert(java.lang.String, java.lang.String, java.util.HashMap)"><!-- --></A><H3>
	insert</H3>
	<PRE>
	public int <B>insert</B>(java.lang.String table,
	java.lang.String key,
	java.util.HashMap<java.lang.String,java.lang.String> values)</PRE>
	<DL>
	<DD><B>Description copied from class: <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#insert(java.lang.String, java.lang.String, java.util.HashMap)">DB</A></CODE></B></DD>
	<DD>Insert a record in the database. Any field/value pairs in the specified values HashMap will be written into the record with the specified
	record key.
	<P>
	<DD><DL>
	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#insert(java.lang.String, java.lang.String, java.util.HashMap)">insert</A></CODE> in class <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">DB</A></CODE></DL>
	</DD>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>table</CODE> - The name of the table<DD><CODE>key</CODE> - The record key of the record to insert.<DD><CODE>values</CODE> - A HashMap of field/value pairs to insert in the record
	<DT><B>Returns:</B><DD>Zero on success, a non-zero error code on error</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="read(java.lang.String, java.lang.String, java.util.Set, java.util.HashMap)"><!-- --></A><H3>
	read</H3>
	<PRE>
	public int <B>read</B>(java.lang.String table,
	java.lang.String key,
	java.util.Set<java.lang.String> fields,
	java.util.HashMap<java.lang.String,java.lang.String> result)</PRE>
	<DL>
	<DD><B>Description copied from class: <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#read(java.lang.String, java.lang.String, java.util.Set, java.util.HashMap)">DB</A></CODE></B></DD>
	<DD>Read a record from the database. Each field/value pair from the result will be stored in a HashMap.
	<P>
	<DD><DL>
	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#read(java.lang.String, java.lang.String, java.util.Set, java.util.HashMap)">read</A></CODE> in class <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">DB</A></CODE></DL>
	</DD>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>table</CODE> - The name of the table<DD><CODE>key</CODE> - The record key of the record to read.<DD><CODE>fields</CODE> - The list of fields to read, or null for all of them<DD><CODE>result</CODE> - A HashMap of field/value pairs for the result
	<DT><B>Returns:</B><DD>Zero on success, a non-zero error code on error</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="scan(java.lang.String, java.lang.String, int, java.util.Set, java.util.Vector)"><!-- --></A><H3>
	scan</H3>
	<PRE>
	public int <B>scan</B>(java.lang.String table,
	java.lang.String startkey,
	int recordcount,
	java.util.Set<java.lang.String> fields,
	java.util.Vector<java.util.HashMap<java.lang.String,java.lang.String>> result)</PRE>
	<DL>
	<DD><B>Description copied from class: <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#scan(java.lang.String, java.lang.String, int, java.util.Set, java.util.Vector)">DB</A></CODE></B></DD>
	<DD>Perform a range scan for a set of records in the database. Each field/value pair from the result will be stored in a HashMap.
	<P>
	<DD><DL>
	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#scan(java.lang.String, java.lang.String, int, java.util.Set, java.util.Vector)">scan</A></CODE> in class <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">DB</A></CODE></DL>
	</DD>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>table</CODE> - The name of the table<DD><CODE>startkey</CODE> - The record key of the first record to read.<DD><CODE>recordcount</CODE> - The number of records to read<DD><CODE>fields</CODE> - The list of fields to read, or null for all of them<DD><CODE>result</CODE> - A Vector of HashMaps, where each HashMap is a set field/value pairs for one record
	<DT><B>Returns:</B><DD>Zero on success, a non-zero error code on error</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="update(java.lang.String, java.lang.String, java.util.HashMap)"><!-- --></A><H3>
	update</H3>
	<PRE>
	public int <B>update</B>(java.lang.String table,
	java.lang.String key,
	java.util.HashMap<java.lang.String,java.lang.String> values)</PRE>
	<DL>
	<DD><B>Description copied from class: <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#update(java.lang.String, java.lang.String, java.util.HashMap)">DB</A></CODE></B></DD>
	<DD>Update a record in the database. Any field/value pairs in the specified values HashMap will be written into the record with the specified
	record key, overwriting any existing values with the same field name.
	<P>
	<DD><DL>
	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/yahoo/ycsb/DB.html#update(java.lang.String, java.lang.String, java.util.HashMap)">update</A></CODE> in class <CODE><A HREF="../../../../com/yahoo/ycsb/DB.html" title="class in com.yahoo.ycsb">DB</A></CODE></DL>
	</DD>
	<DD><DL>
	<DT><B>Parameters:</B><DD><CODE>table</CODE> - The name of the table<DD><CODE>key</CODE> - The record key of the record to write.<DD><CODE>values</CODE> - A HashMap of field/value pairs to update in the record
	<DT><B>Returns:</B><DD>Zero on success, a non-zero error code on error</DL>
	</DD>
	</DL>
	<!-- ========= END OF CLASS DATA ========= -->
	<HR>


	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<A NAME="navbar_bottom"><!-- --></A>
	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_bottom_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../com/yahoo/ycsb/db/ShardClient.html" title="class in com.yahoo.ycsb.db"><B>PREV CLASS</B></A>
	NEXT CLASS</FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../index.html?com/yahoo/ycsb/db/SherpaClient.html" target="_top"><B>FRAMES</B></A>
	<A HREF="SherpaClient.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_bottom"></A>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->

	<HR>

	</BODY>
	</HTML>

SherpaClient.htmlNo OneTemporaryActions

File Metadata

SherpaClient.htmlView Options

Event Timeline

SherpaClient.html
No OneTemporary
Actions

SherpaClient.html
View Options