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 $

            final Collection<EntityVO> aggregatedEntities = new TreeSet<EntityVO>();
            final Collection<QueryVO> aggregatedQueries = new TreeSet<QueryVO>();
            printOutputToDebug(result);


            getLog().info("Starting creation of report");
            final Sink sink = getSink();
            sink.head();
            sink.title();
            sink.text(getName(null));
            sink.title_();
            sink.head_();


            sink.body();
            sink.section1();
            sink.sectionTitle1();
            sink.text("Report");
            sink.sectionTitle1_();


            sink.paragraph();
            addTitleLink(titleEntitiesPerPackage, sink);
            addTitleLink(titleNamesPerEntity, sink);
            addTitleLink(titleJPQLQueries, sink);
            addTitleLink(titleSQLQueries, sink);
            addTitleLink(titleFaults, sink);
            sink.paragraph_();


            sink.section2();
            sink.sectionTitle2();
            sink.text("Entities per packages");
            sink.sectionTitle2_();
            sink.table();
            sink.tableRow();
            sink.tableHeaderCell();
            sink.text("Package");
            sink.tableHeaderCell_();
            sink.tableHeaderCell();
            sink.text("Entities");
            sink.tableHeaderCell_();
            sink.tableRow_();
            for (final PackageVO packge : result.getPackages()) {
                sink.tableRow();
                sink.tableCell();
                sink.text(packge.getName());
                sink.tableCell_();
                sink.tableCell();
                sink.list();
                for (final EntityVO e : packge.getEntities()) {
                    aggregatedEntities.add(e);
                    sink.listItem();
                    sink.text(e.getName());
                    sink.listItem_();
                }
                sink.list_();
                sink.tableCell_();
                sink.tableRow_();
            }


            sink.table_();
            sink.section2_();


            sink.section2();
            sink.sectionTitle2();
            sink.text("List of NamedQueries per entity");
            sink.sectionTitle2_();
            sink.table();
            sink.tableRow();
            sink.tableHeaderCell();
            sink.text("Entity");
            sink.tableHeaderCell_();
            sink.tableHeaderCell();
            sink.text("Named Query");
            sink.tableHeaderCell_();
            sink.tableRow_();
            for (final EntityVO entity : aggregatedEntities) {
                sink.tableRow();
                sink.tableCell();
                sink.text(entity.getName());
                sink.tableCell_();
                sink.tableCell();
                sink.list();
                for (final QueryVO query : entity.getQueries()) {
                    aggregatedQueries.add(query);
                    sink.listItem();
                    sink.text(query.getName());
                    sink.listItem_();
                }
                sink.list_();
                sink.tableCell_();
                sink.tableRow_();
            }


            sink.table_();
            sink.section2_();


            sink.section2();
            sink.sectionTitle2();
            sink.text("List of JPQL queries");
            sink.sectionTitle2_();
            sink.table();
            sink.tableRow();
            sink.tableHeaderCell();
            sink.text("Name");
            sink.tableHeaderCell_();
            sink.tableHeaderCell();
            sink.text("JPQL Query");
            sink.tableHeaderCell_();
            sink.tableRow_();
            for (final QueryVO query : aggregatedQueries) {
                sink.tableRow();
                sink.tableCell();
                sink.text(query.getName());
                sink.tableCell_();
                sink.tableCell();
                sink.text(query.getJPQLQuery());
                sink.tableCell_();
                sink.tableRow_();
            }


            sink.table_();
            sink.section2_();


            sink.section2();
            sink.sectionTitle2();
            sink.text("List of SQL Queries");
            sink.sectionTitle2_();
            sink.table();
            sink.tableRow();
            sink.tableHeaderCell();
            sink.text("Name");
            sink.tableHeaderCell_();
            sink.tableHeaderCell();
            sink.text("SQL Query");
            sink.tableHeaderCell_();
            sink.tableRow_();
            for (final QueryVO query : aggregatedQueries) {
                if (query.isValid()) {
                    sink.tableRow();
                    sink.tableCell();
                    sink.text(query.getName());
                    sink.tableCell_();
                    sink.tableCell();
                    sink.list();
                    for (final String sql : query.getSQLQuery()) {
                        sink.listItem();
                        sink.text(sql);
                        sink.listItem_();
                    }
                    sink.list_();
                    sink.tableCell_();
                    sink.tableRow_();
                }
            }


            sink.table_();
            sink.section2_();


            sink.section2();
            sink.sectionTitle2();
            sink.text("List of Faulty Queries");
            sink.sectionTitle2_();
            sink.table();
            sink.tableRow();
            sink.tableHeaderCell();
            sink.text("Name");
            sink.tableHeaderCell_();
            sink.tableHeaderCell();
            sink.text("SQL Query");
            sink.tableHeaderCell_();
            sink.tableRow_();
            for (final QueryVO query : aggregatedQueries) {
                if (!query.isValid()) {
                    sink.tableRow();
                    sink.tableCell();
                    sink.text(query.getName());
                    sink.tableCell_();
                    sink.tableCell();
                    sink.text(query.getError());
                    sink.tableCell_();
                    sink.tableRow_();
                }
            }


            sink.table_();
            sink.section2_();


            sink.section1_();


            sink.body_();
            sink.flush();
            sink.close();
        } catch (ClassNotFoundException e) {
            getLog().error(e);
            throw new MavenReportException(e.getMessage());
        } catch (IOException e) {
            getLog().error(e);

View Full Code Here


    @Override
    protected void executeReport( Locale locale )
        throws MavenReportException
    {
        final Sink s = getSink();
        s.verbatim( null );
        s.text( "pluginManagement = " + pluginManagement + "\n" );
        s.text( "buildPlugin = " + buildPlugin + "\n" );
        s.text( "buildAndManagement = " + buildAndManagement + "\n" );
        s.text( "reportingPlugin = " + reportingPlugin + "\n" );
        s.text( "reportingPluginReportSet = " + reportingPluginReportSet );
        s.verbatim_();
    }

View Full Code Here

   * Does currently throw a ClassNotFoundException
   */
  public void sampleHtml(){
    //Sink sink = new  XhtmlBaseSink(new OutputStreamWriter(System.out));
    RenderingContext context = new RenderingContext(new File("c:/temp"), "test.html");
    Sink sink = new SiteRendererSink(context);
    fillSink(sink);
    
  }

View Full Code Here

   */
 public void run()
 {
   try
   {
   Sink sink = getSink();
   HTMLDocument doc = (HTMLDocument) html.get(HTML.Tag.HTML);


   handleElement(sink, doc, doc.getDefaultRootElement());
   }
   catch (Exception ex)

View Full Code Here

  /**
   * Runs the conversion
   */
 public void run()
 {
   Sink sink = getSink();
   Object doc = html.get(HTML.Tag.HTML);


   if (doc == null) 
   {
     if (! skipMissingHtml)

View Full Code Here

  protected final void executeReport(Locale locale) throws MavenReportException
  {
    try
    {
      Html2DoxiaConverter converter = new Html2DoxiaConverter();
      Sink sink = getSink();
      converter.setSink(sink);
      // HashMap keyMap = new HashMap();
      // fillParameterMap(keyMap);
      // keyMap.put(HTML.Tag.PARAM, getParameterMap());
      converter.setHtml(getMap().get(/* keyMap */getParameterMap()));


      converter.run();
      sink.flush();
      sink.close();
    } catch (Exception ex)
    {
      if (ex instanceof MavenReportException)
        throw (MavenReportException) ex;
      else

View Full Code Here

  protected final void executeReport(Locale locale) throws MavenReportException
  {
    try
    {
      Html2DoxiaConverter converter = new Html2DoxiaConverter();
      Sink sink = getSink();
      converter.setSink(sink);
      //HashMap keyMap = new HashMap();
      //fillParameterMap(keyMap);
      //keyMap.put(HTML.Tag.PARAM, getParameterMap());
      converter.setHtml(getMap().get(/*keyMap*/getParameterMap()));


      converter.run();
      sink.flush();
      sink.close();
    }
    catch (Exception ex)
    {
      if (ex instanceof MavenReportException)
        throw (MavenReportException) ex;

View Full Code Here

  /**
   * Runs the conversion
   */
 public void run()
 {
   Sink sink = getSink();
   Object doc = html.get(HTML.Tag.HTML);


   if (doc == null) throw new IllegalStateException("html is null in "+ getHtml());
   
   if (doc instanceof HTMLDocument)

View Full Code Here

   */
 public void run()
 {
   try
   {
   Sink sink = getSink();
   HTMLDocument doc = (HTMLDocument) html.get(HTML.Tag.HTML);


   handleElement(sink, doc, doc.getDefaultRootElement());
   }
   catch (Exception ex)

View Full Code Here

        {
            writer = getTestWriter( "test", "txt" );


            reader = getTestReader( "test", outputExtension() );


            Sink sink = new TextSink( writer );


            createParser().parse( reader, sink );
        }
        finally
        {

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.