content: /*
   * 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.carbondata.core.datastore.page;
  
  import java.io.IOException;
  import java.math.BigDecimal;
  import java.nio.ByteBuffer;
  
  import org.apache.carbondata.common.logging.LogServiceFactory;
  import org.apache.carbondata.core.constants.CarbonCommonConstants;
  import org.apache.carbondata.core.keygenerator.KeyGenerator;
  import org.apache.carbondata.core.keygenerator.factory.KeyGeneratorFactory;
  import org.apache.carbondata.core.localdictionary.PageLevelDictionary;
  import org.apache.carbondata.core.localdictionary.exception.DictionaryThresholdReachedException;
  import org.apache.carbondata.core.localdictionary.generator.LocalDictionaryGenerator;
  import org.apache.carbondata.core.metadata.datatype.DataType;
  import org.apache.carbondata.core.metadata.datatype.DataTypes;
  
  import org.apache.log4j.Logger;
  
  /**
   * Column page implementation for Local dictionary generated columns
   * Its a decorator over two column page
   * 1. Which will hold the actual data
   * 2. Which will hold the dictionary encoded data
   */
  public class LocalDictColumnPage extends ColumnPage {
  
    /**
     * LOGGER
     */
    private static final Logger LOGGER =
        LogServiceFactory.getLogService(LocalDictColumnPage.class.getName());
  
    /**
     * to maintain page level dictionary for column page
     */
    private PageLevelDictionary pageLevelDictionary;
  
    /**
     * to hold the actual data of the column
     */
    private ColumnPage actualDataColumnPage;
  
    /**
     * to hold the dictionary encoded column page
     */
    private ColumnPage encodedDataColumnPage;
  
    /**
     * to check if actual column page memory is already clear
     */
    private boolean isActualPageMemoryFreed;
  
    private KeyGenerator keyGenerator;
  
    private int[] dummyKey;
  
    private boolean isDecoderBasedFallBackEnabled;
  
    /**
     * Create a new column page with input data type and page size.
     */
    protected LocalDictColumnPage(ColumnPage actualDataColumnPage, ColumnPage encodedColumnPage,
        LocalDictionaryGenerator localDictionaryGenerator, boolean isComplexTypePrimitive,
        boolean isDecoderBasedFallBackEnabled) {
      super(actualDataColumnPage.getColumnPageEncoderMeta(), actualDataColumnPage.getPageSize());
      // if threshold is not reached then create page level dictionary
      // for encoding with local dictionary
      if (!localDictionaryGenerator.isThresholdReached()) {
        pageLevelDictionary = new PageLevelDictionary(localDictionaryGenerator,
            actualDataColumnPage.getColumnSpec().getFieldName(), actualDataColumnPage.getDataType(),
            isComplexTypePrimitive, actualDataColumnPage.getColumnCompressorName());
        this.encodedDataColumnPage = encodedColumnPage;
        this.keyGenerator = KeyGeneratorFactory
            .getKeyGenerator(new int[] { CarbonCommonConstants.LOCAL_DICTIONARY_MAX + 1 });
        this.dummyKey = new int[1];
      } else {
        // else free the encoded column page memory as its of no use
        encodedColumnPage.freeMemory();
      }
      this.isDecoderBasedFallBackEnabled = isDecoderBasedFallBackEnabled;
      this.actualDataColumnPage = actualDataColumnPage;
    }
  
    @Override
    public byte[][] getByteArrayPage() {
      if (null != pageLevelDictionary) {
        return encodedDataColumnPage.getByteArrayPage();
      } else {
        return actualDataColumnPage.getByteArrayPage();
      }
    }
  
    @Override
    public ByteBuffer getByteBuffer() {
      if (null != pageLevelDictionary) {
        return encodedDataColumnPage.getByteBuffer();
      } else {
        return actualDataColumnPage.getByteBuffer();
      }
    }
  
    /**
     * Below method will be used to check whether page is local dictionary
     * generated or not. This will be used for while encoding the the page
     *
     * @return
     */
    public boolean isLocalDictGeneratedPage() {
      return null != pageLevelDictionary;
    }
  
    /**
     * Below method will be used to add column data to page
     *
     * @param rowId row number
     * @param bytes actual data
     */
    @Override
    public void putBytes(int rowId, byte[] bytes) {
      if (null != pageLevelDictionary) {
        try {
          actualDataColumnPage.putBytes(rowId, bytes);
          byte[] input;
          DataType dataType = actualDataColumnPage.columnPageEncoderMeta.getStoreDataType();
          if (dataType == DataTypes.STRING) {
            ByteBuffer byteBuffer = ByteBuffer.allocate(bytes.length + 2);
            byteBuffer.putShort((short) bytes.length);
            byteBuffer.put(bytes);
            input = byteBuffer.array();
          } else if (dataType == DataTypes.VARCHAR || dataType == DataTypes.BINARY) {
            ByteBuffer byteBuffer = ByteBuffer.allocate(bytes.length + 4);
            byteBuffer.putInt(bytes.length);
            byteBuffer.put(bytes);
            input = byteBuffer.array();
          } else {
            input = bytes;
          }
          dummyKey[0] = pageLevelDictionary.getDictionaryValue(input);
          encodedDataColumnPage.putBytes(rowId, keyGenerator.generateKey(dummyKey));
        } catch (DictionaryThresholdReachedException e) {
          LOGGER.warn("Local Dictionary threshold reached for the column: " + actualDataColumnPage
              .getColumnSpec().getFieldName() + ", " + e.getMessage());
          pageLevelDictionary = null;
          encodedDataColumnPage.freeMemory();
          encodedDataColumnPage = null;
        }
      } else {
        actualDataColumnPage.putBytes(rowId, bytes);
      }
      if (pageSize <= rowId) {
        pageSize = rowId + 1;
      }
    }
  
    @Override
    public void disableLocalDictEncoding() {
      pageLevelDictionary = null;
      freeEncodedColumnPage();
    }
  
    @Override
    public PageLevelDictionary getColumnPageDictionary() {
      return pageLevelDictionary;
    }
  
    @Override
    public void setBytePage(byte[] byteData) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void setShortPage(short[] shortData) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void setShortIntPage(byte[] shortIntData) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void setIntPage(int[] intData) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void setLongPage(long[] longData) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void setFloatPage(float[] floatData) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void setDoublePage(double[] doubleData) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void setByteArrayPage(byte[][] byteArray) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void freeMemory() {
      // free the encoded column page as data is already encoded and it is of no use, during fallback
      // if goes to actual databased fallback, we need actual data and decoder based fallback we need
      // just the encoded data to form a new page
      if (null != encodedDataColumnPage) {
        encodedDataColumnPage.freeMemory();
      }
      if (isDecoderBasedFallBackEnabled) {
        actualDataColumnPage.freeMemory();
        isActualPageMemoryFreed = true;
      } else if (null == pageLevelDictionary) {
        actualDataColumnPage.freeMemory();
        isActualPageMemoryFreed = true;
      }
    }
  
    public void freeMemoryForce() {
      if (!isActualPageMemoryFreed) {
        actualDataColumnPage.freeMemory();
        isActualPageMemoryFreed = true;
      }
    }
  
    private void freeEncodedColumnPage() {
      if (null != encodedDataColumnPage) {
        encodedDataColumnPage.freeMemory();
        encodedDataColumnPage = null;
      }
    }
  
    @Override
    public void putByte(int rowId, byte value) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void putShort(int rowId, short value) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void putInt(int rowId, int value) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void putLong(int rowId, long value) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void putDouble(int rowId, double value) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void putFloat(int rowId, float value) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void putDecimal(int rowId, BigDecimal decimal) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void putShortInt(int rowId, int value) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void putBytes(int rowId, byte[] bytes, int offset, int length) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public byte getByte(int rowId) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public short getShort(int rowId) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public int getShortInt(int rowId) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public int getInt(int rowId) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public long getLong(int rowId) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public float getFloat(int rowId) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public double getDouble(int rowId) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public BigDecimal getDecimal(int rowId) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public byte[] getBytes(int rowId) {
      return actualDataColumnPage.getBytes(rowId);
    }
  
    @Override
    public byte[] getBytePage() {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public short[] getShortPage() {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public byte[] getShortIntPage() {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public int[] getIntPage() {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public long[] getLongPage() {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public float[] getFloatPage() {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public double[] getDoublePage() {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public byte[] getLVFlattenedBytePage() throws IOException {
      if (null != encodedDataColumnPage) {
        return encodedDataColumnPage.getLVFlattenedBytePage();
      } else {
        return actualDataColumnPage.getLVFlattenedBytePage();
      }
    }
  
    @Override
    public byte[] getComplexChildrenLVFlattenedBytePage(DataType dataType) throws IOException {
      if (null != encodedDataColumnPage) {
        return encodedDataColumnPage.getComplexChildrenLVFlattenedBytePage(dataType);
      } else {
        return actualDataColumnPage.getComplexChildrenLVFlattenedBytePage(dataType);
      }
    }
  
    @Override
    public byte[] getComplexParentFlattenedBytePage() throws IOException {
      if (null != encodedDataColumnPage) {
        return encodedDataColumnPage.getComplexParentFlattenedBytePage();
      } else {
        return actualDataColumnPage.getComplexParentFlattenedBytePage();
      }
    }
  
    @Override
    public byte[] getDecimalPage() {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public void convertValue(ColumnPageValueConverter codec) {
      throw new UnsupportedOperationException("Operation not supported");
    }
  
    @Override
    public long getPageLengthInBytes() throws IOException {
      if (null != pageLevelDictionary) {
        return encodedDataColumnPage.getPageLengthInBytes();
      } else {
        return actualDataColumnPage.getPageLengthInBytes();
      }
    }
  }
  