| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.client, class: Operation"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Map;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.util.JsonMapper;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">024</span><span id="line-24"></span> |
| <span class="source-line-no">025</span><span id="line-25">/**</span> |
| <span class="source-line-no">026</span><span id="line-26"> * Superclass for any type that maps to a potentially application-level query. (e.g. Put, Get,</span> |
| <span class="source-line-no">027</span><span id="line-27"> * Delete, Scan, Next, etc.) Contains methods for exposure to logging and debugging tools.</span> |
| <span class="source-line-no">028</span><span id="line-28"> */</span> |
| <span class="source-line-no">029</span><span id="line-29">@InterfaceAudience.Public</span> |
| <span class="source-line-no">030</span><span id="line-30">public abstract class Operation {</span> |
| <span class="source-line-no">031</span><span id="line-31"> // TODO make this configurable</span> |
| <span class="source-line-no">032</span><span id="line-32"> // TODO Do we need this anymore now we have protobuffed it all?</span> |
| <span class="source-line-no">033</span><span id="line-33"> private static final int DEFAULT_MAX_COLS = 5;</span> |
| <span class="source-line-no">034</span><span id="line-34"></span> |
| <span class="source-line-no">035</span><span id="line-35"> /**</span> |
| <span class="source-line-no">036</span><span id="line-36"> * Produces a Map containing a fingerprint which identifies the type and the static schema</span> |
| <span class="source-line-no">037</span><span id="line-37"> * components of a query (i.e. column families)</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @return a map containing fingerprint information (i.e. column families)</span> |
| <span class="source-line-no">039</span><span id="line-39"> */</span> |
| <span class="source-line-no">040</span><span id="line-40"> public abstract Map<String, Object> getFingerprint();</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42"> /**</span> |
| <span class="source-line-no">043</span><span id="line-43"> * Produces a Map containing a summary of the details of a query beyond the scope of the</span> |
| <span class="source-line-no">044</span><span id="line-44"> * fingerprint (i.e. columns, rows...)</span> |
| <span class="source-line-no">045</span><span id="line-45"> * @param maxCols a limit on the number of columns output prior to truncation</span> |
| <span class="source-line-no">046</span><span id="line-46"> * @return a map containing parameters of a query (i.e. rows, columns...)</span> |
| <span class="source-line-no">047</span><span id="line-47"> */</span> |
| <span class="source-line-no">048</span><span id="line-48"> public abstract Map<String, Object> toMap(int maxCols);</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> /**</span> |
| <span class="source-line-no">051</span><span id="line-51"> * Produces a Map containing a full summary of a query.</span> |
| <span class="source-line-no">052</span><span id="line-52"> * @return a map containing parameters of a query (i.e. rows, columns...)</span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54"> public Map<String, Object> toMap() {</span> |
| <span class="source-line-no">055</span><span id="line-55"> return toMap(DEFAULT_MAX_COLS);</span> |
| <span class="source-line-no">056</span><span id="line-56"> }</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /**</span> |
| <span class="source-line-no">059</span><span id="line-59"> * Produces a JSON object for fingerprint and details exposure in a parseable format.</span> |
| <span class="source-line-no">060</span><span id="line-60"> * @param maxCols a limit on the number of columns to include in the JSON</span> |
| <span class="source-line-no">061</span><span id="line-61"> * @return a JSONObject containing this Operation's information, as a string</span> |
| <span class="source-line-no">062</span><span id="line-62"> */</span> |
| <span class="source-line-no">063</span><span id="line-63"> public String toJSON(int maxCols) throws IOException {</span> |
| <span class="source-line-no">064</span><span id="line-64"> return JsonMapper.writeMapAsString(toMap(maxCols));</span> |
| <span class="source-line-no">065</span><span id="line-65"> }</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> /**</span> |
| <span class="source-line-no">068</span><span id="line-68"> * Produces a JSON object sufficient for description of a query in a debugging or logging context.</span> |
| <span class="source-line-no">069</span><span id="line-69"> * @return the produced JSON object, as a string</span> |
| <span class="source-line-no">070</span><span id="line-70"> */</span> |
| <span class="source-line-no">071</span><span id="line-71"> public String toJSON() throws IOException {</span> |
| <span class="source-line-no">072</span><span id="line-72"> return toJSON(DEFAULT_MAX_COLS);</span> |
| <span class="source-line-no">073</span><span id="line-73"> }</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> /**</span> |
| <span class="source-line-no">076</span><span id="line-76"> * Produces a string representation of this Operation. It defaults to a JSON representation, but</span> |
| <span class="source-line-no">077</span><span id="line-77"> * falls back to a string representation of the fingerprint and details in the case of a JSON</span> |
| <span class="source-line-no">078</span><span id="line-78"> * encoding failure.</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param maxCols a limit on the number of columns output in the summary prior to truncation</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @return a JSON-parseable String</span> |
| <span class="source-line-no">081</span><span id="line-81"> */</span> |
| <span class="source-line-no">082</span><span id="line-82"> public String toString(int maxCols) {</span> |
| <span class="source-line-no">083</span><span id="line-83"> /*</span> |
| <span class="source-line-no">084</span><span id="line-84"> * for now this is merely a wrapper from producing a JSON string, but toJSON is kept separate in</span> |
| <span class="source-line-no">085</span><span id="line-85"> * case this is changed to be a less parsable pretty printed representation.</span> |
| <span class="source-line-no">086</span><span id="line-86"> */</span> |
| <span class="source-line-no">087</span><span id="line-87"> try {</span> |
| <span class="source-line-no">088</span><span id="line-88"> return toJSON(maxCols);</span> |
| <span class="source-line-no">089</span><span id="line-89"> } catch (IOException ioe) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> return toMap(maxCols).toString();</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"> }</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> /**</span> |
| <span class="source-line-no">095</span><span id="line-95"> * Produces a string representation of this Operation. It defaults to a JSON representation, but</span> |
| <span class="source-line-no">096</span><span id="line-96"> * falls back to a string representation of the fingerprint and details in the case of a JSON</span> |
| <span class="source-line-no">097</span><span id="line-97"> * encoding failure.</span> |
| <span class="source-line-no">098</span><span id="line-98"> */</span> |
| <span class="source-line-no">099</span><span id="line-99"> @Override</span> |
| <span class="source-line-no">100</span><span id="line-100"> public String toString() {</span> |
| <span class="source-line-no">101</span><span id="line-101"> return toString(DEFAULT_MAX_COLS);</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</span> |
| <span class="source-line-no">103</span><span id="line-103">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
