/components/forks/poi/src/loci/poi/hssf/record/LabelRecord.java
Java | 311 lines | 162 code | 39 blank | 110 comment | 26 complexity | a265baccf3f0d5435d63ee3f5a389b7b MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1, Apache-2.0, BSD-2-Clause, MPL-2.0-no-copyleft-exception
- /*
- * #%L
- * Fork of Apache Jakarta POI.
- * %%
- * Copyright (C) 2008 - 2013 Open Microscopy Environment:
- * - Board of Regents of the University of Wisconsin-Madison
- * - Glencoe Software, Inc.
- * - University of Dundee
- * %%
- * Licensed 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.
- * #L%
- */
- /* ====================================================================
- 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.
- ==================================================================== */
-
- /*
- * LabelRecord.java
- *
- * Created on November 11, 2001, 12:51 PM
- */
- package loci.poi.hssf.record;
- /**
- * Label Record - read only support for strings stored directly in the cell.. Don't
- * use this (except to read), use LabelSST instead <P>
- * REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
- * @author Andrew C. Oliver (acoliver at apache dot org)
- * @author Jason Height (jheight at chariot dot net dot au)
- * @version 2.0-pre
- * @see loci.poi.hssf.record.LabelSSTRecord
- */
- public class LabelRecord
- extends Record
- implements CellValueRecordInterface
- {
- public final static short sid = 0x204;
- //private short field_1_row;
- private int field_1_row;
- private short field_2_column;
- private short field_3_xf_index;
- private short field_4_string_len;
- private byte field_5_unicode_flag;
- private String field_6_value;
- /** Creates new LabelRecord */
- public LabelRecord()
- {
- }
- /**
- * Constructs an Label record and sets its fields appropriately.
- *
- * @param in the RecordInputstream to read the record from
- */
- public LabelRecord(RecordInputStream in)
- {
- super(in);
- }
- /**
- * called by constructor, should throw runtime exception in the event of a
- * record passed with a differing ID.
- *
- * @param id alleged id for this record
- */
- protected void validateSid(short id)
- {
- if (id != sid)
- {
- throw new RecordFormatException("Not a valid LabelRecord");
- }
- }
- /**
- * @param in the RecordInputstream to read the record from
- */
- protected void fillFields(RecordInputStream in)
- {
- //field_1_row = LittleEndian.getShort(data, 0 + offset);
- field_1_row = in.readUShort();
- field_2_column = in.readShort();
- field_3_xf_index = in.readShort();
- field_4_string_len = in.readShort();
- field_5_unicode_flag = in.readByte();
- if (field_4_string_len > 0) {
- if (isUnCompressedUnicode()) {
- field_6_value = in.readUnicodeLEString(field_4_string_len);
- } else {
- field_6_value = in.readCompressedUnicode(field_4_string_len);
- }
- } else field_6_value = null;
- }
- /* READ ONLY ACCESS... THIS IS FOR COMPATIBILITY ONLY...USE LABELSST!
- public void setRow(short row) {
- field_1_row = row;
- }
- public void setColumn(short col) {
- field_2_column = col;
- }
- public void setXFIndex(short index) {
- field_3_xf_index = index;
- }
- */
- //public short getRow()
- public int getRow()
- {
- return field_1_row;
- }
- public short getColumn()
- {
- return field_2_column;
- }
- public short getXFIndex()
- {
- return field_3_xf_index;
- }
- /**
- * get the number of characters this string contains
- * @return number of characters
- */
- public short getStringLength()
- {
- return field_4_string_len;
- }
- /**
- * is this uncompressed unicode (16bit)? Or just 8-bit compressed?
- * @return isUnicode - True for 16bit- false for 8bit
- */
- public boolean isUnCompressedUnicode()
- {
- return (field_5_unicode_flag == 1);
- }
- /**
- * get the value
- *
- * @return the text string
- * @see #getStringLength()
- */
- public String getValue()
- {
- return field_6_value;
- }
- /**
- * THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!
- */
- public int serialize(int offset, byte [] data)
- {
- throw new RecordFormatException(
- "Label Records are supported READ ONLY...convert to LabelSST");
- }
- public short getSid()
- {
- return sid;
- }
- public String toString()
- {
- StringBuffer buffer = new StringBuffer();
- buffer.append("[LABEL]\n");
- buffer.append(" .row = ")
- .append(Integer.toHexString(getRow())).append("\n");
- buffer.append(" .column = ")
- .append(Integer.toHexString(getColumn())).append("\n");
- buffer.append(" .xfindex = ")
- .append(Integer.toHexString(getXFIndex())).append("\n");
- buffer.append(" .string_len = ")
- .append(Integer.toHexString(field_4_string_len)).append("\n");
- buffer.append(" .unicode_flag = ")
- .append(Integer.toHexString(field_5_unicode_flag)).append("\n");
- buffer.append(" .value = ")
- .append(getValue()).append("\n");
- buffer.append("[/LABEL]\n");
- return buffer.toString();
- }
- public boolean isBefore(CellValueRecordInterface i)
- {
- if (this.getRow() > i.getRow())
- {
- return false;
- }
- if ((this.getRow() == i.getRow())
- && (this.getColumn() > i.getColumn()))
- {
- return false;
- }
- if ((this.getRow() == i.getRow())
- && (this.getColumn() == i.getColumn()))
- {
- return false;
- }
- return true;
- }
- public boolean isAfter(CellValueRecordInterface i)
- {
- if (this.getRow() < i.getRow())
- {
- return false;
- }
- if ((this.getRow() == i.getRow())
- && (this.getColumn() < i.getColumn()))
- {
- return false;
- }
- if ((this.getRow() == i.getRow())
- && (this.getColumn() == i.getColumn()))
- {
- return false;
- }
- return true;
- }
- public boolean isEqual(CellValueRecordInterface i)
- {
- return ((this.getRow() == i.getRow())
- && (this.getColumn() == i.getColumn()));
- }
- public boolean isInValueSection()
- {
- return true;
- }
- public boolean isValue()
- {
- return true;
- }
- /**
- * NO-OP!
- */
- public void setColumn(short col)
- {
- }
- /**
- * NO-OP!
- */
- //public void setRow(short row)
- public void setRow(int row)
- {
- }
- /**
- * no op!
- */
- public void setXFIndex(short xf)
- {
- }
- public Object clone() {
- LabelRecord rec = new LabelRecord();
- rec.field_1_row = field_1_row;
- rec.field_2_column = field_2_column;
- rec.field_3_xf_index = field_3_xf_index;
- rec.field_4_string_len = field_4_string_len;
- rec.field_5_unicode_flag = field_5_unicode_flag;
- rec.field_6_value = field_6_value;
- return rec;
- }
- }