PDFData.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * Squale is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.squale.welcom.outils.pdf;

import java.util.Locale;

import org.apache.struts.util.MessageResources;

/**
 * @author M327837 Pour changer le mod�le de ce commentaire de type g�n�r�, allez � :
 *         Fen�tre>Pr�f�rences>Java>G�n�ration de code>Code et commentaires
 */

public abstract class PDFData
{

    /** Locale */
    protected Locale locale = null;

    /** Message Ressources pour internationnalisation */
    protected MessageResources messageResources = null;

    /**
     * Contructeur
     * 
     * @param pLocale : locale
     * @param pMessages : messages
     */
    public PDFData( final Locale pLocale, final MessageResources pMessages )
    {
        this.locale = pLocale;
        this.messageResources = pMessages;
    }

    /**
     * Accesseur
     * 
     * @return Locale
     */
    public Locale getLocale()
    {
        return locale;
    }

    /**
     * Nom du template a utilser (.srt)
     * 
     * @return Nom du fichier template
     */
    public abstract String getTemplateName();

    /**
     * Definiton du templissage du document
     * 
     * @param pdfGenerateur Moteur pour le rendu PDF
     * @throws PDFGenerateurException : Probleme a la generation
     */
    public abstract void fill( PDFGenerateur pdfGenerateur )
        throws PDFGenerateurException;

    /**
     * Simplification de l'acc�s aux messages;
     * 
     * @param key Key du message
     * @return libell�
     */
    public String getMessage( final String key )
    {
        return messageResources.getMessage( locale, key );
    }

    /**
     * @return le message ressource
     */
    public MessageResources getMessageResources()
    {
        return messageResources;
    }

}