*/
public abstract class AbstractEscherOptRecord extends EscherRecord
{
- protected List<EscherProperty> properties = new ArrayList<EscherProperty>();
+ private List<EscherProperty> properties = new ArrayList<EscherProperty>();
/**
* Add a property to this record.
}
public int getNumberOfElementsInArray() {
- return (emptyComplexPart) ? 0 : LittleEndian.getUShort(_complexData, 0);
+ return (emptyComplexPart) ? 0 : LittleEndian.getUShort(getComplexData(), 0);
}
public void setNumberOfElementsInArray(int numberOfElements) {
- int expectedArraySize = numberOfElements * getActualSizeOfElements(getSizeOfElements()) + FIXED_SIZE;
- if (expectedArraySize != _complexData.length) {
- byte[] newArray = new byte[expectedArraySize];
- System.arraycopy(_complexData, 0, newArray, 0, _complexData.length);
- _complexData = newArray;
- }
- LittleEndian.putShort(_complexData, 0, (short) numberOfElements);
+ int expectedArraySize = getArraySizeInBytes(numberOfElements, getSizeOfElements());
+ resizeComplexData(expectedArraySize, getComplexData().length);
+ LittleEndian.putShort(getComplexData(), 0, (short)numberOfElements);
}
public int getNumberOfElementsInMemory() {
- return (emptyComplexPart) ? 0 : LittleEndian.getUShort(_complexData, 2);
+ return (emptyComplexPart) ? 0 : LittleEndian.getUShort(getComplexData(), 2);
}
public void setNumberOfElementsInMemory(int numberOfElements) {
- int expectedArraySize = numberOfElements * getActualSizeOfElements(getSizeOfElements()) + FIXED_SIZE;
- if (expectedArraySize != _complexData.length) {
- byte[] newArray = new byte[expectedArraySize];
- System.arraycopy(_complexData, 0, newArray, 0, expectedArraySize);
- _complexData = newArray;
- }
- LittleEndian.putShort(_complexData, 2, (short) numberOfElements);
+ int expectedArraySize = getArraySizeInBytes(numberOfElements, getSizeOfElements());
+ resizeComplexData(expectedArraySize, expectedArraySize);
+ LittleEndian.putShort(getComplexData(), 2, (short) numberOfElements);
}
public short getSizeOfElements() {
- return (emptyComplexPart) ? 0 : LittleEndian.getShort( _complexData, 4 );
+ return (emptyComplexPart) ? 0 : LittleEndian.getShort( getComplexData(), 4 );
}
public void setSizeOfElements(int sizeOfElements) {
- LittleEndian.putShort( _complexData, 4, (short) sizeOfElements );
-
- int expectedArraySize = getNumberOfElementsInArray() * getActualSizeOfElements(getSizeOfElements()) + FIXED_SIZE;
- if (expectedArraySize != _complexData.length) {
- // Keep just the first 6 bytes. The rest is no good to us anyway.
- byte[] newArray = new byte[expectedArraySize];
- System.arraycopy( _complexData, 0, newArray, 0, 6 );
- _complexData = newArray;
- }
+ LittleEndian.putShort( getComplexData(), 4, (short) sizeOfElements );
+
+ int expectedArraySize = getArraySizeInBytes(getNumberOfElementsInArray(), sizeOfElements);
+ // Keep just the first 6 bytes. The rest is no good to us anyway.
+ resizeComplexData(expectedArraySize, 6);
}
public byte[] getElement(int index) {
int actualSize = getActualSizeOfElements(getSizeOfElements());
byte[] result = new byte[actualSize];
- System.arraycopy(_complexData, FIXED_SIZE + index * actualSize, result, 0, result.length );
+ System.arraycopy(getComplexData(), FIXED_SIZE + index * actualSize, result, 0, result.length );
return result;
}
public void setElement(int index, byte[] element) {
int actualSize = getActualSizeOfElements(getSizeOfElements());
- System.arraycopy( element, 0, _complexData, FIXED_SIZE + index * actualSize, actualSize);
+ System.arraycopy( element, 0, getComplexData(), FIXED_SIZE + index * actualSize, actualSize);
}
@Override
/**
* We have this method because the way in which arrays in escher works
- * is screwed for seemly arbitary reasons. While most properties are
+ * is screwed for seemly arbitrary reasons. While most properties are
* fairly consistent and have a predictable array size, escher arrays
* have special cases.
*
*/
public int setArrayData(byte[] data, int offset) {
if (emptyComplexPart){
- _complexData = new byte[0];
- } else {
- short numElements = LittleEndian.getShort(data, offset);
- // LittleEndian.getShort(data, offset + 2); // numReserved
- short sizeOfElements = LittleEndian.getShort(data, offset + 4);
-
- int arraySize = getActualSizeOfElements(sizeOfElements) * numElements;
- if (arraySize == _complexData.length) {
- // The stored data size in the simple block excludes the header size
- _complexData = new byte[arraySize + 6];
- sizeIncludesHeaderSize = false;
- }
- System.arraycopy(data, offset, _complexData, 0, _complexData.length );
+ resizeComplexData(0, 0);
+ return 0;
}
- return _complexData.length;
+
+ short numElements = LittleEndian.getShort(data, offset);
+ // LittleEndian.getShort(data, offset + 2); // numReserved
+ short sizeOfElements = LittleEndian.getShort(data, offset + 4);
+
+ // TODO: this part is strange - it doesn't make sense to compare
+ // the size of the existing data when setting a new data array ...
+ int arraySize = getArraySizeInBytes(numElements, sizeOfElements);
+ if (arraySize - FIXED_SIZE == getComplexData().length) {
+ // The stored data size in the simple block excludes the header size
+ sizeIncludesHeaderSize = false;
+ }
+ int cpySize = Math.min(arraySize, data.length-offset);
+ resizeComplexData(cpySize, 0);
+ System.arraycopy(data, offset, getComplexData(), 0, cpySize);
+ return cpySize;
}
/**
@Override
public int serializeSimplePart(byte[] data, int pos) {
LittleEndian.putShort(data, pos, getId());
- int recordSize = _complexData.length;
+ int recordSize = getComplexData().length;
if(!sizeIncludesHeaderSize) {
recordSize -= 6;
}
return sizeOfElements;
}
+ private static int getArraySizeInBytes(int numberOfElements, int sizeOfElements) {
+ return numberOfElements * getActualSizeOfElements((short)(sizeOfElements & 0xFFFF)) + FIXED_SIZE;
+ }
+
+
@Override
public Iterator<byte[]> iterator() {
return new Iterator<byte[]>(){
- int idx = 0;
+ private int idx = 0;
@Override
public boolean hasNext() {
return (idx < getNumberOfElementsInArray());
System.arraycopy( data, pos, field_1_UID, 0, 16 ); pos += 16;
field_2_marker = data[pos]; pos++;
- field_pictureData = new byte[bytesAfterHeader - 17];
- System.arraycopy( data, pos, field_pictureData, 0, field_pictureData.length );
+ setPictureData(data, pos, bytesAfterHeader - 17);
return bytesAfterHeader + HEADER_SIZE;
}
System.arraycopy( field_1_UID, 0, data, pos, 16 );
data[pos + 16] = field_2_marker;
- System.arraycopy( field_pictureData, 0, data, pos + 17, field_pictureData.length );
+ byte pd[] = getPicturedata();
+ System.arraycopy( pd, 0, data, pos + 17, pd.length );
listener.afterRecordSerialize(offset + getRecordSize(), getRecordId(), getRecordSize(), this);
- return HEADER_SIZE + 16 + 1 + field_pictureData.length;
+ return HEADER_SIZE + 16 + 1 + pd.length;
}
@Override
public int getRecordSize() {
- return 8 + 16 + 1 + field_pictureData.length;
+ return 8 + 16 + 1 + getPicturedata().length;
}
/**
public String toString() {
String nl = System.getProperty( "line.separator" );
- String extraData = HexDump.dump(this.field_pictureData, 0, 0);
+ String extraData = HexDump.dump(getPicturedata(), 0, 0);
return getClass().getName() + ":" + nl +
" RecordId: 0x" + HexDump.toHex( getRecordId() ) + nl +
@Override
public String toXml(String tab) {
- String extraData = HexDump.dump(this.field_pictureData, 0, 0);
+ String extraData = HexDump.dump(getPicturedata(), 0, 0);
StringBuilder builder = new StringBuilder();
builder.append(tab).append(formatXmlRecordHeader(getClass().getSimpleName(), HexDump.toHex(getRecordId()), HexDump.toHex(getVersion()), HexDump.toHex(getInstance())))
.append(tab).append("\t").append("<UID>0x").append(HexDump.toHex(field_1_UID)).append("</UID>\n")
private static final int HEADER_SIZE = 8;
- protected byte[] field_pictureData;
+ private byte[] field_pictureData;
public EscherBlipRecord() {
}
* @param pictureData the picture data
*/
public void setPictureData(byte[] pictureData) {
- if (pictureData == null) {
+ setPictureData(pictureData, 0, (pictureData == null ? 0 : pictureData.length));
+ }
+
+ /**
+ * Sets the picture data bytes
+ *
+ * @param pictureData the picture data
+ * @param offset the offset into the picture data
+ * @param length the amount of bytes to be used
+ */
+ public void setPictureData(byte[] pictureData, int offset, int length) {
+ if (pictureData == null || offset < 0 || length < 0 || pictureData.length < offset+length) {
throw new IllegalArgumentException("picture data can't be null");
}
- field_pictureData = pictureData.clone();
+ field_pictureData = new byte[length];
+ System.arraycopy(pictureData, offset, field_pictureData, 0, length);
}
@Override
*/
public boolean isTrue()
{
- return propertyValue != 0;
+ return getPropertyValue() != 0;
}
/**
*/
public boolean isFalse()
{
- return propertyValue == 0;
+ return !isTrue();
}
// public String toString()
* An OfficeArtCOLORREF structure entry which also handles color extension opid data\r
*/\r
public class EscherColorRef {\r
- int opid = -1;\r
- int colorRef = 0;\r
+ @SuppressWarnings("unused")\r
+ private int opid = -1;\r
+ private int colorRef = 0;\r
\r
public enum SysIndexSource {\r
/** Use the fill color of the shape. */\r
/** If the shape contains a fill, use the fill color of the shape. Otherwise, use the line color. */\r
FILL_OR_LINE_COLOR(0xF7)\r
;\r
- int value;\r
+ private int value;\r
SysIndexSource(int value) { this.value = value; }\r
}\r
\r
*/\r
INVERT_HIGHBIT_AFTER(0x40)\r
;\r
- BitField mask;\r
+ private BitField mask;\r
SysIndexProcedure(int mask) {\r
this.mask = new BitField(mask);\r
}\r
*/
public class EscherComplexProperty extends EscherProperty {
// TODO - make private and final
- protected byte[] _complexData;
+ private byte[] _complexData;
/**
* Create a complex property using the property id and a byte array containing the complex
return _complexData;
}
+ protected void resizeComplexData(int newSize, int bytesToKeep) {
+ if (newSize == _complexData.length) {
+ return;
+ }
+ byte[] newArray = new byte[newSize];
+ System.arraycopy(_complexData, 0, newArray, 0, Math.min(bytesToKeep, newSize));
+ _complexData = newArray;
+ }
+
+
/**
* Determine whether this property is equal to another property.
*
// 0 means DEFLATE compression
// 0xFE means no compression
if (field_6_fCompression == 0) {
- field_pictureData = inflatePictureData(raw_pictureData);
+ super.setPictureData(inflatePictureData(raw_pictureData));
} else {
- field_pictureData = raw_pictureData;
+ super.setPictureData(raw_pictureData);
}
int remaining = bytesAfterHeader - pos + offset + HEADER_SIZE;
@Override
public short getInstance()
{
- setInstance( (short) properties.size() );
+ setInstance( (short) getEscherProperties().size() );
return super.getInstance();
}
// 0xFE means no compression
if (field_6_fCompression == 0)
{
- field_pictureData = inflatePictureData(raw_pictureData);
+ super.setPictureData(inflatePictureData(raw_pictureData));
}
else
{
- field_pictureData = raw_pictureData;
+ super.setPictureData(raw_pictureData);
}
return bytesAfterHeader + HEADER_SIZE;
@Override
public String toString() {
- String extraData = HexDump.toHex(field_pictureData, 32);
+ String extraData = HexDump.toHex(getPicturedata(), 32);
return getClass().getName() + ":" + '\n' +
" RecordId: 0x" + HexDump.toHex( getRecordId() ) + '\n' +
" Version: 0x" + HexDump.toHex( getVersion() ) + '\n' +
// boolean isBlipId = ( propId & (short) 0x4000 ) != 0;
byte propertyType = EscherProperties.getPropertyType(propNumber);
- if ( propertyType == EscherPropertyMetaData.TYPE_BOOLEAN )
- results.add( new EscherBoolProperty( propId, propData ) );
- else if ( propertyType == EscherPropertyMetaData.TYPE_RGB )
- results.add( new EscherRGBProperty( propId, propData ) );
- else if ( propertyType == EscherPropertyMetaData.TYPE_SHAPEPATH )
- results.add( new EscherShapePathProperty( propId, propData ) );
- else
- {
- if ( !isComplex )
- results.add( new EscherSimpleProperty( propId, propData ) );
- else
- {
- if ( propertyType == EscherPropertyMetaData.TYPE_ARRAY)
- results.add( new EscherArrayProperty( propId, new byte[propData]) );
- else
- results.add( new EscherComplexProperty( propId, new byte[propData]) );
- }
+ EscherProperty ep;
+ switch (propertyType) {
+ case EscherPropertyMetaData.TYPE_BOOLEAN:
+ ep = new EscherBoolProperty( propId, propData );
+ break;
+ case EscherPropertyMetaData.TYPE_RGB:
+ ep = new EscherRGBProperty( propId, propData );
+ break;
+ case EscherPropertyMetaData.TYPE_SHAPEPATH:
+ ep = new EscherShapePathProperty( propId, propData );
+ break;
+ default:
+ if ( !isComplex ) {
+ ep = new EscherSimpleProperty( propId, propData );
+ } else if ( propertyType == EscherPropertyMetaData.TYPE_ARRAY) {
+ ep = new EscherArrayProperty( propId, new byte[propData]);
+ } else {
+ ep = new EscherComplexProperty( propId, new byte[propData]);
+ }
+ break;
}
+ results.add( ep );
pos += 6;
}
*/
public int getRgbColor()
{
- return propertyValue;
+ return getPropertyValue();
}
/**
*/
public byte getRed()
{
- return (byte) ( propertyValue & 0xFF );
+ return (byte) ( getRgbColor() & 0xFF );
}
/**
*/
public byte getGreen()
{
- return (byte) ( (propertyValue >> 8) & 0xFF );
+ return (byte) ( (getRgbColor() >> 8) & 0xFF );
}
/**
*/
public byte getBlue()
{
- return (byte) ( (propertyValue >> 16) & 0xFF );
+ return (byte) ( (getRgbColor() >> 16) & 0xFF );
}
@Override
StringBuilder builder = new StringBuilder();
builder.append(tab).append("<").append(getClass().getSimpleName()).append(" id=\"0x").append(HexDump.toHex(getId()))
.append("\" name=\"").append(getName()).append("\" blipId=\"")
- .append(isBlipId()).append("\" value=\"0x").append(HexDump.toHex(propertyValue)).append("\"/>\n");
+ .append(isBlipId()).append("\" value=\"0x").append(HexDump.toHex(getRgbColor())).append("\"/>\n");
return builder.toString();
}
}
*/
public class EscherSimpleProperty extends EscherProperty
{
- protected int propertyValue;
+ private int propertyValue;
/**
* The id is distinct from the actual property number. The id includes the property number the blip id
/**
* Describes the content stored in a part.
*/
- protected String _type;
+ private String _type;
/**
* The kind of connection between a source part and a target part in a package.
*/
- protected String _relation;
+ private String _relation;
/**
* The path component of a pack URI.
*/
- protected String _defaultName;
+ private String _defaultName;
/**
* Defines what object is used to construct instances of this relationship
*/
public InputStream getContents(PackagePart corePart) throws IOException, InvalidFormatException {
PackageRelationshipCollection prc =
- corePart.getRelationshipsByType(_relation);
+ corePart.getRelationshipsByType(getRelation());
Iterator<PackageRelationship> it = prc.iterator();
if(it.hasNext()) {
PackageRelationship rel = it.next();
PackagePart part = corePart.getPackage().getPart(relName);
return part.getInputStream();
}
- log.log(POILogger.WARN, "No part " + _defaultName + " found");
+ log.log(POILogger.WARN, "No part " + getDefaultFileName() + " found");
return null;
}
package org.apache.poi.ddf;
-import junit.framework.Test;
-import junit.framework.TestSuite;
-/**
- * Tests for org.apache.poi.ddf<br/>
- */
+import org.junit.runner.RunWith;
+import org.junit.runners.Suite;
+
+@RunWith(Suite.class)
+@Suite.SuiteClasses({
+ TestEscherBSERecord.class,
+ TestEscherBlipRecord.class,
+ TestEscherBoolProperty.class,
+ TestEscherChildAnchorRecord.class,
+ TestEscherClientAnchorRecord.class,
+ TestEscherClientDataRecord.class,
+ TestEscherContainerRecord.class,
+ TestEscherDgRecord.class,
+ TestEscherDggRecord.class,
+ TestEscherOptRecord.class,
+ TestEscherPropertyFactory.class,
+ TestEscherSpRecord.class,
+ TestEscherSpgrRecord.class,
+ TestEscherSplitMenuColorsRecord.class,
+ TestUnknownEscherRecord.class
+})
public final class AllPOIDDFTests {
- public static Test suite() {
- TestSuite result = new TestSuite("Tests for org.apache.poi.ddf");
- result.addTestSuite(TestEscherBSERecord.class);
- result.addTestSuite(TestEscherBlipRecord.class);
- result.addTestSuite(TestEscherBoolProperty.class);
- result.addTestSuite(TestEscherChildAnchorRecord.class);
- result.addTestSuite(TestEscherClientAnchorRecord.class);
- result.addTestSuite(TestEscherClientDataRecord.class);
- result.addTestSuite(TestEscherContainerRecord.class);
- result.addTestSuite(TestEscherDgRecord.class);
- result.addTestSuite(TestEscherDggRecord.class);
- result.addTestSuite(TestEscherOptRecord.class);
- result.addTestSuite(TestEscherPropertyFactory.class);
- result.addTestSuite(TestEscherSpRecord.class);
- result.addTestSuite(TestEscherSpgrRecord.class);
- result.addTestSuite(TestEscherSplitMenuColorsRecord.class);
- result.addTestSuite(TestUnknownEscherRecord.class);
- return result;
- }
}
package org.apache.poi.ddf;
-import junit.framework.TestCase;
+import static org.junit.Assert.assertEquals;
import java.util.List;
-import org.apache.poi.util.HexRead;
import org.apache.poi.util.HexDump;
+import org.apache.poi.util.HexRead;
+import org.junit.Test;
-/**
- * @author Glen Stampoultzis (glens @ superlinksoftware.com)
- */
-public class TestEscherPropertyFactory extends TestCase
-{
+public class TestEscherPropertyFactory {
+ @Test
public void testCreateProperties() {
String dataStr = "41 C1 " + // propid, complex ind
"03 00 00 00 " + // size of complex property
;
byte[] data = HexRead.readFromString( dataStr );
EscherPropertyFactory f = new EscherPropertyFactory();
- List props = f.createProperties( data, 0, (short)3 );
+ List<EscherProperty> props = f.createProperties( data, 0, (short)3 );
EscherComplexProperty p1 = (EscherComplexProperty) props.get( 0 );
assertEquals( (short)0xC141, p1.getId() );
assertEquals( "[01, 02, 03]", HexDump.toHex( p1.getComplexData() ) );
projects / poi.git / commitdiff