Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

exctract common properties record code into AbstractEscherOptRecord 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1152126 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sergey Vladimirov 2011-07-29 07:01:39 +00:00
parent 408053e61b
commit e4efe9c5b5
3 changed files with 184 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

175
src/java/org/apache/poi/ddf/AbstractEscherOptRecord.java Normal file
View File

@ -0,0 +1,175 @@
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.ddf;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndian;
/**
* Common abstract class for {@link EscherOptRecord} and
* {@link EscherTertiaryOptRecord}
*
* @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
* @author Glen Stampoultzis
*/
public abstract class AbstractEscherOptRecord extends EscherRecord
{
protected List<EscherProperty> properties = new ArrayList<EscherProperty>();
/**
* Add a property to this record.
*/
public void addEscherProperty( EscherProperty prop )
{
properties.add( prop );
}
public int fillFields( byte[] data, int offset,
EscherRecordFactory recordFactory )
{
int bytesRemaining = readHeader( data, offset );
int pos = offset + 8;
EscherPropertyFactory f = new EscherPropertyFactory();
properties = f.createProperties( data, pos, getInstance() );
return bytesRemaining + 8;
}
/**
* The list of properties stored by this record.
*/
public List<EscherProperty> getEscherProperties()
{
return properties;
}
/**
* The list of properties stored by this record.
*/
public EscherProperty getEscherProperty( int index )
{
return properties.get( index );
}
private int getPropertiesSize()
{
int totalSize = 0;
for ( EscherProperty property : properties )
{
totalSize += property.getPropertySize();
}
return totalSize;
}
@Override
public int getRecordSize()
{
return 8 + getPropertiesSize();
}
public <T extends EscherProperty> T lookup( int propId )
{
for ( EscherProperty prop : properties )
{
if ( prop.getPropertyNumber() == propId )
{
@SuppressWarnings( "unchecked" )
final T result = (T) prop;
return result;
}
}
return null;
}
public int serialize( int offset, byte[] data,
EscherSerializationListener listener )
{
listener.beforeRecordSerialize( offset, getRecordId(), this );
LittleEndian.putShort( data, offset, getOptions() );
LittleEndian.putShort( data, offset + 2, getRecordId() );
LittleEndian.putInt( data, offset + 4, getPropertiesSize() );
int pos = offset + 8;
for ( EscherProperty property : properties )
{
pos += property.serializeSimplePart( data, pos );
}
for ( EscherProperty property : properties )
{
pos += property.serializeComplexPart( data, pos );
}
listener.afterRecordSerialize( pos, getRecordId(), pos - offset, this );
return pos - offset;
}
/**
* Records should be sorted by property number before being stored.
*/
public void sortProperties()
{
Collections.sort( properties, new Comparator<EscherProperty>()
{
public int compare( EscherProperty p1, EscherProperty p2 )
{
short s1 = p1.getPropertyNumber();
short s2 = p2.getPropertyNumber();
return s1 < s2 ? -1 : s1 == s2 ? 0 : 1;
}
} );
}
/**
* Retrieve the string representation of this record.
*/
public String toString()
{
String nl = System.getProperty( "line.separator" );
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append( getClass().getName() );
stringBuilder.append( ":" );
stringBuilder.append( nl );
stringBuilder.append( " isContainer: " );
stringBuilder.append( isContainerRecord() );
stringBuilder.append( nl );
stringBuilder.append( " options: 0x" );
stringBuilder.append( HexDump.toHex( getOptions() ) );
stringBuilder.append( nl );
stringBuilder.append( " recordId: 0x" );
stringBuilder.append( HexDump.toHex( getRecordId() ) );
stringBuilder.append( nl );
stringBuilder.append( " numchildren: " );
stringBuilder.append( getChildRecords().size() );
stringBuilder.append( nl );
stringBuilder.append( " properties:" );
stringBuilder.append( nl );
for ( EscherProperty property : properties )
{
stringBuilder.append( " " + property.toString() + nl );
}
return stringBuilder.toString();
}
}

148
src/java/org/apache/poi/ddf/EscherOptRecord.java
View File

@ -1,4 +1,3 @@
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@ -15,66 +14,21 @@
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.ddf;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndian;
/**
* The opt record is used to store property values for a shape. It is the key to determining
* the attributes of a shape. Properties can be of two types: simple or complex. Simple types
* are fixed length. Complex properties are variable length.
*
* The opt record is used to store property values for a shape. It is the key to
* determining the attributes of a shape. Properties can be of two types: simple
* or complex. Simple types are fixed length. Complex properties are variable
* length.
*
* @author Glen Stampoultzis
*/
public class EscherOptRecord
extends EscherRecord
public class EscherOptRecord extends AbstractEscherOptRecord
{
public static final short RECORD_ID = (short) 0xF00B;
public static final String RECORD_DESCRIPTION = "msofbtOPT";
private List<EscherProperty> properties = new ArrayList<EscherProperty>();
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) {
int bytesRemaining = readHeader( data, offset );
int pos = offset + 8;
EscherPropertyFactory f = new EscherPropertyFactory();
properties = f.createProperties( data, pos, getInstance() );
return bytesRemaining + 8;
}
public int serialize( int offset, byte[] data, EscherSerializationListener listener )
{
listener.beforeRecordSerialize( offset, getRecordId(), this );
LittleEndian.putShort( data, offset, getOptions() );
LittleEndian.putShort( data, offset + 2, getRecordId() );
LittleEndian.putInt( data, offset + 4, getPropertiesSize() );
int pos = offset + 8;
for ( EscherProperty property : properties )
{
pos += property.serializeSimplePart( data, pos );
}
for ( EscherProperty property : properties )
{
pos += property.serializeComplexPart( data, pos );
}
listener.afterRecordSerialize( pos, getRecordId(), pos - offset, this );
return pos - offset;
}
public int getRecordSize()
{
return 8 + getPropertiesSize();
}
/**
* Automatically recalculate the correct option
*/
@ -84,94 +38,8 @@ public class EscherOptRecord
return super.getOptions();
}
public String getRecordName() {
public String getRecordName()
{
return "Opt";
}
private int getPropertiesSize()
{
int totalSize = 0;
for ( EscherProperty property : properties )
{
totalSize += property.getPropertySize();
}
return totalSize;
}
/**
* Retrieve the string representation of this record.
*/
public String toString()
{
String nl = System.getProperty( "line.separator" );
StringBuffer propertiesBuf = new StringBuffer();
for ( EscherProperty property : properties )
{
propertiesBuf.append( " " + property.toString() + nl );
}
return "org.apache.poi.ddf.EscherOptRecord:" + nl +
" isContainer: " + isContainerRecord() + nl +
" options: 0x" + HexDump.toHex( getOptions() ) + nl +
" recordId: 0x" + HexDump.toHex( getRecordId() ) + nl +
" numchildren: " + getChildRecords().size() + nl +
" properties:" + nl +
propertiesBuf.toString();
}
/**
* The list of properties stored by this record.
*/
public List<EscherProperty> getEscherProperties()
{
return properties;
}
/**
* The list of properties stored by this record.
*/
public EscherProperty getEscherProperty( int index )
{
return properties.get( index );
}
/**
* Add a property to this record.
*/
public void addEscherProperty( EscherProperty prop )
{
properties.add( prop );
}
/**
* Records should be sorted by property number before being stored.
*/
public void sortProperties()
{
Collections.sort( properties, new Comparator<EscherProperty>()
{
public int compare( EscherProperty p1, EscherProperty p2 )
{
short s1 = p1.getPropertyNumber();
short s2 = p2.getPropertyNumber();
return s1 < s2 ? -1 : s1 == s2 ? 0 : 1;
}
} );
}
public <T extends EscherProperty> T lookup( int propId )
{
for ( EscherProperty prop : properties )
{
if ( prop.getPropertyNumber() == propId )
{
@SuppressWarnings( "unchecked" )
final T result = (T) prop;
return result;
}
}
return null;
}
}

80
src/java/org/apache/poi/ddf/EscherTertiaryOptRecord.java
View File

@ -16,96 +16,18 @@
==================================================================== */
package org.apache.poi.ddf;
import java.util.ArrayList;
import java.util.List;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndian;
/**
* "The OfficeArtTertiaryFOPT record specifies a table of OfficeArtRGFOPTE properties, as defined in section 2.3.1."
* -- [MS-ODRAW] — v20110608; Office Drawing Binary File Format
*
* @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
*/
public class EscherTertiaryOptRecord extends EscherRecord
public class EscherTertiaryOptRecord extends AbstractEscherOptRecord
{
public static final short RECORD_ID = (short) 0xF122;
private List<EscherProperty> properties = new ArrayList<EscherProperty>();
public int fillFields( byte[] data, int offset,
EscherRecordFactory recordFactory )
{
int bytesRemaining = readHeader( data, offset );
int pos = offset + 8;
EscherPropertyFactory f = new EscherPropertyFactory();
properties = f.createProperties( data, pos, getInstance() );
return bytesRemaining + 8;
}
private int getPropertiesSize()
{
int totalSize = 0;
for ( EscherProperty property : properties )
{
totalSize += property.getPropertySize();
}
return totalSize;
}
public String getRecordName()
{
return "TertiaryOpt";
}
@Override
public int getRecordSize()
{
return 8 + getPropertiesSize();
}
public int serialize( int offset, byte[] data,
EscherSerializationListener listener )
{
listener.beforeRecordSerialize( offset, getRecordId(), this );
LittleEndian.putShort( data, offset, getOptions() );
LittleEndian.putShort( data, offset + 2, getRecordId() );
LittleEndian.putInt( data, offset + 4, getPropertiesSize() );
int pos = offset + 8;
for ( EscherProperty property : properties )
{
pos += property.serializeSimplePart( data, pos );
}
for ( EscherProperty property : properties )
{
pos += property.serializeComplexPart( data, pos );
}
listener.afterRecordSerialize( pos, getRecordId(), pos - offset, this );
return pos - offset;
}
/**
* Retrieve the string representation of this record.
*/
public String toString()
{
String nl = System.getProperty( "line.separator" );
StringBuffer propertiesBuf = new StringBuffer();
for ( EscherProperty property : properties )
{
propertiesBuf.append( " " + property.toString() + nl );
}
return "org.apache.poi.ddf.EscherTertiaryOptRecord:" + nl
+ " isContainer: " + isContainerRecord() + nl
+ " options: 0x" + HexDump.toHex( getOptions() ) + nl
+ " recordId: 0x" + HexDump.toHex( getRecordId() ) + nl
+ " numchildren: " + getChildRecords().size() + nl
+ " properties:" + nl + propertiesBuf.toString();
}
}