Package org.apache.poi.hslf.record
Class ExOleObjStg
java.lang.Object
org.apache.poi.hslf.record.Record
org.apache.poi.hslf.record.RecordAtom
org.apache.poi.hslf.record.PositionDependentRecordAtom
org.apache.poi.hslf.record.ExOleObjStg
- All Implemented Interfaces:
PersistRecord,PositionDependentRecord
Storage for embedded OLE objects.
-
Field Summary
-
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs a new empty storage container.protectedExOleObjStg(byte[] source, int start, int len) Constructs the link related atom record from its source data. -
Method Summary
Modifier and TypeMethodDescriptiongetData()Opens an input stream which will decompress the data on the fly.intGets the uncompressed length of the data.intFetch our sheet ID, as found from a PersistPtrHolder.byte[]intGets the record instance from the headerlongGets the record type.booleanvoidsetData(byte[] data) Sets the embedded data.voidsetPersistId(int id) Set our sheet ID, as found from a PersistPtrHoldervoidupdateOtherRecordReferences(Map<Integer, Integer> oldToNewReferencesLookup) Offer the record the list of records that have changed their location as part of the writeout.voidwriteOut(OutputStream out) Write the contents of the record back, so it can be written to disk.Methods inherited from class org.apache.poi.hslf.record.PositionDependentRecordAtom
getLastOnDiskOffset, setLastOnDiskOffsetMethods inherited from class org.apache.poi.hslf.record.RecordAtom
getChildRecords, isAnAtomMethods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
-
Constructor Details
-
ExOleObjStg
public ExOleObjStg()Constructs a new empty storage container. -
ExOleObjStg
protected ExOleObjStg(byte[] source, int start, int len) Constructs the link related atom record from its source data.- Parameters:
source- the source data as a byte array.start- the start offset into the byte array.len- the length of the slice in the byte array.
-
-
Method Details
-
isCompressed
public boolean isCompressed() -
getDataLength
public int getDataLength()Gets the uncompressed length of the data.- Returns:
- the uncompressed length of the data.
-
getData
Opens an input stream which will decompress the data on the fly.- Returns:
- the data input stream.
-
getRawData
public byte[] getRawData() -
setData
Sets the embedded data.- Parameters:
data- the embedded data.- Throws:
IOException
-
getRecordType
public long getRecordType()Gets the record type.- Specified by:
getRecordTypein classRecord- Returns:
- the record type.
-
getRecordInstance
public int getRecordInstance()Gets the record instance from the header- Returns:
- record instance
-
writeOut
Write the contents of the record back, so it can be written to disk.- Specified by:
writeOutin classRecord- Parameters:
out- the output stream to write to.- Throws:
IOException- if an error occurs.
-
getPersistId
public int getPersistId()Fetch our sheet ID, as found from a PersistPtrHolder. Should match the RefId of our matching SlidePersistAtom- Specified by:
getPersistIdin interfacePersistRecord
-
setPersistId
public void setPersistId(int id) Set our sheet ID, as found from a PersistPtrHolder- Specified by:
setPersistIdin interfacePersistRecord
-
updateOtherRecordReferences
Description copied from class:PositionDependentRecordAtomOffer the record the list of records that have changed their location as part of the writeout. Allows records to update their internal pointers to other records locations- Specified by:
updateOtherRecordReferencesin interfacePositionDependentRecord- Specified by:
updateOtherRecordReferencesin classPositionDependentRecordAtom
-