/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache POI" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* "Apache POI", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
*
* Description: I really don't understand this thing... its supposed to be "a hash * table for optimizing external copy operations" -- *
* This sounds like a job for Marc "BitMaster" Johnson aka the * "Hawaiian Master Chef".
* REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
* @author Andrew C. Oliver (acoliver at apache dot org) * @version 2.0-pre * @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord */ public class ExtSSTRecord extends Record { public final static short sid = 0xff; private short field_1_strings_per_bucket; private ArrayList field_2_sst_info; public ExtSSTRecord() { field_2_sst_info = new ArrayList(); } /** * Constructs a EOFRecord record and sets its fields appropriately. * * @param id id must be 0xff or an exception will be throw upon validation * @param size the size of the data area of the record * @param data data of the record (should not contain sid/len) */ public ExtSSTRecord(short id, short size, byte [] data) { super(id, size, data); } /** * Constructs a EOFRecord record and sets its fields appropriately. * * @param id id must be 0xff or an exception will be throw upon validation * @param size the size of the data area of the record * @param data data of the record (should not contain sid/len) * @param offset of the record's data */ public ExtSSTRecord(short id, short size, byte [] data, int offset) { super(id, size, data, offset); } protected void validateSid(short id) { if (id != sid) { throw new RecordFormatException("NOT An EXTSST RECORD"); } } // this probably doesn't work but we don't really care at this point protected void fillFields(byte [] data, short size, int offset) { field_2_sst_info = new ArrayList(); field_1_strings_per_bucket = LittleEndian.getShort(data, 0 + offset); for (int k = 2; k < ((data.length - offset) - size); k += 8) { byte[] tempdata = new byte[ 8 + offset ]; System.arraycopy(data, k, tempdata, 0, 8); ExtSSTInfoSubRecord rec = new ExtSSTInfoSubRecord(( short ) 0, ( short ) 8, tempdata); field_2_sst_info.add(rec); } } public void setNumStringsPerBucket(short numStrings) { field_1_strings_per_bucket = numStrings; } public void addInfoRecord(ExtSSTInfoSubRecord rec) { field_2_sst_info.add(rec); } public short getNumStringsPerBucket() { return field_1_strings_per_bucket; } public int getNumInfoRecords() { return field_2_sst_info.size(); } public ExtSSTInfoSubRecord getInfoRecordAt(int elem) { return ( ExtSSTInfoSubRecord ) field_2_sst_info.get(elem); } public String toString() { StringBuffer buffer = new StringBuffer(); buffer.append("[EXTSST]\n"); buffer.append(" .dsst = ") .append(Integer.toHexString(getNumStringsPerBucket())) .append("\n"); buffer.append(" .numInfoRecords = ").append(getNumInfoRecords()) .append("\n"); for (int k = 0; k < getNumInfoRecords(); k++) { buffer.append(" .inforecord = ").append(k).append("\n"); buffer.append(" .streampos = ") .append(Integer .toHexString(getInfoRecordAt(k).getStreamPos())).append("\n"); buffer.append(" .sstoffset = ") .append(Integer .toHexString(getInfoRecordAt(k).getBucketSSTOffset())) .append("\n"); } buffer.append("[/EXTSST]\n"); return buffer.toString(); } public int serialize(int offset, byte [] data) { LittleEndian.putShort(data, 0 + offset, sid); LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); LittleEndian.putShort(data, 4 + offset, field_1_strings_per_bucket); int pos = 6; for (int k = 0; k < getNumInfoRecords(); k++) { System.arraycopy(getInfoRecordAt(k).serialize(), 0, data, pos + offset, 8); pos += getInfoRecordAt(k).getRecordSize(); } return getRecordSize(); } public int getRecordSize() { return 4 + 2 + field_2_sst_info.size() * 8; } public short getSid() { return sid; } public void setBucketOffsets( int[] bucketAbsoluteOffsets, int[] bucketRelativeOffsets ) { this.field_2_sst_info = new ArrayList(bucketAbsoluteOffsets.length); for ( int i = 0; i < bucketAbsoluteOffsets.length; i++ ) { ExtSSTInfoSubRecord r = new ExtSSTInfoSubRecord(); r.setBucketRecordOffset((short)bucketRelativeOffsets[i]); r.setStreamPos(bucketAbsoluteOffsets[i]); field_2_sst_info.add(r); } } }