View Javadoc

1   /*
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  
20  package org.apache.hadoop.hbase.rest.model;
21  
22  import java.io.IOException;
23  import java.io.Serializable;
24  import java.util.ArrayList;
25  import java.util.List;
26  
27  import javax.xml.bind.annotation.XmlAccessType;
28  import javax.xml.bind.annotation.XmlAccessorType;
29  import javax.xml.bind.annotation.XmlElement;
30  import javax.xml.bind.annotation.XmlRootElement;
31  
32  import org.apache.hadoop.hbase.util.ByteStringer;
33  import org.apache.hadoop.hbase.classification.InterfaceAudience;
34  import org.apache.hadoop.hbase.HConstants;
35  import org.apache.hadoop.hbase.rest.ProtobufMessageHandler;
36  import org.apache.hadoop.hbase.rest.protobuf.generated.CellMessage.Cell;
37  import org.apache.hadoop.hbase.rest.protobuf.generated.CellSetMessage.CellSet;
38  
39  /**
40   * Representation of a grouping of cells. May contain cells from more than
41   * one row. Encapsulates RowModel and CellModel models.
42   * 
43   * <pre>
44   * &lt;complexType name="CellSet"&gt;
45   *   &lt;sequence&gt;
46   *     &lt;element name="row" type="tns:Row" maxOccurs="unbounded" 
47   *       minOccurs="1"&gt;&lt;/element&gt;
48   *   &lt;/sequence&gt;
49   * &lt;/complexType&gt;
50   * 
51   * &lt;complexType name="Row"&gt;
52   *   &lt;sequence&gt;
53   *     &lt;element name="key" type="base64Binary"&gt;&lt;/element&gt;
54   *     &lt;element name="cell" type="tns:Cell" 
55   *       maxOccurs="unbounded" minOccurs="1"&gt;&lt;/element&gt;
56   *   &lt;/sequence&gt;
57   * &lt;/complexType&gt;
58   *
59   * &lt;complexType name="Cell"&gt;
60   *   &lt;sequence&gt;
61   *     &lt;element name="value" maxOccurs="1" minOccurs="1"&gt;
62   *       &lt;simpleType&gt;
63   *         &lt;restriction base="base64Binary"/&gt;
64   *       &lt;/simpleType&gt;
65   *     &lt;/element&gt;
66   *   &lt;/sequence&gt;
67   *   &lt;attribute name="column" type="base64Binary" /&gt;
68   *   &lt;attribute name="timestamp" type="int" /&gt;
69   * &lt;/complexType&gt;
70   * </pre>
71   */
72  @XmlRootElement(name="CellSet")
73  @XmlAccessorType(XmlAccessType.FIELD)
74  @InterfaceAudience.Private
75  public class CellSetModel implements Serializable, ProtobufMessageHandler {
76  
77    private static final long serialVersionUID = 1L;
78  
79    @XmlElement(name="Row")
80    private List<RowModel> rows;
81  
82    /**  
83     * Constructor
84     */
85    public CellSetModel() {
86      this.rows = new ArrayList<RowModel>();
87    }
88    
89    /**
90     * @param rows the rows
91     */
92    public CellSetModel(List<RowModel> rows) {
93      super();
94      this.rows = rows;
95    }
96    
97    /**
98     * Add a row to this cell set
99     * @param row the row
100    */
101   public void addRow(RowModel row) {
102     rows.add(row);
103   }
104 
105   /**
106    * @return the rows
107    */
108   public List<RowModel> getRows() {
109     return rows;
110   }
111 
112   @Override
113   public byte[] createProtobufOutput() {
114     CellSet.Builder builder = CellSet.newBuilder();
115     for (RowModel row: getRows()) {
116       CellSet.Row.Builder rowBuilder = CellSet.Row.newBuilder();
117       rowBuilder.setKey(ByteStringer.wrap(row.getKey()));
118       for (CellModel cell: row.getCells()) {
119         Cell.Builder cellBuilder = Cell.newBuilder();
120         cellBuilder.setColumn(ByteStringer.wrap(cell.getColumn()));
121         cellBuilder.setData(ByteStringer.wrap(cell.getValue()));
122         if (cell.hasUserTimestamp()) {
123           cellBuilder.setTimestamp(cell.getTimestamp());
124         }
125         rowBuilder.addValues(cellBuilder);
126       }
127       builder.addRows(rowBuilder);
128     }
129     return builder.build().toByteArray();
130   }
131 
132   @Override
133   public ProtobufMessageHandler getObjectFromMessage(byte[] message)
134       throws IOException {
135     CellSet.Builder builder = CellSet.newBuilder();
136     builder.mergeFrom(message);
137     for (CellSet.Row row: builder.getRowsList()) {
138       RowModel rowModel = new RowModel(row.getKey().toByteArray());
139       for (Cell cell: row.getValuesList()) {
140         long timestamp = HConstants.LATEST_TIMESTAMP;
141         if (cell.hasTimestamp()) {
142           timestamp = cell.getTimestamp();
143         }
144         rowModel.addCell(
145             new CellModel(cell.getColumn().toByteArray(), timestamp,
146                   cell.getData().toByteArray()));
147       }
148       addRow(rowModel);
149     }
150     return this;
151   }
152 }