OAITMPlugin

From Gcube Wiki
Revision as of 17:25, 16 April 2013 by Valentina.marioli (Talk | contribs) (→‎Example)

Jump to: navigation, search

OAI TM Plugin is a plugin of the Tree Based Access Facilities that allows harvesting of metadata descriptions of the records in an archive, using The Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH).

Each OAI Record is transformed in a edge-labelled tree by OAI TM Plugin.

Plugin parameters fields

Plugins lead to the creation of one or more collections. Thus, in addition to the information below, the user should specify collection name and description.

In order to instruct a Plugin on how to perform the harvesting, a user should specify the following mandatory information:

  • repository name: the name of the repository to be harvested, e.g. "aquacomm";
  • base URL: the base URL of the repository, e.g. "http://aquacomm.fcla.edu/cgi/oai2";
  • default metadata format: the metadata format to be used for harvesting, e.g. "oai_dc";
  • title XPath: the expression for identifying the title of the harvested resource, e.g. "//*[local-name()='title']";

In addition to that, the user might specify the following information:

  • content XPath: the expression for identifying the content of the harvested resource, e.g. "//*[local-name()='identifier' and contains(.,'://')]";
  • alternatives XPath: the expression for identifying additional content of the harvested resource, e.g. "//*[local-name()='relation' and contains(.,'://')]";
  • set Identifiers List: the list of id of the sets to take into consideration during the harvesting phase;

Two typologies of plugins have been defined:

  • WrapSetsRequest: to create a collection for each set of the external repository or for each set specified in the setIdentifierList;
  • WrapRepositoryRequest: to create a single collection containing the whole content of the repository or the content of the sets specified in the setIdentifierList;

Tree model

Conceptual Schema

Each collection item produced by this plugin is characterised by the following information:

  • item metadata: global information on the item including
    • title: the title of the record;
    • collectionID: the collection this item belongs to;
    • creationTime: the time the item was created;
    • lastUpdateTime: the most recent time the item has been updated;
    • provenance: It is characterised by the following information:
      • statement: "This item has been created by the gCube "+ pluginName +" via OAI-PMH metadata harvesting from the metadata provider "+repositoryName+" at "+baseURL;
      • setID: the repository set the object belongs to (optional and repeatable);
      • recordID: the identifier of the metadata record;
  • metadata (repeatable): the metadata record harvested. It is characterised by the following information:
    • schema: the metadata format of the metadata record;
    • schemaLocation: the metadata format schema URI;
    • record: the manifestation of the metadata record harvested;
  • content (repeatable): any potential payload shipped with the metadata record. It is characterised by the following information:
    • contentType: i.e. whether main or alternative content;
    • mimeType: MIME type of the actual content;
    • url: URL to the actual content;

XML Schema

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" >
       <xs:element name="t:root" >
              <xs:complexType>
                     <xs:sequence>
                            <xs:element name="title" type="xs:string" />
                            <xs:element name="collectionID" type="xs:string" />
                            <xs:element name="creationTime" type="xs:string" />
                            <xs:element name="lastUpdateTime" type="xs:string" />
                            <xs:element name="provenance" >
                                   <xs:complexType>
                                          <xs:sequence>
                                                 <xs:element name="statement" type="xs:string" />
                                                 <xs:element name="setID" type="xs:string" maxOccurs="unbounded" />
                                                 <xs:element name="recordID" type="xs:string" />
                                             </xs:sequence>
                                      </xs:complexType>
                               </xs:element>
                            <xs:element name="metadata" >
                                   <xs:complexType>
                                          <xs:sequence>
                                                 <xs:element name="schema" type="xs:string" />
                                                 <xs:element name="schemaLocation" type="xs:string" />
                                                 <xs:element name="record" type="xs:string" />
                                             </xs:sequence>
                                      </xs:complexType>
                               </xs:element>
                            <xs:element name="content" maxOccurs="unbounded" minOccurs="0">
                                   <xs:complexType>
                                          <xs:sequence>
                                                 <xs:element name="contentType" type="xs:string" />
                                                 <xs:element name="mimeType" type="xs:string" />
                                                 <xs:element name="url" type="xs:string" />
                                             </xs:sequence>
                                      </xs:complexType>
                               </xs:element>
                        </xs:sequence>
                     <xs:attribute name="xmlns:t" type="xs:string" />
                     <xs:attribute name="t:id" type="xs:string" />
                 </xs:complexType>
          </xs:element>
   </xs:schema>

Example

A tree generated by OAI TM Plugin looks like this: 

<?xml version="1.0" ?>
 
<t:root xmlns:t="http://gcube-system.org/namespaces/data/trees" t:id="oai:generic.eprints.org:16">
 
	<title>Southern California partyboat angler survey</title>
	<collectionID>7375626A656374733D54</collectionID>
	<creationTime>2011-09-29T22:41:21.000+02:00</creationTime>
	<lastUpdateTime>2011-09-29T22:41:21.000+02:00</lastUpdateTime>
 
	<provenance>
		<statement>This item has been created by the gCube OAI-TM plugin via OAI-PMH metadata harvesting from the metadata provider aquacomm at http://aquacomm.fcla.edu/cgi/oai2</statement>
		<setID>7375626A656374733D54</setID>
                <setID>7375626A656374733D48</setID>
                <setID>7375626A656374733D44</setID>
                <setID>74797065733D6D6F6E6F6772617068</setID>
		<recordID>oai:generic.eprints.org:16</recordID>
	</provenance>
 
	<metadata>
		<schema>oai_dc</schema>
		<schemaLocation>http://www.openarchives.org/OAI/2.0/oai_dc/</schemaLocation>
		<record>
			<oai_dc:dc xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
			xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd" xmlns:dc="http://purl.org/dc/elements/1.1/">
				<dc:title>The Distribution of Kemp's Ridley Sea Turtles (Lepidochelys kempi) Along the Texas Coast: An Atlas</dc:title>
				<dc:creator>Manzella, Sharon A.</dc:creator>
				<dc:creator>Williams, Jo A.</dc:creator>
				<dc:subject>Conservation</dc:subject>
				<dc:subject>Management</dc:subject>
				<dc:subject>Fisheries</dc:subject>
				<dc:description>Eight hundred sixty-five records of Kemp's ridley sea turtles (Lepidochelys kempi) reported from Texas between the late 1940's to April 1990 were compiled from six data
				bases and the literature, then plotted on a series of Texas maps. Four categories of Kemp's ridleys are identified throughout the atlas: head-started (turtles that are raised in captivity their first year of life), wild, historical (pre-1980), and nesters. Geographic, seasonal, and size distributions of the turtle categories are plotted by regions. Most Kemp's ridleys were reported from the northeast and central Texas coast. They were
				reported from both inshore (landward of barrier islands) and offshore (seaward of barrier islands). Scattered nestings occurred in the central to southern regions. Kemp's
				ridleys were found more often during the spring and summer. A total of 546 turtle records contained measurements; most were 20-59.9 cm curved carapace length and considered sub-adults. Comparison of distributions of head-started and wild Kemp's ridleys suggests head-started Kemp's ridleys inhabit the same areas as wild Kemp's ridleys. (PDF file contains 56 pages.)</dc:description>
				<dc:publisher>NOAA/National Marine Fisheries Service</dc:publisher>
				<dc:date>1992</dc:date>
				<dc:type>Monograph or Serial issue</dc:type>
				<dc:type>NonPeerReviewed</dc:type>
				<dc:format>application/pdf</dc:format>
				<dc:identifier>http://aquaticcommons.org/2705/1/tr110.pdf</dc:identifier>
				<dc:relation>jttp://spo.nwr.noaa.gov/tr110.pdf</dc:relation>
				<dc:identifier>Manzella, Sharon A. and Williams, Jo A. (1992) The Distribution of Kemp's Ridley Sea Turtles (Lepidochelys kempi) Along the Texas Coast: An Atlas. NOAA/National Marine Fisheries Service, (NOAA Technical Report NMFS, 110)</dc:identifier>
				<dc:relation>http://aquaticcommons.org/2705/</dc:relation>
			</oai_dc:dc>
		</record>
	</metadata>
 
	<content>
		<contentType>main</contentType>
		<mimeType>text/url</mimeType>
		<url>http://aquaticcommons.org/16/1/Marine_Resources_Administrative_Report_No._80%2D7.pdf</url>
	</content>
 
	<content>
		<contentType>alternative</contentType>
		<mimeType>text/html; charset=UTF-8</mimeType>
		<url>http://aquaticcommons.org/16/</url>
	</content>
 
</t:root>

Maven coordinates

The Maven coordinates of oai-tree-plugin of its development versions are: 

<dependency>
  <groupId>org.gcube.data.oai.tmplugin</groupId>
  <artifactId>oai-tm-plugin</artifactId>
  <version>1.1.0-2.13.0</version>
</dependency>
Retrieved from "https://gcube.wiki.gcube-system.org/index.php?title=OAITMPlugin&oldid=18466"