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
public class DocumentNode extends EntryNode implements DocumentEntry, POIFSViewable
Simple implementation of DocumentEntry- Author:
- Marc Johnson (mjohnson at apache dot org)
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description POIFSDocument
getDocument()
get the POIFSDocumentString
getShortDescription()
Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.int
getSize()
get the zize of the document, in bytesObject[]
getViewableArray()
Get an array of objects, some of which may implement POIFSViewableIterator
getViewableIterator()
Get an Iterator of objects, some of which may implement POIFSViewableprotected boolean
isDeleteOK()
extensions use this method to verify internal rules regarding deletion of the underlying store.boolean
isDocumentEntry()
is this a DocumentEntry?boolean
preferArray()
Give viewers a hint as to whether to call getViewableArray or getViewableIterator-
Methods inherited from class loci.poi.poifs.filesystem.EntryNode
delete, getName, getParent, getProperty, isDirectoryEntry, isRoot, renameTo
-
-
-
-
Method Detail
-
getDocument
public POIFSDocument getDocument()
get the POIFSDocument- Returns:
- the internal POIFSDocument
-
getSize
public int getSize()
get the zize of the document, in bytes- Specified by:
getSize
in interfaceDocumentEntry
- Returns:
- size in bytes
-
isDocumentEntry
public boolean isDocumentEntry()
is this a DocumentEntry?- Specified by:
isDocumentEntry
in interfaceEntry
- Overrides:
isDocumentEntry
in 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:
isDeleteOK
in classEntryNode
- Returns:
- true if it's ok to delete the underlying store, else false
-
getViewableArray
public Object[] getViewableArray()
Get an array of objects, some of which may implement POIFSViewable- Specified by:
getViewableArray
in interfacePOIFSViewable
- Returns:
- an array of Object; may not be null, but may be empty
-
getViewableIterator
public Iterator getViewableIterator()
Get an Iterator of objects, some of which may implement POIFSViewable- Specified by:
getViewableIterator
in 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:
preferArray
in interfacePOIFSViewable
- Returns:
- true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator
-
getShortDescription
public String getShortDescription()
Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.- Specified by:
getShortDescription
in interfacePOIFSViewable
- Returns:
- short description
-
-