ExplorerFile.java

/*
 * Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
 *
 * 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 3 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, see http://www.gnu.org/licenses/
 */

package org.esa.beam.dataio.smos;

import com.bc.ceres.binio.CompoundData;
import com.bc.ceres.binio.DataContext;
import com.bc.ceres.binio.DataFormat;
import org.esa.beam.dataio.smos.dddb.Dddb;
import org.esa.beam.smos.EEFilePair;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.jdom.filter.Filter;
import org.jdom.input.SAXBuilder;

import java.io.File;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.Iterator;

public abstract class ExplorerFile implements ProductFile {

    protected static final String TAG_SPECIFIC_PRODUCT_HEADER = "Specific_Product_Header";

    private final EEFilePair eeFilePair;
    private final DataFormat dataFormat;
    private final DataContext dataContext;

    protected ExplorerFile(EEFilePair eeFilePair, DataContext dataContext) throws IOException {
        this.eeFilePair = eeFilePair;
        this.dataFormat = Dddb.getInstance().getDataFormat(eeFilePair.getHdrFile());
        this.dataContext = dataContext;
    }

    public final File getHeaderFile() {
        return eeFilePair.getHdrFile();
    }

    @Override
    public final File getDataFile() {
        return eeFilePair.getDblFile();
    }

    public final DataFormat getDataFormat() {
        return dataFormat;
    }

    public final CompoundData getDataBlock() {
        return dataContext.getData();
    }

    @Override
    public void close() {
        dataContext.dispose();
    }

    protected String getProductType() {
        return dataFormat.getName().substring(12, 22);
    }

    protected final Document getDocument() throws IOException {
        final Document document;
        try {
            document = new SAXBuilder().build(eeFilePair.getHdrFile());
        } catch (JDOMException e) {
            throw new IOException(MessageFormat.format("File ''{0}'': Invalid document", eeFilePair.getHdrFile().getPath()), e);
        }
        return document;
    }

    protected Element getElement(Element parent, final String name) throws IOException {
        final Iterator descendants = parent.getDescendants(new Filter() {
            @Override
            public boolean matches(Object o) {
                if (o instanceof Element) {
                    final Element e = (Element) o;
                    if (name.equals(e.getName())) {
                        return true;
                    }
                }

                return false;
            }
        });
        if (descendants.hasNext()) {
            return (Element) descendants.next();
        } else {
            throw new IOException(MessageFormat.format("File ''{0}'': Missing element ''{1}''.", getHeaderFile().getPath(), name));
        }
    }
}