View Javadoc

1   /*
2    * Report.java
3    * Created on 29 Август 2006 г., 23:32
4    */
5   
6   package org.weda.report;
7   
8   import java.io.InputStream;
9   
10  /**
11   *
12   * @author Mikhail Titov
13   */
14  public interface Report {
15      /**Метод возвращает имя отчета. Имя должно быть уникальным в группе.
16       * @see #getGroup()
17       */ 
18      public String getName();
19      /**Метод возвращает имя группы к которой принадлежит отчет.
20       * @see #getName()
21       * @see ReportRegistry#getReportsForGroup(String)
22       */
23      public String getGroup();
24      /**Метод возвращает mime тип отчета.
25       */
26      public String getMimeType();
27      /**Метод генерирует отчет и возвращает поток с данными полученными
28       * в результате генерации.
29       * @see #release()
30       */
31      public InputStream generate() throws ReportException;
32      /**Метод освобождает ресурсы которые были заняты отчетом во время
33       * генерации.
34       * @see #generate()
35       */
36      public void release() throws ReportException;
37  }