org.apache.poi.ddf

Class EscherArrayProperty

java.lang.Object

org.apache.poi.ddf.EscherProperty

org.apache.poi.ddf.EscherComplexProperty

org.apache.poi.ddf.EscherArrayProperty

All Implemented Interfaces:

java.lang.Iterable<byte[]>, GenericRecord

public final class EscherArrayProperty
extends EscherComplexProperty
implements java.lang.Iterable<byte[]>

Escher array properties are the most weird construction ever invented with all sorts of special cases. I'm hopeful I've got them all. (Escher 数组属性是有史以来最奇怪的构造，具有各种特殊情况。我希望我已经拥有了所有这些。)

Constructor Summary

Constructors

Constructor and Description
EscherArrayProperty(EscherPropertyTypes type, boolean isBlipId, int complexSize) Create an instance of an escher array property.
EscherArrayProperty(short propertyNumber, boolean isBlipId, byte[] complexData) Deprecated. use EscherArrayProperty(EscherPropertyTypes, boolean, int) and EscherComplexProperty.setComplexData(byte[])
EscherArrayProperty(short id, int complexSize) Create an instance of an escher array property.

Method Summary

Modifier and Type	Method and Description
byte[]	getElement(int index)
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
int	getNumberOfElementsInArray()
int	getNumberOfElementsInMemory()
short	getSizeOfElements()
java.util.Iterator<byte[]>	iterator()
int	serializeSimplePart(byte[] data, int pos) Serializes the simple part of this property. (序列化此属性的简单部分。)
int	setArrayData(byte[] data, int offset) We have this method because the way in which arrays in escher works is screwed for seemly arbitrary reasons. (我们有这种方法是因为 escher 中的数组的工作方式似乎出于任意原因而被搞砸了。)
void	setElement(int index, byte[] element)
void	setNumberOfElementsInArray(int numberOfElements)
void	setNumberOfElementsInMemory(int numberOfElements)
void	setSizeOfElements(int sizeOfElements)

Methods inherited from class org.apache.poi.ddf.EscherComplexProperty

equals, getComplexData, getPropertySize, hashCode, resizeComplexData, resizeComplexData, serializeComplexPart, setComplexData, setComplexData

Methods inherited from class org.apache.poi.ddf.EscherProperty

getGenericChildren, getGenericRecordType, getId, getName, getPropertyNumber, isBlipId, isComplex, toString, toXml

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EscherArrayProperty

@Internal
public EscherArrayProperty(short id,
                                     int complexSize)

Create an instance of an escher array property. This constructor can be used to create emptyComplexParts with a complexSize = 0. Preferably use EscherArrayProperty(EscherPropertyTypes, boolean, int) with EscherComplexProperty.setComplexData(byte[]). (创建一个 escher 数组属性的实例。此构造函数可用于创建 complexSize = 0 的 emptyComplexParts。最好将 EscherArrayProperty(EscherPropertyTypes, boolean, int) 与 EscherComplexProperty.setComplexData(byte[]) 一起使用。)

Parameters:

id - The id consists of the property number, a flag indicating whether this is a blip id and a flag indicating that this is a complex property. (id - id 由属性编号、指示这是否是 blip id 的标志和指示这是复杂属性的标志组成。)

complexSize - the data size (complexSize - 数据大小)

EscherArrayProperty

@Deprecated
 @Removal(version="5.0.0")
public EscherArrayProperty(short propertyNumber,
                                                                  boolean isBlipId,
                                                                  byte[] complexData)

Deprecated. use EscherArrayProperty(EscherPropertyTypes, boolean, int) and EscherComplexProperty.setComplexData(byte[])

Create an instance of an escher array property. This constructor defaults to a 6 bytes header if the complexData is null or byte[0]. (创建一个 escher 数组属性的实例。如果 complexData 为 null 或 byte[0]，则此构造函数默认为 6 字节标头。)

Parameters:

propertyNumber - the property number part of the property id (propertyNumber - 属性 id 的属性编号部分)

isBlipId - true, if it references a blip (isBlipId - true，如果它引用了一个 blip)

complexData - the data (complexData - 数据)

EscherArrayProperty

public EscherArrayProperty(EscherPropertyTypes type,
                           boolean isBlipId,
                           int complexSize)

Create an instance of an escher array property. This constructor defaults to a 6 bytes header if the complexSize is 0. (创建一个 escher 数组属性的实例。如果 complexSize 为 0，则此构造函数默认为 6 字节标头。)

Parameters:

type - the property type of the property id (type - 属性 id 的属性类型)

isBlipId - true, if it references a blip (isBlipId - true，如果它引用了一个 blip)

complexSize - the data size (complexSize - 数据大小)

Method Detail

getNumberOfElementsInArray

public int getNumberOfElementsInArray()

setNumberOfElementsInArray

public void setNumberOfElementsInArray(int numberOfElements)

getNumberOfElementsInMemory

public int getNumberOfElementsInMemory()

setNumberOfElementsInMemory

public void setNumberOfElementsInMemory(int numberOfElements)

getSizeOfElements

public short getSizeOfElements()

setSizeOfElements

public void setSizeOfElements(int sizeOfElements)

getElement

public byte[] getElement(int index)

setElement

public void setElement(int index,
                       byte[] element)

setArrayData

public int setArrayData(byte[] data,
                        int offset)

We have this method because the way in which arrays in escher works is screwed for seemly arbitrary reasons. While most properties are fairly consistent and have a predictable array size, escher arrays have special cases. (我们有这种方法是因为 escher 中的数组的工作方式似乎出于任意原因而被搞砸了。虽然大多数属性都相当一致并且具有可预测的数组大小，但 escher 数组有特殊情况。)

Parameters:

data - The data array containing the escher array information (data - 包含 escher 数组信息的数据数组)

offset - The offset into the array to start reading from. (offset - 要开始读取的数组的偏移量。)

Returns:

the number of bytes used by this complex property. (此复杂属性使用的字节数。)

serializeSimplePart

public int serializeSimplePart(byte[] data,
                               int pos)

Serializes the simple part of this property. ie the first 6 bytes. Needs special code to handle the case when the size doesn't include the size of the header block (序列化此属性的简单部分。即前6个字节。需要特殊代码来处理大小不包括头块大小的情况)

Overrides:

serializeSimplePart in class EscherComplexProperty

Parameters:

data - the buffer to write to (data - 要写入的缓冲区)

pos - the starting position (pos - 起始位置)

Returns:

the length of the part (零件的长度)

iterator

public java.util.Iterator<byte[]> iterator()

Specified by:

iterator in interface java.lang.Iterable<byte[]> (接口 java.lang.Iterable 中的迭代器 )

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord (接口 GenericRecord 中的 getGenericProperties)

Overrides:

getGenericProperties in class EscherComplexProperty