src/main/java/org/apache/maven/plugins/issues/AbstractIssuesReportGenerator.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.plugins.issues;

import java.util.ResourceBundle;

import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;

/**
 * An abstract super class that helps when generating a report on issues.
 *
 * @author Dennis Lundberg
 * @version $Id$
 * @since 2.4
 */
public abstract class AbstractIssuesReportGenerator {
    protected String author;

    protected String title;

    public AbstractIssuesReportGenerator() {}

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    protected void sinkBeginReport(Sink sink, ResourceBundle bundle) {
        sink.head();

        String title;
        if (this.title != null) {
            title = this.title;
        } else {
            title = bundle.getString("report.issues.header");
        }
        sink.title();
        sink.text(title);
        sink.title_();

        if (author != null && !author.isEmpty()) {
            sink.author();
            sink.text(author);
            sink.author_();
        }

        sink.head_();

        sink.body();

        sink.section1();

        sink.sectionTitle1();

        sink.text(title);

        sink.sectionTitle1_();
    }

    protected void sinkCell(Sink sink, String text) {
        sink.tableCell();

        if (text != null) {
            sink.text(text);
        } else {
            sink.nonBreakingSpace();
        }

        sink.tableCell_();
    }

    protected void sinkCellLink(Sink sink, String text, String link) {
        sink.tableCell();

        sinkLink(sink, text, link);

        sink.tableCell_();
    }

    protected void sinkEndReport(Sink sink) {
        sink.section1_();

        sink.body_();

        sink.flush();

        sink.close();
    }

    protected void sinkFigure(Sink sink, String image, String altText) {
        SinkEventAttributes attributes = new SinkEventAttributeSet();
        attributes.addAttribute("alt", altText);
        attributes.addAttribute("title", altText);

        sink.figureGraphics(image, attributes);
    }

    protected void sinkHeader(Sink sink, String header) {
        sink.tableHeaderCell();

        sink.text(header);

        sink.tableHeaderCell_();
    }

    protected void sinkLink(Sink sink, String text, String link) {
        sink.link(link);

        sink.text(text);

        sink.link_();
    }

    protected void sinkShowTypeIcon(Sink sink, String type) {
        String image = "";
        String altText = "";

        if (type == null) {
            image = "images/icon_help_sml.gif";
            altText = "Unknown";
        } else if (type.equals("fix")) {
            image = "images/fix.gif";
            altText = "Fix";
        } else if (type.equals("update")) {
            image = "images/update.gif";
            altText = "Update";
        } else if (type.equals("add")) {
            image = "images/add.gif";
            altText = "Add";
        } else if (type.equals("remove")) {
            image = "images/remove.gif";
            altText = "Remove";
        }

        sink.tableCell();

        sinkFigure(sink, image, altText);

        sink.tableCell_();
    }
}