http://xmlgraphics.apache.org/fop/: Apache FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting objects (XSL-FO) and the world's first output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PCL, PS, AFP, TIFF, PNG, SVG, XML (area tree representation), Print, AWT and TXT. The primary output target is PDF. (Apache Software Foundation) 
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id: FormattingResults.java 1610839 2014-07-15 20:25:58Z vhennebert $ */

package org.apache.fop.apps;

import java.util.List;

import org.apache.fop.fo.pagination.AbstractPageSequence;


Class for reporting back formatting results to the calling application.

/**
 * Class for reporting back formatting results to the calling application.
 */
public class FormattingResults {

    private int pageCount;
    private List pageSequences;

    
Constructor for the FormattingResults object

/**
     * Constructor for the FormattingResults object
     */
    public FormattingResults() {
    }

    
Gets the number of pages rendered

Returns:  The number of pages overall
/**
     * Gets the number of pages rendered
     *
     * @return   The number of pages overall
     */
    public int getPageCount() {
        return this.pageCount;
    }

    
Gets the results for the individual page-sequences.

Returns:  A List with PageSequenceResults objects
/**
     * Gets the results for the individual page-sequences.
     *
     * @return   A List with PageSequenceResults objects
     */
    public List getPageSequences() {
        return this.pageSequences;
    }

    
Resets this object

/**
     * Resets this object
     */
    public void reset() {
        this.pageCount = 0;
        if (this.pageSequences != null) {
            this.pageSequences.clear();
        }
    }

    
Reports the result of one page sequence rendering
back into this object.

Params:
  • pageSequence –  the page sequence which just completed rendering
  • pageCount –     the number of pages rendered for that PageSequence
/**
     * Reports the result of one page sequence rendering
     * back into this object.
     *
     * @param pageSequence  the page sequence which just completed rendering
     * @param pageCount     the number of pages rendered for that PageSequence
     */
    public void haveFormattedPageSequence(AbstractPageSequence pageSequence, int pageCount) {
        this.pageCount += pageCount;
        if (this.pageSequences == null) {
            this.pageSequences = new java.util.ArrayList();
        }
        this.pageSequences.add(
                new PageSequenceResults(pageSequence.getId(),
                                        pageCount));
    }
}