com.netflix.astyanax.model.ColumnFamily Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of astyanax-cassandra Show documentation
astyanax-cassandra
There is a newer version: 3.10.2
/*******************************************************************************
 * Copyright 2011 Netflix
 * 
 * Licensed 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.netflix.astyanax.model;

import com.netflix.astyanax.Keyspace;
import com.netflix.astyanax.Serializer;
import com.netflix.astyanax.connectionpool.exceptions.ConnectionException;
import com.netflix.astyanax.ddl.ColumnFamilyDefinition;
import com.netflix.astyanax.ddl.KeyspaceDefinition;
import com.netflix.astyanax.impl.PreparedIndexExpressionImpl;
import com.netflix.astyanax.query.PreparedIndexExpression;
import com.netflix.astyanax.serializers.ByteBufferSerializer;

/**
 * Basic column family definition. The column family definition encapsulates the
 * column family name as well as the type and serializers for the row keys and
 * first level columns. Super column subcolumn name type and serializers are
 * specified using a ColumnPath.
 * 
 * @author elandau
 * 
 * @param 
 * @param 
 */
public class ColumnFamily implements Comparable>{
    private final String columnFamilyName;
    private final Serializer keySerializer;
    private final Serializer columnSerializer;
    private final Serializer defaultValueSerializer;
    private final ColumnType type;

    private ColumnFamilyDefinition cfDef; 
    
    private String keyAlias = "key";
    
    /**
     * @param columnFamilyName
     * @param keySerializer
     * @param columnSerializer
     * @param type
     * @deprecated Super columns should be replaced with composite columns
     */
    public ColumnFamily(String columnFamilyName, Serializer keySerializer, Serializer columnSerializer,
            ColumnType type) {
        this.columnFamilyName = columnFamilyName;
        this.keySerializer = keySerializer;
        this.columnSerializer = columnSerializer;
        this.defaultValueSerializer = ByteBufferSerializer.get();
        this.type = type;
    }

    public ColumnFamily(String columnFamilyName, Serializer keySerializer, Serializer columnSerializer) {
        this(columnFamilyName, keySerializer, columnSerializer, ByteBufferSerializer.get());
    }

    public ColumnFamily(String columnFamilyName, Serializer keySerializer, Serializer columnSerializer, Serializer defaultValueSerializer) {
        this.columnFamilyName = columnFamilyName;
        this.keySerializer = keySerializer;
        this.columnSerializer = columnSerializer;
        this.defaultValueSerializer = defaultValueSerializer;
        this.type = ColumnType.STANDARD;
    }
    
    public String getName() {
        return columnFamilyName;
    }
    
    /**
     * Serializer for first level column names. This serializer does not apply
     * to sub column names.
     * 
     * @return
     */
    public Serializer getColumnSerializer() {
        return columnSerializer;
    }

    /**
     * Serializer used to generate row keys.
     * 
     * @return
     */
    public Serializer getKeySerializer() {
        return keySerializer;
    }
    
    public Serializer getDefaultValueSerializer() {
        return defaultValueSerializer;
    }

    /**
     * Type of columns in this column family (Standard or Super)
     * 
     * @deprecated Super columns should be replaced with composite columns
     * @return
     */
    public ColumnType getType() {
        return type;
    }
    
    public void setKeyAlias(String alias) {
    	keyAlias = alias; 
    }

    public String getKeyAlias() {
    	return keyAlias;
    }
    
    public PreparedIndexExpression newIndexClause() {
        return new PreparedIndexExpressionImpl(this.columnSerializer);
    }

    public static  ColumnFamily newColumnFamily(String columnFamilyName, Serializer keySerializer,
            Serializer columnSerializer) {
        return new ColumnFamily(columnFamilyName, keySerializer, columnSerializer);
    }
    
    public static  ColumnFamily newColumnFamily(String columnFamilyName, Serializer keySerializer,
            Serializer columnSerializer, Serializer defaultSerializer) {
        return new ColumnFamily(columnFamilyName, keySerializer, columnSerializer, defaultSerializer);
    }

    @Override
    public int compareTo(ColumnFamily other) {
        return getName().compareTo(other.getName());
    }

    @Override
    public boolean equals(Object obj) {
        
        if (this == obj) return true;
        if (obj == null) return false;
        
        if (!(obj instanceof ColumnFamily))
            return false;
        
        ColumnFamily other = (ColumnFamily) obj;
        return (getName() == null) ? other.getName() == null : getName().equals(other.getName());
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((getName() == null) ? 0 : getName().hashCode());
        return result;
    }
    
    public boolean inThriftMode() {
    	return true;
    }
    
    public ColumnFamilyDefinition describe(Keyspace keyspace) throws ConnectionException {
    	
		KeyspaceDefinition ksDef = keyspace.describeKeyspace();
		cfDef = ksDef.getColumnFamily(this.getName());
    	return cfDef;
    }
    
    public ColumnFamilyDefinition getColumnFamilyDefinition() {
    	return cfDef;
    }
    
}