fr.cnes.doi.resource.citation

Class FormatCitationResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.restlet.ext.wadl.WadlServerResource

fr.cnes.doi.resource.AbstractResource

fr.cnes.doi.resource.citation.BaseCitationResource

fr.cnes.doi.resource.citation.FormatCitationResource

public class FormatCitationResource
extends BaseCitationResource

Formats a citation. CrossRef, DataCite and mEDRA support formatted citations via the text/bibliography content type. These are the output of the Citation Style Language processor, citeproc-js. The content type can take two additional parameters to customise its response format.

"\"style\" can be chosen from the list of style names found in the CSL style repository. Many styles are supported, including common styles such as apa and harvard3

Author:

Jean-Christophe Malapert (jean-christophe.malapert@cnes.fr)

Field Summary

Fields

Modifier and Type	Field and Description
private String	doiName The digital object identifier to format.
private String	language The language to format.
private String	style The style of formatting.

Fields inherited from class fr.cnes.doi.resource.citation.BaseCitationResource

DOI_PARAMETER, LANG_PARAMETER, LOG, STYLE_PARAMETER

Constructor Summary

Constructors

Constructor and Description
FormatCitationResource()

Method Summary

Modifier and Type	Method and Description
private void	checkInputs() Checks input parameters
protected void	describeGet(org.restlet.ext.wadl.MethodInfo info) Describes the Get Method.
protected void	doInit() Init by getting doi, lang and style values.
String	getFormat() Returns the formatted citation.

Methods inherited from class fr.cnes.doi.resource.citation.BaseCitationResource

getApp, listRepresentation

Methods inherited from class fr.cnes.doi.resource.AbstractResource

addRequestDocToMethod, addRequestDocToMethod, addRequestDocToMethod, addResponseDocToMethod, createQueryParamDoc, createQueryRepresentationDoc, createResponseDoc, createResponseDoc, createResponseDoc, htmlRepresentation, isObjectExist, isObjectNotExist, isValueExist, isValueNotExist, stringRepresentation

Methods inherited from class org.restlet.ext.wadl.WadlServerResource

canDescribe, createHtmlRepresentation, createWadlRepresentation, describe, describe, describe, describe, describe, describe, describe, describe, describeDelete, describeMethod, describeMethod, describeOptions, describeParameters, describePatch, describePost, describePut, getDescription, getName, getParameter, getParameters, getPreferredWadlVariant, getResourcePath, getResourcesBase, getWadlVariants, isAutoDescribing, options, setAutoDescribing, setDescription, setName

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doNegotiatedHandle, get, get, getAttribute, getInfo, getInfo, getOnSent, getPreferredVariant, getRole, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, patch, patch, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDimensions, setExisting, setLocationRef, setLocationRef, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toBoolean, toByte, toDouble, toFloat, toInteger, toLong, toObject, toRepresentation, toRepresentation, toRepresentation, toShort, toString

Methods inherited from class java.lang.Object

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

Field Detail

doiName

private volatile String doiName

The digital object identifier to format.

style

private volatile String style

The style of formatting.

language

private volatile String language

The language to format.

Constructor Detail

FormatCitationResource

public FormatCitationResource()

Method Detail

doInit

protected void doInit()
               throws org.restlet.resource.ResourceException

Init by getting doi, lang and style values.

Overrides:

doInit in class BaseCitationResource

Throws:

org.restlet.resource.ResourceException - - if a problem happens

getFormat

@Requirement(reqId="DOI_SRV_120",reqName="Formatage d\u2019une citation") @Requirement(reqId="DOI_MONIT_020",reqName="Monitoring de l\'\u00e9tat de DataCite")
 @Get
public String getFormat()
                                                                                                                                                                                      throws org.restlet.resource.ResourceException

Returns the formatted citation.

Returns:

the formatted citation

Throws:

org.restlet.resource.ResourceException - - if a problem happens when requesting Cross Cite or if BaseCitationResource.DOI_PARAMETER and BaseCitationResource.LANG_PARAMETER and BaseCitationResource.STYLE_PARAMETER are not set

checkInputs

private void checkInputs()
                  throws org.restlet.resource.ResourceException

Checks input parameters

Throws:

org.restlet.resource.ResourceException - - if BaseCitationResource.DOI_PARAMETER and BaseCitationResource.LANG_PARAMETER and BaseCitationResource.STYLE_PARAMETER are not set

describeGet

@Requirement(reqId="DOI_DOC_010",
             reqName="Documentation des interfaces")
protected final void describeGet(org.restlet.ext.wadl.MethodInfo info)

Describes the Get Method.

Overrides:

describeGet in class org.restlet.ext.wadl.WadlServerResource

Parameters:

info - Wadl description