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 $


    protected void executeReport(final Locale locale) throws MavenReportException {
        try {
            this.execute(this.outputDirectory, locale);


            Sink kitchenSink = getSink();
            if (kitchenSink != null) {
                kitchenSink.rawText(indexHtmlContent);
            } else {
                writeIndexHtmlFile(outputDirectory, "index.html", indexHtmlContent);
            }
        } catch (Exception e) {
            final MavenReportException ex = new MavenReportException(e.getMessage());

View Full Code Here


    protected void executeReport(final Locale locale) throws MavenReportException {
        try {
            this.execute(this.outputDirectory, locale);


            Sink kitchenSink = getSink();
            if (kitchenSink != null) {
                kitchenSink.rawText(indexHtmlContent);
            } else {
                writeIndexHtmlFile(outputDirectory, "index.html", indexHtmlContent);
            }
        } catch (Exception e) {
            final MavenReportException ex = new MavenReportException(e.getMessage());

View Full Code Here


    protected void executeReport(final Locale locale) throws MavenReportException {
        try {
            this.execute(this.outputDirectory, locale);


            Sink kitchenSink = getSink();
            if (kitchenSink != null) {
                kitchenSink.rawText(indexHtmlContent);
            } else {
                writeIndexHtmlFile(outputDirectory, "index.html", indexHtmlContent);
            }
        } catch (Exception e) {
            final MavenReportException ex = new MavenReportException(e.getMessage());

View Full Code Here

            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


    protected void executeReport(final Locale locale) throws MavenReportException {
        try {
            this.execute(this.outputDirectory, locale);


            Sink kitchenSink = getSink();
            if (kitchenSink != null) {
                kitchenSink.rawText(indexHtmlContent);
            } else {
                writeIndexHtmlFile(outputDirectory, "index.html", indexHtmlContent);
            }
        } catch (Exception e) {
            final MavenReportException ex = new MavenReportException(e.getMessage());

View Full Code Here


    protected void executeReport(final Locale locale) throws MavenReportException {
        try {
            this.execute(this.outputDirectory, locale);


            Sink kitchenSink = getSink();
            if (kitchenSink != null) {
                kitchenSink.rawText(indexHtmlContent);
            } else {
                writeIndexHtmlFile(outputDirectory, "index.html", indexHtmlContent);
            }
        } catch (Exception e) {
            final MavenReportException ex = new MavenReportException(e.getMessage());

View Full Code Here

                        return name.toLowerCase().endsWith(".html");
                    }
                });
                if (files != null && files.length > 0) {
                    boolean showIndex = files.length > 1;
                    Sink sink = getSink();
                    if (sink != null) {
                        StringBuilder buffer = new StringBuilder();
                        sink.head();
                        sink.title();
                        sink.text("Camel Endpoints");
                        sink.title_();
                        sink.rawText("<style>\n"
                                + "th, td {\n"
                                + "  text-align:left;\n\n"
                                + "}\n"
                                + "</style>\n");
                        sink.head_();


                        sink.body();
                        sink.section1();
                        sink.sectionTitle1();
                        sink.text("Camel Endpoints");
                        sink.sectionTitle1_();


                        if (showIndex) {
                            sink.list();
                        }
                        for (File file : files) {
                            getLog().info("found " + file.getAbsolutePath());


                            String linkName = file.getName();
                            if (linkName.endsWith(".html")) {
                                linkName = linkName.substring(0, linkName.length() - 5);
                            }
                            String endpointHtml = IOUtil.toString(new FileInputStream(file));
                            endpointHtml = extractBodyContents(endpointHtml);


                            if (showIndex) {
                                sink.listItem();
                                sink.link("#" + linkName);
                                sink.text(linkName);
                                sink.link_();
                                sink.listItem_();


                                buffer.append("<a name='" + linkName + "'>\n");
                                buffer.append(endpointHtml);
                                buffer.append("</a>\n");
                            } else {
                                sink.section1_();


                                sink.section2();
                                sink.rawText(endpointHtml);
                                sink.section2_();
                            }
                        }
                        if (showIndex) {
                            sink.list_();
                            sink.section1_();


                            sink.section2();
                            sink.rawText(buffer.toString());
                            sink.section2_();
                        }
                        sink.body_();
                        sink.flush();
                        sink.close();
                    }
                }
            }
        } catch (Exception e) {
            final MavenReportException ex = new MavenReportException(e.getMessage());

View Full Code Here


    protected void executeReport(final Locale locale) throws MavenReportException {
        try {
            this.execute(this.outputDirectory, locale);


            Sink kitchenSink = getSink();
            if (kitchenSink != null) {
                kitchenSink.rawText(indexHtmlContent);
            } else {
                writeIndexHtmlFile(outputDirectory, "index.html", indexHtmlContent);
            }
        } catch (Exception e) {
            final MavenReportException ex = new MavenReportException(e.getMessage());

View Full Code Here


    protected void executeReport(final Locale locale) throws MavenReportException {
        try {
            this.execute(this.outputDirectory, locale);


            Sink kitchenSink = getSink();
            if (kitchenSink != null) {
                kitchenSink.rawText(indexHtmlContent);
            } else {
                writeIndexHtmlFile(outputDirectory, "index.html", indexHtmlContent);
            }
        } catch (Exception e) {
            final MavenReportException ex = new MavenReportException(e.getMessage());

View Full Code Here


    protected void executeReport(final Locale locale) throws MavenReportException {
        try {
            this.execute(this.outputDirectory, locale);


            Sink kitchenSink = getSink();
            if (kitchenSink != null) {
                kitchenSink.rawText(indexHtmlContent);
            } else {
                writeIndexHtmlFile(outputDirectory, "index.html", indexHtmlContent);
            }
        } catch (Exception e) {
            final MavenReportException ex = new MavenReportException(e.getMessage());

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.