View Javadoc

1   package org.apache.maven.plugins.site;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.doxia.module.xhtml.decoration.render.RenderingContext;
23  import org.apache.maven.doxia.siterenderer.DocumentRenderer;
24  import org.apache.maven.doxia.siterenderer.Renderer;
25  import org.apache.maven.doxia.siterenderer.RendererException;
26  import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
27  import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
28  import org.apache.maven.reporting.MavenReport;
29  import org.codehaus.plexus.i18n.I18N;
30  
31  import java.io.FileNotFoundException;
32  import java.io.Writer;
33  import java.util.Collections;
34  import java.util.Iterator;
35  import java.util.List;
36  import java.util.Locale;
37  
38  /**
39   * Renders a Maven report.
40   *
41   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
42   */
43  public class CategorySummaryDocumentRenderer
44      implements DocumentRenderer
45  {
46      private RenderingContext renderingContext;
47  
48      private String title;
49  
50      private String desc1;
51  
52      private String desc2;
53  
54      private I18N i18n;
55  
56      private List categoryReports;
57  
58      public CategorySummaryDocumentRenderer( RenderingContext renderingContext, String title, String desc1, String desc2,
59                                              I18N i18n, List categoryReports )
60      {
61          this.renderingContext = renderingContext;
62          this.title = title;
63          this.desc1 = desc1;
64          this.desc2 = desc2;
65          this.i18n = i18n;
66          this.categoryReports = Collections.unmodifiableList( categoryReports );
67      }
68  
69      public void renderDocument( Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext )
70          throws RendererException, FileNotFoundException
71      {
72          SiteRendererSink sink = new SiteRendererSink( renderingContext );
73  
74          sink.head();
75  
76          sink.title();
77  
78          sink.text( title );
79  
80          sink.title_();
81  
82          sink.head_();
83  
84          sink.body();
85  
86          sink.section1();
87          sink.sectionTitle1();
88          sink.text( title );
89          sink.sectionTitle1_();
90  
91          sink.paragraph();
92          sink.text( desc1 + " " );
93          sink.link( "http://maven.apache.org" );
94          sink.text( "Maven" );
95          sink.link_();
96          sink.text( " " + desc2 );
97          sink.paragraph_();
98  
99          sink.section2();
100         sink.sectionTitle2();
101         Locale locale = siteRenderingContext.getLocale();
102         sink.text( i18n.getString( "site-plugin", locale, "report.category.sectionTitle" ) );
103         sink.sectionTitle2_();
104 
105         sink.table();
106 
107         String name = i18n.getString( "site-plugin", locale, "report.category.column.document" );
108         String description = i18n.getString( "site-plugin", locale, "report.category.column.description" );
109 
110         sink.tableRow();
111 
112         sink.tableHeaderCell();
113 
114         sink.text( name );
115 
116         sink.tableHeaderCell_();
117 
118         sink.tableHeaderCell();
119 
120         sink.text( description );
121 
122         sink.tableHeaderCell_();
123 
124         sink.tableRow_();
125 
126         if ( categoryReports != null )
127         {
128             for ( Iterator i1 = categoryReports.iterator(); i1.hasNext(); )
129             {
130                 MavenReport report = (MavenReport) i1.next();
131 
132                 sink.tableRow();
133                 sink.tableCell();
134                 sink.link( report.getOutputName() + ".html" );
135                 sink.text( report.getName( locale ) );
136                 sink.link_();
137                 sink.tableCell_();
138                 sink.tableCell();
139                 sink.text( report.getDescription( locale ) );
140                 sink.tableCell_();
141                 sink.tableRow_();
142             }
143         }
144 
145         sink.table_();
146 
147         sink.section2_();
148 
149         sink.section1_();
150 
151         sink.body_();
152 
153         sink.flush();
154 
155         sink.close();
156 
157         renderer.generateDocument( writer, sink, siteRenderingContext );
158     }
159 
160     public String getOutputName()
161     {
162         return renderingContext.getOutputName();
163     }
164 
165     public RenderingContext getRenderingContext()
166     {
167         return renderingContext;
168     }
169 
170     public boolean isOverwrite()
171     {
172         return true;
173     }
174 }