cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
411 lines (410 loc) • 17.1 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:35 CEST 2014 -->
<title>AbstractColumnFamilyInputFormat (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="AbstractColumnFamilyInputFormat (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/AbstractColumnFamilyInputFormat.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>Prev Class</li>
<li><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.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/AbstractColumnFamilyInputFormat.html" target="_top">Frames</a></li>
<li><a href="AbstractColumnFamilyInputFormat.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: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </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 AbstractColumnFamilyInputFormat" class="title">Class AbstractColumnFamilyInputFormat<K,Y></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.mapreduce.InputFormat<K,Y></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.hadoop.AbstractColumnFamilyInputFormat<K,Y></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.hadoop.mapred.InputFormat<K,Y></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/cassandra/hadoop/ColumnFamilyInputFormat.html" title="class in org.apache.cassandra.hadoop">ColumnFamilyInputFormat</a>, <a href="../../../../org/apache/cassandra/hadoop/cql3/CqlInputFormat.html" title="class in org.apache.cassandra.hadoop.cql3">CqlInputFormat</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractColumnFamilyInputFormat<K,Y></span>
extends org.apache.hadoop.mapreduce.InputFormat<K,Y>
implements org.apache.hadoop.mapred.InputFormat<K,Y></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html#CASSANDRA_HADOOP_MAX_KEY_SIZE">CASSANDRA_HADOOP_MAX_KEY_SIZE</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html#CASSANDRA_HADOOP_MAX_KEY_SIZE_DEFAULT">CASSANDRA_HADOOP_MAX_KEY_SIZE_DEFAULT</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html#MAPRED_TASK_ID">MAPRED_TASK_ID</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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"> </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/AbstractColumnFamilyInputFormat.html#AbstractColumnFamilyInputFormat()">AbstractColumnFamilyInputFormat</a></strong>()</code> </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"> </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 <a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html#createAuthenticatedClient(java.lang.String,%20int,%20org.apache.hadoop.conf.Configuration)">createAuthenticatedClient</a></strong>(java.lang.String location,
int port,
org.apache.hadoop.conf.Configuration conf)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.mapred.InputSplit[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html#getSplits(org.apache.hadoop.mapred.JobConf,%20int)">getSplits</a></strong>(org.apache.hadoop.mapred.JobConf jobConf,
int numSplits)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<org.apache.hadoop.mapreduce.InputSplit></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html#getSplits(org.apache.hadoop.mapreduce.JobContext)">getSplits</a></strong>(org.apache.hadoop.mapreduce.JobContext context)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html#validateConfiguration(org.apache.hadoop.conf.Configuration)">validateConfiguration</a></strong>(org.apache.hadoop.conf.Configuration conf)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.mapreduce.InputFormat">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.hadoop.mapreduce.InputFormat</h3>
<code>createRecordReader</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.mapred.InputFormat">
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.hadoop.mapred.InputFormat</h3>
<code>getRecordReader</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="MAPRED_TASK_ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAPRED_TASK_ID</h4>
<pre>public static final java.lang.String MAPRED_TASK_ID</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.hadoop.AbstractColumnFamilyInputFormat.MAPRED_TASK_ID">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CASSANDRA_HADOOP_MAX_KEY_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CASSANDRA_HADOOP_MAX_KEY_SIZE</h4>
<pre>public static final java.lang.String CASSANDRA_HADOOP_MAX_KEY_SIZE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.hadoop.AbstractColumnFamilyInputFormat.CASSANDRA_HADOOP_MAX_KEY_SIZE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CASSANDRA_HADOOP_MAX_KEY_SIZE_DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CASSANDRA_HADOOP_MAX_KEY_SIZE_DEFAULT</h4>
<pre>public static final int CASSANDRA_HADOOP_MAX_KEY_SIZE_DEFAULT</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.hadoop.AbstractColumnFamilyInputFormat.CASSANDRA_HADOOP_MAX_KEY_SIZE_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractColumnFamilyInputFormat()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractColumnFamilyInputFormat</h4>
<pre>public AbstractColumnFamilyInputFormat()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="validateConfiguration(org.apache.hadoop.conf.Configuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateConfiguration</h4>
<pre>protected void validateConfiguration(org.apache.hadoop.conf.Configuration conf)</pre>
</li>
</ul>
<a name="createAuthenticatedClient(java.lang.String, int, org.apache.hadoop.conf.Configuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAuthenticatedClient</h4>
<pre>public static <a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a> createAuthenticatedClient(java.lang.String location,
int port,
org.apache.hadoop.conf.Configuration conf)
throws java.lang.Exception</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd></dl>
</li>
</ul>
<a name="getSplits(org.apache.hadoop.mapreduce.JobContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSplits</h4>
<pre>public java.util.List<org.apache.hadoop.mapreduce.InputSplit> getSplits(org.apache.hadoop.mapreduce.JobContext context)
throws java.io.IOException</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getSplits</code> in class <code>org.apache.hadoop.mapreduce.InputFormat<<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html" title="type parameter in AbstractColumnFamilyInputFormat">K</a>,<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html" title="type parameter in AbstractColumnFamilyInputFormat">Y</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getSplits(org.apache.hadoop.mapred.JobConf, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSplits</h4>
<pre>public org.apache.hadoop.mapred.InputSplit[] getSplits(org.apache.hadoop.mapred.JobConf jobConf,
int numSplits)
throws java.io.IOException</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getSplits</code> in interface <code>org.apache.hadoop.mapred.InputFormat<<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html" title="type parameter in AbstractColumnFamilyInputFormat">K</a>,<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyInputFormat.html" title="type parameter in AbstractColumnFamilyInputFormat">Y</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</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/AbstractColumnFamilyInputFormat.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>Prev Class</li>
<li><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.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/AbstractColumnFamilyInputFormat.html" target="_top">Frames</a></li>
<li><a href="AbstractColumnFamilyInputFormat.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: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </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 © 2014 The Apache Software Foundation</small></p>
</body>
</html>