org.apache.stanbol.entityhub.servicesapi.site

Interface ReferencedSiteConfiguration

All Superinterfaces:

SiteConfiguration

public interface ReferencedSiteConfiguration
extends SiteConfiguration

Configuration for a Site that uses external services to access and query for Entities. ReferencedSites may cache remote entities locally.

Author:

Rupert Westenthaler

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_URI Key used for the configuration of the AccessURI for a site
static String	CACHE_ID The key used for the configuration of the id for the yard used as a cache for the data of a referenced Site.
static String	CACHE_STRATEGY Key used for the configuration of the default expiration duration for entities and data for a site
static String	ENTITY_DEREFERENCER_TYPE Key used for the configuration of the name of the dereferencer type to be used for this site
static String	ENTITY_SEARCHER_TYPE Key used for the configuration of the type of the query
static String	QUERY_URI Key used for the configuration of the uri to access the query service of the site

Fields inherited from interface org.apache.stanbol.entityhub.servicesapi.site.SiteConfiguration

DEFAULT_EXPIRE_DURATION, DEFAULT_MAPPING_STATE, DEFAULT_SYMBOL_STATE, DESCRIPTION, ENTITY_PREFIX, ID, NAME, SITE_ATTRIBUTION, SITE_ATTRIBUTION_URL, SITE_FIELD_MAPPINGS, SITE_LICENCE_NAME, SITE_LICENCE_TEXT, SITE_LICENCE_URL

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccessUri() The URI used to access the Data of this Site.
String	getCacheId() The id of the Yard used to cache data of this referenced site.
CacheStrategy	getCacheStrategy() The cache strategy used by for this site to be used.
String	getEntityDereferencerType() The name of the EntityDereferencer to be used for accessing representations of entities managed by this Site
String	getEntitySearcherType() The type of the EntitySearcher to be used to query for representations of entities managed by this Site.
String	getQueryUri() Getter for the queryUri of the site.

Methods inherited from interface org.apache.stanbol.entityhub.servicesapi.site.SiteConfiguration

getAttribution, getAttributionUrl, getConfiguration, getDefaultExpireDuration, getDefaultManagedEntityState, getDefaultMappedEntityState, getDescription, getEntityPrefixes, getFieldMappings, getId, getLicenses, getName

Field Detail

ACCESS_URI

static final String ACCESS_URI

Key used for the configuration of the AccessURI for a site

See Also:

Constant Field Values

ENTITY_DEREFERENCER_TYPE

static final String ENTITY_DEREFERENCER_TYPE

Key used for the configuration of the name of the dereferencer type to be used for this site

See Also:

Constant Field Values

QUERY_URI

static final String QUERY_URI

Key used for the configuration of the uri to access the query service of the site

See Also:

Constant Field Values

ENTITY_SEARCHER_TYPE

static final String ENTITY_SEARCHER_TYPE

Key used for the configuration of the type of the query

See Also:

Constant Field Values

CACHE_STRATEGY

static final String CACHE_STRATEGY

Key used for the configuration of the default expiration duration for entities and data for a site

See Also:

Constant Field Values

CACHE_ID

static final String CACHE_ID

The key used for the configuration of the id for the yard used as a cache for the data of a referenced Site. This property is ignored if CacheStrategy.none is used.

See Also:

Constant Field Values

Method Detail

getAccessUri

String getAccessUri()

The URI used to access the Data of this Site. This is usually a different URI as the ID of the site.

To give some Examples:

symbol.label: DBPedia
symbol.id: http://dbpedia.org
site.acessUri: http://dbpedia.org/resource/

symbol.label: Freebase
symbol.id: http://www.freebase.com
site.acessUri: http://rdf.freebase.com/

Returns:

the accessURI for the data of the referenced site

getEntityDereferencerType

String getEntityDereferencerType()

The name of the EntityDereferencer to be used for accessing representations of entities managed by this Site

Returns:

the id of the entity dereferencer implementation

getQueryUri

String getQueryUri()

Getter for the queryUri of the site.

Returns:

the uri to access the query service of this site

getEntitySearcherType

String getEntitySearcherType()

The type of the EntitySearcher to be used to query for representations of entities managed by this Site.

Returns:

the id of the entity searcher implementation.

getCacheStrategy

CacheStrategy getCacheStrategy()

The cache strategy used by for this site to be used.

Returns:

the cache strategy

getCacheId

String getCacheId()

The id of the Yard used to cache data of this referenced site.

Returns:

the id of the Yard used as a cache. May be null if CacheStrategy.none is configured for this yard