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: FlowControlOperation.java 3525 2007-10-16 11:43:48Z tmorgner $
027: * ------------
028: * (C) Copyright 2000-2005, by Object Refinery Limited.
029: * (C) Copyright 2005-2007, by Pentaho Corporation.
030: */package org.jfree.report.flow;
031:
032: /**
033: * These objects define, how the iteration over the report definition affects
034: * the data source.
035: *
036: * @author Thomas Morgner
037: */
038: public class FlowControlOperation {
039: /**
040: * Stores the current datarow state for a later recall. Markpoints from different
041: * sources can be nested. Marking does not change the user datasource.
042: */
043: public static final FlowControlOperation MARK = new FlowControlOperation(
044: "mark");
045: /**
046: * Requests that the datasource should be moved to the next row. An advance
047: * operation does not change the current cursor position. The cursor is not
048: * moved until a 'COMMIT' operation has been reached.
049: *
050: * Repeatable sections will perform an auto-commit based on the group in which
051: * they are in.
052: */
053: public static final FlowControlOperation ADVANCE = new FlowControlOperation(
054: "advance");
055: /** Recalls a marked position. */
056: public static final FlowControlOperation RECALL = new FlowControlOperation(
057: "recall");
058:
059: /** Do nothing. */
060: public static final FlowControlOperation NO_OP = new FlowControlOperation(
061: "no-op");
062:
063: /**
064: * Finishes (and closes) the currently open context. If the last mark has been
065: * closed, the datasource is also closed.
066: * <p/>
067: * If all datasources have been closes, the empty datasource is used. This
068: * datasource cannot be closed (closing has no effect on it).
069: */
070: public static final FlowControlOperation DONE = new FlowControlOperation(
071: "done");
072:
073: private final String myName; // for debug only
074:
075: /**
076: * A commit checks for an pending advance request and commites that request
077: * by moving the cursor of the currend datarow forward by one row.
078: */
079: public static final FlowControlOperation COMMIT = new FlowControlOperation(
080: "commit");
081:
082: protected FlowControlOperation(final String name) {
083: if (name == null) {
084: throw new NullPointerException();
085: }
086: myName = name;
087: }
088:
089: public String toString() {
090: return myName;
091: }
092:
093: public boolean equals(final Object o) {
094: if (this == o) {
095: return true;
096: }
097: if (o == null || getClass() != o.getClass()) {
098: return false;
099: }
100:
101: final FlowControlOperation that = (FlowControlOperation) o;
102:
103: return myName.equals(that.myName);
104: }
105:
106: public int hashCode() {
107: return myName.hashCode();
108: }
109: }
|