org.apache.poi.ss.formula.ptg.NameXPtg Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apache-poi Show documentation

The Apache Commons Codec package contains simple encoder and decoders for various formats such as Base64 and Hexadecimal. In addition to these widely used encoders and decoders, the codec package also maintains a collection of phonetic encoding utilities.

There is a newer version: 62

Show newest version

/* ====================================================================
   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.ss.formula.ptg;

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

import org.apache.poi.ss.formula.FormulaRenderingWorkbook;
import org.apache.poi.ss.formula.WorkbookDependentFormula;
import org.apache.poi.util.GenericRecordUtil;
import org.apache.poi.util.LittleEndianInput;
import org.apache.poi.util.LittleEndianOutput;

/**
 * A Name, be that a Named Range or a Function / User Defined
 *  Function, addressed in the HSSF External Sheet style.
 *
 * This is HSSF only, as it matches the HSSF file format way of
 *  referring to the sheet by an extern index. The XSSF equivalent
 *  is {@link NameXPxg}
 */
public final class NameXPtg extends OperandPtg implements WorkbookDependentFormula {
    public static final short sid = 0x39;
    private static final int SIZE = 7;

    /** index to REF entry in externsheet record */
    private final int _sheetRefIndex;
    /** index to defined name or externname table(1 based) */
    private final int _nameNumber;
    /** reserved must be 0 */
    private final int _reserved;

    private NameXPtg(int sheetRefIndex, int nameNumber, int reserved) {
        _sheetRefIndex = sheetRefIndex;
        _nameNumber = nameNumber;
        _reserved = reserved;
    }

    /**
     * @param sheetRefIndex index to REF entry in externsheet record
     * @param nameIndex index to defined name or externname table
     */
    public NameXPtg(int sheetRefIndex, int nameIndex) {
        this(sheetRefIndex, nameIndex + 1, 0);
    }

    public NameXPtg(LittleEndianInput in)  {
        this(in.readUShort(), in.readUShort(), in.readUShort());
    }

    public void write(LittleEndianOutput out) {
        out.writeByte(sid + getPtgClass());
        out.writeShort(_sheetRefIndex);
        out.writeShort(_nameNumber);
        out.writeShort(_reserved);
    }

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

    public int getSize() {
        return SIZE;
    }

    public String toFormulaString(FormulaRenderingWorkbook book) {
        // -1 to convert definedNameIndex from 1-based to zero-based
        return book.resolveNameXText(this);
    }
    public String toFormulaString() {
        throw new RuntimeException("3D references need a workbook to determine formula text");
    }

    @Override
    public byte getDefaultOperandClass() {
        return Ptg.CLASS_VALUE;
    }

    public int getSheetRefIndex() {
        return _sheetRefIndex;
    }
    public int getNameIndex() {
        return _nameNumber - 1;
    }

    @Override
    public NameXPtg copy() {
        // immutable
        return this;
    }

    @Override
    public Map> getGenericProperties() {
        return GenericRecordUtil.getGenericProperties(
            "sheetRefIndex", this::getSheetRefIndex,
            "nameIndex", this::getNameIndex
        );
    }
}