MappingDiscoveryStep.java

/*
 *    Copyright (c) 2013, University of Toronto.
 *
 *    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 edu.toronto.cs.xcurator.discoverer;

import edu.toronto.cs.xcurator.common.DataDocument;
import edu.toronto.cs.xcurator.mapping.Mapping;
import java.util.List;

/**
 *
 * @author zhuerkan
 */
public interface MappingDiscoveryStep {

    public enum TYPE {
        BASIC('B'),
        INTERLIKNING('I'),
        KEYATTRIBUTE('K'),
        REMOVE_GROUPING_NODES('G');

        private final char id;

        TYPE(char id) {
            this.id = id;
        }

        public char getValue() {
            return id;
        }
    }

    /**
     * Processes the mapping.
     *
     * @param dataDocuments A list of XML data documents to be processed
     * @param mapping The map of processed entities. Note that the step should
     * only modify the mapping.
     */
    void process(List<DataDocument> dataDocuments, Mapping mapping);

}