eu.ehri.extension

Class CvocConceptResource

java.lang.Object

eu.ehri.extension.base.AbstractResource

eu.ehri.extension.base.AbstractAccessibleResource<Concept>

eu.ehri.extension.CvocConceptResource

All Implemented Interfaces:

DeleteResource, GetResource, ListResource, ParentResource, TxCheckedResource, UpdateResource

public class CvocConceptResource
extends AbstractAccessibleResource<Concept>
implements ParentResource, GetResource, ListResource, UpdateResource, DeleteResource

Provides a web service interface for the Concept model. Note that the concept creation endpoint is part of the VocabularyResource and creation without a Vocabulary is not possible via this API.

Nested Class Summary

Nested classes/interfaces inherited from class eu.ehri.extension.base.AbstractAccessibleResource

AbstractAccessibleResource.Handler<E extends Accessible>, AbstractAccessibleResource.NoOpHandler<E extends Accessible>

Field Summary

Fields inherited from class eu.ehri.extension.base.AbstractAccessibleResource

aclManager, actionManager, AGGREGATION_PARAM, cls, EVENT_TYPE_PARAM, FROM_PARAM, ITEM_ID_PARAM, ITEM_TYPE_PARAM, SHOW_PARAM, TO_PARAM, USER_PARAM

Fields inherited from class eu.ehri.extension.base.AbstractResource

ACCESSOR_PARAM, ALL_PARAM, AUTH_HEADER_NAME, COMMIT_PARAM, CSV_MEDIA_TYPE, DEFAULT_LIST_LIMIT, FILTER_PARAM, graph, GROUP_PARAM, ID_PARAM, INCLUDE_PROPS_PARAM, ITEM_CACHE_TIME, jsonFactory, jsonMapper, LIMIT_PARAM, LOG_MESSAGE_HEADER_NAME, LOG_PARAM, logger, manager, N3_MIMETYPE, OFFSET_PARAM, PATCH_HEADER_NAME, RANGE_HEADER_NAME, RDF_MIMETYPE_FORMATS, RDF_XML_MIMETYPE, request, requestHeaders, RESOURCE_ENDPOINT_PREFIX, SCOPE_PARAM, SORT_PARAM, STREAM_HEADER_NAME, TOLERANT_PARAM, TURTLE_MIMETYPE, uriInfo, VERSION_PARAM

Constructor Summary

Constructors

Constructor and Description
CvocConceptResource(org.neo4j.graphdb.GraphDatabaseService database)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addNarrowerCvocConcept(String id, List<String> narrower) Add an existing concept to the list of 'narrower' relations.
javax.ws.rs.core.Response	addRelatedCvocConcept(String id, List<String> related) Add a relation by creating the 'related' edge between the two existing items.
javax.ws.rs.core.Response	createChild(String id, Bundle bundle, List<String> accessors) Create a subordinate resource.
void	delete(String id) Delete a resource.
javax.ws.rs.core.Response	get(String id) Fetch a resource by id.
javax.ws.rs.core.Response	getCvocBroaderConcepts(String id) List broader concepts.
javax.ws.rs.core.Response	getCvocRelatedByConcepts(String id) List concepts related to another concept.
javax.ws.rs.core.Response	getCvocRelatedConcepts(String id) List concepts related to another concept.
javax.ws.rs.core.Response	list() List available resources.
javax.ws.rs.core.Response	listChildren(String id, boolean all) List available resources subordinate to this item.
javax.ws.rs.core.Response	removeNarrowerCvocConcept(String id, List<String> narrower) Remove a narrower relationship between two concepts.
javax.ws.rs.core.Response	removeRelatedCvocConcept(String id, List<String> related) Remove a relation by deleting the edge, not the vertex of the related concept.
javax.ws.rs.core.Response	update(String id, Bundle bundle) Update a resource.

Methods inherited from class eu.ehri.extension.base.AbstractAccessibleResource

createItem, createItem, createItem, deleteItem, deleteItem, exportItemsAsZip, getAccessors, getEventsApi, getItem, listItems, updateItem, updateItem

Methods inherited from class eu.ehri.extension.base.AbstractResource

anonymousApi, api, beginTx, creationResponse, getCacheControl, getCurrentActioner, getCurrentUser, getGraph, getIntQueryParam, getItemUri, getLogMessage, getQuery, getRdfFormat, getRequesterUserProfile, getSerializer, getStringListQueryParam, isPatch, isStreaming, single, streamingList, streamingList, streamingListOfLists, streamingPage, streamingPage, streamingVertexList, streamingVertexList

Methods inherited from class java.lang.Object

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

Constructor Detail

CvocConceptResource

public CvocConceptResource(@Context
                           org.neo4j.graphdb.GraphDatabaseService database)

Method Detail

get

public javax.ws.rs.core.Response get(String id)
                              throws ItemNotFound

Description copied from interface: GetResource

Fetch a resource by id.

Specified by:

get in interface GetResource

Parameters:

id - The requested item id

Returns:

A serialized item representation

Throws:

ItemNotFound

list

public javax.ws.rs.core.Response list()

Description copied from interface: ListResource

List available resources. The default behaviour is to return a page of 20 items.

The default list limit can be overridden using the limit parameter, and disabled completely using a value of -1.

Item lists are paginated using the page parameter.

The page, limit, and total number of items is returned in the Content-Range response header in the form:

page=1; count=20; total=50

If the header X-Stream is set to true no count of total items will be performed. This is more efficient when returning large numbers of items or when limiting is disabled completely. Example:

      
 curl http://localhost:7474/ehri/[RESOURCE]/list?page=5&limit=10
      
 

Specified by:

list in interface ListResource

Returns:

A list of serialized item representations

update

public javax.ws.rs.core.Response update(String id,
                                        Bundle bundle)
                                 throws PermissionDenied,
                                        ValidationError,
                                        DeserializationError,
                                        ItemNotFound

Description copied from interface: UpdateResource

Update a resource.

Specified by:

update in interface UpdateResource

Parameters:

id - The resource ID.

bundle - A resource bundle, with or without an ID.

Returns:

A serialized representation of the updated resource.

Throws:

PermissionDenied

ValidationError

DeserializationError

ItemNotFound

delete

public void delete(String id)
            throws PermissionDenied,
                   ItemNotFound,
                   ValidationError

Description copied from interface: DeleteResource

Delete a resource.

Specified by:

delete in interface DeleteResource

Parameters:

id - The resource ID.

Throws:

PermissionDenied

ItemNotFound

ValidationError

listChildren

public javax.ws.rs.core.Response listChildren(String id,
                                              boolean all)
                                       throws ItemNotFound

Description copied from interface: ParentResource

List available resources subordinate to this item. Behaviour is the same as the general list method with respect to parameters.

Example:

     
 curl http://localhost:7474/ehri/[RESOURCE]/[ID]/list
     
 

Specified by:

listChildren in interface ParentResource

Returns:

A list of serialized item representations

Throws:

ItemNotFound

createChild

public javax.ws.rs.core.Response createChild(String id,
                                             Bundle bundle,
                                             List<String> accessors)
                                      throws PermissionDenied,
                                             ValidationError,
                                             DeserializationError,
                                             ItemNotFound

Description copied from interface: ParentResource

Create a subordinate resource.

Specified by:

createChild in interface ParentResource

Parameters:

id - The parent resource ID.

bundle - A resource bundle.

accessors - The users/groups who can access this item.

Returns:

A serialized representation of the created resource.

Throws:

PermissionDenied

ValidationError

DeserializationError

ItemNotFound

addNarrowerCvocConcept

public javax.ws.rs.core.Response addNarrowerCvocConcept(String id,
                                                        List<String> narrower)
                                                 throws AccessDenied,
                                                        PermissionDenied,
                                                        ItemNotFound

Add an existing concept to the list of 'narrower' relations.

Parameters:

id - the item ID

narrower - the narrower item IDs

Throws:

AccessDenied

PermissionDenied

ItemNotFound

removeNarrowerCvocConcept

public javax.ws.rs.core.Response removeNarrowerCvocConcept(String id,
                                                           List<String> narrower)
                                                    throws PermissionDenied,
                                                           AccessDenied,
                                                           ItemNotFound

Remove a narrower relationship between two concepts.

Parameters:

id - the item ID

narrower - the narrower item IDs

Throws:

PermissionDenied

AccessDenied

ItemNotFound

getCvocBroaderConcepts

public javax.ws.rs.core.Response getCvocBroaderConcepts(String id)
                                                 throws ItemNotFound,
                                                        AccessDenied

List broader concepts.

Parameters:

id - The item ID

Returns:

A list of broader resources

Throws:

ItemNotFound

AccessDenied

getCvocRelatedConcepts

public javax.ws.rs.core.Response getCvocRelatedConcepts(String id)
                                                 throws ItemNotFound

List concepts related to another concept.

Parameters:

id - The item ID

Returns:

A list of related resources

Throws:

ItemNotFound

getCvocRelatedByConcepts

public javax.ws.rs.core.Response getCvocRelatedByConcepts(String id)
                                                   throws ItemNotFound

List concepts related to another concept. This is the "reverse" form of the "/related" method.

Parameters:

id - The item ID

Returns:

A list of related resources

Throws:

ItemNotFound

addRelatedCvocConcept

public javax.ws.rs.core.Response addRelatedCvocConcept(String id,
                                                       List<String> related)
                                                throws AccessDenied,
                                                       PermissionDenied,
                                                       ItemNotFound

Add a relation by creating the 'related' edge between the two existing items.

Parameters:

id - the item ID

related - the related item IDs

Throws:

AccessDenied

PermissionDenied

ItemNotFound

removeRelatedCvocConcept

public javax.ws.rs.core.Response removeRelatedCvocConcept(String id,
                                                          List<String> related)
                                                   throws AccessDenied,
                                                          PermissionDenied,
                                                          ItemNotFound

Remove a relation by deleting the edge, not the vertex of the related concept.

Parameters:

id - the item ID

related - the related item ID

Throws:

AccessDenied

PermissionDenied

ItemNotFound