JRHyperlinkProducerFactory


1   /*
2    * ============================================================================
3    * GNU Lesser General Public License
4    * ============================================================================
5    *
6    * JasperReports - Free Java report-generating library.
7    * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
8    * 
9    * This library is free software; you can redistribute it and/or
10   * modify it under the terms of the GNU Lesser General Public
11   * License as published by the Free Software Foundation; either
12   * version 2.1 of the License, or (at your option) any later version.
13   * 
14   * This library is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17   * Lesser General Public License for more details.
18   * 
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this library; if not, write to the Free Software
21   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
22   * 
23   * JasperSoft Corporation
24   * 303 Second Street, Suite 450 North
25   * San Francisco, CA 94107
26   * http://www.jaspersoft.com
27   */
28  package net.sf.jasperreports.engine.export;
29  
30  import net.sf.jasperreports.engine.JRPrintHyperlink;
31  
32  
33  /**
34   * An abstract factory of {@link JRHyperlinkProducer hyperlink producers}.
35   * <p>
36   * The factory is responsible for returning a hyperlink producer for a
37   * custom hyperlink type.
38   * </p>
39   * 
40   * @author Lucian Chirita (lucianc@users.sourceforge.net)
41   * @version $Id: JRHyperlinkProducerFactory.java 1364 2006-08-31 18:13:20 +0300 (Thu, 31 Aug 2006) lucianc $
42   */
43  public abstract class JRHyperlinkProducerFactory
44  {
45  
46      /**
47       * Returns the hyperlink producer associated with a specific hyperlink type.
48       * 
49       * @param linkType the hyperlink type
50       * @return an associated hyperlink producer, or <code>null</code> when none associated
51       */
52      public abstract JRHyperlinkProducer getHandler(String   linkType);
53      
54      
55      /**
56       * Generates the String hyperlink for a hyperlink instance based on its
57       * type and on the associated hyperlink producer.
58       * 
59       * @param hyperlink the hyperlink instance
60       * @return the genereated String hyperlink
61       * @see JRHyperlinkProducer#getHyperlink(JRPrintHyperlink)
62       */
63      public String   produceHyperlink(JRPrintHyperlink hyperlink)
64      {
65          String   linkType = hyperlink.getLinkType();
66          String   href = null;
67          if (linkType != null)
68          {
69              JRHyperlinkProducer producer = getHandler(linkType);
70              if (producer != null)
71              {
72                  href = producer.getHyperlink(hyperlink);
73              }
74          }
75          return href;
76      }
77  
78  }
79
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags