Coverage Report - org.apache.maven.plugins.site.CategorySummaryDocumentRenderer
 
Classes in this File Line Coverage Branch Coverage Complexity
CategorySummaryDocumentRenderer
0%
0/72
0%
0/6
0
 
 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 java.io.FileNotFoundException;
 23  
 import java.io.Writer;
 24  
 
 25  
 import java.util.Collections;
 26  
 import java.util.List;
 27  
 import java.util.Locale;
 28  
 
 29  
 import org.apache.maven.doxia.sink.Sink;
 30  
 import org.apache.maven.doxia.sink.render.RenderingContext;
 31  
 import org.apache.maven.doxia.siterenderer.DocumentRenderer;
 32  
 import org.apache.maven.doxia.siterenderer.Renderer;
 33  
 import org.apache.maven.doxia.siterenderer.RendererException;
 34  
 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
 35  
 import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
 36  
 import org.apache.maven.doxia.tools.MojoLogWrapper;
 37  
 import org.apache.maven.plugin.logging.Log;
 38  
 import org.apache.maven.reporting.MavenReport;
 39  
 
 40  
 import org.codehaus.plexus.i18n.I18N;
 41  
 
 42  
 /**
 43  
  * Renders a Maven report.
 44  
  *
 45  
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 46  
  */
 47  
 public class CategorySummaryDocumentRenderer
 48  
     implements DocumentRenderer
 49  
 {
 50  
     private RenderingContext renderingContext;
 51  
 
 52  
     private String title;
 53  
 
 54  
     private String desc1;
 55  
 
 56  
     private String desc2;
 57  
 
 58  
     private I18N i18n;
 59  
 
 60  
     private List<MavenReport> categoryReports;
 61  
 
 62  
     private final Log log;
 63  
 
 64  
     public CategorySummaryDocumentRenderer( RenderingContext renderingContext, String title, String desc1, String desc2,
 65  
                                             I18N i18n, List<MavenReport> categoryReports )
 66  
     {
 67  0
         this( renderingContext, title, desc1, desc2, i18n, categoryReports, null );
 68  0
     }
 69  
 
 70  
     public CategorySummaryDocumentRenderer( RenderingContext renderingContext, String title, String desc1, String desc2,
 71  
                                             I18N i18n, List<MavenReport> categoryReports, Log log )
 72  0
     {
 73  0
         this.renderingContext = renderingContext;
 74  0
         this.title = title;
 75  0
         this.desc1 = desc1;
 76  0
         this.desc2 = desc2;
 77  0
         this.i18n = i18n;
 78  0
         this.categoryReports = Collections.unmodifiableList( categoryReports );
 79  0
         this.log = log;
 80  0
     }
 81  
 
 82  
     public void renderDocument( Writer writer, Renderer renderer, SiteRenderingContext siteRenderingContext )
 83  
         throws RendererException, FileNotFoundException
 84  
     {
 85  0
         SiteRendererSink sink = new SiteRendererSink( renderingContext );
 86  
 
 87  0
         if ( log != null )
 88  
         {
 89  0
             sink.enableLogging( new MojoLogWrapper( log ) );
 90  
         }
 91  
 
 92  0
         sink.head();
 93  
 
 94  0
         sink.title();
 95  
 
 96  0
         sink.text( title );
 97  
 
 98  0
         sink.title_();
 99  
 
 100  0
         sink.head_();
 101  
 
 102  0
         sink.body();
 103  
 
 104  0
         sink.section1();
 105  0
         sink.sectionTitle1();
 106  0
         sink.text( title );
 107  0
         sink.sectionTitle1_();
 108  
 
 109  0
         sink.paragraph();
 110  0
         sink.text( desc1 + " " );
 111  0
         sink.link( "http://maven.apache.org" );
 112  0
         sink.text( "Maven" );
 113  0
         sink.link_();
 114  0
         sink.text( " " + desc2 );
 115  0
         sink.paragraph_();
 116  
 
 117  0
         sink.section2();
 118  0
         sink.sectionTitle2();
 119  0
         Locale locale = siteRenderingContext.getLocale();
 120  0
         sink.text( i18n.getString( "site-plugin", locale, "report.category.sectionTitle" ) );
 121  0
         sink.sectionTitle2_();
 122  
 
 123  0
         sink.table();
 124  
 
 125  0
         sink.tableRows( new int[] {Sink.JUSTIFY_LEFT, Sink.JUSTIFY_LEFT}, false );
 126  
 
 127  0
         String name = i18n.getString( "site-plugin", locale, "report.category.column.document" );
 128  0
         String description = i18n.getString( "site-plugin", locale, "report.category.column.description" );
 129  
 
 130  0
         sink.tableRow();
 131  
 
 132  0
         sink.tableHeaderCell();
 133  
 
 134  0
         sink.text( name );
 135  
 
 136  0
         sink.tableHeaderCell_();
 137  
 
 138  0
         sink.tableHeaderCell();
 139  
 
 140  0
         sink.text( description );
 141  
 
 142  0
         sink.tableHeaderCell_();
 143  
 
 144  0
         sink.tableRow_();
 145  
 
 146  0
         if ( categoryReports != null )
 147  
         {
 148  0
             for ( MavenReport report : categoryReports )
 149  
             {
 150  0
                 sink.tableRow();
 151  0
                 sink.tableCell();
 152  0
                 sink.link( report.getOutputName() + ".html" );
 153  0
                 sink.text( report.getName( locale ) );
 154  0
                 sink.link_();
 155  0
                 sink.tableCell_();
 156  0
                 sink.tableCell();
 157  0
                 sink.text( report.getDescription( locale ) );
 158  0
                 sink.tableCell_();
 159  0
                 sink.tableRow_();
 160  
             }
 161  
         }
 162  
 
 163  0
         sink.tableRows_();
 164  
 
 165  0
         sink.table_();
 166  
 
 167  0
         sink.section2_();
 168  
 
 169  0
         sink.section1_();
 170  
 
 171  0
         sink.body_();
 172  
 
 173  0
         sink.flush();
 174  
 
 175  0
         sink.close();
 176  
 
 177  0
         renderer.generateDocument( writer, sink, siteRenderingContext );
 178  0
     }
 179  
 
 180  
     public String getOutputName()
 181  
     {
 182  0
         return renderingContext.getOutputName();
 183  
     }
 184  
 
 185  
     public RenderingContext getRenderingContext()
 186  
     {
 187  0
         return renderingContext;
 188  
     }
 189  
 
 190  
     public boolean isOverwrite()
 191  
     {
 192  0
         return true;
 193  
     }
 194  
 }