1 2 /* ==================================================================== 3 * The Apache Software License, Version 1.1 4 * 5 * Copyright (c) 2002 The Apache Software Foundation. All rights 6 * reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in 17 * the documentation and/or other materials provided with the 18 * distribution. 19 * 20 * 3. The end-user documentation included with the redistribution, 21 * if any, must include the following acknowledgment: 22 * "This product includes software developed by the 23 * Apache Software Foundation (http://www.apache.org/)." 24 * Alternately, this acknowledgment may appear in the software itself, 25 * if and wherever such third-party acknowledgments normally appear. 26 * 27 * 4. The names "Apache" and "Apache Software Foundation" and 28 * "Apache POI" must not be used to endorse or promote products 29 * derived from this software without prior written permission. For 30 * written permission, please contact apache@apache.org. 31 * 32 * 5. Products derived from this software may not be called "Apache", 33 * "Apache POI", nor may "Apache" appear in their name, without 34 * prior written permission of the Apache Software Foundation. 35 * 36 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 37 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 38 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 39 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 42 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 43 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 44 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 45 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 46 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 47 * SUCH DAMAGE. 48 * ==================================================================== 49 * 50 * This software consists of voluntary contributions made by many 51 * individuals on behalf of the Apache Software Foundation. For more 52 * information on the Apache Software Foundation, please see 53 * <http://www.apache.org/>. 54 */ 55 56 package org.apache.poi.poifs.dev; 57 58 import java.io.*; 59 60 import java.util.*; 61 62 /** 63 * This class contains methods used to inspect POIFSViewable objects 64 * 65 * @author Marc Johnson (mjohnson at apache dot org) 66 */ 67 68 public class POIFSViewEngine 69 { 70 private static final String _EOL = System.getProperty("line.separator"); 71 72 /** 73 * Inspect an object that may be viewable, and drill down if told 74 * to 75 * 76 * @param viewable the object to be viewed 77 * @param drilldown if true, and the object implements 78 * POIFSViewable, inspect the objects' contents 79 * (recursively) 80 * @param indentLevel how far in to indent each string 81 * @param indentString string to use for indenting 82 * 83 * @return a List of Strings holding the content 84 */ 85 86 public static List inspectViewable(final Object viewable, 87 final boolean drilldown, 88 final int indentLevel, 89 final String indentString) 90 { 91 List objects = new ArrayList(); 92 93 if (viewable instanceof POIFSViewable) 94 { 95 POIFSViewable inspected = ( POIFSViewable ) viewable; 96 97 objects.add(indent(indentLevel, indentString, 98 inspected.getShortDescription())); 99 if (drilldown) 100 { 101 if (inspected.preferArray()) 102 { 103 Object[] data = inspected.getViewableArray(); 104 105 for (int j = 0; j < data.length; j++) 106 { 107 objects.addAll(inspectViewable(data[ j ], drilldown, 108 indentLevel + 1, 109 indentString)); 110 } 111 } 112 else 113 { 114 Iterator iter = inspected.getViewableIterator(); 115 116 while (iter.hasNext()) 117 { 118 objects.addAll(inspectViewable(iter.next(), 119 drilldown, 120 indentLevel + 1, 121 indentString)); 122 } 123 } 124 } 125 } 126 else 127 { 128 objects.add(indent(indentLevel, indentString, 129 viewable.toString())); 130 } 131 return objects; 132 } 133 134 private static String indent(final int indentLevel, 135 final String indentString, final String data) 136 { 137 StringBuffer finalBuffer = new StringBuffer(); 138 StringBuffer indentPrefix = new StringBuffer(); 139 140 for (int j = 0; j < indentLevel; j++) 141 { 142 indentPrefix.append(indentString); 143 } 144 LineNumberReader reader = 145 new LineNumberReader(new StringReader(data)); 146 147 try 148 { 149 String line = reader.readLine(); 150 151 while (line != null) 152 { 153 finalBuffer.append(indentPrefix).append(line).append(_EOL); 154 line = reader.readLine(); 155 } 156 } 157 catch (IOException e) 158 { 159 finalBuffer.append(indentPrefix).append(e.getMessage()) 160 .append(_EOL); 161 } 162 return finalBuffer.toString(); 163 } 164 } // end public class POIFSViewEngine 165 166