org.apache.cocoon.poi.poifs.filesystem: public class: DocumentNode

org.apache.cocoon.poi.poifs.filesystem
public class: DocumentNode [javadoc | source]

java.lang.Object
   org.apache.cocoon.poi.poifs.filesystem.EntryNode
      org.apache.cocoon.poi.poifs.filesystem.DocumentNode

All Implemented Interfaces:
DocumentEntry, Entry

Simple implementation of DocumentEntry

author: Marc - Johnson (marc_johnson27591@hotmail.com)

Constructor:

Constructor:
DocumentNode(DocumentProperty property, DirectoryNode parent) { super(property, parent); _document = property.getDocument(); } create a DocumentNode. This method is not public by design; it is intended strictly for the internal use of this package Parameters: `property` - the DocumentProperty for this DocumentEntry `parent` - the parent of this entry

 DocumentNode(DocumentProperty property,
    DirectoryNode parent) {
        super(property, parent);
        _document = property.getDocument();
}

create a DocumentNode. This method is not public by design; it is intended strictly for the internal use of this package

Parameters:

property - the DocumentProperty for this DocumentEntry

parent - the parent of this entry

Method from org.apache.cocoon.poi.poifs.filesystem.DocumentNode Summary:
getDocument, getSize, isDeleteOK, isDocumentEntry

Methods from org.apache.cocoon.poi.poifs.filesystem.EntryNode:
delete, getName, getParent, getProperty, isDeleteOK, isDirectoryEntry, isDocumentEntry, isRoot, renameTo

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.cocoon.poi.poifs.filesystem.DocumentNode Detail:
Document getDocument() { return _document; } get the Document
public int getSize() { return getProperty().getSize(); } get the zize of the document, in bytes
protected boolean isDeleteOK() { return true; } extensions use this method to verify internal rules regarding deletion of the underlying store.
public boolean isDocumentEntry() { return true; } is this a DocumentEntry?

Method from org.apache.cocoon.poi.poifs.filesystem.DocumentNode Detail:

 Document getDocument() {
        return _document;
}

get the Document

 public int getSize() {
        return getProperty().getSize();
}

get the zize of the document, in bytes

 protected boolean isDeleteOK() {
        return true;
}

extensions use this method to verify internal rules regarding deletion of the underlying store.

 public boolean isDocumentEntry() {
        return true;
}

is this a DocumentEntry?