310 lines
8.2 KiB
Java
310 lines
8.2 KiB
Java
|
|
/* ====================================================================
|
|
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 org.apache.poi.util.LittleEndian;
|
|
|
|
/**
|
|
* Title: Beginning Of File<P>
|
|
* Description: Somewhat of a misnomer, its used for the beginning of a set of
|
|
* records that have a particular pupose or subject.
|
|
* Used in sheets and workbooks.<P>
|
|
* REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
|
|
* @author Andrew C. Oliver
|
|
* @author Jason Height (jheight at chariot dot net dot au)
|
|
* @version 2.0-pre
|
|
*/
|
|
|
|
public class BOFRecord
|
|
extends Record
|
|
{
|
|
|
|
/**
|
|
* for BIFF8 files the BOF is 0x809. For earlier versions it was 0x09 or 0x(biffversion)09
|
|
*/
|
|
|
|
public final static short sid = 0x809;
|
|
private short field_1_version;
|
|
private short field_2_type;
|
|
private short field_3_build;
|
|
private short field_4_year;
|
|
private int field_5_history;
|
|
private int field_6_rversion;
|
|
|
|
/**
|
|
* suggested default (0x06 - BIFF8)
|
|
*/
|
|
|
|
public final static short VERSION = 0x06;
|
|
|
|
/**
|
|
* suggested default 0x10d3
|
|
*/
|
|
|
|
public final static short BUILD = 0x10d3;
|
|
|
|
/**
|
|
* suggested default 0x07CC (1996)
|
|
*/
|
|
|
|
public final static short BUILD_YEAR = 0x07CC; // 1996
|
|
|
|
/**
|
|
* suggested default for a normal sheet (0x41)
|
|
*/
|
|
|
|
public final static short HISTORY_MASK = 0x41;
|
|
public final static short TYPE_WORKBOOK = 0x05;
|
|
public final static short TYPE_VB_MODULE = 0x06;
|
|
public final static short TYPE_WORKSHEET = 0x10;
|
|
public final static short TYPE_CHART = 0x20;
|
|
public final static short TYPE_EXCEL_4_MACRO = 0x40;
|
|
public final static short TYPE_WORKSPACE_FILE = 0x100;
|
|
|
|
/**
|
|
* Constructs an empty BOFRecord with no fields set.
|
|
*/
|
|
|
|
public BOFRecord()
|
|
{
|
|
}
|
|
|
|
public BOFRecord(RecordInputStream in)
|
|
{
|
|
field_1_version = in.readShort();
|
|
field_2_type = in.readShort();
|
|
|
|
// Some external tools don't generate all of
|
|
// the remaining fields
|
|
if (in.remaining() >= 2) {
|
|
field_3_build = in.readShort();
|
|
}
|
|
if (in.remaining() >= 2) {
|
|
field_4_year = in.readShort();
|
|
}
|
|
if (in.remaining() >= 4) {
|
|
field_5_history = in.readInt();
|
|
}
|
|
if (in.remaining() >= 4) {
|
|
field_6_rversion = in.readInt();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Version number - for BIFF8 should be 0x06
|
|
* @see #VERSION
|
|
* @param version version to be set
|
|
*/
|
|
|
|
public void setVersion(short version)
|
|
{
|
|
field_1_version = version;
|
|
}
|
|
|
|
/**
|
|
* type of object this marks
|
|
* @see #TYPE_WORKBOOK
|
|
* @see #TYPE_VB_MODULE
|
|
* @see #TYPE_WORKSHEET
|
|
* @see #TYPE_CHART
|
|
* @see #TYPE_EXCEL_4_MACRO
|
|
* @see #TYPE_WORKSPACE_FILE
|
|
* @param type type to be set
|
|
*/
|
|
|
|
public void setType(short type)
|
|
{
|
|
field_2_type = type;
|
|
}
|
|
|
|
/**
|
|
* build that wrote this file
|
|
* @see #BUILD
|
|
* @param build build number to set
|
|
*/
|
|
|
|
public void setBuild(short build)
|
|
{
|
|
field_3_build = build;
|
|
}
|
|
|
|
/**
|
|
* Year of the build that wrote this file
|
|
* @see #BUILD_YEAR
|
|
* @param year build year to set
|
|
*/
|
|
|
|
public void setBuildYear(short year)
|
|
{
|
|
field_4_year = year;
|
|
}
|
|
|
|
/**
|
|
* set the history bit mask (not very useful)
|
|
* @see #HISTORY_MASK
|
|
* @param bitmask bitmask to set for the history
|
|
*/
|
|
|
|
public void setHistoryBitMask(int bitmask)
|
|
{
|
|
field_5_history = bitmask;
|
|
}
|
|
|
|
/**
|
|
* set the minimum version required to read this file
|
|
*
|
|
* @see #VERSION
|
|
* @param version version to set
|
|
*/
|
|
|
|
public void setRequiredVersion(int version)
|
|
{
|
|
field_6_rversion = version;
|
|
}
|
|
|
|
/**
|
|
* Version number - for BIFF8 should be 0x06
|
|
* @see #VERSION
|
|
* @return short version number of the generator of this file
|
|
*/
|
|
|
|
public short getVersion()
|
|
{
|
|
return field_1_version;
|
|
}
|
|
|
|
/**
|
|
* type of object this marks
|
|
* @see #TYPE_WORKBOOK
|
|
* @see #TYPE_VB_MODULE
|
|
* @see #TYPE_WORKSHEET
|
|
* @see #TYPE_CHART
|
|
* @see #TYPE_EXCEL_4_MACRO
|
|
* @see #TYPE_WORKSPACE_FILE
|
|
* @return short type of object
|
|
*/
|
|
|
|
public short getType()
|
|
{
|
|
return field_2_type;
|
|
}
|
|
|
|
/**
|
|
* get the build that wrote this file
|
|
* @see #BUILD
|
|
* @return short build number of the generator of this file
|
|
*/
|
|
|
|
public short getBuild()
|
|
{
|
|
return field_3_build;
|
|
}
|
|
|
|
/**
|
|
* Year of the build that wrote this file
|
|
* @see #BUILD_YEAR
|
|
* @return short build year of the generator of this file
|
|
*/
|
|
|
|
public short getBuildYear()
|
|
{
|
|
return field_4_year;
|
|
}
|
|
|
|
/**
|
|
* get the history bit mask (not very useful)
|
|
* @see #HISTORY_MASK
|
|
* @return int bitmask showing the history of the file (who cares!)
|
|
*/
|
|
|
|
public int getHistoryBitMask()
|
|
{
|
|
return field_5_history;
|
|
}
|
|
|
|
/**
|
|
* get the minimum version required to read this file
|
|
*
|
|
* @see #VERSION
|
|
* @return int least version that can read the file
|
|
*/
|
|
|
|
public int getRequiredVersion()
|
|
{
|
|
return field_6_rversion;
|
|
}
|
|
|
|
public String toString()
|
|
{
|
|
StringBuffer buffer = new StringBuffer();
|
|
|
|
buffer.append("[BOF RECORD]\n");
|
|
buffer.append(" .version = ")
|
|
.append(Integer.toHexString(getVersion())).append("\n");
|
|
buffer.append(" .type = ")
|
|
.append(Integer.toHexString(getType())).append("\n");
|
|
buffer.append(" .build = ")
|
|
.append(Integer.toHexString(getBuild())).append("\n");
|
|
buffer.append(" .buildyear = ").append(getBuildYear())
|
|
.append("\n");
|
|
buffer.append(" .history = ")
|
|
.append(Integer.toHexString(getHistoryBitMask())).append("\n");
|
|
buffer.append(" .requiredversion = ")
|
|
.append(Integer.toHexString(getRequiredVersion())).append("\n");
|
|
buffer.append("[/BOF RECORD]\n");
|
|
return buffer.toString();
|
|
}
|
|
|
|
public int serialize(int offset, byte [] data)
|
|
{
|
|
LittleEndian.putShort(data, 0 + offset, sid);
|
|
LittleEndian.putShort(data, 2 + offset,
|
|
(( short ) 0x10)); // 16 byte length
|
|
LittleEndian.putShort(data, 4 + offset, getVersion());
|
|
LittleEndian.putShort(data, 6 + offset, getType());
|
|
LittleEndian.putShort(data, 8 + offset, getBuild());
|
|
LittleEndian.putShort(data, 10 + offset, getBuildYear());
|
|
LittleEndian.putInt(data, 12 + offset, getHistoryBitMask());
|
|
LittleEndian.putInt(data, 16 + offset, getRequiredVersion());
|
|
return getRecordSize();
|
|
}
|
|
|
|
public int getRecordSize()
|
|
{
|
|
return 20;
|
|
}
|
|
|
|
public short getSid()
|
|
{
|
|
return sid;
|
|
}
|
|
|
|
public Object clone() {
|
|
BOFRecord rec = new BOFRecord();
|
|
rec.field_1_version = field_1_version;
|
|
rec.field_2_type = field_2_type;
|
|
rec.field_3_build = field_3_build;
|
|
rec.field_4_year = field_4_year;
|
|
rec.field_5_history = field_5_history;
|
|
rec.field_6_rversion = field_6_rversion;
|
|
return rec;
|
|
}
|
|
}
|