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: * OutputFunction.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report.function;
30:
31: /**
32: * A simple tagging interface for the transition from function-based layouting back to explicit layouting. Output
33: * functions are always considered internal information, so there is no way to write a report-processor that is
34: * not aware of the actual implementation of the output-function.
35: *
36: * @author Thomas Morgner
37: */
38: public interface OutputFunction extends Function {
39: /**
40: * Creates a storage-copy of the output function. A storage copy must create a deep clone of all referenced objects so
41: * that it is guaranteed that changes to either the original or the clone do not affect the other instance.
42: * <p/>
43: * Any failure to implement this method correctly will be a great source of very subtle bugs.
44: *
45: * @return the deep clone.
46: */
47: public OutputFunction deriveForStorage();
48:
49: /**
50: * Creates a cheaper version of the deep-copy of the output function. A pagebreak-derivate is created on every possible
51: * pagebreak position and must contain all undo/rollback information to restore the state of any shared object when
52: * a roll-back is requested.
53: * <p/>
54: * Any failure to implement this method correctly will be a great source of very subtle bugs.
55: *
56: * @return the deep clone.
57: */
58: public OutputFunction deriveForPagebreak();
59: }
|