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 $

            refDir.mkdirs();




            List<File> docSearchPath = createDocSearchPath();


            Sink sink = getSink();


            sink.head();
            sink.title();
            sink.text("Component Reference");
            sink.title_();
            sink.head_();


            sink.section1();
            sink.sectionTitle1();
            sink.text("Component Reference");
            sink.sectionTitle1_();
            sink.list();


            String currentSubpackage = null;


            for (String className : InternalUtils.sortedKeys(descriptions))
            {
                String subpackage = extractSubpackage(className);


                if (!SUPPORTED_SUBPACKAGES.contains(subpackage)) continue;


                if (!subpackage.equals(currentSubpackage))
                {
                    if (currentSubpackage != null)
                    {
                        sink.list_();
                        sink.section2_();
                    }


                    sink.section2();
                    sink.sectionTitle2();
                    sink.text(StringUtils.capitalize(subpackage));
                    sink.sectionTitle2_();




                    sink.list();


                    currentSubpackage = subpackage;
                }




                sink.listItem();


                sink.link(toHtml(toPath(className)));


                sink.text(className);
                sink.link_();


                writeClassDescription(descriptions, refDir, docSearchPath, className);




                sink.listItem_();
            }


            if (currentSubpackage != null)
            {
                sink.list_();
                sink.section2_();
            }
        }
        catch (Exception ex)
        {
            throw new MavenReportException(ex.getMessage(), ex);

View Full Code Here

     * @throws Exception if any
     */
    public void testModel()
        throws Exception
    {
        Sink sink = createSink( getXmlTestWriter( "test_model", "xml" ) );


        SinkTestDocument.generate( sink );


        sink.close();


        ITextUtil.writePdf( new FileInputStream( getGeneratedFile( "test_model", "xml" ) ),
                            new FileOutputStream( getGeneratedFile( "test_model", "pdf" ) ) );
        ITextUtil.writeRtf( new FileInputStream( getGeneratedFile( "test_model", "xml" ) ),
                            new FileOutputStream( getGeneratedFile( "test_model", "rtf" ) ) );

View Full Code Here

     * @throws Exception if any
     */
    public void testEmptyAnchor()
        throws Exception
    {
        Sink sink = createSink( getXmlTestWriter( "empty_anchor", "xml" ) );


        SinkTestDocument.generateHead( sink );


        sink.body();


        sink.anchor( "empty_local_anchor" );
        sink.anchor_();
        sink.lineBreak();
        sink.link( "#empty_local_anchor" );
        sink.text( "link to empty local anchor" );
        sink.link_();


        sink.lineBreak();


        sink.anchor( "defined_local_anchor" );
        sink.text( "defined local anchor" );
        sink.anchor_();
        sink.lineBreak();
        sink.link( "#defined_local_anchor" );
        sink.text( "link to defined local anchor" );
        sink.link_();


        sink.body_();


        sink.flush();
        sink.close();


        ITextUtil.writePdf( new FileInputStream( getGeneratedFile( "empty_anchor", "xml" ) ),
                            new FileOutputStream( getGeneratedFile( "empty_anchor", "pdf" ) ) );
    }

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

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


        output = new StringWriter();
        Sink sink = new TextSink( new FilterWriter( output )
        {
            public void close() throws IOException
            {
                super.close();
                this.out = null;

View Full Code Here

        throws ParseException
    {
        String document = "Up\n---\nDown\n";


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


        /* parsing with separator in middle of paragraph */
        createParser().parse( new StringReader( document ), sink );
        assertTrue( "generated document should have a size > 0", output.toString().length() > 0 );

View Full Code Here

    }


    private String getLineBreakString()
    {
        StringWriter sw = new StringWriter();
        Sink sink = new TextSink( sw );
        sink.lineBreak();


        return sw.toString();
    }

View Full Code Here

    {
        output = new StringWriter();
        reader = getTestReader( stem, outputExtension() );
        writer = getTestWriter( stem, "txt" );


        Sink sink = new TextSink( output );
        createParser().parse( reader, sink );


        // write to file
        String expected = output.toString();
        writer.write( expected );

View Full Code Here

        try
        {
            writer = getTestWriter( "test", "docbook" );
            reader = getTestReader( "test" );


            Sink sink = new DocBookSink( writer );


            createParser().parse( reader, sink );


            writer = getTestWriter( "sdocbook_full", "docbook" );
            reader = getTestReader( "sdocbook_full" );

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.