01: /**
02: * ===========================================
03: * JFreeReport : a free Java reporting library
04: * ===========================================
05: *
06: * Project Info: http://reporting.pentaho.org/
07: *
08: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
09: *
10: * This library is free software; you can redistribute it and/or modify it under the terms
11: * of the GNU Lesser General Public License as published by the Free Software Foundation;
12: * either 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, but WITHOUT ANY WARRANTY;
15: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16: * See the GNU Lesser General Public License for more details.
17: *
18: * You should have received a copy of the GNU Lesser General Public License along with this
19: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20: * Boston, MA 02111-1307, USA.
21: *
22: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
23: * in the United States and other countries.]
24: *
25: * ------------
26: * ParameterMapping.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report;
30:
31: import java.io.Serializable;
32:
33: /**
34: * A parameter mapping defines an aliasing rule for incoming and outgoing
35: * sub-report parameters.
36: *
37: * @author Thomas Morgner
38: */
39: public class ParameterMapping implements Serializable {
40: /** A serialization helper. */
41: private static final long serialVersionUID = -8790399939032695626L;
42:
43: /** The source name of the parameter. */
44: private String name;
45: /** The target name of the parameter. */
46: private String alias;
47:
48: /**
49: * Creates a new parameter mapping for the given parameter. The parameter will
50: * be made available using the given 'alias' name. If the alias is null,
51: * the name will not be changed during the mapping.
52: *
53: * @param name the name.
54: * @param alias the alias (can be null).
55: */
56: public ParameterMapping(final String name, final String alias) {
57: if (name == null) {
58: throw new NullPointerException();
59: }
60: this .name = name;
61: if (alias == null) {
62: this .alias = name;
63: } else {
64: this .alias = alias;
65: }
66: }
67:
68: /**
69: * Returns the source parameter name.
70: *
71: * @return the source name.
72: */
73: public String getName() {
74: return name;
75: }
76:
77: /**
78: * Returns the alias parameter name.
79: *
80: * @return the alias name.
81: */
82: public String getAlias() {
83: return alias;
84: }
85: }
|