moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

String record added

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352815 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Glen Stampoultzis 2002-07-29 13:25:46 +00:00
parent bcf6cea52c
commit 4d7e207efd
6 changed files with 783 additions and 425 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/java/org/apache/poi/hssf/dev/BiffViewer.java
View File

@ -74,7 +74,6 @@ import java.util.ArrayList;
*
*@author Andrew C. Oliver (acoliver at apache dot org)
*@author Glen Stampoultzis (glens at apache.org)
*@created May 10, 2002
*@see #main
*/
@ -256,7 +255,8 @@ public class BiffViewer {
*@param data Description of the Parameter
*@exception IOException Description of the Exception
*/
private static void dump(short rectype, short recsize, byte[] data) throws IOException {
private static void dump( short rectype, short recsize, byte[] data ) throws IOException
{
// System.out
// .println("fixing to recordize the following");
System.out.print( "rectype = 0x"
@ -265,9 +265,12 @@ public class BiffViewer {
+ Integer.toHexString( recsize ) );
System.out.println(
"-BEGIN DUMP---------------------------------" );
if (data.length > 0) {
if ( data.length > 0 )
{
HexDump.dump( data, 0, System.out, 0 );
} else {
}
else
{
System.out.println( "**NO RECORD DATA**" );
}
// System.out.println();
@ -287,12 +290,14 @@ public class BiffViewer {
*/
private static Record[] createRecord( short rectype, short size,
byte[] data) {
byte[] data )
{
Record retval = null;
Record[] realretval = null;
// int irectype = rectype;
switch (rectype) {
switch ( rectype )
{
case ChartRecord.sid:
retval = new ChartRecord( rectype, size, data );
@ -612,6 +617,9 @@ public class BiffViewer {
case LeftMarginRecord.sid:
retval = new LeftMarginRecord( rectype, size, data );
break;
case LeftMarginRecord.sid:
retval = new LeftMarginRecord( rectype, size, data );
break;
case RightMarginRecord.sid:
retval = new RightMarginRecord( rectype, size, data );
break;
@ -624,11 +632,14 @@ public class BiffViewer {
case PaletteRecord.sid:
retval = new PaletteRecord( rectype, size, data );
break;
case StringRecord.sid:
retval = new StringRecord( rectype, size, data );
break;
default:
retval = new UnknownRecord( rectype, size, data );
}
if (realretval == null) {
if ( realretval == null )
{
realretval = new Record[1];
realretval[0] = retval;
System.out.println( "recordid = 0x" + Integer.toHexString( rectype ) + ", size =" + size );

1
src/java/org/apache/poi/hssf/model/Workbook.java
View File

@ -429,7 +429,6 @@ public class Workbook {
public void setSheetName(int sheetnum, String sheetname, short encoding ) {
checkSheets(sheetnum);
BoundSheetRecord sheet = (BoundSheetRecord)boundsheets.get( sheetnum );
sheet.setSheetname(sheetname);
sheet.setSheetnameLength( (byte)sheetname.length() );

2
src/java/org/apache/poi/hssf/record/Record.java
View File

@ -182,7 +182,7 @@ public abstract class Record
public abstract int serialize(int offset, byte [] data);
/**
* gives the current serialized size of the record.
* gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
*/
public int getRecordSize()

4
src/java/org/apache/poi/hssf/record/RecordFactory.java
View File

@ -109,7 +109,7 @@ public class RecordFactory
FormulaRecord.class, BoolErrRecord.class, ExternSheetRecord.class,
NameRecord.class, LeftMarginRecord.class, RightMarginRecord.class,
TopMarginRecord.class, BottomMarginRecord.class,
PaletteRecord.class
PaletteRecord.class, StringRecord.class
};
} else {
records = new Class[]
@ -140,7 +140,7 @@ public class RecordFactory
BoolErrRecord.class, ExternSheetRecord.class, NameRecord.class,
LeftMarginRecord.class, RightMarginRecord.class,
TopMarginRecord.class, BottomMarginRecord.class,
PaletteRecord.class
PaletteRecord.class, StringRecord.class
};
}

242
src/java/org/apache/poi/hssf/record/StringRecord.java Normal file
View File

@ -0,0 +1,242 @@
/* ====================================================================
* 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
* <http://www.apache.org/>.
*/
package org.apache.poi.hssf.record;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.StringUtil;
/**
* Supports the STRING record structure.
*
* @author Glen Stampoultzis (glens at apache.org)
*/
public class StringRecord
extends Record
{
public final static short sid = 0x207;
private int field_1_string_length;
private byte field_2_unicode_flag;
private String field_3_string;
public StringRecord()
{
}
/**
* Constructs a String record and sets its fields appropriately.
*
* @param id id must be 0x204 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 StringRecord( short id, short size, byte[] data )
{
super( id, size, data );
}
/**
* Constructs an String record and sets its fields appropriately.
*
* @param id id must be 0x204 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
*/
public StringRecord( short id, short size, byte[] data, int offset )
{
super( id, size, data, offset );
}
/**
* Throw a 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 != this.sid)
{
throw new RecordFormatException("Not a valid StringRecord");
}
}
/**
* called by the constructor, should set class level fields. Should throw
* runtime exception for bad/icomplete data.
*
* @param data raw data
* @param size size of data
* @param offset of the record's data (provided a big array of the file)
*/
protected void fillFields( byte[] data, short size, int offset )
{
field_1_string_length = LittleEndian.getUShort(data, 0 + offset);
field_2_unicode_flag = data[ 2 + offset ];
if (isUnCompressedUnicode())
{
field_3_string = StringUtil.getFromUnicode(data, 3 + offset, field_1_string_length );
}
else
{
field_3_string = new String(data, 3 + offset, getStringLength());
}
}
private int getStringLength()
{
return field_1_string_length;
}
private int getStringByteLength()
{
return isUnCompressedUnicode() ? field_1_string_length * 2 : field_1_string_length;
}
/**
* gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
*/
public int getRecordSize()
{
return 4 + 2 + 1 + getStringByteLength();
}
/**
* is this uncompressed unicode (16bit)? Or just 8-bit compressed?
* @return isUnicode - True for 16bit- false for 8bit
*/
public boolean isUnCompressedUnicode()
{
return (field_2_unicode_flag == 1);
}
/**
* called by the class that is responsible for writing this sucker.
* Subclasses should implement this so that their data is passed back in a
* byte array.
*
* @param offset to begin writing at
* @param data byte array containing instance data
* @return number of bytes written
*/
public int serialize( int offset, byte[] data )
{
LittleEndian.putShort(data, 0 + offset, sid);
LittleEndian.putShort(data, 2 + offset, ( short ) (2 + getStringByteLength()));
LittleEndian.putUShort(data, 4 + offset, field_1_string_length);
data[6 + offset] = field_2_unicode_flag;
if (isUnCompressedUnicode())
{
StringUtil.putUncompressedUnicode(field_3_string, data, 7 + offset);
}
else
{
StringUtil.putCompressedUnicode(field_3_string, data, 7 + offset);
}
return getRecordSize();
}
/**
* return the non static version of the id for this record.
*/
public short getSid()
{
return sid;
}
/**
* @return The string represented by this record.
*/
public String getString()
{
return field_3_string;
}
/**
* Sets whether the string is compressed or not
* @param unicode_flag 1 = uncompressed, 0 = compressed
*/
public void setCompressedFlag( byte unicode_flag )
{
this.field_2_unicode_flag = unicode_flag;
}
/**
* Sets the string represented by this record.
*/
public void setString( String string )
{
this.field_1_string_length = string.length();
this.field_3_string = string;
}
public String toString()
{
StringBuffer buffer = new StringBuffer();
buffer.append("[STRING]\n");
buffer.append(" .string = ")
.append(field_3_string).append("\n");
buffer.append("[/STRING]\n");
return buffer.toString();
}
}

106
src/testcases/org/apache/poi/hssf/record/TestStringRecord.java Normal file
View File

@ -0,0 +1,106 @@
/* ====================================================================
* 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
* <http://www.apache.org/>.
*/
package org.apache.poi.hssf.record;
import junit.framework.TestCase;
/**
* Tests the serialization and deserialization of the StringRecord
* class works correctly. Test data taken directly from a real
* Excel file.
*
* @author Glen Stampoultzis (glens at apache.org)
*/
public class TestStringRecord
extends TestCase
{
byte[] data = new byte[] {
(byte)0x0B,(byte)0x00, // length
(byte)0x00, // option
// string
(byte)0x46,(byte)0x61,(byte)0x68,(byte)0x72,(byte)0x7A,(byte)0x65,(byte)0x75,(byte)0x67,(byte)0x74,(byte)0x79,(byte)0x70
};
public TestStringRecord(String name)
{
super(name);
}
public void testLoad()
throws Exception
{
StringRecord record = new StringRecord((short)0x207, (short)data.length, data);
assertEquals( "Fahrzeugtyp", record.getString());
assertEquals( 18, record.getRecordSize() );
record.validateSid((short)0x207);
}
public void testStore()
{
StringRecord record = new StringRecord();
record.setString("Fahrzeugtyp");
byte [] recordBytes = record.serialize();
assertEquals(recordBytes.length - 4, data.length);
for (int i = 0; i < data.length; i++)
assertEquals("At offset " + i, data[i], recordBytes[i+4]);
}
}