glens 02/03/18 03:03:56
Added: src/java/org/apache/poi/hssf/record
CategorySeriesAxisRecord.java
src/records/definitions category_series_axis_record.xml
src/testcases/org/apache/poi/hssf/record
TestCategorySeriesAxisRecord.java
Log:
New record... Slowly but surely. Wonder if I have enough to make a whole chart yet?
Revision Changes Path
1.1
jakarta-poi/src/java/org/apache/poi/hssf/record/CategorySeriesAxisRecord.java
Index: CategorySeriesAxisRecord.java
===================================================================
/* ====================================================================
* 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 [EMAIL PROTECTED]
*
* 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.BitField;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.StringUtil;
import org.apache.poi.util.HexDump;
/**
* This record refers to a category or series axis and is used to specify
label/tickmark frequency.
* NOTE: This source is automatically generated please do not modify this file.
Either subclass or
* remove the record in src/records/definitions.
* @author Glen Stampoultzis (glens at apache.org)
*/
public class CategorySeriesAxisRecord
extends Record
{
public final static short sid = 0x1020;
private short field_1_crossingPoint;
private short field_2_labelFrequency;
private short field_3_tickMarkFrequency;
private short field_4_options;
private BitField valueAxisCrossing = new
BitField(0x1);
private BitField crossesFarRight = new
BitField(0x2);
private BitField reversed = new
BitField(0x4);
public CategorySeriesAxisRecord()
{
}
/**
* Constructs a CategorySeriesAxis record and sets its fields appropriately.
*
* @param id id must be 0x1020 or an exception
* will be throw upon validation
* @param size size the size of the data area of the record
* @param data data of the record (should not contain sid/len)
*/
public CategorySeriesAxisRecord(short id, short size, byte [] data)
{
super(id, size, data);
}
/**
* Constructs a CategorySeriesAxis record and sets its fields appropriately.
*
* @param id id must be 0x1020 or an exception
* will be throw upon validation
* @param size 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 CategorySeriesAxisRecord(short id, short size, byte [] data, int offset)
{
super(id, size, data, offset);
}
/**
* Checks the sid matches the expected side for this record
*
* @param id the expected sid.
*/
protected void validateSid(short id)
{
if (id != sid)
{
throw new RecordFormatException("Not a CategorySeriesAxis record");
}
}
protected void fillFields(byte [] data, short size, int offset)
{
field_1_crossingPoint = LittleEndian.getShort(data, 0 + offset);
field_2_labelFrequency = LittleEndian.getShort(data, 2 + offset);
field_3_tickMarkFrequency = LittleEndian.getShort(data, 4 + offset);
field_4_options = LittleEndian.getShort(data, 6 + offset);
}
public String toString()
{
StringBuffer buffer = new StringBuffer();
buffer.append("[CategorySeriesAxis]\n");
buffer.append(" .crossingPoint = ")
.append("0x")
.append(HexDump.toHex((short)getCrossingPoint()))
.append(" (").append(getCrossingPoint()).append(" )\n");
buffer.append(" .labelFrequency = ")
.append("0x")
.append(HexDump.toHex((short)getLabelFrequency()))
.append(" (").append(getLabelFrequency()).append(" )\n");
buffer.append(" .tickMarkFrequency = ")
.append("0x")
.append(HexDump.toHex((short)getTickMarkFrequency()))
.append(" (").append(getTickMarkFrequency()).append(" )\n");
buffer.append(" .options = ")
.append("0x")
.append(HexDump.toHex((short)getOptions()))
.append(" (").append(getOptions()).append(" )\n");
buffer.append(" .valueAxisCrossing =
").append(isValueAxisCrossing ()).append('\n');
buffer.append(" .crossesFarRight =
").append(isCrossesFarRight ()).append('\n');
buffer.append(" .reversed = ").append(isReversed
()).append('\n');
buffer.append("[/CategorySeriesAxis]\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_crossingPoint);
LittleEndian.putShort(data, 6 + offset, field_2_labelFrequency);
LittleEndian.putShort(data, 8 + offset, field_3_tickMarkFrequency);
LittleEndian.putShort(data, 10 + offset, field_4_options);
return getRecordSize();
}
/**
* Size of record (exluding 4 byte header)
*/
public int getRecordSize()
{
return 4 + 2 + 2 + 2 + 2;
}
public short getSid()
{
return this.sid;
}
/**
* Get the crossing point field for the CategorySeriesAxis record.
*/
public short getCrossingPoint()
{
return field_1_crossingPoint;
}
/**
* Set the crossing point field for the CategorySeriesAxis record.
*/
public void setCrossingPoint(short field_1_crossingPoint)
{
this.field_1_crossingPoint = field_1_crossingPoint;
}
/**
* Get the label frequency field for the CategorySeriesAxis record.
*/
public short getLabelFrequency()
{
return field_2_labelFrequency;
}
/**
* Set the label frequency field for the CategorySeriesAxis record.
*/
public void setLabelFrequency(short field_2_labelFrequency)
{
this.field_2_labelFrequency = field_2_labelFrequency;
}
/**
* Get the tick mark frequency field for the CategorySeriesAxis record.
*/
public short getTickMarkFrequency()
{
return field_3_tickMarkFrequency;
}
/**
* Set the tick mark frequency field for the CategorySeriesAxis record.
*/
public void setTickMarkFrequency(short field_3_tickMarkFrequency)
{
this.field_3_tickMarkFrequency = field_3_tickMarkFrequency;
}
/**
* Get the options field for the CategorySeriesAxis record.
*/
public short getOptions()
{
return field_4_options;
}
/**
* Set the options field for the CategorySeriesAxis record.
*/
public void setOptions(short field_4_options)
{
this.field_4_options = field_4_options;
}
/**
* Sets the value axis crossing field value.
* set true to indicate axis crosses between categories and false to cross axis
midway
*/
public void setValueAxisCrossing(boolean value)
{
field_4_options = valueAxisCrossing.setShortBoolean(field_4_options, value);
}
/**
* set true to indicate axis crosses between categories and false to cross axis
midway
* @return the value axis crossing field value.
*/
public boolean isValueAxisCrossing()
{
return valueAxisCrossing.isSet(field_4_options);
}
/**
* Sets the crosses far right field value.
* axis crosses at the far right
*/
public void setCrossesFarRight(boolean value)
{
field_4_options = crossesFarRight.setShortBoolean(field_4_options, value);
}
/**
* axis crosses at the far right
* @return the crosses far right field value.
*/
public boolean isCrossesFarRight()
{
return crossesFarRight.isSet(field_4_options);
}
/**
* Sets the reversed field value.
* categories are displayed in reverse order
*/
public void setReversed(boolean value)
{
field_4_options = reversed.setShortBoolean(field_4_options, value);
}
/**
* categories are displayed in reverse order
* @return the reversed field value.
*/
public boolean isReversed()
{
return reversed.isSet(field_4_options);
}
} // END OF CLASS
1.1
jakarta-poi/src/records/definitions/category_series_axis_record.xml
Index: category_series_axis_record.xml
===================================================================
<record id="0x1020" name="CategorySeriesAxis" package="org.apache.poi.hssf.record">
<suffix>Record</suffix>
<extends>Record</extends>
<description>This record refers to a category or series axis and is used to
specify label/tickmark frequency.</description>
<author>Glen Stampoultzis (glens at apache.org)</author>
<fields>
<field type="int" size="2" name="crossing point" description="axis or
category crossing point for 2d charts"/>
<field type="int" size="2" name="label frequency" description="label
frequency"/>
<field type="int" size="2" name="tick mark frequency" description="tick mark
frequency"/>
<field type="int" size="2" name="options" description="various options">
<bit number="0" name="value axis crossing" description="set true to
indicate axis crosses between categories and false to cross axis midway"/>
<bit number="1" name="crosses far right" description="axis crosses at
the far right"/>
<bit number="2" name="reversed" description="categories are displayed in
reverse order"/>
</field>
</fields>
</record>
1.1
jakarta-poi/src/testcases/org/apache/poi/hssf/record/TestCategorySeriesAxisRecord.java
Index: TestCategorySeriesAxisRecord.java
===================================================================
/* ====================================================================
* 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 [EMAIL PROTECTED]
*
* 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 CategorySeriesAxisRecord
* class works correctly. Test data taken directly from a real
* Excel file.
*
* @author Glen Stampoultzis (glens at apache.org)
*/
public class TestCategorySeriesAxisRecord
extends TestCase
{
byte[] data = new byte[] {
(byte)0x01,(byte)0x00, // crossing point
(byte)0x01,(byte)0x00, // label frequency
(byte)0x01,(byte)0x00, // tick mark frequency
(byte)0x01,(byte)0x00 // options
};
public TestCategorySeriesAxisRecord(String name)
{
super(name);
}
public void testLoad()
throws Exception
{
CategorySeriesAxisRecord record = new
CategorySeriesAxisRecord((short)0x1020, (short)data.length, data);
assertEquals( 1, record.getCrossingPoint());
assertEquals( 1, record.getLabelFrequency());
assertEquals( 1, record.getTickMarkFrequency());
assertEquals( 1, record.getOptions());
assertEquals( true, record.isValueAxisCrossing() );
assertEquals( false, record.isCrossesFarRight() );
assertEquals( false, record.isReversed() );
assertEquals( 4 + 8, record.getRecordSize() );
record.validateSid((short)0x1020);
}
public void testStore()
{
CategorySeriesAxisRecord record = new CategorySeriesAxisRecord();
record.setCrossingPoint( (short)1 );
record.setLabelFrequency( (short)1 );
record.setTickMarkFrequency( (short)1 );
record.setValueAxisCrossing( true );
record.setCrossesFarRight( false );
record.setReversed( false );
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]);
}
}
