1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/* ====================================================================
Copyright 2002-2004 Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.poifs.filesystem;
import java.util.*;
import org.apache.poi.poifs.dev.POIFSViewable;
import org.apache.poi.poifs.property.DocumentProperty;
/**
* Simple implementation of DocumentEntry
*
* @author Marc Johnson (mjohnson at apache dot org)
*/
public class DocumentNode
extends EntryNode
implements DocumentEntry, POIFSViewable
{
// underlying POIFSDocument instance
private POIFSDocument _document;
/**
* create a DocumentNode. This method is not public by design; it
* is intended strictly for the internal use of this package
*
* @param property the DocumentProperty for this DocumentEntry
* @param parent the parent of this entry
*/
DocumentNode(final DocumentProperty property, final DirectoryNode parent)
{
super(property, parent);
_document = property.getDocument();
}
/**
* get the POIFSDocument
*
* @return the internal POIFSDocument
*/
POIFSDocument getDocument()
{
return _document;
}
/* ********** START implementation of DocumentEntry ********** */
/**
* get the zize of the document, in bytes
*
* @return size in bytes
*/
public int getSize()
{
return getProperty().getSize();
}
/* ********** END implementation of DocumentEntry ********** */
/* ********** START implementation of Entry ********** */
/**
* is this a DocumentEntry?
*
* @return true if the Entry is a DocumentEntry, else false
*/
public boolean isDocumentEntry()
{
return true;
}
/* ********** END implementation of Entry ********** */
/* ********** START extension of Entry ********** */
/**
* extensions use this method to verify internal rules regarding
* deletion of the underlying store.
*
* @return true if it's ok to delete the underlying store, else
* false
*/
protected boolean isDeleteOK()
{
return true;
}
/* ********** END extension of Entry ********** */
/* ********** START begin implementation of POIFSViewable ********** */
/**
* Get an array of objects, some of which may implement
* POIFSViewable
*
* @return an array of Object; may not be null, but may be empty
*/
public Object [] getViewableArray()
{
return new Object[ 0 ];
}
/**
* Get an Iterator of objects, some of which may implement
* POIFSViewable
*
* @return an Iterator; may not be null, but may have an empty
* back end store
*/
public Iterator getViewableIterator()
{
List components = new ArrayList();
components.add(getProperty());
components.add(_document);
return components.iterator();
}
/**
* Give viewers a hint as to whether to call getViewableArray or
* getViewableIterator
*
* @return true if a viewer should call getViewableArray, false if
* a viewer should call getViewableIterator
*/
public boolean preferArray()
{
return false;
}
/**
* Provides a short description of the object, to be used when a
* POIFSViewable object has not provided its contents.
*
* @return short description
*/
public String getShortDescription()
{
return getName();
}
/* ********** END begin implementation of POIFSViewable ********** */
} // end public class DocumentNode
|
