com.facebook.infrastructure.db.Column.java Source code

Java tutorial

Introduction

Here is the source code for com.facebook.infrastructure.db.Column.java

Source

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.facebook.infrastructure.db;

import com.facebook.infrastructure.utils.FBUtilities;
import org.apache.log4j.Logger;
import org.apache.commons.lang.ArrayUtils;

import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.util.Collection;

/**
 * Author : Avinash Lakshman ( alakshman@facebook.com) & Prashant Malik ( pmalik@facebook.com )
 */

public final class Column implements IColumn {
    private static Logger logger_ = Logger.getLogger(SuperColumn.class);
    private static ColumnSerializer serializer_ = new ColumnSerializer();

    static ColumnSerializer serializer() {
        return serializer_;
    }

    private final String name;
    private final byte[] value;
    private final long timestamp;
    private final boolean isMarkedForDelete;

    Column(String name) {
        this(name, ArrayUtils.EMPTY_BYTE_ARRAY);
    }

    Column(String name, byte[] value) {
        this(name, value, 0);
    }

    Column(String name, byte[] value, long timestamp) {
        this(name, value, timestamp, false);
    }

    Column(String name, byte[] value, long timestamp, boolean isDeleted) {
        assert name != null;
        assert value != null;
        this.name = name;
        this.value = value;
        this.timestamp = timestamp;
        isMarkedForDelete = isDeleted;
    }

    public String name() {
        return name;
    }

    public String name(String key) {
        throw new UnsupportedOperationException("This operation is unsupported on simple columns.");
    }

    public byte[] value() {
        return value;
    }

    public byte[] value(String key) {
        throw new UnsupportedOperationException("This operation is unsupported on simple columns.");
    }

    public Collection<IColumn> getSubColumns() {
        throw new UnsupportedOperationException("This operation is unsupported on simple columns.");
    }

    public int getObjectCount() {
        return 1;
    }

    public long timestamp() {
        return timestamp;
    }

    public long timestamp(String key) {
        throw new UnsupportedOperationException("This operation is unsupported on simple columns.");
    }

    public boolean isMarkedForDelete() {
        return isMarkedForDelete;
    }

    public long getMarkedForDeleteAt() {
        if (!isMarkedForDelete()) {
            throw new IllegalStateException("column is not marked for delete");
        }
        return timestamp;
    }

    public int size() {
        /*
         * Size of a column is =
         *   size of a name (UtfPrefix + length of the string)
         * + 1 byte to indicate if the column has been deleted
         * + 8 bytes for timestamp
         * + 4 bytes which basically indicates the size of the byte array
         * + entire byte array.
        */

        /*
         * We store the string as UTF-8 encoded, so when we calculate the length, it
         * should be converted to UTF-8.
         */
        return IColumn.UtfPrefix_ + FBUtilities.getUTF8Length(name) + DBConstants.boolSize_ + DBConstants.tsSize_
                + DBConstants.intSize_ + value.length;
    }

    /*
     * This returns the size of the column when serialized.
     * @see com.facebook.infrastructure.db.IColumn#serializedSize()
    */
    public int serializedSize() {
        return size();
    }

    public void addColumn(String name, IColumn column) {
        throw new UnsupportedOperationException("This operation is not supported for simple columns.");
    }

    public IColumn diff(IColumn column) {
        if (timestamp() < column.timestamp()) {
            return column;
        }
        return null;
    }

    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append(name);
        sb.append(":");
        sb.append(isMarkedForDelete());
        sb.append(":");
        sb.append(value().length);
        sb.append("@");
        sb.append(timestamp());
        return sb.toString();
    }

    public byte[] digest() {
        StringBuilder stringBuilder = new StringBuilder();
        stringBuilder.append(name);
        stringBuilder.append(":");
        stringBuilder.append(timestamp);
        return stringBuilder.toString().getBytes();
    }

}

class ColumnSerializer implements ICompactSerializer2<IColumn> {
    public void serialize(IColumn column, DataOutputStream dos) throws IOException {
        dos.writeUTF(column.name());
        dos.writeBoolean(column.isMarkedForDelete());
        dos.writeLong(column.timestamp());
        dos.writeInt(column.value().length);
        dos.write(column.value());
    }

    private IColumn defreeze(DataInputStream dis, String name) throws IOException {
        IColumn column = null;
        boolean delete = dis.readBoolean();
        long ts = dis.readLong();
        int size = dis.readInt();
        byte[] value = new byte[size];
        dis.readFully(value);
        column = new Column(name, value, ts, delete);
        return column;
    }

    public IColumn deserialize(DataInputStream dis) throws IOException {
        String name = dis.readUTF();
        return defreeze(dis, name);
    }

    /**
     * Here we need to get the column and apply the filter.
     */
    public IColumn deserialize(DataInputStream dis, IFilter filter) throws IOException {
        if (dis.available() == 0)
            return null;

        String name = dis.readUTF();
        IColumn column = new Column(name);
        column = filter.filter(column, dis);
        if (column != null) {
            column = defreeze(dis, name);
        } else {
            /* Skip a boolean and the timestamp */
            dis.skip(DBConstants.boolSize_ + DBConstants.tsSize_);
            int size = dis.readInt();
            dis.skip(size);
        }
        return column;
    }

    /**
     * We know the name of the column here so just return it.
     * Filter is pretty much useless in this call and is ignored.
     */
    public IColumn deserialize(DataInputStream dis, String columnName, IFilter filter) throws IOException {
        if (dis.available() == 0)
            return null;
        IColumn column = null;
        String name = dis.readUTF();
        if (name.equals(columnName)) {
            column = defreeze(dis, name);
            if (filter instanceof IdentityFilter) {
                /*
                 * If this is being called with identity filter
                 * since a column name is passed in we know
                 * that this is a final call 
                 * Hence if the column is found set the filter to done 
                 * so that we do not look for the column in further files
                 */
                IdentityFilter f = (IdentityFilter) filter;
                f.setDone();
            }
        } else {
            /* Skip a boolean and the timestamp */
            dis.skip(DBConstants.boolSize_ + DBConstants.tsSize_);
            int size = dis.readInt();
            dis.skip(size);
        }
        return column;
    }

    public void skip(DataInputStream dis) throws IOException {
        /* read the column name */
        dis.readUTF();
        /* boolean indicating if the column is deleted */
        dis.readBoolean();
        /* timestamp associated with the column */
        dis.readLong();
        /* size of the column */
        int size = dis.readInt();
        dis.skip(size);
    }
}