jacsonreport.java

java编写的OCR软件

package de.spieleck.app.jacson;

import de.spieleck.config.ConfigNode;

/**
 * A Report, that is something that takes certain events
 * and know where to put it. This was kind of inspired of
 * SAX(1) and is a very tiny event API. The intelligence
 * has to be in the implementation underneath.
 * <br>
 * Reports distributed with Jacson reside in 
 * the {@link de.spieleck.app.jacson.report} package.
 * <br>
 * The lifecycle of a report is documented
 * <a href="../../../../../lifecycle.html">elsewhere</a>. In short
 * it is: 
 * <ul>
 * <li>one init() event</li>
 * <li>one begin() event</li>
 * <li>arbitrary many begin()/end() events, properly nested, mixed with
 * everywhere within these report() events</li>
 * <li>one finish() event</li>
 * </ul>
 * <br>
 * @author fsn
 * @author Patrick Carl
 */
public interface JacsonReport extends JacsonStately
{
    /**
     * Initialize the report. 
     * The passed {@link ConfigNode} can be used to obtain
     * configuration information of the report from the global
     * config xml.
     */
    public void init(ConfigNode config)
        throws JacsonConfigException;

    /** Finish and close underlying resources */
    public void finish();

    /** Finish and optionally close the underlying resources 
     * @param close flag whether to close resources or not.
     */
    public void finish(boolean close);

    /** Begin a subsection within report */
    public void begin(String id);

    /** Report a single name value pair within a report */
    public void report(String localName, String value);

    /** Close a subsection within a report */
    public void end();
    
    /**
     * returns the set JacsonState
     */
    public JacsonState getRegState();
}

//
//    Jacson - Text Filtering with Java.
//    Copyright (C) 2002 Frank S. Nestel (nestefan -at- users.sourceforge.net)
//
//    This library is free software; you can redistribute it and/or
//    modify it under the terms of the GNU Lesser General Public
//    License as published by the Free Software Foundation; either
//    version 2.1 of the License, or (at your option) any later version.
//
//    This library is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//    Lesser General Public License for more details.
//
//    You should have received a copy of the GNU Lesser General Public
//    License along with this library; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//