Difference between revisions of "Service for Control of Named Entities"

	eSciDoc Solutions
	PubMan:; Overview · Functionalities; Interfaces · Support ;
	Faces:; Overview · Functionalities; Scope · Support ;
	ViRR:; Overview · Functionalities ; Scope · Support;
	imeji; Digitization Lifecycle;
	edit

Revision as of 08:51, 30 October 2008

This is a protected page.

Work in progress

Introduction[edit]

The Control of named entities (Cone) service at present supports the following named entity types:

Journals
Languages

It is integrated with PubMan in the publication metadata editing forms via "auto suggest" component for respective metadata edit fields (journal name, language of the publication).

Operations[edit]

The CoNE service supports two operations:

searching (based on the metadata of named entity i.e. in case of journals: journal name, publisher name, place of publication
retrieving details of selected named entity e.g. retrieving the metadata of a selected journal based on the journal identifier

Operation	Status	Input	Output	Description
query	implemented	q:String (opt)lang: String	String	Scope:Public Gives back a list of resources/ids in the given language (default 'en') matching the given query. The number of maximum hits given back is configurable (default 50).
details	implemented	id: String (opt)lang: String	String	Scope:Public Returns all available information on the resource in the given language (default 'en') identified by the given id.

Interfaces[edit]

The CoNE service comes with a flexible interface definition that defines the Input/Output formats. The following formats are available

Interface	Status	Input	Output	Description
jquery	implemented	HTTP Get-Request	jquery proprietary list, JSON	HTTPServlet used by jquery Javascript components for autosuggest features
json	planned	HTTP Get-Request	pure JSON	HTTPServlet usable by Javascript/AJAX components
html	planned	HTTP Get-Request	(X)HTML	HTTPServlet that provides a human readable overview on the data (planned to be used for author pages)
unapi	planned	HTTP Get-Request	varying	HTTPServlet that conforms to the unAPI interface specification

Current Interfaces[edit]

Journals[edit]

url to the journal service interface
metadata description
example urls to the service
url to the test-jsp

Languages[edit]

url to the language service interface
metadata description
example urls to the service

Future development[edit]

Offering the service for:
- Persons (Authors)
- DDC (Dewey Decimal Classification, first 3 public levels)
Integration of the new entity types with PubMan (editing of metadata for authors and subjects)
Extending the service with editing functionality for named entities
Planned schedule: PubMan Release 4.1

@@ Line 13: / Line 13: @@
 ==Operations==
-The Cone service supports two operations:
+The CoNE service supports two operations:
 *searching (based on the metadata of named entity i.e. in case of journals: journal name, publisher name, place of publication
 *retrieving details of selected named entity e.g. retrieving the metadata of a selected journal based on the journal identifier
+{| style=" height:340px" border="2"
+|- bgcolor="#ccccff"
+! width="150" |'''Operation'''
+! width="150" |'''Status'''
+!width="200"|'''Input'''
+! width="150" |'''Output'''
+!width="300"|'''Description'''
+|- style="height:33px"
+|query||implemented||q:String<br/>(opt)lang: String||String||Scope:'''Public''' <br/>Gives back a list of resources/ids in the given language (default 'en') matching the given query. The number of maximum hits given back is configurable (default 50).
+|-
+|details||implemented||id: String<br/>(opt)lang: String||String||Scope:'''Public''' <br/>Returns all available information on the resource in the given language (default 'en') identified by the given id.
+|}
+==Interfaces==
+The CoNE service comes with a flexible interface definition that defines the Input/Output formats. The following formats are available
+{| style=" height:340px" border="2"
+|- bgcolor="#ccccff"
+! width="150" |'''Interface'''
+! width="150" |'''Status'''
+!width="200"|'''Input'''
+! width="150" |'''Output'''
+!width="300"|'''Description'''
+|- style="height:33px"
+|jquery||implemented||HTTP Get-Request||jquery proprietary list, JSON||HTTPServlet used by jquery Javascript components for autosuggest features
+|-
+|json||planned||HTTP Get-Request||pure JSON||HTTPServlet usable by Javascript/AJAX components
+|-
+|html||planned||HTTP Get-Request||(X)HTML||HTTPServlet that provides a human readable overview on the data (planned to be used for author pages)
+|-
+|unapi||planned||HTTP Get-Request||varying||HTTPServlet that conforms to the unAPI interface specification
+|-
+|}
 ==Current Interfaces==