0.8.1-rc1/metadata/src/main/java/org/apache/oodt/cas/metadata/MetExtractorConfigReader.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.oodt.cas.metadata;

//JDK imports
import java.io.File;

//OODT imports
import org.apache.oodt.cas.metadata.exceptions.MetExtractorConfigReaderException;

/**
 * 
 * @author bfoster
 * @version $Revision$
 * 
 * <p>
 * A reader interface which converts config {@link File}s into
 * {@link MetExtractorConfig} objects
 * </p>.
 */
public interface MetExtractorConfigReader {

    /**
     * Parses a config {@link File} into a {@link MetExtractorConfig} obj
     * 
     * @param configFile
     *            The config {@link File} to be parsed
     * @return The {@link MetExtractorConfig} obj created by parsing the input
     *         config {@link File}
     * @throws MetExtractorConfigReaderException
     *             If any error occurs
     */
    public MetExtractorConfig parseConfigFile(File configFile)
            throws MetExtractorConfigReaderException;

}