Project Report: fawkez

Packagesummary org.jcoderz.phoenix.report

org.jcoderz.phoenix.report.ReportReader

LineHitsNoteSource
1  /*
2   * $Id: ReportReader.java 627 2008-03-16 11:11:43Z amandel $
3   *
4   * Copyright 2006, The jCoderZ.org Project. All rights reserved.
5   *
6   * Redistribution and use in source and binary forms, with or without
7   * modification, are permitted provided that the following conditions are
8   * met:
9   *
10   *    * Redistributions of source code must retain the above copyright
11   *      notice, this list of conditions and the following disclaimer.
12   *    * Redistributions in binary form must reproduce the above
13   *      copyright notice, this list of conditions and the following
14   *      disclaimer in the documentation and/or other materials
15   *      provided with the distribution.
16   *    * Neither the name of the jCoderZ.org Project nor the names of
17   *      its contributors may be used to endorse or promote products
18   *      derived from this software without specific prior written
19   *      permission.
20   *
21   * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
22   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24   * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS
25   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30   * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32   */
33  package org.jcoderz.phoenix.report;
34  
35  import java.io.File;
36  import java.io.FileNotFoundException;
37  import java.util.List;
38  import java.util.Map;
39  
40  import javax.xml.bind.JAXBException;
41  
42  import org.jcoderz.phoenix.report.jaxb.Item;
43  
44  /**
45   * Common Interface for all Report Readers.
46   *
47   * @author Michael Griffel
48   */
49  public interface ReportReader
50  {
51     /**
52      * Parses the report file/directory.
53      *
54      * @param f input XML report or directory.
55      * @throws JAXBException if an JAXB exception occures.
56      * @throws FileNotFoundException if the given file does not exists.
57      */
58     void parse (File f)
59        throws JAXBException, FileNotFoundException;
60  
61     /**
62      * Merges the items of the input report as a Map of filename string and of
63      * the type Item (org.jcoderz.phoenix.report.jaxb.Item) into the
64      * given item Map.
65      *
66      * @param items the items that should be merged with the report's
67      *        input items.
68      * @throws JAXBException if an JAXB exception occurs.
69      */
70     void merge (Map<ResourceInfo, List<Item>> items)
71        throws JAXBException;
72  }

Findings in this File