Package org.apache.poi.poifs.filesystem
Class Ole10Native
java.lang.Object
org.apache.poi.poifs.filesystem.Ole10Native
Represents an Ole10Native record which is wrapped around certain binary
files being embedded in OLE2 documents.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionOle10Native
(byte[] data, int offset) Creates an instance and fills the fields based on the data in the given buffer.Ole10Native
(String label, String filename, String command, byte[] data) Creates an instance and fills the fields based on ... -
Method Summary
Modifier and TypeMethodDescriptionstatic Ole10Native
createFromEmbeddedOleObject
(DirectoryNode directory) Creates an instance of this class from an embedded OLE Object.static Ole10Native
Creates an instance of this class from an embedded OLE Object.static void
createOleMarkerEntry
(DirectoryEntry parent) Add the \1OLE marker entry, which is not the Ole10Native entry.static void
Add the \1OLE marker entry, which is not the Ole10Native entry.Returns the command field - usually the name of the file being embedded including the full path, may be a command specified during embedding the file.byte[]
Returns the buffer containing the embedded file's data, ornull
if no data was embedded.int
Returns the size of the embedded file.Returns the fileName field - usually the name of the file being embedded including the full path.short
Returns flags1 - currently unknown - usually 0x0002.short
Returns flags2 - currently unknown - mostly 0x0000.short
Returns the flags3 - currently unknown.getLabel()
Returns the label field - usually the name of the file (without directory) but probably may be any name specified during packaging/embedding the data.int
Returns the value of the totalSize field - the total length of the structure is totalSize + 4 (value of this field + size of this field).short
Returns unknown1 field - currently unknown.void
setCommand
(String command) void
setDataBuffer
(byte[] dataBuffer) void
setFileName
(String fileName) void
setFlags1
(short flags1) void
setFlags2
(short flags2) void
setFlags3
(short flags3) void
void
setUnknown1
(short unknown1) void
writeOut
(OutputStream out) Have the contents printer out into an OutputStream, used when writing a file back out to disk (Normally, atom classes will keep their bytes around, but non atom classes will just request the bytes from their children, then chuck on their header and return)
-
Field Details
-
OLE10_NATIVE
- See Also:
-
ISO1
- See Also:
-
-
Constructor Details
-
Ole10Native
Creates an instance and fills the fields based on ... the fields -
Ole10Native
Creates an instance and fills the fields based on the data in the given buffer.- Parameters:
data
- The buffer containing the Ole10Native recordoffset
- The start offset of the record in the buffer- Throws:
Ole10NativeException
- on invalid or unexcepted data format
-
-
Method Details
-
createFromEmbeddedOleObject
public static Ole10Native createFromEmbeddedOleObject(POIFSFileSystem poifs) throws IOException, Ole10NativeException Creates an instance of this class from an embedded OLE Object. The OLE Object is expected to include a stream "{01}Ole10Native" which contains the actual data relevant for this class.- Parameters:
poifs
- POI Filesystem object- Returns:
- Returns an instance of this class
- Throws:
IOException
- on IO errorOle10NativeException
- on invalid or unexcepted data format
-
createFromEmbeddedOleObject
public static Ole10Native createFromEmbeddedOleObject(DirectoryNode directory) throws IOException, Ole10NativeException Creates an instance of this class from an embedded OLE Object. The OLE Object is expected to include a stream "{01}Ole10Native" which contains the actual data relevant for this class.- Parameters:
directory
- POI Filesystem object- Returns:
- Returns an instance of this class
- Throws:
IOException
- on IO errorOle10NativeException
- on invalid or unexcepted data format
-
createOleMarkerEntry
Add the \1OLE marker entry, which is not the Ole10Native entry. Beside this "Ole" record there were several other records, e.g. CompObj, OlePresXXX, but it seems, that they aren't necessary- Throws:
IOException
-
createOleMarkerEntry
Add the \1OLE marker entry, which is not the Ole10Native entry. Beside this "Ole" record there were several other records, e.g. CompObj, OlePresXXX, but it seems, that they aren't necessary- Throws:
IOException
-
getTotalSize
public int getTotalSize()Returns the value of the totalSize field - the total length of the structure is totalSize + 4 (value of this field + size of this field).- Returns:
- the totalSize
-
getFlags1
public short getFlags1()Returns flags1 - currently unknown - usually 0x0002.- Returns:
- the flags1
-
getLabel
Returns the label field - usually the name of the file (without directory) but probably may be any name specified during packaging/embedding the data.- Returns:
- the label
-
getFileName
Returns the fileName field - usually the name of the file being embedded including the full path.- Returns:
- the fileName
-
getFlags2
public short getFlags2()Returns flags2 - currently unknown - mostly 0x0000.- Returns:
- the flags2
-
getUnknown1
public short getUnknown1()Returns unknown1 field - currently unknown.- Returns:
- the unknown1
-
getCommand
Returns the command field - usually the name of the file being embedded including the full path, may be a command specified during embedding the file.- Returns:
- the command
-
getDataSize
public int getDataSize()Returns the size of the embedded file. If the size is 0 (zero), no data has been embedded. To be sure, that no data has been embedded, check whethergetDataBuffer()
returnsnull
.- Returns:
- the dataSize
-
getDataBuffer
public byte[] getDataBuffer()Returns the buffer containing the embedded file's data, ornull
if no data was embedded. Note that an embedding may provide information about the data, but the actual data is not included. (So label, filename etc. are available, but this method returnsnull
.)- Returns:
- the dataBuffer
-
getFlags3
public short getFlags3()Returns the flags3 - currently unknown.- Returns:
- the flags3
-
writeOut
Have the contents printer out into an OutputStream, used when writing a file back out to disk (Normally, atom classes will keep their bytes around, but non atom classes will just request the bytes from their children, then chuck on their header and return)- Throws:
IOException
-
setFlags1
public void setFlags1(short flags1) -
setFlags2
public void setFlags2(short flags2) -
setFlags3
public void setFlags3(short flags3) -
setLabel
-
setFileName
-
setCommand
-
setUnknown1
public void setUnknown1(short unknown1) -
setDataBuffer
public void setDataBuffer(byte[] dataBuffer)
-