Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

# Record Linkage API

The Record Linkage API is a lightweight framework for matching two arbitrary sets of records against each other using a customized linkage engine; to get started using the framework, read the overview description below.

See:
Description

Packages
edu.uky.kcr.recordlinkage |
edu.uky.kcr.recordlinkage.configuration |
edu.uky.kcr.recordlinkage.datasource |
edu.uky.kcr.recordlinkage.engine |
edu.uky.kcr.recordlinkage.resultset |
edu.uky.kcr.test |
edu.uky.kcr.util |

The Record Linkage API is a lightweight framework for matching two arbitrary sets of records against each other using a customized linkage engine; to get started using the framework, read the overview description below.

- For guidelines on implementing a record linkage engine, read the `AbstractLinkageEngine` overview.
- If you already have a linkage engine and want to configure a linkage operation with blocking and matching settings, cutoff scores, and an engine name, read the `LinkageConfiguration` overview.
- If you want to configure a JDBC connection to a data source, read the `JdbcDataSourceConfiguration` overview.
- If you want to use a CSV file as a data source, read the `CsvFileLinkageDataSource` overview.
- Once you have a linkage engine, two data sources, and a linkage configuration file, you can run a linkage operation using the command line. Make sure you have Java 1.5 or later installed and enter the following on the command line:
  `java -jar recordlinkage.jar <Primary Data Source File> <Secondary Data Source File> <Linkage Configuration File>`
- To use this framework inside a Java application, follow the basic usage scenario below:
  `LinkageController linkageController = new LinkageController();
  LinkageConfiguration linkageConfiguration = linkageController.createLinkageConfiguration(configFile);
  LinkageEngine linkageEngine = linkageController.getLinkageEngine(linkageConfiguration);
  LinkageDataSource primaryDataSource = linkageController.createDataSource(primaryFile);
  LinkageDataSource secondaryDataSource = linkageController.createDataSource(secondaryFile);
  LinkageResultSet linkageResultSet = linkageEngine.findLinkedRecords(primaryDataSource, secondaryDataSource);
  `

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES