org.apache.poi.hssf.record.chart.SeriesTextRecord Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi Show documentation
Apache POI - Java API To Access Microsoft Format Files
There is a newer version: 5.2.5
/* ====================================================================
   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.chart;

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.StringUtil;

/**
 * SERIESTEXT (0x100D)
 * Defines a series name
 */
public final class SeriesTextRecord extends StandardRecord {
    public static final short sid = 0x100D;

    /**
     * the actual text cannot be longer than 255 characters
     */
    private static final int MAX_LEN = 0xFF;

    private int field_1_id;
    private boolean is16bit;
    private String field_4_text;

    public SeriesTextRecord() {
        field_4_text = "";
        is16bit = false;
    }

    public SeriesTextRecord(SeriesTextRecord other) {
        super(other);
        field_1_id = other.field_1_id;
        is16bit = other.is16bit;
        field_4_text = other.field_4_text;
    }

    public SeriesTextRecord(RecordInputStream in) {
        field_1_id = in.readUShort();
        int field_2_textLength = in.readUByte();
        is16bit = (in.readUByte() & 0x01) != 0;
        if (is16bit) {
            field_4_text = in.readUnicodeLEString(field_2_textLength);
        } else {
            field_4_text = in.readCompressedUnicode(field_2_textLength);
        }
    }

    public void serialize(LittleEndianOutput out) {

        out.writeShort(field_1_id);
        out.writeByte(field_4_text.length());
        if (is16bit) {
            // Excel (2007) seems to choose 16bit regardless of whether it is needed
            out.writeByte(0x01);
            StringUtil.putUnicodeLE(field_4_text, out);
        } else {
            // Excel can read this OK
            out.writeByte(0x00);
            StringUtil.putCompressedUnicode(field_4_text, out);
        }
    }

    protected int getDataSize() {
        return 2 + 1 + 1 + field_4_text.length() * (is16bit ? 2 : 1);
    }

    public short getSid() {
        return sid;
    }

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

    /**
     * Get the id field for the SeriesText record.
     */
    public int getId() {
        return field_1_id;
    }

    /**
     * Set the id field for the SeriesText record.
     */
    public void setId(int id) {
        field_1_id = id;
    }

    /**
     * Get the text field for the SeriesText record.
     */
    public String getText() {
        return field_4_text;
    }

    /**
     * Set the text field for the SeriesText record.
     */
    public void setText(String text) {
        if (text.length() > MAX_LEN) {
            throw new IllegalArgumentException("Text is too long ("
                    + text.length() + ">" + MAX_LEN + ")");
        }
        field_4_text = text;
        is16bit = StringUtil.hasMultibyte(text);
    }

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

    @Override
    public Map> getGenericProperties() {
        return GenericRecordUtil.getGenericProperties(
            "id", this::getId,
            "bit16", () -> is16bit,
            "text", this::getText
        );
    }
}