org.openimaj.text.nlp.namedentity

Class EntityExtractionResourceBuilder

java.lang.Object

org.openimaj.text.nlp.namedentity.EntityExtractionResourceBuilder

public class EntityExtractionResourceBuilder
extends Object

This class has various methods that can be used to build the resources required by YagoEntityCandidateFinderFactory.YagoEntityCandidateFinder, YagoEntityContextScorerFactory.YagoEntityContextScorer and YagoEntityExactMatcherFactory.YagoEntityExactMatcher. These resources are a text File of entity aliases, and a lucene index of contextual data. The directory of the stripped down Yago tsv files is required. This directory can be built with SeedBuilder.

Author:

Laurence Willmore (lgw1e10@ecs.soton.ac.uk), Sina Samangooei (ss@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityExtractionResourceBuilder.StreamLooper Helper class to iterate through the lines of a Reader to do a bit of work on each.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ALIAS_NAME Default file name for the alias text file.
static String	DEFAULT_CONTEXT_NAME Default directory name for the lucene index.

Constructor Summary

Constructors

Constructor and Description
EntityExtractionResourceBuilder()

Method Summary

Modifier and Type	Method and Description
void	buildAll(String seedDirectoryPath) Builds the alias text file and the lucene index in the default root directory.
void	buildAll(String seedDirectoryPath, String destinationPath) Builds the alias text file and the lucene index in the specified root directory.
void	buildCandidateAliasFile(String seedDirectoryPath) Builds the alias text file in the default location.
void	buildCandidateAliasFile(String seedDirectoryPath, String destinationPath) Builds the alias text file in the specified location.
void	buildContextLuceneIndex(String seedDirectoryPath) Builds the lucene index in the default path.
void	buildContextLuceneIndex(String seedDirectoryPath, String destinationPath) Builds the lucene index at the specified path.
static String	getAliasFrom(String rootName)
static String	getDefaultAliasFilePath()
static String	getDefaultIndexDirectoryPath()
static String	getDefaultRootPath()
static void	main(String[] args) Defualt main.
static BufferedReader	openFileAsReadStream(String path)
static BufferedWriter	openFileAsWriteStream(String path)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ALIAS_NAME

public static String DEFAULT_ALIAS_NAME

Default file name for the alias text file.

DEFAULT_CONTEXT_NAME

public static String DEFAULT_CONTEXT_NAME

Default directory name for the lucene index.

Constructor Detail

EntityExtractionResourceBuilder

public EntityExtractionResourceBuilder()

Method Detail

buildCandidateAliasFile

public void buildCandidateAliasFile(String seedDirectoryPath)

Builds the alias text file in the default location.

Parameters:

seedDirectoryPath - = path location of the stripped down Yago .tsv files.

buildCandidateAliasFile

public void buildCandidateAliasFile(String seedDirectoryPath,
                                    String destinationPath)

Builds the alias text file in the specified location.

Parameters:

seedDirectoryPath - = path location of the stripped down Yago .tsv files.

destinationPath - = path to build the alias text file.

buildContextLuceneIndex

public void buildContextLuceneIndex(String seedDirectoryPath)

Builds the lucene index in the default path.

Parameters:

seedDirectoryPath - = path location of the stripped down Yago .tsv files.

buildContextLuceneIndex

public void buildContextLuceneIndex(String seedDirectoryPath,
                                    String destinationPath)

Builds the lucene index at the specified path.

Parameters:

seedDirectoryPath -

destinationPath -

buildAll

public void buildAll(String seedDirectoryPath)

Builds the alias text file and the lucene index in the default root directory.

Parameters:

seedDirectoryPath -

buildAll

public void buildAll(String seedDirectoryPath,
                     String destinationPath)

Builds the alias text file and the lucene index in the specified root directory.

Parameters:

seedDirectoryPath -

destinationPath -

getDefaultRootPath

public static String getDefaultRootPath()

Returns:

default root directory path for all YagoEntity resources.

getDefaultAliasFilePath

public static String getDefaultAliasFilePath()

Returns:

default alias text file path.

getDefaultIndexDirectoryPath

public static String getDefaultIndexDirectoryPath()

Returns:

defualt lucene directory path.

getAliasFrom

public static String getAliasFrom(String rootName)

openFileAsReadStream

public static BufferedReader openFileAsReadStream(String path)
                                           throws FileNotFoundException

Throws:

FileNotFoundException

openFileAsWriteStream

public static BufferedWriter openFileAsWriteStream(String path)
                                            throws IOException

Throws:

IOException

main

public static void main(String[] args)

Defualt main.

Parameters:

args - = path to the seed directory.