UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

459 lines (458 loc) 20.2 kB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:35 CEST 2014 --> <title>HadoopCompat (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="HadoopCompat (apache-cassandra API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/HadoopCompat.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/cassandra/hadoop/ConfigHelper.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/hadoop/ReporterWrapper.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/hadoop/HadoopCompat.html" target="_top">Frames</a></li> <li><a href="HadoopCompat.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">org.apache.cassandra.hadoop</div> <h2 title="Class HadoopCompat" class="title">Class HadoopCompat</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.hadoop.HadoopCompat</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">HadoopCompat</span> extends java.lang.Object</pre> <div class="block">Utility methods to allow applications to deal with inconsistencies between MapReduce Context Objects API between Hadoop 1.x and 2.x.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#HadoopCompat()">HadoopCompat</a></strong>()</code>&nbsp;</td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static org.apache.hadoop.conf.Configuration</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#getConfiguration(org.apache.hadoop.mapreduce.JobContext)">getConfiguration</a></strong>(org.apache.hadoop.mapreduce.JobContext&nbsp;context)</code> <div class="block">Invoke getConfiguration() on JobContext.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static org.apache.hadoop.mapreduce.Counter</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#getCounter(org.apache.hadoop.mapreduce.TaskInputOutputContext,%20java.lang.String,%20java.lang.String)">getCounter</a></strong>(org.apache.hadoop.mapreduce.TaskInputOutputContext&nbsp;context, java.lang.String&nbsp;groupName, java.lang.String&nbsp;counterName)</code> <div class="block">Invoke getCounter() on TaskInputOutputContext.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static org.apache.hadoop.mapreduce.TaskAttemptID</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#getTaskAttemptID(org.apache.hadoop.mapreduce.TaskAttemptContext)">getTaskAttemptID</a></strong>(org.apache.hadoop.mapreduce.TaskAttemptContext&nbsp;taskContext)</code> <div class="block">returns TaskAttemptContext.getTaskAttemptID().</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#incrementCounter(org.apache.hadoop.mapreduce.Counter,%20long)">incrementCounter</a></strong>(org.apache.hadoop.mapreduce.Counter&nbsp;counter, long&nbsp;increment)</code> <div class="block">Increment the counter.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#isVersion2x()">isVersion2x</a></strong>()</code> <div class="block">True if runtime Hadoop version is 2.x, false otherwise.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static org.apache.hadoop.mapreduce.Counter</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#newGenericCounter(java.lang.String,%20java.lang.String,%20long)">newGenericCounter</a></strong>(java.lang.String&nbsp;name, java.lang.String&nbsp;displayName, long&nbsp;value)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static org.apache.hadoop.mapreduce.JobContext</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#newJobContext(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.mapreduce.JobID)">newJobContext</a></strong>(org.apache.hadoop.conf.Configuration&nbsp;conf, org.apache.hadoop.mapreduce.JobID&nbsp;jobId)</code> <div class="block">Creates JobContext from a JobConf and jobId using the correct constructor for based on Hadoop version.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static org.apache.hadoop.mapreduce.MapContext</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#newMapContext(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.mapreduce.TaskAttemptID,%20org.apache.hadoop.mapreduce.RecordReader,%20org.apache.hadoop.mapreduce.RecordWriter,%20org.apache.hadoop.mapreduce.OutputCommitter,%20org.apache.hadoop.mapreduce.StatusReporter,%20org.apache.hadoop.mapreduce.InputSplit)">newMapContext</a></strong>(org.apache.hadoop.conf.Configuration&nbsp;conf, org.apache.hadoop.mapreduce.TaskAttemptID&nbsp;taskAttemptID, org.apache.hadoop.mapreduce.RecordReader&nbsp;recordReader, org.apache.hadoop.mapreduce.RecordWriter&nbsp;recordWriter, org.apache.hadoop.mapreduce.OutputCommitter&nbsp;outputCommitter, org.apache.hadoop.mapreduce.StatusReporter&nbsp;statusReporter, org.apache.hadoop.mapreduce.InputSplit&nbsp;inputSplit)</code> <div class="block">Instantiates MapContext under Hadoop 1 and MapContextImpl under Hadoop 2.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static org.apache.hadoop.mapreduce.TaskAttemptContext</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#newTaskAttemptContext(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.mapreduce.TaskAttemptID)">newTaskAttemptContext</a></strong>(org.apache.hadoop.conf.Configuration&nbsp;conf, org.apache.hadoop.mapreduce.TaskAttemptID&nbsp;taskAttemptId)</code> <div class="block">Creates TaskAttempContext from a JobConf and jobId using the correct constructor for based on Hadoop version.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#progress(org.apache.hadoop.mapreduce.TaskAttemptContext)">progress</a></strong>(org.apache.hadoop.mapreduce.TaskAttemptContext&nbsp;context)</code> <div class="block">Invoke TaskAttemptContext.progress().</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/HadoopCompat.html#setStatus(org.apache.hadoop.mapreduce.TaskAttemptContext,%20java.lang.String)">setStatus</a></strong>(org.apache.hadoop.mapreduce.TaskAttemptContext&nbsp;context, java.lang.String&nbsp;status)</code> <div class="block">Invoke setStatus() on TaskAttemptContext.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class&nbsp;java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="HadoopCompat()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>HadoopCompat</h4> <pre>public&nbsp;HadoopCompat()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="isVersion2x()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isVersion2x</h4> <pre>public static&nbsp;boolean&nbsp;isVersion2x()</pre> <div class="block">True if runtime Hadoop version is 2.x, false otherwise.</div> </li> </ul> <a name="newJobContext(org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.JobID)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newJobContext</h4> <pre>public static&nbsp;org.apache.hadoop.mapreduce.JobContext&nbsp;newJobContext(org.apache.hadoop.conf.Configuration&nbsp;conf, org.apache.hadoop.mapreduce.JobID&nbsp;jobId)</pre> <div class="block">Creates JobContext from a JobConf and jobId using the correct constructor for based on Hadoop version. <code>jobId</code> could be null.</div> </li> </ul> <a name="newTaskAttemptContext(org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newTaskAttemptContext</h4> <pre>public static&nbsp;org.apache.hadoop.mapreduce.TaskAttemptContext&nbsp;newTaskAttemptContext(org.apache.hadoop.conf.Configuration&nbsp;conf, org.apache.hadoop.mapreduce.TaskAttemptID&nbsp;taskAttemptId)</pre> <div class="block">Creates TaskAttempContext from a JobConf and jobId using the correct constructor for based on Hadoop version.</div> </li> </ul> <a name="newMapContext(org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.RecordReader, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter, org.apache.hadoop.mapreduce.InputSplit)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newMapContext</h4> <pre>public static&nbsp;org.apache.hadoop.mapreduce.MapContext&nbsp;newMapContext(org.apache.hadoop.conf.Configuration&nbsp;conf, org.apache.hadoop.mapreduce.TaskAttemptID&nbsp;taskAttemptID, org.apache.hadoop.mapreduce.RecordReader&nbsp;recordReader, org.apache.hadoop.mapreduce.RecordWriter&nbsp;recordWriter, org.apache.hadoop.mapreduce.OutputCommitter&nbsp;outputCommitter, org.apache.hadoop.mapreduce.StatusReporter&nbsp;statusReporter, org.apache.hadoop.mapreduce.InputSplit&nbsp;inputSplit)</pre> <div class="block">Instantiates MapContext under Hadoop 1 and MapContextImpl under Hadoop 2.</div> </li> </ul> <a name="newGenericCounter(java.lang.String, java.lang.String, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newGenericCounter</h4> <pre>public static&nbsp;org.apache.hadoop.mapreduce.Counter&nbsp;newGenericCounter(java.lang.String&nbsp;name, java.lang.String&nbsp;displayName, long&nbsp;value)</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>with Hadoop 2 : <code>new GenericCounter(args)</code>,<br> with Hadoop 1 : <code>new Counter(args)</code></dd></dl> </li> </ul> <a name="getConfiguration(org.apache.hadoop.mapreduce.JobContext)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getConfiguration</h4> <pre>public static&nbsp;org.apache.hadoop.conf.Configuration&nbsp;getConfiguration(org.apache.hadoop.mapreduce.JobContext&nbsp;context)</pre> <div class="block">Invoke getConfiguration() on JobContext. Works with both Hadoop 1 and 2.</div> </li> </ul> <a name="setStatus(org.apache.hadoop.mapreduce.TaskAttemptContext, java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setStatus</h4> <pre>public static&nbsp;void&nbsp;setStatus(org.apache.hadoop.mapreduce.TaskAttemptContext&nbsp;context, java.lang.String&nbsp;status)</pre> <div class="block">Invoke setStatus() on TaskAttemptContext. Works with both Hadoop 1 and 2.</div> </li> </ul> <a name="getTaskAttemptID(org.apache.hadoop.mapreduce.TaskAttemptContext)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTaskAttemptID</h4> <pre>public static&nbsp;org.apache.hadoop.mapreduce.TaskAttemptID&nbsp;getTaskAttemptID(org.apache.hadoop.mapreduce.TaskAttemptContext&nbsp;taskContext)</pre> <div class="block">returns TaskAttemptContext.getTaskAttemptID(). Works with both Hadoop 1 and 2.</div> </li> </ul> <a name="getCounter(org.apache.hadoop.mapreduce.TaskInputOutputContext, java.lang.String, java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCounter</h4> <pre>public static&nbsp;org.apache.hadoop.mapreduce.Counter&nbsp;getCounter(org.apache.hadoop.mapreduce.TaskInputOutputContext&nbsp;context, java.lang.String&nbsp;groupName, java.lang.String&nbsp;counterName)</pre> <div class="block">Invoke getCounter() on TaskInputOutputContext. Works with both Hadoop 1 and 2.</div> </li> </ul> <a name="progress(org.apache.hadoop.mapreduce.TaskAttemptContext)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>progress</h4> <pre>public static&nbsp;void&nbsp;progress(org.apache.hadoop.mapreduce.TaskAttemptContext&nbsp;context)</pre> <div class="block">Invoke TaskAttemptContext.progress(). Works with both Hadoop 1 and 2.</div> </li> </ul> <a name="incrementCounter(org.apache.hadoop.mapreduce.Counter, long)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>incrementCounter</h4> <pre>public static&nbsp;void&nbsp;incrementCounter(org.apache.hadoop.mapreduce.Counter&nbsp;counter, long&nbsp;increment)</pre> <div class="block">Increment the counter. Works with both Hadoop 1 and 2</div> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/HadoopCompat.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/cassandra/hadoop/ConfigHelper.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/hadoop/ReporterWrapper.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/hadoop/HadoopCompat.html" target="_top">Frames</a></li> <li><a href="HadoopCompat.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright &copy; 2014 The Apache Software Foundation</small></p> </body> </html>