MetadataTransformer.java

/**
 * Copyright (c) Codice Foundation
 * <p>
 * This is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 * <p>
 * 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
 * Lesser General Public License for more details. A copy of the GNU Lesser General Public License
 * is distributed along with this program and can be found at
 * <http://www.gnu.org/licenses/lgpl.html>.
 **/
package org.codice.ddf.spatial.ogc.catalog;

import ddf.catalog.data.Metacard;
import ddf.catalog.transform.CatalogTransformerException;

/**
 * Metacard-to-Metacard transformer that allows implementers to transform a {@link Metacard}'s
 * metadata.
 *
 * @author rodgersh
 *
 */
public interface MetadataTransformer {

    /**
     * Get the type of the transformer.
     *
     * @return
     */
    public String getType();

    /**
     * Transform metacard to another metacard.
     *
     * @param metacard
     * @return
     */
    public Metacard transform(Metacard metacard) throws CatalogTransformerException;

}