001 /**
002 * ========================================
003 * JFreeReport : a free Java report library
004 * ========================================
005 *
006 * Project Info: http://reporting.pentaho.org/
007 *
008 * (C) Copyright 2000-2007, by Object Refinery Limited, Pentaho Corporation and Contributors.
009 *
010 * This library is free software; you can redistribute it and/or modify it under the terms
011 * of the GNU Lesser General Public License as published by the Free Software Foundation;
012 * either version 2.1 of the License, or (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
015 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016 * See the GNU Lesser General Public License for more details.
017 *
018 * You should have received a copy of the GNU Lesser General Public License along with this
019 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
020 * Boston, MA 02111-1307, USA.
021 *
022 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
023 * in the United States and other countries.]
024 *
025 * ------------
026 * $Id: StaticTextLayoutController.java,v 1.8 2007/04/01 18:49:26 taqua Exp $
027 * ------------
028 * (C) Copyright 2000-2005, by Object Refinery Limited.
029 * (C) Copyright 2005-2007, by Pentaho Corporation.
030 */
031
032 package org.jfree.report.flow.layoutprocessor;
033
034 import org.jfree.report.DataSourceException;
035 import org.jfree.report.ReportDataFactoryException;
036 import org.jfree.report.ReportProcessingException;
037 import org.jfree.report.flow.FlowController;
038 import org.jfree.report.flow.ReportTarget;
039 import org.jfree.report.structure.StaticText;
040
041 /**
042 * Creation-Date: 24.11.2006, 15:06:56
043 *
044 * @author Thomas Morgner
045 */
046 public class StaticTextLayoutController extends AbstractLayoutController
047 {
048 public static final int NOT_STARTED = 0;
049 public static final int FINISHED = 2;
050
051 private int state;
052
053 public StaticTextLayoutController()
054 {
055 }
056
057 /**
058 * Advances the processing position.
059 *
060 * @param target the report target that receives generated events.
061 * @return the new layout controller instance representing the new state.
062 *
063 * @throws DataSourceException if there was a problem reading data from
064 * the datasource.
065 * @throws ReportProcessingException if there was a general problem during
066 * the report processing.
067 * @throws ReportDataFactoryException if a query failed.
068 */
069 public LayoutController advance(final ReportTarget target)
070 throws DataSourceException, ReportDataFactoryException, ReportProcessingException
071 {
072 if (state != StaticTextLayoutController.NOT_STARTED)
073 {
074 throw new IllegalStateException();
075 }
076
077 final StaticText text = (StaticText) getNode();
078 target.processText(text.getText());
079
080 final StaticTextLayoutController derived = (StaticTextLayoutController) clone();
081 derived.state = StaticTextLayoutController.FINISHED;
082 return derived;
083 }
084
085 /**
086 * Joins with a delegated process flow. This is generally called from a child
087 * flow and should *not* (I mean it!) be called from outside. If you do,
088 * you'll suffer.
089 *
090 * @param flowController the flow controller of the parent.
091 * @return the joined layout controller that incorperates all changes from
092 * the delegate.
093 */
094 public LayoutController join(final FlowController flowController)
095 {
096 throw new UnsupportedOperationException("Static text does not have childs.");
097 }
098
099 /**
100 * Checks, whether the layout controller would be advanceable. If this method
101 * returns true, it is generally safe to call the 'advance()' method.
102 *
103 * @return true, if the layout controller is advanceable, false otherwise.
104 */
105 public boolean isAdvanceable()
106 {
107 return state != StaticTextLayoutController.FINISHED;
108 }
109
110 /**
111 * Derives a copy of this controller that is suitable to perform a
112 * precomputation. The returned layout controller must be independent from
113 * the it's anchestor controller.
114 *
115 * @param fc a new flow controller for the precomputation.
116 * @return a copy that is suitable for precomputation.
117 */
118 public LayoutController createPrecomputeInstance(final FlowController fc)
119 {
120 throw new UnsupportedOperationException
121 ("Static Text does not perform any precomputation.");
122 }
123 }