123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123 |
- /* ====================================================================
- 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;
-
- import java.util.Map;
- import java.util.function.Supplier;
-
- import org.apache.poi.util.GenericRecordUtil;
- import org.apache.poi.util.HexDump;
- import org.apache.poi.util.IOUtils;
- import org.apache.poi.util.POILogFactory;
- import org.apache.poi.util.POILogger;
- import org.apache.poi.util.RecordFormatException;
-
- /**
- * Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for
- * strings stored directly in the cell, from the older file formats that
- * didn't use {@link LabelSSTRecord}
- */
- public final class OldLabelRecord extends OldCellRecord {
- private static final POILogger LOG = POILogFactory.getLogger(OldLabelRecord.class);
- //arbitrarily set, may need to increase
- private static final int MAX_RECORD_LENGTH = 100_000;
-
- public static final short biff2_sid = 0x0004;
- public static final short biff345_sid = 0x0204;
-
- private short field_4_string_len;
- private final byte[] field_5_bytes;
- private CodepageRecord codepage;
-
- /**
- * @param in the RecordInputstream to read the record from
- */
- public OldLabelRecord(RecordInputStream in)
- {
- super(in, in.getSid() == biff2_sid);
-
- if (isBiff2()) {
- field_4_string_len = (short)in.readUByte();
- } else {
- field_4_string_len = in.readShort();
- }
-
- // Can only decode properly later when you know the codepage
- field_5_bytes = IOUtils.safelyAllocate(field_4_string_len, MAX_RECORD_LENGTH);
- in.read(field_5_bytes, 0, field_4_string_len);
-
- if (in.remaining() > 0) {
- LOG.log(POILogger.INFO,
- "LabelRecord data remains: ", in.remaining(),
- " : ", HexDump.toHex(in.readRemainder())
- );
- }
- }
-
- public void setCodePage(CodepageRecord codepage) {
- this.codepage = codepage;
- }
-
- /**
- * get the number of characters this string contains
- * @return number of characters
- */
- public short getStringLength()
- {
- return field_4_string_len;
- }
-
- /**
- * Get the String of the cell
- *
- * @return the String of the cell
- */
- public String getValue()
- {
- return OldStringRecord.getString(field_5_bytes, codepage);
- }
-
- /**
- * Not supported
- *
- * @param offset not supported
- * @param data not supported
- * @return not supported
- */
- public int serialize(int offset, byte [] data) {
- throw new RecordFormatException("Old Label Records are supported READ ONLY");
- }
-
- public int getRecordSize() {
- throw new RecordFormatException("Old Label Records are supported READ ONLY");
- }
-
- @Override
- public HSSFRecordTypes getGenericRecordType() {
- return HSSFRecordTypes.LABEL;
- }
-
- @Override
- public Map<String, Supplier<?>> getGenericProperties() {
- return GenericRecordUtil.getGenericProperties(
- "base", super::getGenericProperties,
- "stringLength", this::getStringLength,
- "value", this::getValue
- );
- }
- }
|