View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *  http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.any23.extractor;
19  
20  import org.apache.any23.validator.ValidationReport;
21  
22  import java.util.Collection;
23  import java.util.Map;
24  
25  /**
26   * This class provides the report for a {@link SingleDocumentExtraction} run.
27   *
28   * @see SingleDocumentExtraction
29   * @author Michele Mostarda (mostarda@fbk.eu)
30   */
31  public class SingleDocumentExtractionReport {
32  
33      private final ValidationReport validationReport;
34  
35      private final Map<String, Collection<IssueReport.Issue>> extractorToIssues;
36  
37      public SingleDocumentExtractionReport(
38              ValidationReport validationReport,
39              Map<String, Collection<IssueReport.Issue>> extractorToIssues
40      ) {
41          if(validationReport  == null) throw new NullPointerException("validation report cannot be null.");
42          if(extractorToIssues == null) throw new NullPointerException("extractor issues map cannot be null.");
43          this.validationReport  = validationReport;
44          this.extractorToIssues = extractorToIssues;
45      }
46  
47      public ValidationReport getValidationReport() {
48          return validationReport;
49      }
50  
51      public Map<String, Collection<IssueReport.Issue>> getExtractorToIssues() {
52          return extractorToIssues;
53      }
54  
55  }