Package org.apache.poi
Class POIDocument
java.lang.Object
org.apache.poi.POIDocument
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Direct Known Subclasses:
HPSFPropertiesOnlyDocument
,HSLFSlideShowImpl
,HSSFWorkbook
,HWPFDocumentCore
,POIReadOnlyDocument
This holds the common functionality for all POI
Document classes.
Currently, this relates to Document Information Properties
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
POIDocument
(DirectoryNode dir) Constructs a POIDocument with the given directory node.protected
Constructs from the default POIFS -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Clear/unlink the attached directory entryvoid
close()
Closes the underlyingPOIFSFileSystem
from which the document was read, if any.void
Will create whichever of SummaryInformation and DocumentSummaryInformation (HPSF) properties are not already part of your document.Fetch the Document Summary Information of the documentprotected String
protected PropertySet
getPropertySet
(String setName) For a given named property entry, either return it or null if if it wasn't foundprotected PropertySet
getPropertySet
(String setName, EncryptionInfo encryptionInfo) For a given named property entry, either return it or null if if it wasn't foundFetch the Summary Information of the documentprotected boolean
check if we were created by POIFS otherwise create a new dummy POIFS for storing the package dataprotected void
Find, and create objects for, the standard Document Information Properties (HPSF).protected void
replaceDirectory
(DirectoryNode newDirectory) Replaces the attached directory, e.g.protected void
Called during awrite()
to ensure that the Document (and associatedPOIFSFileSystem
) was opened in a way compatible with an in-place write.abstract void
write()
Writes the document out to the currently openFile
, via the writeablePOIFSFileSystem
it was opened from.abstract void
Writes the document out to the specified newFile
.abstract void
write
(OutputStream out) Writes the document out to the specified output stream.protected void
Writes out the updated standard Document Information Properties (HPSF) into the currently open NPOIFSFileSystemprotected void
writeProperties
(POIFSFileSystem outFS) Writes out the standard Document Information Properties (HPSF)protected void
writeProperties
(POIFSFileSystem outFS, List<String> writtenEntries) Writes out the standard Document Information Properties (HPSF)
-
Constructor Details
-
POIDocument
Constructs a POIDocument with the given directory node.- Parameters:
dir
- TheDirectoryNode
where information is read from.
-
POIDocument
Constructs from the default POIFS- Parameters:
fs
- the filesystem the document is read from
-
-
Method Details
-
getDocumentSummaryInformation
Fetch the Document Summary Information of the document- Returns:
- The Document Summary Information or null if it could not be read for this document.
-
getSummaryInformation
Fetch the Summary Information of the document- Returns:
- The Summary information for the document or null if it could not be read for this document.
-
createInformationProperties
public void createInformationProperties()Will create whichever of SummaryInformation and DocumentSummaryInformation (HPSF) properties are not already part of your document. This is normally useful when creating a new document from scratch. If the information properties are already there, then nothing will happen. -
readProperties
protected void readProperties()Find, and create objects for, the standard Document Information Properties (HPSF). If a given property set is missing or corrupt, it will remain null; -
getPropertySet
For a given named property entry, either return it or null if if it wasn't found- Parameters:
setName
- The property to read- Returns:
- The value of the given property or null if it wasn't found.
- Throws:
IOException
- If retrieving properties fails
-
getPropertySet
protected PropertySet getPropertySet(String setName, EncryptionInfo encryptionInfo) throws IOException For a given named property entry, either return it or null if if it wasn't found- Parameters:
setName
- The property to readencryptionInfo
- the encryption descriptor in case of cryptoAPI encryption- Returns:
- The value of the given property or null if it wasn't found.
- Throws:
IOException
- If retrieving properties fails
-
writeProperties
Writes out the updated standard Document Information Properties (HPSF) into the currently open NPOIFSFileSystem- Throws:
IOException
- if an error when writing to the openPOIFSFileSystem
occurs
-
writeProperties
Writes out the standard Document Information Properties (HPSF)- Parameters:
outFS
- the POIFSFileSystem to write the properties into- Throws:
IOException
- if an error when writing to thePOIFSFileSystem
occurs
-
writeProperties
protected void writeProperties(POIFSFileSystem outFS, List<String> writtenEntries) throws IOException Writes out the standard Document Information Properties (HPSF)- Parameters:
outFS
- the NPOIFSFileSystem to write the properties intowrittenEntries
- a list of POIFS entries to add the property names too- Throws:
IOException
- if an error when writing to thePOIFSFileSystem
occurs
-
validateInPlaceWritePossible
Called during awrite()
to ensure that the Document (and associatedPOIFSFileSystem
) was opened in a way compatible with an in-place write.- Throws:
IllegalStateException
- if the document was opened suitably
-
write
Writes the document out to the currently openFile
, via the writeablePOIFSFileSystem
it was opened from.This will fail (with an
IllegalStateException
if the document was opened read-only, opened from anInputStream
instead of a File, or if this is not the root document. For those cases, you must usewrite(OutputStream)
orwrite(File)
to write to a brand new document.- Throws:
IOException
- thrown on errors writing to the fileIllegalStateException
- if this isn't from a writable File- Since:
- POI 3.15 beta 3
-
write
Writes the document out to the specified newFile
. If the file exists, it will be replaced, otherwise a new one will be created- Parameters:
newFile
- The new File to write to.- Throws:
IOException
- thrown on errors writing to the file- Since:
- POI 3.15 beta 3
-
write
Writes the document out to the specified output stream. The stream is not closed as part of this operation. Note - if the Document was opened from aFile
rather than anInputStream
, you must write out usingwrite()
or to a different File. Overwriting the currently open file via an OutputStream isn't possible. Ifstream
is aFileOutputStream
on a networked drive or has a high cost/latency associated with each written byte, consider wrapping the OutputStream in aBufferedOutputStream
to improve write performance, or usewrite()
/write(File)
if possible.- Parameters:
out
- The stream to write to.- Throws:
IOException
- thrown on errors writing to the stream
-
close
Closes the underlyingPOIFSFileSystem
from which the document was read, if any. Has no effect on documents opened from an InputStream, or newly created ones.Once
close()
has been called, no further operations should be called on the document.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
getDirectory
-
clearDirectory
Clear/unlink the attached directory entry -
initDirectory
check if we were created by POIFS otherwise create a new dummy POIFS for storing the package data- Returns:
true
if dummy directory was created,false
otherwise
-
replaceDirectory
Replaces the attached directory, e.g. if this document is written to a new POIFSFileSystem- Parameters:
newDirectory
- the new directory
-
getEncryptedPropertyStreamName
- Returns:
- the stream name of the property set collection, if the document is encrypted
-
getEncryptionInfo
- Returns:
- the encryption info if the document is encrypted, otherwise
null
- Throws:
IOException
- If retrieving the encryption information fails
-