io.redlink.nlp.entitylinking.solr

Class SolrLinkingDescriptor

java.lang.Object

io.redlink.nlp.entitylinking.solr.SolrLinkingDescriptor

public class SolrLinkingDescriptor
extends Object

TODO: The intension of this class is that one creates a Bean that provides all the necessary configurations for linking against a SolrCore. Those configurations would be injected to the SolrEntityLinker Processor. Thsi would avoid the requirement to subclass the SolrEntityLinker for every Solr you want to link against.

Author:

Rupert Westenthaler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolrLinkingDescriptor.SolrLanguageConfigBuilder
static class	SolrLinkingDescriptor.SolrLinkingDescriptorBuilder

Method Summary

Modifier and Type	Method and Description
static SolrLinkingDescriptor.SolrLinkingDescriptorBuilder	createDefaultFor(String coreName, String titleField, String tagField) Returns a builder already configured for the parsed coreName using id as documentId field.
static SolrLinkingDescriptor.SolrLinkingDescriptorBuilder	createFor(String coreName)
String	getCoreName() The name of the Solr core this linking descriptor is configured for
LinkingConfig	getLinkingConfiguration(String lang) The configuration to be used for linking in the parsed language or null if the parsed language is not supported.
boolean	hasDefaultLanguageConfig() If a default language configuration is present
boolean	hasLanguageConfig(String lang) If a language specific configuration for the parsed language is present
Set<String>	supportedLanguages() Getter for the set of supported languages.

Methods inherited from class java.lang.Object

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

Method Detail

createDefaultFor

public static SolrLinkingDescriptor.SolrLinkingDescriptorBuilder createDefaultFor(String coreName,
                                                                                  String titleField,
                                                                                  String tagField)

Returns a builder already configured for the parsed coreName using id as documentId field. It will also have a default (null) language configuration with the parsed title and tag field. So for the most simple configurations where a single field pair is used for all languages this should be sufficient.

Parameters:

idField - the id field of the Solr schema

titleField - the Solr field that stores the title of the entity

tagField - the Solr field used for tagging (needs to be configured accordingly)

Returns:

the SolrLinkingDescriptor with the minimal configuration based on the parsed parameters

createFor

public static SolrLinkingDescriptor.SolrLinkingDescriptorBuilder createFor(String coreName)

getCoreName

public String getCoreName()

The name of the Solr core this linking descriptor is configured for

Returns:

the Solr core name

supportedLanguages

public Set<String> supportedLanguages()

Getter for the set of supported languages. A null value indicated that a default configuration is present. This will be used as fallback for all languages without a specific configuration.

Returns:

the set of supported languages

hasLanguageConfig

public boolean hasLanguageConfig(String lang)

If a language specific configuration for the parsed language is present

Parameters:

lang - the language

Returns:

the state

hasDefaultLanguageConfig

public boolean hasDefaultLanguageConfig()

If a default language configuration is present

Returns:

getLinkingConfiguration

public LinkingConfig getLinkingConfiguration(String lang)

The configuration to be used for linking in the parsed language or null if the parsed language is not supported.

Parameters:

lang - the language

Returns:

the LinkingConfig or null if the parsed language is not supported