Package org.openprovenance.prov.service.xplain

Class NarrativeService

java.lang.Object

org.openprovenance.prov.service.xplain.NarrativeService

All Implemented Interfaces:

InteropMediaType, Constants, SwaggerTags

@Path("")
public class NarrativeService
extends Object
implements Constants, InteropMediaType, SwaggerTags

Field Summary

Fields

Modifier and Type	Field	Description
final NarrativeLogic	narrativeLogic

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.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, NARRATIVE, NLG, RANDOM, RESOURCES, TEMPLATE, VALIDATION, VIEW

Constructor Summary

Constructors

Constructor	Description
NarrativeService(PostService postService)
NarrativeService(PostService postService, List<ActionPerformer> performers, Optional<OtherActionPerformer> otherPerformer)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	explanationConfig(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, String explanationId)
jakarta.ws.rs.core.Response	explanationDetails(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, String explanationId, String accept)
jakarta.ws.rs.core.Response	explanationDetailsConfig(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, String explanationId)
jakarta.ws.rs.core.Response	explanations(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String docId, String explanationId, String accept)
jakarta.ws.rs.core.Response	explanationsDetailsForDoc(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, TemplateAndProfile tap, jakarta.ws.rs.core.UriInfo uriInfo, String accept)
jakarta.ws.rs.core.Response	explanationsForDoc(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, TemplateAndProfile tap, jakarta.ws.rs.core.UriInfo uriInfo, String accept)
jakarta.ws.rs.core.Response	linear_narrative(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, String accept)
jakarta.ws.rs.core.Response	random_nar(jakarta.servlet.http.HttpServletResponse response, jakarta.ws.rs.core.Request request, String msg, String accept)
jakarta.ws.rs.core.Response	svg4anim(jakarta.servlet.http.HttpServletResponse ignoredResponse, jakarta.ws.rs.core.Request ignoredRequest, String msg, String ignoredAccept)

Methods inherited from class java.lang.Object

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

Field Details

narrativeLogic

public final NarrativeLogic narrativeLogic

Constructor Details

NarrativeService

public NarrativeService(PostService postService)

NarrativeService

public NarrativeService(PostService postService,
 List<ActionPerformer> performers,
 Optional<OtherActionPerformer> otherPerformer)

Method Details

random_nar

@GET
@Path("/documents/{docId}/random_narrative")
public jakarta.ws.rs.core.Response random_nar(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.ws.rs.core.Request request,
 @PathParam("docId")
 String msg,
 @HeaderParam("Accept")
 String accept)

explanations

@GET
@Path("/documents/{docId}/explanation/{expid}")
@Produces("application/json")
public jakarta.ws.rs.core.Response explanations(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.ws.rs.core.Request request,
 @PathParam("docId")
 String docId,
 @PathParam("expid")
 String explanationId,
 @HeaderParam("Accept")
 String accept)

explanationDetails

@GET
@Path("/documents/{docId}/explanationdetails/{expid}")
@Produces("application/json")
public jakarta.ws.rs.core.Response explanationDetails(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.ws.rs.core.Request request,
 @PathParam("docId")
 String msg,
 @PathParam("expid")
 String explanationId,
 @HeaderParam("Accept")
 String accept)

svg4anim

@GET
@Path("/documents/{docId}/animation.svg")
@Produces("image/svg+xml")
public jakarta.ws.rs.core.Response svg4anim(@Context
 jakarta.servlet.http.HttpServletResponse ignoredResponse,
 @Context
 jakarta.ws.rs.core.Request ignoredRequest,
 @PathParam("docId")
 String msg,
 @HeaderParam("Accept")
 String ignoredAccept)
                                     throws IOException

Throws:

IOException

explanationDetailsConfig

@GET
@Path("/documents/{docId}/explanationdetails/{expid}/config")
@Produces("application/json")
public jakarta.ws.rs.core.Response explanationDetailsConfig(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.ws.rs.core.Request request,
 @PathParam("docId")
 String msg,
 @PathParam("expid")
 String explanationId)

explanationConfig

@GET
@Path("/documents/{docId}/explanation/{expid}/config")
@Produces("application/json")
public jakarta.ws.rs.core.Response explanationConfig(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.ws.rs.core.Request request,
 @PathParam("docId")
 String msg,
 @PathParam("expid")
 String explanationId)

explanationsForDoc

@POST
@Path("/documents/{docId}/explanation/")
@Produces("application/json")
@Consumes("application/json")
public jakarta.ws.rs.core.Response explanationsForDoc(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.ws.rs.core.Request request,
 @PathParam("docId")
 String msg,
 TemplateAndProfile tap,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @HeaderParam("Accept")
 String accept)

explanationsDetailsForDoc

@POST
@Path("/documents/{docId}/explanationdetails/")
@Produces("application/json")
@Consumes("application/json")
public jakarta.ws.rs.core.Response explanationsDetailsForDoc(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.ws.rs.core.Request request,
 @PathParam("docId")
 String msg,
 TemplateAndProfile tap,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @HeaderParam("Accept")
 String accept)

linear_narrative

@GET
@Path("/documents/{docId}/linear_narrative")
@Produces({"application/json","text/plain"})
public jakarta.ws.rs.core.Response linear_narrative(@Context
 jakarta.servlet.http.HttpServletResponse response,
 @Context
 jakarta.ws.rs.core.Request request,
 @PathParam("docId")
 String msg,
 @HeaderParam("Accept")
 String accept)