|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.POIDocument
public abstract class POIDocument
This holds the common functionality for all POI Document classes. Currently, this relates to Document Information Properties
| Field Summary | |
|---|---|
protected DirectoryNode |
directory
The directory that our document lives in |
| Constructor Summary | |
|---|---|
protected |
POIDocument(DirectoryNode dir)
|
protected |
POIDocument(DirectoryNode dir,
POIFSFileSystem fs)
Deprecated. use POIDocument(DirectoryNode) instead |
protected |
POIDocument(NPOIFSFileSystem fs)
|
protected |
POIDocument(POIFSFileSystem fs)
|
| Method Summary | |
|---|---|
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 |
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<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 |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected DirectoryNode directory
| Constructor Detail |
|---|
protected POIDocument(DirectoryNode dir)
@Deprecated
protected POIDocument(DirectoryNode dir,
POIFSFileSystem fs)
POIDocument(DirectoryNode) instead
protected POIDocument(POIFSFileSystem fs)
protected POIDocument(NPOIFSFileSystem fs)
| Method Detail |
|---|
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 into
java.io.IOException
protected 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 too
java.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 into
java.io.IOException
public abstract void write(java.io.OutputStream out)
throws java.io.IOException
java.io.IOException
@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 copy
java.io.IOException
@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 copy
java.io.IOException
@Internal
@Deprecated
protected void copyNodeRecursively(Entry entry,
DirectoryEntry target)
throws java.io.IOException
java.io.IOException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||