org.datacleaner.reference.SynonymCatalog Maven / Gradle / Ivy

Go to download
/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * 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.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.reference;

import org.datacleaner.configuration.DataCleanerConfiguration;

/**
 * A synonym catalog represents a set of synonyms which are related.
 *
 * Meaningful examples of synonym catalogs:
 * 
 * Country names (with ISO code as master term)
 * Given name synonyms (eg. 'William' is the master term for 'Billy')
 * 
 */
public interface SynonymCatalog extends ReferenceData {

    /**
     * Gets the name of this synonym catalog
     *
     * @return
     */
    String getName();

    /**
     * Opens a connection to the {@link SynonymCatalog}. Keep the connection
     * open while using the synonym catalog in a session, job or so. Close it
     * when you don't expect more interaction.
     *
     * @param configuration
     * @return
     */
    SynonymCatalogConnection openConnection(DataCleanerConfiguration configuration);

    default boolean isCaseSensitive() {
        return true;
    }
}