org.apache.poi.hssf.record.pivottable.ExtendedPivotTableViewFieldsRecord Maven / Gradle / Ivy

/* ====================================================================
   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.poi.hssf.record.pivottable;

import java.util.Map;
import java.util.function.Supplier;

import org.apache.poi.hssf.record.HSSFRecordTypes;
import org.apache.poi.hssf.record.RecordInputStream;
import org.apache.poi.hssf.record.StandardRecord;
import org.apache.poi.util.GenericRecordUtil;
import org.apache.poi.util.LittleEndianOutput;
import org.apache.poi.util.RecordFormatException;
import org.apache.poi.util.StringUtil;

/**
 * SXVDEX - Extended PivotTable View Fields (0x0100)
 */
public final class ExtendedPivotTableViewFieldsRecord extends StandardRecord {
    public static final short sid = 0x0100;

    /** the value of the subname length when the {@link #_subtotalName} is not present */
    private static final int STRING_NOT_PRESENT_LEN = 0xFFFF;

    private int _grbit1;
    private int _grbit2;
    private int _citmShow;
    private int _isxdiSort;
    private int _isxdiShow;
    private int _reserved1;
    private int _reserved2;
    /** custom sub-total name */
    private String _subtotalName;

    public ExtendedPivotTableViewFieldsRecord(ExtendedPivotTableViewFieldsRecord other) {
        super(other);
        _grbit1 = other._grbit1;
        _grbit2 = other._grbit2;
        _citmShow = other._citmShow;
        _isxdiSort = other._isxdiSort;
        _isxdiShow = other._isxdiShow;
        _reserved1 = other._reserved1;
        _reserved2 = other._reserved2;
        _subtotalName = other._subtotalName;
    }

    public ExtendedPivotTableViewFieldsRecord(RecordInputStream in) {
        _grbit1 = in.readInt();
        _grbit2 = in.readUByte();
        _citmShow = in.readUByte();
        _isxdiSort = in.readUShort();
        _isxdiShow = in.readUShort();
        // This record seems to have different valid encodings
        switch (in.remaining()) {
            case 0:
                // as per "Microsoft Excel Developer's Kit" book
                // older version of SXVDEX - doesn't seem to have a sub-total name
                _reserved1 = 0;
                _reserved2 = 0;
                _subtotalName = null;
                return;
            case 10:
                // as per "MICROSOFT OFFICE EXCEL 97-2007 BINARY FILE FORMAT SPECIFICATION" pdf
                break;
            default:
                throw new RecordFormatException("Unexpected remaining size (" + in.remaining() + ")");
        }
        int cchSubName = in.readUShort();
        _reserved1 = in.readInt();
        _reserved2 = in.readInt();
        if (cchSubName != STRING_NOT_PRESENT_LEN) {
            _subtotalName = in.readUnicodeLEString(cchSubName);
        }
    }

    @Override
    protected void serialize(LittleEndianOutput out) {

        out.writeInt(_grbit1);
        out.writeByte(_grbit2);
        out.writeByte(_citmShow);
        out.writeShort(_isxdiSort);
        out.writeShort(_isxdiShow);

        if (_subtotalName == null) {
            out.writeShort(STRING_NOT_PRESENT_LEN);
        } else {
            out.writeShort(_subtotalName.length());
        }

        out.writeInt(_reserved1);
        out.writeInt(_reserved2);
        if (_subtotalName != null) {
            StringUtil.putUnicodeLE(_subtotalName, out);
        }
    }

    @Override
    protected int getDataSize() {

        return 4 + 1 + 1 + 2 + 2 + 2 +  4 + 4 +
                    (_subtotalName == null ? 0 : (2*_subtotalName.length())); // in unicode
    }

    @Override
    public short getSid() {
        return sid;
    }

    @Override
    public ExtendedPivotTableViewFieldsRecord copy() {
        return new ExtendedPivotTableViewFieldsRecord(this);
    }

    @Override
    public HSSFRecordTypes getGenericRecordType() {
        return HSSFRecordTypes.EXTENDED_PIVOT_TABLE_VIEW_FIELDS;
    }

    @Override
    public Map> getGenericProperties() {
        return GenericRecordUtil.getGenericProperties(
            "grbit1", () -> _grbit1,
            "grbit2", () -> _grbit2,
            "citmShow", () -> _citmShow,
            "isxdiSort", () -> _isxdiSort,
            "isxdiShow", () -> _isxdiShow,
            "subtotalName", () -> _subtotalName
        );
    }
}