Class NlgService

java.lang.Object

org.openprovenance.prov.service.xplain.NlgService

All Implemented Interfaces:

org.openprovenance.prov.model.interop.InteropMediaType, Constants, SwaggerTags

@Path("")
public class NlgService
extends Object
implements Constants, org.openprovenance.prov.model.interop.InteropMediaType, SwaggerTags

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,String>	defaultConfiguration

Fields inherited from interface org.openprovenance.prov.service.core.Constants

ACCESS_CONTROL_ALLOW_ORIGIN, ALLOWABLE_INPUT_DOCUMENT_EXTENSIONS, ALLOWABLE_OUTPUT_DOCUMENT_EXTENSIONS, DOCUMENT_NOT_FOUND, EXPANSION, GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET, HAS_PROVENANCE, HEADER_PARAM_ACCEPT, HTTP_HEADER_PROVENANCE_ACCEPT_DATETIME_OPTION, HTTP_HEADER_PROVENANCE_ACCEPT_TIMEZONE, HTTP_HEADER_PROVENANCE_CONTENT_DATETIME_OPTION, HTTP_HEADER_PROVENANCE_CONTENT_TIMEZONE, PROVAPI, SUMMARISATION, TEMPLATE_EXPANSION, translationExtensions, WILDCARD

Fields inherited from interface org.openprovenance.prov.model.interop.InteropMediaType

ALL_PROV_INPUT_MEDIA_TYPES, ALL_PROV_OUTPUT_MEDIA_TYPES, EXTENSION_DOT, EXTENSION_JPEG, EXTENSION_JPG, EXTENSION_JSON, EXTENSION_JSONLD, EXTENSION_PDF, EXTENSION_PNG, EXTENSION_PROVN, EXTENSION_PROVX, EXTENSION_RDF, EXTENSION_SVG, EXTENSION_TRIG, EXTENSION_TTL, EXTENSION_XML, MEDIA_APPLICATION_FORM_URLENCODED, MEDIA_APPLICATION_JSON, MEDIA_APPLICATION_JSONLD, MEDIA_APPLICATION_PDF, MEDIA_APPLICATION_PROVENANCE_XML, MEDIA_APPLICATION_RDF_XML, MEDIA_APPLICATION_SQL, MEDIA_APPLICATION_TRIG, MEDIA_APPLICATION_XML, MEDIA_IMAGE_JPEG, MEDIA_IMAGE_PNG, MEDIA_IMAGE_SVG_XML, MEDIA_TEXT_CSV, MEDIA_TEXT_HTML, MEDIA_TEXT_PLAIN, MEDIA_TEXT_PROVENANCE_NOTATION, MEDIA_TEXT_TURTLE, MEDIA_TEXT_VND_GRAPHVIZ, MEDIA_TEXT_XML

Fields inherited from interface org.openprovenance.prov.service.core.SwaggerTags

DOCUMENTS, METRICS, NARRATIVE, NLG, RANDOM, RESOURCES, TEMPLATE, TYPES, VALIDATION, VIEW

Constructor Summary

Constructors

Constructor	Description
NlgService(PostService ps)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	authenticate(jakarta.servlet.http.HttpServletResponse ignoredResponse, jakarta.servlet.http.HttpServletRequest ignoredRequest, String code)
jakarta.ws.rs.core.Response	blockly(jakarta.servlet.http.HttpServletResponse ignoredResponse, jakarta.servlet.http.HttpServletRequest ignoredRequest, org.openprovenance.prov.scala.nlgspec_transformer.specTypes.Phrase phrase)
jakarta.ws.rs.core.Response	conversion(jakarta.servlet.http.HttpServletResponse ignoredResponse, jakarta.ws.rs.core.Request request, org.openprovenance.prov.vanilla.Document document)
Map<?,?>	doPost(String url, String requestBody)
jakarta.ws.rs.core.Response	nlgExpander(jakarta.servlet.http.HttpServletResponse ignoredResponse, jakarta.ws.rs.core.Request ignoredRequest, PhraseEnvironment phraseEnvironment, String accept, String expandOnlyParam)
jakarta.ws.rs.core.Response	nlgExpanderWithQuery(jakarta.servlet.http.HttpServletResponse ignoredResponse, jakarta.ws.rs.core.Request ignoredRequest, PhraseEnvironment phraseEnvironment, String accept, String ignoredExpandOnlyParam)
jakarta.ws.rs.core.Response	nlgRealiser(jakarta.servlet.http.HttpServletResponse ignoredResponse, jakarta.ws.rs.core.Request ignoredRequest, org.openprovenance.prov.scala.wrapper.defs.Phrase phrase, String accept)
Map<String,String>	theDefaultConfiguration()

Methods inherited from class java.lang.Object

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

Field Details

defaultConfiguration

public Map<String,String> defaultConfiguration

Constructor Details

NlgService

public NlgService(PostService ps)

Method Details

theDefaultConfiguration

public Map<String,String> theDefaultConfiguration()

nlgRealiser

@POST
@Path("/nlg/realiser/")
@Consumes("application/json")
@Produces({"application/json","text/html","text/plain"})
public jakarta.ws.rs.core.Response nlgRealiser(@Context
 jakarta.servlet.http.HttpServletResponse ignoredResponse,
 @Context
 jakarta.ws.rs.core.Request ignoredRequest,
 org.openprovenance.prov.scala.wrapper.defs.Phrase phrase,
 @HeaderParam("Accept")
 String accept)

nlgExpander

@POST
@Path("/nlg/expander/")
@Consumes("application/json")
@Produces({"application/json","text/html","text/plain"})
public jakarta.ws.rs.core.Response nlgExpander(@Context
 jakarta.servlet.http.HttpServletResponse ignoredResponse,
 @Context
 jakarta.ws.rs.core.Request ignoredRequest,
 PhraseEnvironment phraseEnvironment,
 @HeaderParam("Accept")
 String accept,
 @HeaderParam("prov_xpand_only")
 String expandOnlyParam)

nlgExpanderWithQuery

@POST
@Path("/nlg/expander2/")
@Consumes("application/json")
@Produces({"application/json","text/html","text/plain"})
public jakarta.ws.rs.core.Response nlgExpanderWithQuery(@Context
 jakarta.servlet.http.HttpServletResponse ignoredResponse,
 @Context
 jakarta.ws.rs.core.Request ignoredRequest,
 PhraseEnvironment phraseEnvironment,
 @HeaderParam("Accept")
 String accept,
 @HeaderParam("prov_xpand_only")
 String ignoredExpandOnlyParam)

doPost

public Map<?,?> doPost(String url,
 String requestBody)
                throws IOException

Throws:

IOException

authenticate

@GET
@Path("/authenticate")
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response authenticate(@Context
 jakarta.servlet.http.HttpServletResponse ignoredResponse,
 @Context
 jakarta.servlet.http.HttpServletRequest ignoredRequest,
 @QueryParam("code")
 String code)
                                         throws IOException

Throws:

IOException

blockly

@POST
@Path("/xplan")
@Consumes("application/json")
@Produces("text/xml")
public jakarta.ws.rs.core.Response blockly(@Context
 jakarta.servlet.http.HttpServletResponse ignoredResponse,
 @Context
 jakarta.servlet.http.HttpServletRequest ignoredRequest,
 org.openprovenance.prov.scala.nlgspec_transformer.specTypes.Phrase phrase)
                                    throws jakarta.servlet.ServletException,
IOException

Throws:

jakarta.servlet.ServletException

IOException

conversion

@POST
@Path("/conversion")
@Consumes({"text/provenance-notation","application/ld+json","application/json"})
@Produces({"text/provenance-notation","application/json","application/ld+json","image/svg+xml","image/png","image/jpeg","application/pdf"})
public jakarta.ws.rs.core.Response conversion(@Context
 jakarta.servlet.http.HttpServletResponse ignoredResponse,
 @Context
 jakarta.ws.rs.core.Request request,
 org.openprovenance.prov.vanilla.Document document)