Examples of org.apache.maven.doxia.sink.Sink

org.apache.maven.doxia.sink.Sink
A Sink consumes Doxia events to produce a resultant output format (eg Docbook, PDF, XHTML...).
Doxia allows you to transform any supported input document format (ie for which a Parser exists) into any supported output document format (ie for which a Sink exists).

A parser is responsible for reading an input document and emitting a sequence of Doxia events which can then be consumed by a Doxia Sink. Thus, you can parse any front- end format (eg APT, FML, Xdoc, ...) and have them all contribute to a final XHTML version of a web site. All documents being parsed result in a stream of Doxia events (eg paragraph, bold, italic, text,...), which are then fed into a XHTML Sink to produce a set of XHTML pages.

A Sink is ultimately responsible for the final format and structure of the output document. For example, you can take a collection of APT documents, let a Parser emit a series of Doxia events and have that be fed into a Sink to produce a single PDF, a book, a site, or a Word document. The Sink is fully responsible for the final output.

You can easily integrate any custom (XML, Wiki,...) format by creating a Doxia Parser which reads your input document and produces a proper sequence of Doxia events. Those can then be fed into an arbitrary Sink to produce any desired final output.

Note: All implemented sink should use UTF-8 as encoding.
@since 1.0-alpha-6 @author Jason van Zyl @author Vincent Siveton @author ltheussl @version $Id: Sink.java 905077 2010-01-31 17:24:47Z hboutemy $

        sink.close();
    }


    private void constructSummarySection( List<? extends BuildJob> buildJobs, Locale locale )
    {
        Sink sink = getSink();


        sink.section2();
        sink.sectionTitle2();


        sink.text( getText( locale, "report.invoker.summary.title" ) );


        sink.sectionTitle2_();
        sink.section2_();


        // ------------------------------------------------------------------------
        // Building a table with
        // it number | succes nb | failed nb | Success rate | total time | avg time
        // ------------------------------------------------------------------------


        sink.table();
        sink.tableRow();


        sinkTableHeader( sink, getText( locale, "report.invoker.summary.number" ) );
        sinkTableHeader( sink, getText( locale, "report.invoker.summary.success" ) );
        sinkTableHeader( sink, getText( locale, "report.invoker.summary.failed" ) );
        sinkTableHeader( sink, getText( locale, "report.invoker.summary.skipped" ) );
        sinkTableHeader( sink, getText( locale, "report.invoker.summary.success.rate" ) );
        sinkTableHeader( sink, getText( locale, "report.invoker.summary.time.total" ) );
        sinkTableHeader( sink, getText( locale, "report.invoker.summary.time.avg" ) );


        int number = buildJobs.size();
        int success = 0;
        int failed = 0;
        int skipped = 0;
        double totalTime = 0;


        for ( BuildJob buildJob : buildJobs )
        {
            if ( BuildJob.Result.SUCCESS.equals( buildJob.getResult() ) )
            {
                success++;
            }
            else if ( BuildJob.Result.SKIPPED.equals( buildJob.getResult() ) )
            {
                skipped++;
            }
            else
            {
                failed++;
            }
            totalTime += buildJob.getTime();
        }


        sink.tableRow_();
        sink.tableRow();


        sinkCell( sink, Integer.toString( number ) );
        sinkCell( sink, Integer.toString( success ) );
        sinkCell( sink, Integer.toString( failed ) );
        sinkCell( sink, Integer.toString( skipped ) );


        if ( success + failed > 0 )
        {
            sinkCell( sink, percentFormat.format( (double) success / ( success + failed ) ) );
        }
        else
        {
            sinkCell( sink, "" );
        }


        sinkCell( sink, secondsFormat.format( totalTime ) );


        sinkCell( sink, secondsFormat.format( totalTime / number ) );


        sink.tableRow_();
        sink.table_();


    }

View Full Code Here


    }


    private void renderBuildJob( BuildJob buildJob, Locale locale )
    {
        Sink sink = getSink();
        sink.tableRow();
        StringBuilder buffer = new StringBuilder();
        if ( !StringUtils.isEmpty( buildJob.getName() ) && !StringUtils.isEmpty( buildJob.getDescription() ) )
        {
            buffer.append( buildJob.getName() );
            buffer.append( " : " );
            buffer.append( buildJob.getDescription() );
        }
        else
        {
            buffer.append( buildJob.getProject() );
        }
        sinkCell( sink, buffer.toString() );
        // FIXME image
        sinkCell( sink, buildJob.getResult() );
        sinkCell( sink, secondsFormat.format( buildJob.getTime() ) );
        sinkCell( sink, buildJob.getFailureMessage() );
        sink.tableRow_();
    }

View Full Code Here

        {
            analysis = analysis.ignoreNonCompile();
        }


        // Step 2: Create sink and bundle
        Sink sink = getSink();
        ResourceBundle bundle = getBundle( locale );


        // Step 3: Generate the report
        AnalyzeReportView analyzethis = new AnalyzeReportView();
        analyzethis.generateReport( analysis, sink, bundle );

View Full Code Here


    @Override
    protected void executeReport( Locale locale )
        throws MavenReportException
    {
        Sink sink = getSink();


        sink.head();
        sink.title();
        sink.text( getI18nString( locale, "title" ) );
        sink.title_();
        sink.head_();


        sink.body();


        sink.section1();


        sink.sectionTitle1();
        sink.text( getI18nString( locale, "title" ) );
        sink.sectionTitle1_();


        Map<String, List<ReverseDependencyLink>> dependencyMap = getDependencyMap();


        // legend
        generateLegend( locale, sink );


        sink.lineBreak();


        // stats
        generateStats( locale, sink, dependencyMap );


        sink.section1_();


        // convergence
        generateConvergence( locale, sink, dependencyMap );


        sink.body_();
        sink.flush();
        sink.close();
    }

View Full Code Here

    public void parse(Reader input, Writer output) throws IOException, SlingAptParseException {
        parse(input, output, null);
    }
    
    public void parse(Reader input, Writer output, Map<String, Object> options) throws IOException, SlingAptParseException {
        final Sink sink = new CustomAptSink(output, options);
        final AptParser parser = new CustomAptParser(macroProvider);
        try {
            parser.parse(input, sink);
        } catch(AptParseException ape) {
            throw new SlingAptParseExceptionImpl(ape);

View Full Code Here

            analysis = analysisTemp;
        }
        
        
        // Step 2: Create sink and bundle
        Sink sink = getSink();
        ResourceBundle bundle = getBundle( locale );


        // Step 3: Generate the report
        AnalyzeReportView analyzethis = new AnalyzeReportView();
        analyzethis.generateReport( analysis, sink, bundle );

View Full Code Here

     */
    public void generate( DecorationModel model, File targetDir, Locale locale )
            throws IOException
    {
        File outputDir = new File( targetDir, "xdoc" );
        Sink sink = new XdocSinkFactory().createSink( outputDir, "sitemap.xml", encoding );


        try
        {
            extract( model, sink, locale );
        }
        finally
        {
            sink.close();
        }
    }

View Full Code Here

    }


    private Report generateReport( Locale locale )
        throws MavenReportException
    {
        Sink sink = getSink();


        PMDConfiguration pmdConfiguration = getPMDConfiguration();
        final PmdReportListener reportSink = new PmdReportListener( getLog(), sink, getBundle( locale ), aggregate );
        RuleContext ruleContext = new RuleContext()
        {

View Full Code Here

            + "\n\n* list2"
            + "\n\n* list2"
            + "\n{pre}123{/pre}";


        output = new StringWriter();
        Sink sink = new TextSink( output );


        /* parsing with additional space at end works */
        createParser().parse( new StringReader( document + " " ), sink );
        assertTrue( "generated document should have a size > 0", output.toString().length() > 0 );

View Full Code Here

            + "\n\n* list2"
            + "\n\n* list2{pre}123{/pre}"
            + "\n123";


        output = new StringWriter();
        Sink sink = new TextSink( output );


        /* parsing with additional space at end of list item works */
        createParser().parse( new StringReader( document1 ), sink );
        assertTrue( "generated document should have a size > 0", output.toString().length() > 0 );

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.maven.doxia.sink.Sink

com.lexicalscope.jewelcli.maven.report.JewelCliReportMojo

com.redhat.rcm.maven.plugin.buildmetadata.BuildReportMojo

gluebooster.maven.doxia.Html2DoxiaConverter

gluebooster.maven.doxia.HtmlDocument2DoxiaConverter

gluebooster.maven.doxia.SinkUse

gluebooster.maven.reports.ConfigurableDoxiaReport

hudson.plugins.jdepend.JDependReporter

net.sf.oqt.maven.QueryTranslatorReportingMojo

org.apache.camel.guice.maven.DotMojo

org.apache.camel.maven.DotMojo

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.