org.apache.lens.cube.parse.BetweenTimeRangeWriter.java Source code

Introduction

Here is the source code for org.apache.lens.cube.parse.BetweenTimeRangeWriter.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 org.apache.lens.cube.parse;

import java.util.Set;
import java.util.TreeSet;

import org.apache.lens.cube.error.LensCubeErrorCode;
import org.apache.lens.cube.metadata.FactPartition;
import org.apache.lens.server.api.error.LensException;

import com.google.common.collect.BoundType;

/**
 * Writes partitions queried in timerange as between clause.
 */
public class BetweenTimeRangeWriter implements TimeRangeWriter {

    @Override
    public String getTimeRangeWhereClause(CubeQueryContext cubeQueryContext, String tableName,
            Set<FactPartition> rangeParts) throws LensException {
        if (rangeParts.size() == 0) {
            return "";
        }
        //Flag to check if only between range needs to be used
        boolean useBetweenOnly = cubeQueryContext.getConf().getBoolean(
                CubeQueryConfUtil.BETWEEN_ONLY_TIME_RANGE_WRITER,
                CubeQueryConfUtil.DEFAULT_BETWEEN_ONLY_TIME_RANGE_WRITER);

        //Fetch the date start and end bounds from config
        BoundType startBound = BoundType.valueOf(cubeQueryContext.getConf()
                .get(CubeQueryConfUtil.START_DATE_BOUND_TYPE, CubeQueryConfUtil.DEFAULT_START_BOUND_TYPE));
        BoundType endBound = BoundType.valueOf(cubeQueryContext.getConf().get(CubeQueryConfUtil.END_DATE_BOUND_TYPE,
                CubeQueryConfUtil.DEFAULT_END_BOUND_TYPE));

        StringBuilder partStr = new StringBuilder();
        if (!useBetweenOnly && rangeParts.size() == 1) {
            partStr.append("(");
            String partFilter = TimeRangeUtils.getTimeRangePartitionFilter(rangeParts.iterator().next(),
                    cubeQueryContext, tableName);
            partStr.append(partFilter);
            partStr.append(")");
        } else {
            TreeSet<FactPartition> parts = new TreeSet<>();
            FactPartition first = null;
            for (FactPartition part : rangeParts) {
                if (part.hasContainingPart()) {
                    throw new LensException(LensCubeErrorCode.CANNOT_USE_TIMERANGE_WRITER.getLensErrorInfo(),
                            "Partition has containing part");
                }
                if (first == null) {
                    first = part;
                } else {
                    // validate partcol, update period are same for both
                    if (!first.getPartCol().equalsIgnoreCase(part.getPartCol())) {
                        throw new LensException(LensCubeErrorCode.CANNOT_USE_TIMERANGE_WRITER.getLensErrorInfo(),
                                "Part columns are different in partitions");
                    }
                    if (!first.getPeriod().equals(part.getPeriod())) {
                        throw new LensException(LensCubeErrorCode.CANNOT_USE_TIMERANGE_WRITER.getLensErrorInfo(),
                                "Partitions are in different update periods");
                    }
                }
                parts.add(part);
            }

            FactPartition start = parts.first();
            FactPartition end = parts.last();

            if (startBound.equals(BoundType.OPEN)) {
                start = start.previous();
            }

            if (endBound.equals(BoundType.OPEN)) {
                end = end.next();
            }

            String partCol = start.getPartCol();
            if (!cubeQueryContext.shouldReplaceTimeDimWithPart()) {
                partCol = cubeQueryContext.getTimeDimOfPartitionColumn(partCol);
            }

            partStr.append(" (").append(tableName).append(".").append(partCol).append(" BETWEEN '")
                    .append(start.getFormattedPartSpec()).append("' AND '").append(end.getFormattedPartSpec())
                    .append("') ");
        }
        return partStr.toString();
    }
}