de.datexis.index

Class ArticleIndex

java.lang.Object

de.datexis.index.ArticleIndex

Direct Known Subclasses:

LuceneArticleIndex

public abstract class ArticleIndex
extends Object

An Index holds a collection of Articles that are used as target for Entity Linking.

Author:

Denis Martin

Constructor Summary

Constructors

Constructor and Description
ArticleIndex() used for JSON deserialization

Method Summary

Modifier and Type	Method and Description
abstract Optional<ArticleRef>	queryID(String id) Retrieve the article with a given ID
abstract List<ArticleRef>	queryNames(String name, int hits) Retrieve candidates for a query on the "name" field.
abstract List<ArticleRef>	queryPrefixNames(String prefix, int hits) Retrieve candidates for auto completion on the "name" field.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArticleIndex

public ArticleIndex()

used for JSON deserialization

Method Detail

queryNames

public abstract List<ArticleRef> queryNames(String name,
                                            int hits)

Retrieve candidates for a query on the "name" field.

Parameters:

name - The name to search, e.g. "obama barack"

hits - Max number of hits to generate

Returns:

An List of matching ArticleRefs, e.g. Wiki URL of "Barack Obama"

queryPrefixNames

public abstract List<ArticleRef> queryPrefixNames(String prefix,
                                                  int hits)

Retrieve candidates for auto completion on the "name" field.

Parameters:

prefix -

hits -

Returns:

queryID

public abstract Optional<ArticleRef> queryID(String id)

Retrieve the article with a given ID

Parameters:

id - The indexed ID, e.g. "Q64"

Returns:

The ArticleRef, if exists