org.wikidata.query.rdf.blazegraph.mwapi

Class MWApiServiceFactory

java.lang.Object

com.bigdata.rdf.sparql.ast.eval.AbstractServiceFactoryBase

com.bigdata.rdf.sparql.ast.eval.AbstractServiceFactory

org.wikidata.query.rdf.blazegraph.mwapi.MWApiServiceFactory

All Implemented Interfaces:

com.bigdata.rdf.sparql.ast.service.ServiceFactory

public class MWApiServiceFactory
extends com.bigdata.rdf.sparql.ast.eval.AbstractServiceFactory

Service factory for calling out to Mediawiki API Services. Service call looks like: Fetching catrgories for "Albert Einstein" page: SERVICE wikibase:mwapi { bd:serviceParam wikibase:api "Categories" . bd:serviceParam wikibase:endpoint "en.wikipedia.org" . # Input params bd:serviceParam mwapi:titles "Albert Einstein" . # Output params ?title wikibase:output mwapi:title . ?item wikibase:outputItem mwapi:item . ?ns wikibase:output "@ns" . }

Field Summary

Fields

Modifier and Type	Field and Description
static org.openrdf.model.URI	API_KEY API type parameter name.
static String	CONFIG_DEFAULT Default service config filename.
static String	CONFIG_FILE Filename of the config.
static String	CONFIG_MAX_CONTINUATIONS Config variable for changing maximum number of continuations.
static String	CONFIG_MAX_EMPTY_CONTINUATIONS Config variable for changing maximum number of empty continuations.
static String	CONFIG_MAX_RESULTS Config variable for changing maximum number of results.
static String	CONFIG_NAME Config file parameter.
static org.openrdf.model.URI	ENDPOINT_KEY Endpoint hostname parameter name.
static org.openrdf.model.URI	LIMIT_CONTINUATIONS_KEY Parameter setting limit on continuations.
static org.openrdf.model.URI	LIMIT_EMPTY_CONTINUATIONS_KEY Parameter setting limit on continuations with empty results.
static org.openrdf.model.URI	LIMIT_RESULTS_KEY Parameter setting global limit on results across continuations.
static String	MWAPI_NAMESPACE Namespace for MWAPI parameters.
static org.openrdf.model.URI	SERVICE_KEY The URI service key.
static com.bigdata.rdf.sparql.ast.service.BigdataNativeServiceOptions	SERVICE_OPTIONS Options configuring this service as a native Blazegraph service.

Constructor Summary

Constructors

Constructor and Description
MWApiServiceFactory(ServiceConfig config, com.codahale.metrics.Timer requestTimer)

Method Summary

Modifier and Type	Method and Description
com.bigdata.rdf.sparql.ast.service.BigdataServiceCall	create(com.bigdata.rdf.sparql.ast.service.ServiceCallCreateParams params, com.bigdata.rdf.sparql.ast.eval.ServiceParams serviceParams)
Set<com.bigdata.bop.IVariable<?>>	getRequiredBound(com.bigdata.rdf.sparql.ast.service.ServiceNode serviceNode)
com.bigdata.rdf.sparql.ast.service.IServiceOptions	getServiceOptions()
static org.openrdf.model.URI	paramNameToURI(String name) Create predicate parameter URI from name.
static void	register(com.codahale.metrics.Timer requestTimer) Register the service so it is recognized by Blazegraph.

Methods inherited from class com.bigdata.rdf.sparql.ast.eval.AbstractServiceFactory

create

Methods inherited from class com.bigdata.rdf.sparql.ast.eval.AbstractServiceFactoryBase

getDesiredBound

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_OPTIONS

public static final com.bigdata.rdf.sparql.ast.service.BigdataNativeServiceOptions SERVICE_OPTIONS

Options configuring this service as a native Blazegraph service.

SERVICE_KEY

public static final org.openrdf.model.URI SERVICE_KEY

The URI service key.

API_KEY

public static final org.openrdf.model.URI API_KEY

API type parameter name.

ENDPOINT_KEY

public static final org.openrdf.model.URI ENDPOINT_KEY

Endpoint hostname parameter name.

LIMIT_RESULTS_KEY

public static final org.openrdf.model.URI LIMIT_RESULTS_KEY

Parameter setting global limit on results across continuations.

LIMIT_CONTINUATIONS_KEY

public static final org.openrdf.model.URI LIMIT_CONTINUATIONS_KEY

Parameter setting limit on continuations.

LIMIT_EMPTY_CONTINUATIONS_KEY

public static final org.openrdf.model.URI LIMIT_EMPTY_CONTINUATIONS_KEY

Parameter setting limit on continuations with empty results.

MWAPI_NAMESPACE

public static final String MWAPI_NAMESPACE

Namespace for MWAPI parameters.

See Also:

Constant Field Values

CONFIG_DEFAULT

public static final String CONFIG_DEFAULT

Default service config filename.

See Also:

Constant Field Values

CONFIG_NAME

public static final String CONFIG_NAME

Config file parameter.

CONFIG_FILE

public static final String CONFIG_FILE

Filename of the config.

CONFIG_MAX_RESULTS

public static final String CONFIG_MAX_RESULTS

Config variable for changing maximum number of results.

CONFIG_MAX_CONTINUATIONS

public static final String CONFIG_MAX_CONTINUATIONS

Config variable for changing maximum number of continuations.

CONFIG_MAX_EMPTY_CONTINUATIONS

public static final String CONFIG_MAX_EMPTY_CONTINUATIONS

Config variable for changing maximum number of empty continuations.

Constructor Detail

MWApiServiceFactory

public MWApiServiceFactory(ServiceConfig config,
                           com.codahale.metrics.Timer requestTimer)

Method Detail

getServiceOptions

public com.bigdata.rdf.sparql.ast.service.IServiceOptions getServiceOptions()

register

public static void register(com.codahale.metrics.Timer requestTimer)

Register the service so it is recognized by Blazegraph.

create

public com.bigdata.rdf.sparql.ast.service.BigdataServiceCall create(com.bigdata.rdf.sparql.ast.service.ServiceCallCreateParams params,
                                                                    com.bigdata.rdf.sparql.ast.eval.ServiceParams serviceParams)

Specified by:

create in class com.bigdata.rdf.sparql.ast.eval.AbstractServiceFactory

getRequiredBound

public Set<com.bigdata.bop.IVariable<?>> getRequiredBound(com.bigdata.rdf.sparql.ast.service.ServiceNode serviceNode)

Specified by:

getRequiredBound in interface com.bigdata.rdf.sparql.ast.service.ServiceFactory

Overrides:

getRequiredBound in class com.bigdata.rdf.sparql.ast.eval.AbstractServiceFactoryBase

paramNameToURI

public static org.openrdf.model.URI paramNameToURI(String name)

Create predicate parameter URI from name.