com.impetus.client.cassandra.index.CassandraIndexHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kundera-cassandra Show documentation

There is a newer version: 3.13

/**
 * Copyright 2012 Impetus Infotech.
 *
 * 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.impetus.client.cassandra.index;

import org.apache.cassandra.thrift.IndexType;

import com.impetus.client.cassandra.config.CassandraPropertyReader;
import com.impetus.kundera.Constants;
import com.impetus.kundera.metadata.model.EntityMetadata;

/**
 * Provides functionalities related to indexing in cassandra
 * 
 * @author amresh.singh
 */
public class CassandraIndexHelper
{
    /**
     * Generates inverted index table name for a given table
     * 
     * @param tableName
     * @return
     */
    public static String getInvertedIndexTableName(String tableName)
    {
        return tableName + Constants.INDEX_TABLE_SUFFIX;
    }

    /**
     * Checks whether Inverted indexing is applicable for a given entity whose
     * metadata is passed as parameter
     * 
     * @param m
     * @return
     */
    public static boolean isInvertedIndexingApplicable(EntityMetadata m, boolean useSecondryIndex)
    {
        boolean invertedIndexingApplicable = useSecondryIndex
                && CassandraPropertyReader.csmd.isInvertedIndexingEnabled(m.getSchema())
                && m.getType().isSuperColumnFamilyMetadata() && !m.isCounterColumnType();

        return invertedIndexingApplicable;
    }

    /**
     * @param indexType
     * @return
     */
    public static IndexType getIndexType(String indexType)
    {
        if (indexType != null)
        {
            if (indexType.equals(IndexType.KEYS.name()))
            {
                return IndexType.KEYS;
            }
            else if (indexType.equals(IndexType.CUSTOM.name()))
            {
                return IndexType.CUSTOM;
            }
        }
        return IndexType.KEYS;
    }

}