View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.files;
35  
36  import info.magnolia.cms.util.ClasspathResourcesUtil;
37  
38  import java.io.IOException;
39  
40  /**
41   * Basic file extractor; does not do any check but provides the actual file extraction mechanisms,
42   * via {@link info.magnolia.module.files.FileExtractorOperation}s.
43   *
44   * @see FileExtractorOperation
45   * 
46   * @author gjoseph
47   * @version $Revision: $ ($Author: $)
48   */
49  public class BasicFileExtractor implements FileExtractor {
50  
51      public void extractFile(String resourcePath, String absTargetPath) throws IOException {
52          newOperation(resourcePath, absTargetPath).extract();
53      }
54  
55      public void extractFile(String resourcePath, Transformer transformer) throws IOException {
56          final String absTargetPath = transformer.accept(resourcePath);
57          extractFile(resourcePath, absTargetPath);
58      }
59  
60      public void extractFiles(Transformer transformer) throws IOException {
61          final String[] resources = collectResources(transformer);
62          for (final String resourcePath : resources) {
63              final String absTargetPath = transformer.accept(resourcePath);
64              extractFile(resourcePath, absTargetPath);
65          }
66      }
67  
68      protected FileExtractorOperation newOperation(String resourcePath, String absTargetPath) {
69          return new BasicFileExtractorOperation(resourcePath, absTargetPath);
70      }
71  
72      protected String[] collectResources(Transformer transformer) {
73          final ClasspathResourcesFilterAdapter filter = new ClasspathResourcesFilterAdapter(transformer);
74          return ClasspathResourcesUtil.findResources(filter);
75      }
76  
77  }