HDGFDiagram
, HPBFDocument
, HPSFPropertiesOnlyDocument
, HSLFSlideShow
, HSSFWorkbook
, HWPFDocumentCore
, MAPIMessage
public abstract class POIDocument
extends java.lang.Object
Modifier and Type | Field | Description |
---|---|---|
protected DirectoryNode |
directory |
The directory that our document lives in
|
Modifier | Constructor | Description |
---|---|---|
protected |
POIDocument(DirectoryNode dir) |
Constructs a POIDocument with the given directory node.
|
protected |
POIDocument(DirectoryNode dir,
POIFSFileSystem fs) |
Deprecated.
use
POIDocument(DirectoryNode) instead |
protected |
POIDocument(NPOIFSFileSystem fs) |
|
protected |
POIDocument(POIFSFileSystem fs) |
Modifier and Type | Method | Description |
---|---|---|
protected void |
copyNodeRecursively(Entry entry,
DirectoryEntry target) |
Deprecated.
|
protected void |
copyNodes(DirectoryNode sourceRoot,
DirectoryNode targetRoot,
java.util.List<java.lang.String> excepts) |
Deprecated.
|
protected void |
copyNodes(POIFSFileSystem source,
POIFSFileSystem target,
java.util.List<java.lang.String> excepts) |
Deprecated.
|
void |
createInformationProperties() |
Will create whichever of SummaryInformation
and DocumentSummaryInformation (HPSF) properties
are not already part of your document.
|
DocumentSummaryInformation |
getDocumentSummaryInformation() |
Fetch the Document Summary Information of the document
|
protected PropertySet |
getPropertySet(java.lang.String setName) |
For a given named property entry, either return it or null if
if it wasn't found
|
protected PropertySet |
getPropertySet(java.lang.String setName,
EncryptionInfo encryptionInfo) |
For a given named property entry, either return it or null if
if it wasn't found
|
SummaryInformation |
getSummaryInformation() |
Fetch the Summary Information of the document
|
protected void |
readProperties() |
Find, and create objects for, the standard
Document Information Properties (HPSF).
|
abstract void |
write(java.io.OutputStream out) |
Writes the document out to the specified output stream.
|
protected void |
writeProperties(POIFSFileSystem outFS) |
Writes out the standard Documment Information Properties (HPSF)
|
protected void |
writeProperties(POIFSFileSystem outFS,
java.util.List<java.lang.String> writtenEntries) |
Writes out the standard Documment Information Properties (HPSF)
|
protected void |
writePropertySet(java.lang.String name,
PropertySet set,
POIFSFileSystem outFS) |
Writes out a given ProperySet
|
protected DirectoryNode directory
protected POIDocument(DirectoryNode dir)
dir
- The DirectoryNode
where information is read from.@Deprecated protected POIDocument(DirectoryNode dir, POIFSFileSystem fs)
POIDocument(DirectoryNode)
insteadprotected POIDocument(POIFSFileSystem fs)
protected POIDocument(NPOIFSFileSystem fs)
public DocumentSummaryInformation getDocumentSummaryInformation()
public SummaryInformation getSummaryInformation()
public void createInformationProperties()
protected void readProperties()
protected PropertySet getPropertySet(java.lang.String setName)
setName
- The property to readprotected PropertySet getPropertySet(java.lang.String setName, EncryptionInfo encryptionInfo)
setName
- The property to readencryptionInfo
- the encryption descriptor in case of cryptoAPI encryptionprotected void writeProperties(POIFSFileSystem outFS) throws java.io.IOException
outFS
- the POIFSFileSystem to write the properties intojava.io.IOException
- if an error when writing to the
POIFSFileSystem
occursprotected void writeProperties(POIFSFileSystem outFS, java.util.List<java.lang.String> writtenEntries) throws java.io.IOException
outFS
- the POIFSFileSystem to write the properties intowrittenEntries
- a list of POIFS entries to add the property names toojava.io.IOException
- if an error when writing to the
POIFSFileSystem
occursprotected void writePropertySet(java.lang.String name, PropertySet set, POIFSFileSystem outFS) throws java.io.IOException
name
- the (POIFS Level) name of the property to writeset
- the PropertySet to write outoutFS
- the POIFSFileSystem to write the property intojava.io.IOException
- if an error when writing to the
POIFSFileSystem
occurspublic abstract void write(java.io.OutputStream out) throws java.io.IOException
out
- The stream to write to.java.io.IOException
- thrown on errors writing to the stream@Deprecated protected void copyNodes(POIFSFileSystem source, POIFSFileSystem target, java.util.List<java.lang.String> excepts) throws java.io.IOException
source
- is the source POIFS to copy fromtarget
- is the target POIFS to copy toexcepts
- is a list of Strings specifying what nodes NOT to copyjava.io.IOException
- thrown on errors writing to the target file system.@Deprecated protected void copyNodes(DirectoryNode sourceRoot, DirectoryNode targetRoot, java.util.List<java.lang.String> excepts) throws java.io.IOException
sourceRoot
- is the source POIFS to copy fromtargetRoot
- is the target POIFS to copy toexcepts
- is a list of Strings specifying what nodes NOT to copyjava.io.IOException
- thrown on errors writing to the target directory node.@Internal @Deprecated protected void copyNodeRecursively(Entry entry, DirectoryEntry target) throws java.io.IOException
entry
- the entry to copy fromtarget
- the entry to write tojava.io.IOException
- thrown on errors writing to the target directory entry.Copyright 2018 The Apache Software Foundation or its licensors, as applicable.