Package loci.poi.poifs.filesystem
Class DocumentNode
java.lang.Object
loci.poi.poifs.filesystem.EntryNode
loci.poi.poifs.filesystem.DocumentNode
- All Implemented Interfaces:
POIFSViewable,DocumentEntry,Entry
Simple implementation of DocumentEntry
- Author:
- Marc Johnson (mjohnson at apache dot org)
-
Method Summary
Modifier and TypeMethodDescriptionget the POIFSDocumentProvides a short description of the object, to be used when a POIFSViewable object has not provided its contents.intgetSize()get the zize of the document, in bytesObject[]Get an array of objects, some of which may implement POIFSViewableGet an Iterator of objects, some of which may implement POIFSViewableprotected booleanextensions use this method to verify internal rules regarding deletion of the underlying store.booleanis this a DocumentEntry?booleanGive viewers a hint as to whether to call getViewableArray or getViewableIteratorMethods inherited from class loci.poi.poifs.filesystem.EntryNode
delete, getName, getParent, getProperty, isDirectoryEntry, isRoot, renameTo
-
Method Details
-
getDocument
get the POIFSDocument- Returns:
- the internal POIFSDocument
-
getSize
public int getSize()get the zize of the document, in bytes- Specified by:
getSizein interfaceDocumentEntry- Returns:
- size in bytes
-
isDocumentEntry
public boolean isDocumentEntry()is this a DocumentEntry?- Specified by:
isDocumentEntryin interfaceEntry- Overrides:
isDocumentEntryin classEntryNode- Returns:
- true if the Entry is a DocumentEntry, else false
-
isDeleteOK
protected boolean isDeleteOK()extensions use this method to verify internal rules regarding deletion of the underlying store.- Specified by:
isDeleteOKin classEntryNode- Returns:
- true if it's ok to delete the underlying store, else false
-
getViewableArray
Get an array of objects, some of which may implement POIFSViewable- Specified by:
getViewableArrayin interfacePOIFSViewable- Returns:
- an array of Object; may not be null, but may be empty
-
getViewableIterator
Get an Iterator of objects, some of which may implement POIFSViewable- Specified by:
getViewableIteratorin interfacePOIFSViewable- Returns:
- an Iterator; may not be null, but may have an empty back end store
-
preferArray
public boolean preferArray()Give viewers a hint as to whether to call getViewableArray or getViewableIterator- Specified by:
preferArrayin interfacePOIFSViewable- Returns:
- true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator
-
getShortDescription
Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.- Specified by:
getShortDescriptionin interfacePOIFSViewable- Returns:
- short description
-