DataConverter.java

/*
 * Copyright 2013 Serdar.
 *
 * Licensed 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.
 */
package de.fub.maps.project.detector.model.converter;

import de.fub.maps.project.detector.model.gpx.TrackSegment;
import java.util.List;
import org.openide.filesystems.FileObject;

/**
 * Interface to convert a Fileobject to a designated Type. These DataConverters
 * will be used to convert the specified dataset in the DetectorDescriptor.
 *
 * @author Serdar
 */
public interface DataConverter {

    /**
     * Indicated whether this converter is able to convert the specified
     * fileObject to a GPSTrack instance. The method should check at first the
     * mime type of the fileObject and as a fall back the file extention.
     *
     * @param fileObject
     * @return true if this DataConverter is able to convert the specified
     * fileObject to a GPX object, otherwise false.
     */
    public boolean isFileTypeSupported(FileObject fileObject);

    /**
     * Converts the specified fileObject to a List<GPSTrack> instance.
     *
     * @param fileObject - that will be read and converted to anGPSTrack
     * instance.
     * @return List<GPSTrack> instance
     * @throws
     * de.fub.maps.project.detector.model.converter.DataConverter.DataConverterException
     */
    public List<TrackSegment> convert(FileObject fileObject) throws DataConverterException;

    public static class DataConverterException extends Exception {

        private static final long serialVersionUID = 1L;

        public DataConverterException() {
        }

        public DataConverterException(String message) {
            super(message);
        }

        public DataConverterException(String message, Throwable cause) {
            super(message, cause);
        }

        public DataConverterException(Throwable cause) {
            super(cause);
        }

        public DataConverterException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
            super(message, cause, enableSuppression, writableStackTrace);
        }
    }
}