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