/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 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
*
* If an SST record and any subsequent Continue records are read * in to create this instance, this method should produce a byte * array that is identical to the byte array produced by * concatenating the input records' data. * * @return the byte array */ public int serialize( int offset, byte[] data ) { int record_size = getRecordSize(); int record_length_index = 0; if ( calculateUnicodeSize() > SSTRecord.MAX_DATA_SPACE ) serializeLargeRecord( record_size, record_length_index, data, offset ); else serializeSingleSSTRecord( data, offset, record_length_index ); return record_size; } private int calculateUnicodeSize() { int retval = 0; for ( int k = 0; k < strings.size(); k++ ) { retval += getUnicodeString(k).getRecordSize(); } return retval; } // we can probably simplify this later...this calculates the size // w/o serializing but still is a bit slow public int getRecordSize() { recordLengths = new ArrayList(); int retval = 0; int unicodesize = calculateUnicodeSize(); if ( unicodesize > SSTRecord.MAX_DATA_SPACE ) { retval = calcRecordSizesForLongStrings( unicodesize ); } else { // short data: write one simple SST record retval = SSTRecord.SST_RECORD_OVERHEAD + unicodesize; recordLengths.add( new Integer( unicodesize ) ); } return retval; } private int calcRecordSizesForLongStrings( int unicodesize ) { int retval; UnicodeString unistr = null; int stringreminant = 0; int unipos = 0; boolean lastneedcontinue = false; int stringbyteswritten = 0; boolean finished = false; boolean first_record = true; int totalWritten = 0; while ( !finished ) { int record = 0; int pos = 0; if ( first_record ) { // writing SST record record = SSTRecord.MAX_RECORD_SIZE; pos = 12; first_record = false; recordLengths.add( new Integer( record - SSTRecord.STD_RECORD_OVERHEAD ) ); } else { // writing continue record pos = 0; int to_be_written = ( unicodesize - stringbyteswritten ) + ( lastneedcontinue ? 1 : 0 ); int size = Math.min( SSTRecord.MAX_RECORD_SIZE - SSTRecord.STD_RECORD_OVERHEAD, to_be_written ); if ( size == to_be_written ) { finished = true; } record = size + SSTRecord.STD_RECORD_OVERHEAD; recordLengths.add( new Integer( size ) ); pos = 4; } if ( lastneedcontinue ) { int available = SSTRecord.MAX_RECORD_SIZE - pos; if ( stringreminant <= available ) { // write reminant stringbyteswritten += stringreminant - 1; pos += stringreminant; lastneedcontinue = false; } else { // write as much of the remnant as possible int toBeWritten = unistr.maxBrokenLength( available ); if ( available != toBeWritten ) { int shortrecord = record - ( available - toBeWritten ); recordLengths.set( recordLengths.size() - 1, new Integer( shortrecord - SSTRecord.STD_RECORD_OVERHEAD ) ); record = shortrecord; } stringbyteswritten += toBeWritten - 1; pos += toBeWritten; stringreminant -= toBeWritten - 1; lastneedcontinue = true; } } for ( ; unipos < strings.size(); unipos++ ) { int available = SSTRecord.MAX_RECORD_SIZE - pos; Integer intunipos = new Integer( unipos ); unistr = ( (UnicodeString) strings.get( intunipos ) ); if ( unistr.getRecordSize() <= available ) { stringbyteswritten += unistr.getRecordSize(); pos += unistr.getRecordSize(); } else { if ( available >= SSTRecord.STRING_MINIMAL_OVERHEAD ) { int toBeWritten = unistr.maxBrokenLength( available ); stringbyteswritten += toBeWritten; stringreminant = ( unistr.getRecordSize() - toBeWritten ) + LittleEndianConsts.BYTE_SIZE; if ( available != toBeWritten ) { int shortrecord = record - ( available - toBeWritten ); recordLengths.set( recordLengths.size() - 1, new Integer( shortrecord - SSTRecord.STD_RECORD_OVERHEAD ) ); record = shortrecord; } lastneedcontinue = true; unipos++; } else { int shortrecord = record - available; recordLengths.set( recordLengths.size() - 1, new Integer( shortrecord - SSTRecord.STD_RECORD_OVERHEAD ) ); record = shortrecord; } break; } } totalWritten += record; } retval = totalWritten; return retval; } private void serializeSingleSSTRecord( byte[] data, int offset, int record_length_index ) { // short data: write one simple SST record int len = ( (Integer) recordLengths.get( record_length_index++ ) ).intValue(); int recordSize = SSTRecord.SST_RECORD_OVERHEAD + len - SSTRecord.STD_RECORD_OVERHEAD; sstRecordHeader.writeSSTHeader( data, 0 + offset, recordSize ); int pos = SSTRecord.SST_RECORD_OVERHEAD; for ( int k = 0; k < strings.size(); k++ ) { // UnicodeString unistr = ( (UnicodeString) strings.get( new Integer( k ) ) ); System.arraycopy( getUnicodeString(k).serialize(), 0, data, pos + offset, getUnicodeString(k).getRecordSize() ); pos += getUnicodeString(k).getRecordSize(); } } /** * Large records are serialized to an SST and to one or more CONTINUE records. Joy. They have the special * characteristic that they can change the option field when a single string is split across to a * CONTINUE record. */ private void serializeLargeRecord( int record_size, int record_length_index, byte[] buffer, int offset ) { byte[] stringReminant = null; int stringIndex = 0; boolean lastneedcontinue = false; boolean first_record = true; int totalWritten = 0; while ( totalWritten != record_size ) { int recordLength = ( (Integer) recordLengths.get( record_length_index++ ) ).intValue(); RecordProcessor recordProcessor = new RecordProcessor( buffer, recordLength, numStrings, numUniqueStrings ); // write the appropriate header recordProcessor.writeRecordHeader( offset, totalWritten, recordLength, first_record ); first_record = false; // now, write the rest of the data into the current // record space if ( lastneedcontinue ) { lastneedcontinue = stringReminant.length > recordProcessor.getAvailable(); // the last string in the previous record was not written out completely stringReminant = recordProcessor.writeStringRemainder( lastneedcontinue, stringReminant, offset, totalWritten ); } // last string's remnant, if any, is cleaned up as best as can be done ... now let's try and write // some more strings for ( ; stringIndex < strings.size(); stringIndex++ ) { UnicodeString unistr = getUnicodeString( stringIndex ); if ( unistr.getRecordSize() <= recordProcessor.getAvailable() ) { recordProcessor.writeWholeString( unistr, offset, totalWritten ); } else { // can't write the entire string out if ( recordProcessor.getAvailable() >= SSTRecord.STRING_MINIMAL_OVERHEAD ) { // we can write some of it stringReminant = recordProcessor.writePartString( unistr, offset, totalWritten ); lastneedcontinue = true; stringIndex++; } break; } } totalWritten += recordLength + SSTRecord.STD_RECORD_OVERHEAD; } } private UnicodeString getUnicodeString( int index ) { Integer intunipos = new Integer( index ); return ( (UnicodeString) strings.get( intunipos ) ); } }