rrenkert@243: /*
rrenkert@243:  * Copyright (c) 2011 by Intevation GmbH, Germany <info@intevation.de>
rrenkert@243:  *
rrenkert@243:  * This file is part of MXD2map.
rrenkert@243:  *
rrenkert@243:  * This program is free software under the LGPL (>=v2.1)
rrenkert@243:  * Read the file LICENCE.txt coming with the software for details
rrenkert@243:  * or visit http://www.gnu.org/licenses/ if it does not exist.
rrenkert@243:  *
rrenkert@243:  * MXD2map has been developed on behalf of the
rrenkert@243:  * Bundesamt fuer Seeschifffahrt und Hydrographie (BSH) in Hamburg
rrenkert@243:  * by Intevation GmbH.
rrenkert@243:  *
rrenkert@243:  * Authors:
rrenkert@243:  * Raimund Renkert <raimund.renkert@intevation.de>
rrenkert@243:  * Bjoern Schilberg <bjoern.schilberg@intevation.de>
rrenkert@243:  * Stephan Holl <stephan.holl@intevation.de>
rrenkert@243:  */
rrenkert@243: 
rrenkert@33: package de.intevation.mxd.reader;
rrenkert@25: 
rrenkert@25: import java.io.IOException;
rrenkert@25: 
rrenkert@27: import org.w3c.dom.Document;
rrenkert@27: 
rrenkert@25: /**
rrenkert@25:  * The interface to the MXD-Reader.
rrenkert@25:  *
rrenkert@25:  * @author <a href="mailto:raimund.renkert@intevation.de">Raimund Renkert</a>
rrenkert@25:  */
rrenkert@25: public interface IReader {
rrenkert@25:     /**
rrenkert@25:      * Initializes the reader component.
rrenkert@25:      */
rrenkert@25:     boolean init() throws IOException;
rrenkert@25: 
rrenkert@25:     /**
rrenkert@25:      * Method to perform actions at the of reader usage.
rrenkert@25:      */
rrenkert@25:     boolean shutdown() throws IOException;
rrenkert@25: 
rrenkert@25:     /**
rrenkert@25:      * Set the filename.
rrenkert@25:      */
rrenkert@25:     void setFilename(String name);
rrenkert@25: 
rrenkert@25:     /**
rrenkert@25:      * Read the content.
rrenkert@25:      */
rrenkert@121:     boolean read() throws Exception;
rrenkert@25: 
rrenkert@25:     /**
rrenkert@25:      * Request DOM Document containing the map data.
rrenkert@25:      */
rrenkert@27:     Document getMapDocument();
rrenkert@25: }
rrenkert@25: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :