KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > apps > FormattingResults


1 /*
2  * $Id: FormattingResults.java,v 1.1.2.2 2003/02/25 10:18:32 jeremias Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */
51 package org.apache.fop.apps;
52
53 import java.util.List JavaDoc;
54
55 import org.apache.fop.fo.pagination.PageSequence;
56
57 /**
58  * Class for reporting back formatting results to the calling application.
59  *
60  * @author Jeremias Maerki
61  */
62 public class FormattingResults {
63
64     private int pageCount = 0;
65     private List JavaDoc pageSequences = null;
66
67     /**
68      * Constructor for the FormattingResults object
69      */
70     public FormattingResults() {
71     }
72
73     /**
74      * Gets the number of pages rendered
75      *
76      * @return The number of pages overall
77      */
78     public int getPageCount() {
79         return this.pageCount;
80     }
81
82     /**
83      * Gets the results for the individual page-sequences.
84      *
85      * @return A List with PageSequenceResults objects
86      */
87     public List JavaDoc getPageSequences() {
88         return this.pageSequences;
89     }
90
91     /**
92      * Resets this object
93      */
94     public void reset() {
95         this.pageCount = 0;
96         if (this.pageSequences != null) {
97             this.pageSequences.clear();
98         }
99     }
100
101     /**
102      * Description of the Method
103      *
104      * @param pageSequence Description of Parameter
105      */
106     public void haveFormattedPageSequence(PageSequence pageSequence) {
107         this.pageCount += pageSequence.getPageCount();
108         if (this.pageSequences == null) {
109             this.pageSequences = new java.util.ArrayList JavaDoc();
110         }
111         this.pageSequences.add(
112                 new PageSequenceResults(pageSequence.getProperty("id").getString(),
113                                         pageSequence.getPageCount()));
114     }
115 }
116
117
Popular Tags