org.apache.poi
public abstract class POIDocument extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected DirectoryNode |
directory
The directory that our document lives in
|
protected POIFSFileSystem |
filesystem
The open POIFS FileSystem that contains our document
|
Modifier | Constructor and Description |
---|---|
protected |
POIDocument(DirectoryNode dir,
POIFSFileSystem fs) |
protected |
POIDocument(POIFSFileSystem fs) |
Modifier and Type | Method and Description |
---|---|
protected void |
copyNodes(POIFSFileSystem source,
POIFSFileSystem target,
java.util.List excepts)
Copies nodes from one POIFS to the other minus the excepts
|
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
|
SummaryInformation |
getSummaryInformation()
Fetch the Summary Information of the document
|
protected void |
readProperties()
Find, and create objects for, the standard
Documment 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 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 POIFSFileSystem filesystem
protected DirectoryNode directory
protected POIDocument(DirectoryNode dir, POIFSFileSystem fs)
protected POIDocument(POIFSFileSystem fs)
public DocumentSummaryInformation getDocumentSummaryInformation()
public SummaryInformation getSummaryInformation()
public void createInformationProperties()
protected void readProperties()
protected PropertySet getPropertySet(java.lang.String setName)
protected void writeProperties(POIFSFileSystem outFS) throws java.io.IOException
outFS
- the POIFSFileSystem to write the properties intojava.io.IOException
protected void writeProperties(POIFSFileSystem outFS, java.util.List 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
protected 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
public abstract void write(java.io.OutputStream out) throws java.io.IOException
java.io.IOException
protected void copyNodes(POIFSFileSystem source, POIFSFileSystem target, java.util.List 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
Copyright 2016 The Apache Software Foundation or its licensors, as applicable.