Service for Control of Named Entities

From MPDLMediaWiki
Revision as of 14:28, 25 April 2012 by Webers (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
eSciDoc SOA

SOAP and REST style interfaces
Service layers

Core services
Context Handler · Item Handler
Container Handler
Organizational Unit Handler
User Account Handler
Authentication
Content Model Handler
Semantic Store Handler

Intermediate services
Validation Service
Statistics Manager
Technical Metadata extraction
PIDManager
Basket Handler
Duplication detection
ImageHandler(Digilib)

Application services
Depositing
Searching
Search&Export
Control of Named Entities
Citation style Manager
RightsChecking
DataAcquisition
Transformation
Fledged Data
PID Cache
OAI-PMH

SOA Introduction

edit



The purpose of this service is to provide methods to deal with controlled lists of named entities to assure data quality and facilitate data access and data entry. Read more on the background here.

Introduction[edit]

The Control of named entities (Cone) service at present supports the named entity types listed below. 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 the following 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 (opt)q:String - the query (see below)
(opt)[predicate]: String - a value for a certain field (see below)
(opt)lang: String - the language as ISO 636-1 code
(opt)n: int - The maximum number of results that should be returned
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.
all implemented (opt)lang: String String Scope:Public
Gives back a list of all resources/ids in the given language (default 'en').

The query parameter q may contain a single term (e.g. q=nature) or multiple terms (e.g. q=psychology therapy). CoNE will return those entries that contain all terms in one or more of the searchable fields. Putting the query into quotes e.g. q="John Doe" will cause CoNE to search for exact matches, wildcards (*) are allowed. As an alternative to search all fields, it is also possible to search certain fields (predicates) by specifying the predicate name and a query similar to the syntax described above (e.g. foaf:family_name=Miller or http://purl.org/escidoc/metadata/terms/0.1/suffix="*x"). The namespace of the predicate can be given fully or as prefix, prefixes are predefined here.

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
options implemented HTTP Get-Request Format that can easily be read by Java to generate JSF options HTTPServlet usable by Java a.o.
json implemented HTTP Get-Request pure JSON HTTPServlet usable by Javascript/AJAX components
html implemented HTTP Get-Request (X)HTML HTTPServlet that provides a human readable overview on the data (planned to be used for author pages)
rdf implemented HTTP Get-Request RDF/XML HTTPServlet that provides a RDF view on the data
unapi planned HTTP Get-Request varying HTTPServlet that conforms to the unAPI interface specification
vcard planned HTTP Get-Request ASCII(UTF-8 for single values possible using BASE64 encoding?) HTTPServlet that conforms to the vCard specification (RFC2425)

Supported Named Entity Types[edit]

Currently, we support following vocabularies:

Journals[edit]

Languages[edit]

  • url to the language service interface (to be done)
  • metadata description (to be done)
  • example urls to the service (to be done)
  • Functional Specification to handle the entity (to be done)

Persons[edit]

DDC[edit]

  • Metadata description (to be done)
  • Functional Specification for handling entity (to be done)
  • Currently implemented: Dewey Decimal Classification

Mimetypes[edit]

A list of the IANA mimetype list plus additional mimetypes needed for PubMan (currently used for validation).

  • Metadata description (to be done)
  • Functional description for handling the entity (to be done)

eSciDoc mimetypes[edit]

A subset of the mimetypes list above. Planned to be used for PubMan in the future.

  • Metadata description (to be done)
  • Functional description for handling the entity (to be done)

Candidates for Named Entity Types[edit]

Potential further candidates for normalized metadata entries:

MPG Units[edit]

Potential metadata elements[edit]

Complete name In Englisch and/or German?

Alternative name

Place

Address

Homepage

Resources[edit]

Name of service Scope Info Formats supported Interfaces Costs Access
Körperschaftsnormdatei (GKD) More than 1 mio records (german&foreign corporate bodies and conferences) Introduction MAB2 Z39.50 see PND see PND

Conferences/events[edit]

Potential metadata elements[edit]

Title The name of the event (e.g. Symposium on Theory of Computing)

Alternative title Any alternative name of the event

Abbreviation Abbreviated name of the event (e.g. STOC)

Start date Start date of the event

End date End date of the event

Place Place where the event took place

Invitation status The information if the creator was explicitly invited

Remark Sabine: Should this information be stored in controlled metadata record?
Remark Ulla: No, not to my understanding
To my understanding, the invitation status can only be specified for each talk individually and is therefore no generic metadata for the conference --Inga 12:19, 28 December 2007 (CET)