org.wikidata.query.rdf.blazegraph.mwapi

Class ApiTemplate

java.lang.Object

org.wikidata.query.rdf.blazegraph.mwapi.ApiTemplate

public class ApiTemplate
extends Object

This class represents API template.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiTemplate.OutputVariable Variable in the output of the API.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApiTemplate(Map<String,String> fixedParams, Set<String> inputVars, Map<String,String> defaults, Map<String,String> outputVars, String items) Hidden ctor.

Method Summary

Modifier and Type	Method and Description
static ApiTemplate	fromJSON(com.fasterxml.jackson.databind.JsonNode json) Create API template from JSON configuration.
Map<String,String>	getFixedParams() Get call fixed parameters.
String	getInputDefault(String name) Find default for this parameter.
Map<String,com.bigdata.bop.IVariableOrConstant>	getInputVars(com.bigdata.rdf.sparql.ast.eval.ServiceParams serviceParams) Create list of bindings from input params to specific variables or constants.
String	getItemsPath() Get items XPath.
List<ApiTemplate.OutputVariable>	getOutputVars(com.bigdata.rdf.sparql.ast.service.ServiceNode serviceNode) Create map of output variables from template and service params.
boolean	isRequiredParameter(String name) Check if parameter is required.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiTemplate

protected ApiTemplate(Map<String,String> fixedParams,
                      Set<String> inputVars,
                      Map<String,String> defaults,
                      Map<String,String> outputVars,
                      String items)

Hidden ctor. Use fromJSON() to create the object.

Method Detail

fromJSON

public static ApiTemplate fromJSON(com.fasterxml.jackson.databind.JsonNode json)

Create API template from JSON configuration.

getItemsPath

public String getItemsPath()

Get items XPath.

isRequiredParameter

public boolean isRequiredParameter(String name)

Check if parameter is required.

getFixedParams

public Map<String,String> getFixedParams()

Get call fixed parameters.

getInputDefault

public String getInputDefault(String name)

Find default for this parameter.

Returns:

Default value or null.

getInputVars

public Map<String,com.bigdata.bop.IVariableOrConstant> getInputVars(com.bigdata.rdf.sparql.ast.eval.ServiceParams serviceParams)

Create list of bindings from input params to specific variables or constants.

Parameters:

serviceParams - Specific invocation params.

Returns:

Map of bindings, which has constant or variable from service params if bound, or null if not bound.

getOutputVars

public List<ApiTemplate.OutputVariable> getOutputVars(com.bigdata.rdf.sparql.ast.service.ServiceNode serviceNode)

Create map of output variables from template and service params.