Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.impl.store.rmf;

import java.io.IOException;

import org.gvsig.fmap.dal.coverage.exception.ParsingException;

/**

 * Interfaz que deben implementar las clases que escriben bloques XML en ficheros RMF.

 * Contiene m?todos para escribir y leer un bloque de informaci?n del fichero RMF. La clase

 * que implementa este interfaz es la encargada de serializar un objeto en cadenas XML y 

 * crear este desde cadenas XML. Esto lo har? a trav?s de los m?todos de este interfaz para

 * que el gestor de RMF pueda administrar la escritura y lectura del fichero.

 * 

 * 21-abr-2007

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public interface IRmfBlock {

        /**

         * Lee el bloque XML pasado por par?metro y carga el objeto correspondiente

         * con los datos.

         * @param xml. Texto XML que representa el objeto.

         */

        public void read(String xml) throws ParsingException;

        /**

         * Obtiene un bloque XML que representa a las propiedades del objeto a 

         * serializar.

         * @return Texto XML que representa el objeto.

         */

        public String write() throws IOException;

        /**

         * Obtiene el tag principal del bloque

         * @return Tag principal

         */

        public String getMainTag();

        /**

         * Obtiene el objeto resultante de haber aplicado un read.

         * @return Object del tipo correspondiente al bloque implementado.

         */

        public Object getResult();

}