blob: b9ebccbe7ac000fd82a7ae3a78d4c150039da545 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.mapred;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.Closeable;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.HConstants;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.TableName;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.client.RegionLocator;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.Result;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.Table;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.filter.Filter;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.io.ImmutableBytesWritable;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.mapred.InputFormat;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.mapred.InputSplit;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.mapred.JobConf;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.mapred.RecordReader;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.mapred.Reporter;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.slf4j.Logger;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.slf4j.LoggerFactory;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>/**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * A Base for {@link TableInputFormat}s. Receives a {@link Table}, a byte[] of input columns and<a name="line.40"></a>
<span class="sourceLineNo">041</span> * optionally a {@link Filter}. Subclasses may use other TableRecordReader implementations.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p/&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Subclasses MUST ensure initializeTable(Connection, TableName) is called for an instance to<a name="line.43"></a>
<span class="sourceLineNo">044</span> * function properly. Each of the entry points to this class used by the MapReduce framework,<a name="line.44"></a>
<span class="sourceLineNo">045</span> * {@link #getRecordReader(InputSplit, JobConf, Reporter)} and {@link #getSplits(JobConf, int)},<a name="line.45"></a>
<span class="sourceLineNo">046</span> * will call {@link #initialize(JobConf)} as a convenient centralized location to handle retrieving<a name="line.46"></a>
<span class="sourceLineNo">047</span> * the necessary configuration information. If your subclass overrides either of these methods,<a name="line.47"></a>
<span class="sourceLineNo">048</span> * either call the parent version or call initialize yourself.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;p&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * An example of a subclass:<a name="line.50"></a>
<span class="sourceLineNo">051</span> *<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;pre&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * class ExampleTIF extends TableInputFormatBase {<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> * {@literal @}Override<a name="line.55"></a>
<span class="sourceLineNo">056</span> * protected void initialize(JobConf context) throws IOException {<a name="line.56"></a>
<span class="sourceLineNo">057</span> * // We are responsible for the lifecycle of this connection until we hand it over in<a name="line.57"></a>
<span class="sourceLineNo">058</span> * // initializeTable.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Connection connection =<a name="line.59"></a>
<span class="sourceLineNo">060</span> * ConnectionFactory.createConnection(HBaseConfiguration.create(job));<a name="line.60"></a>
<span class="sourceLineNo">061</span> * TableName tableName = TableName.valueOf("exampleTable");<a name="line.61"></a>
<span class="sourceLineNo">062</span> * // mandatory. once passed here, TableInputFormatBase will handle closing the connection.<a name="line.62"></a>
<span class="sourceLineNo">063</span> * initializeTable(connection, tableName);<a name="line.63"></a>
<span class="sourceLineNo">064</span> * byte[][] inputColumns = new byte [][] { Bytes.toBytes("columnA"),<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Bytes.toBytes("columnB") };<a name="line.65"></a>
<span class="sourceLineNo">066</span> * // mandatory<a name="line.66"></a>
<span class="sourceLineNo">067</span> * setInputColumns(inputColumns);<a name="line.67"></a>
<span class="sourceLineNo">068</span> * // optional, by default we'll get everything for the given columns.<a name="line.68"></a>
<span class="sourceLineNo">069</span> * Filter exampleFilter = new RowFilter(CompareOp.EQUAL, new RegexStringComparator("aa.*"));<a name="line.69"></a>
<span class="sourceLineNo">070</span> * setRowFilter(exampleFilter);<a name="line.70"></a>
<span class="sourceLineNo">071</span> * }<a name="line.71"></a>
<span class="sourceLineNo">072</span> * }<a name="line.72"></a>
<span class="sourceLineNo">073</span> * &lt;/pre&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span>@InterfaceAudience.Public<a name="line.76"></a>
<span class="sourceLineNo">077</span>public abstract class TableInputFormatBase implements InputFormat&lt;ImmutableBytesWritable, Result&gt; {<a name="line.77"></a>
<span class="sourceLineNo">078</span> private static final Logger LOG = LoggerFactory.getLogger(TableInputFormatBase.class);<a name="line.78"></a>
<span class="sourceLineNo">079</span> private byte[][] inputColumns;<a name="line.79"></a>
<span class="sourceLineNo">080</span> private Table table;<a name="line.80"></a>
<span class="sourceLineNo">081</span> private RegionLocator regionLocator;<a name="line.81"></a>
<span class="sourceLineNo">082</span> private Connection connection;<a name="line.82"></a>
<span class="sourceLineNo">083</span> private TableRecordReader tableRecordReader;<a name="line.83"></a>
<span class="sourceLineNo">084</span> private Filter rowFilter;<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> private static final String NOT_INITIALIZED = "The input format instance has not been properly "<a name="line.86"></a>
<span class="sourceLineNo">087</span> + "initialized. Ensure you call initializeTable either in your constructor or initialize "<a name="line.87"></a>
<span class="sourceLineNo">088</span> + "method";<a name="line.88"></a>
<span class="sourceLineNo">089</span> private static final String INITIALIZATION_ERROR = "Cannot create a record reader because of a"<a name="line.89"></a>
<span class="sourceLineNo">090</span> + " previous error. Please look at the previous logs lines from"<a name="line.90"></a>
<span class="sourceLineNo">091</span> + " the task's full log for more details.";<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> /**<a name="line.93"></a>
<span class="sourceLineNo">094</span> * Builds a TableRecordReader. If no TableRecordReader was provided, uses the default.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @see InputFormat#getRecordReader(InputSplit, JobConf, Reporter)<a name="line.95"></a>
<span class="sourceLineNo">096</span> */<a name="line.96"></a>
<span class="sourceLineNo">097</span> public RecordReader&lt;ImmutableBytesWritable, Result&gt; getRecordReader(InputSplit split, JobConf job,<a name="line.97"></a>
<span class="sourceLineNo">098</span> Reporter reporter) throws IOException {<a name="line.98"></a>
<span class="sourceLineNo">099</span> // In case a subclass uses the deprecated approach or calls initializeTable directly<a name="line.99"></a>
<span class="sourceLineNo">100</span> if (table == null) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> initialize(job);<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> // null check in case our child overrides getTable to not throw.<a name="line.103"></a>
<span class="sourceLineNo">104</span> try {<a name="line.104"></a>
<span class="sourceLineNo">105</span> if (getTable() == null) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> // initialize() must not have been implemented in the subclass.<a name="line.106"></a>
<span class="sourceLineNo">107</span> throw new IOException(INITIALIZATION_ERROR);<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span> } catch (IllegalStateException exception) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> throw new IOException(INITIALIZATION_ERROR, exception);<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> TableSplit tSplit = (TableSplit) split;<a name="line.113"></a>
<span class="sourceLineNo">114</span> // if no table record reader was provided use default<a name="line.114"></a>
<span class="sourceLineNo">115</span> final TableRecordReader trr =<a name="line.115"></a>
<span class="sourceLineNo">116</span> this.tableRecordReader == null ? new TableRecordReader() : this.tableRecordReader;<a name="line.116"></a>
<span class="sourceLineNo">117</span> trr.setStartRow(tSplit.getStartRow());<a name="line.117"></a>
<span class="sourceLineNo">118</span> trr.setEndRow(tSplit.getEndRow());<a name="line.118"></a>
<span class="sourceLineNo">119</span> trr.setHTable(this.table);<a name="line.119"></a>
<span class="sourceLineNo">120</span> trr.setInputColumns(this.inputColumns);<a name="line.120"></a>
<span class="sourceLineNo">121</span> trr.setRowFilter(this.rowFilter);<a name="line.121"></a>
<span class="sourceLineNo">122</span> trr.init();<a name="line.122"></a>
<span class="sourceLineNo">123</span> return new RecordReader&lt;ImmutableBytesWritable, Result&gt;() {<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> @Override<a name="line.125"></a>
<span class="sourceLineNo">126</span> public void close() throws IOException {<a name="line.126"></a>
<span class="sourceLineNo">127</span> trr.close();<a name="line.127"></a>
<span class="sourceLineNo">128</span> closeTable();<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> @Override<a name="line.131"></a>
<span class="sourceLineNo">132</span> public ImmutableBytesWritable createKey() {<a name="line.132"></a>
<span class="sourceLineNo">133</span> return trr.createKey();<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> @Override<a name="line.136"></a>
<span class="sourceLineNo">137</span> public Result createValue() {<a name="line.137"></a>
<span class="sourceLineNo">138</span> return trr.createValue();<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> @Override<a name="line.141"></a>
<span class="sourceLineNo">142</span> public long getPos() throws IOException {<a name="line.142"></a>
<span class="sourceLineNo">143</span> return trr.getPos();<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> @Override<a name="line.146"></a>
<span class="sourceLineNo">147</span> public float getProgress() throws IOException {<a name="line.147"></a>
<span class="sourceLineNo">148</span> return trr.getProgress();<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> @Override<a name="line.151"></a>
<span class="sourceLineNo">152</span> public boolean next(ImmutableBytesWritable key, Result value) throws IOException {<a name="line.152"></a>
<span class="sourceLineNo">153</span> return trr.next(key, value);<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span> };<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> /**<a name="line.158"></a>
<span class="sourceLineNo">159</span> * Calculates the splits that will serve as input for the map tasks.<a name="line.159"></a>
<span class="sourceLineNo">160</span> * &lt;p/&gt;<a name="line.160"></a>
<span class="sourceLineNo">161</span> * Splits are created in number equal to the smallest between numSplits and the number of<a name="line.161"></a>
<span class="sourceLineNo">162</span> * {@link org.apache.hadoop.hbase.regionserver.HRegion}s in the table. If the number of splits is<a name="line.162"></a>
<span class="sourceLineNo">163</span> * smaller than the number of {@link org.apache.hadoop.hbase.regionserver.HRegion}s then splits<a name="line.163"></a>
<span class="sourceLineNo">164</span> * are spanned across multiple {@link org.apache.hadoop.hbase.regionserver.HRegion}s and are<a name="line.164"></a>
<span class="sourceLineNo">165</span> * grouped the most evenly possible. In the case splits are uneven the bigger splits are placed<a name="line.165"></a>
<span class="sourceLineNo">166</span> * first in the {@link InputSplit} array.<a name="line.166"></a>
<span class="sourceLineNo">167</span> * @param job the map task {@link JobConf}<a name="line.167"></a>
<span class="sourceLineNo">168</span> * @param numSplits a hint to calculate the number of splits (mapred.map.tasks).<a name="line.168"></a>
<span class="sourceLineNo">169</span> * @return the input splits<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @see InputFormat#getSplits(org.apache.hadoop.mapred.JobConf, int)<a name="line.170"></a>
<span class="sourceLineNo">171</span> */<a name="line.171"></a>
<span class="sourceLineNo">172</span> public InputSplit[] getSplits(JobConf job, int numSplits) throws IOException {<a name="line.172"></a>
<span class="sourceLineNo">173</span> if (this.table == null) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> initialize(job);<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span> // null check in case our child overrides getTable to not throw.<a name="line.176"></a>
<span class="sourceLineNo">177</span> try {<a name="line.177"></a>
<span class="sourceLineNo">178</span> if (getTable() == null) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> // initialize() must not have been implemented in the subclass.<a name="line.179"></a>
<span class="sourceLineNo">180</span> throw new IOException(INITIALIZATION_ERROR);<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> } catch (IllegalStateException exception) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> throw new IOException(INITIALIZATION_ERROR, exception);<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span><a name="line.185"></a>
<span class="sourceLineNo">186</span> byte[][] startKeys = this.regionLocator.getStartKeys();<a name="line.186"></a>
<span class="sourceLineNo">187</span> if (startKeys == null || startKeys.length == 0) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> throw new IOException("Expecting at least one region");<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (this.inputColumns == null || this.inputColumns.length == 0) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> throw new IOException("Expecting at least one column");<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span> int realNumSplits = numSplits &gt; startKeys.length ? startKeys.length : numSplits;<a name="line.193"></a>
<span class="sourceLineNo">194</span> InputSplit[] splits = new InputSplit[realNumSplits];<a name="line.194"></a>
<span class="sourceLineNo">195</span> int middle = startKeys.length / realNumSplits;<a name="line.195"></a>
<span class="sourceLineNo">196</span> int startPos = 0;<a name="line.196"></a>
<span class="sourceLineNo">197</span> for (int i = 0; i &lt; realNumSplits; i++) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> int lastPos = startPos + middle;<a name="line.198"></a>
<span class="sourceLineNo">199</span> lastPos = startKeys.length % realNumSplits &gt; i ? lastPos + 1 : lastPos;<a name="line.199"></a>
<span class="sourceLineNo">200</span> String regionLocation = regionLocator.getRegionLocation(startKeys[startPos]).getHostname();<a name="line.200"></a>
<span class="sourceLineNo">201</span> splits[i] = new TableSplit(this.table.getName(), startKeys[startPos],<a name="line.201"></a>
<span class="sourceLineNo">202</span> ((i + 1) &lt; realNumSplits) ? startKeys[lastPos] : HConstants.EMPTY_START_ROW,<a name="line.202"></a>
<span class="sourceLineNo">203</span> regionLocation);<a name="line.203"></a>
<span class="sourceLineNo">204</span> LOG.info("split: " + i + "-&gt;" + splits[i]);<a name="line.204"></a>
<span class="sourceLineNo">205</span> startPos = lastPos;<a name="line.205"></a>
<span class="sourceLineNo">206</span> }<a name="line.206"></a>
<span class="sourceLineNo">207</span> return splits;<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span> /**<a name="line.210"></a>
<span class="sourceLineNo">211</span> * Allows subclasses to initialize the table information.<a name="line.211"></a>
<span class="sourceLineNo">212</span> * @param connection The Connection to the HBase cluster. MUST be unmanaged. We will close.<a name="line.212"></a>
<span class="sourceLineNo">213</span> * @param tableName The {@link TableName} of the table to process. n<a name="line.213"></a>
<span class="sourceLineNo">214</span> */<a name="line.214"></a>
<span class="sourceLineNo">215</span> protected void initializeTable(Connection connection, TableName tableName) throws IOException {<a name="line.215"></a>
<span class="sourceLineNo">216</span> if (this.table != null || this.connection != null) {<a name="line.216"></a>
<span class="sourceLineNo">217</span> LOG.warn("initializeTable called multiple times. Overwriting connection and table "<a name="line.217"></a>
<span class="sourceLineNo">218</span> + "reference; TableInputFormatBase will not close these old references when done.");<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span> this.table = connection.getTable(tableName);<a name="line.220"></a>
<span class="sourceLineNo">221</span> this.regionLocator = connection.getRegionLocator(tableName);<a name="line.221"></a>
<span class="sourceLineNo">222</span> this.connection = connection;<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span><a name="line.224"></a>
<span class="sourceLineNo">225</span> /**<a name="line.225"></a>
<span class="sourceLineNo">226</span> * @param inputColumns to be passed in {@link Result} to the map task.<a name="line.226"></a>
<span class="sourceLineNo">227</span> */<a name="line.227"></a>
<span class="sourceLineNo">228</span> protected void setInputColumns(byte[][] inputColumns) {<a name="line.228"></a>
<span class="sourceLineNo">229</span> this.inputColumns = inputColumns;<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span> /**<a name="line.232"></a>
<span class="sourceLineNo">233</span> * Allows subclasses to get the {@link Table}.<a name="line.233"></a>
<span class="sourceLineNo">234</span> */<a name="line.234"></a>
<span class="sourceLineNo">235</span> protected Table getTable() {<a name="line.235"></a>
<span class="sourceLineNo">236</span> if (table == null) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> throw new IllegalStateException(NOT_INITIALIZED);<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span> return this.table;<a name="line.239"></a>
<span class="sourceLineNo">240</span> }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span> /**<a name="line.242"></a>
<span class="sourceLineNo">243</span> * Allows subclasses to set the {@link TableRecordReader}. n * to provide other<a name="line.243"></a>
<span class="sourceLineNo">244</span> * {@link TableRecordReader} implementations.<a name="line.244"></a>
<span class="sourceLineNo">245</span> */<a name="line.245"></a>
<span class="sourceLineNo">246</span> protected void setTableRecordReader(TableRecordReader tableRecordReader) {<a name="line.246"></a>
<span class="sourceLineNo">247</span> this.tableRecordReader = tableRecordReader;<a name="line.247"></a>
<span class="sourceLineNo">248</span> }<a name="line.248"></a>
<span class="sourceLineNo">249</span><a name="line.249"></a>
<span class="sourceLineNo">250</span> /**<a name="line.250"></a>
<span class="sourceLineNo">251</span> * Allows subclasses to set the {@link Filter} to be used. n<a name="line.251"></a>
<span class="sourceLineNo">252</span> */<a name="line.252"></a>
<span class="sourceLineNo">253</span> protected void setRowFilter(Filter rowFilter) {<a name="line.253"></a>
<span class="sourceLineNo">254</span> this.rowFilter = rowFilter;<a name="line.254"></a>
<span class="sourceLineNo">255</span> }<a name="line.255"></a>
<span class="sourceLineNo">256</span><a name="line.256"></a>
<span class="sourceLineNo">257</span> /**<a name="line.257"></a>
<span class="sourceLineNo">258</span> * Handle subclass specific set up. Each of the entry points used by the MapReduce framework,<a name="line.258"></a>
<span class="sourceLineNo">259</span> * {@link #getRecordReader(InputSplit, JobConf, Reporter)} and {@link #getSplits(JobConf, int)},<a name="line.259"></a>
<span class="sourceLineNo">260</span> * will call {@link #initialize(JobConf)} as a convenient centralized location to handle<a name="line.260"></a>
<span class="sourceLineNo">261</span> * retrieving the necessary configuration information and calling<a name="line.261"></a>
<span class="sourceLineNo">262</span> * {@link #initializeTable(Connection, TableName)}.<a name="line.262"></a>
<span class="sourceLineNo">263</span> * &lt;p/&gt;<a name="line.263"></a>
<span class="sourceLineNo">264</span> * Subclasses should implement their initialize call such that it is safe to call multiple times.<a name="line.264"></a>
<span class="sourceLineNo">265</span> * The current TableInputFormatBase implementation relies on a non-null table reference to decide<a name="line.265"></a>
<span class="sourceLineNo">266</span> * if an initialize call is needed, but this behavior may change in the future. In particular, it<a name="line.266"></a>
<span class="sourceLineNo">267</span> * is critical that initializeTable not be called multiple times since this will leak Connection<a name="line.267"></a>
<span class="sourceLineNo">268</span> * instances.<a name="line.268"></a>
<span class="sourceLineNo">269</span> */<a name="line.269"></a>
<span class="sourceLineNo">270</span> protected void initialize(JobConf job) throws IOException {<a name="line.270"></a>
<span class="sourceLineNo">271</span> }<a name="line.271"></a>
<span class="sourceLineNo">272</span><a name="line.272"></a>
<span class="sourceLineNo">273</span> /**<a name="line.273"></a>
<span class="sourceLineNo">274</span> * Close the Table and related objects that were initialized via<a name="line.274"></a>
<span class="sourceLineNo">275</span> * {@link #initializeTable(Connection, TableName)}. n<a name="line.275"></a>
<span class="sourceLineNo">276</span> */<a name="line.276"></a>
<span class="sourceLineNo">277</span> protected void closeTable() throws IOException {<a name="line.277"></a>
<span class="sourceLineNo">278</span> close(table, connection);<a name="line.278"></a>
<span class="sourceLineNo">279</span> table = null;<a name="line.279"></a>
<span class="sourceLineNo">280</span> connection = null;<a name="line.280"></a>
<span class="sourceLineNo">281</span> }<a name="line.281"></a>
<span class="sourceLineNo">282</span><a name="line.282"></a>
<span class="sourceLineNo">283</span> private void close(Closeable... closables) throws IOException {<a name="line.283"></a>
<span class="sourceLineNo">284</span> for (Closeable c : closables) {<a name="line.284"></a>
<span class="sourceLineNo">285</span> if (c != null) {<a name="line.285"></a>
<span class="sourceLineNo">286</span> c.close();<a name="line.286"></a>
<span class="sourceLineNo">287</span> }<a name="line.287"></a>
<span class="sourceLineNo">288</span> }<a name="line.288"></a>
<span class="sourceLineNo">289</span> }<a name="line.289"></a>
<span class="sourceLineNo">290</span>}<a name="line.290"></a>
</pre>
</div>
</body>
</html>