FishFinderTMPlugin

From Gcube Wiki
Jump to: navigation, search

FishFinder TM Plugin (it was erroneously named FIGIS until gCube 2.17) is a plugin of the Tree Based Access Facilities that defines and maintains tree views of factsheets produced by the FIGIS group and exposed by the FIGIS APIs.

Each fact sheet retrieved by FIGIS APIs is transformed in an edge-labelled tree by FishFinder TM Plugin.

Plugin parameters fields

The Plugin requires two parameters:

  • source name: a name of the source; it will be used as identifier for the collection, e.g. "c13e3995-c85f-4cac-a026-e9e1ab6906d5";
  • description: information about the source.

Tree model

Conceptual Schema

A tree generated by FishFinderTMPlugin has a flat structure that reflects the CSV file structure:

  • title: name of the fact sheet composed by the scientific name with authorship information, e.g. "Sarda chiliensis (Cuvier, 1831) - Fact sheet";
  • three_alpha_code: three letters to identify the fact sheet;
  • name_en: the english common name of the species which the fact sheet refers to;
  • name_fr: the french common name of the species which the fact sheet refers to;
  • name_es: the spanish common name of the species which the fact sheet refers to;
  • images: url to the species image;
  • scientific_name: the scientific name of the species which the fact sheet refers to;
  • family: the scientific name of the family in which the scientific name is classified;
  • personal_author: the authorship information for the scientific_name;
  • year: the four-digit year in which the scientific name was published;
  • diagnostic_features: information about the species;
  • area_text: a free text area;
  • habitat_bio: information about the habitat;
  • interest_fisheries: information about the fishery;
  • local_names: a list of couples "common name, country"; the country is where such common name is used.
  • factsheet_url: url of the fact sheet;
  • factsheet_id: the identifier of the fact sheet.

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="three_alpha_code" type="xs:string"/>
                            <xs:element name="name_en" type="xs:string"/>
                            <xs:element name="name_fr" type="xs:string"/>
                            <xs:element name="name_es" type="xs:string"/>
                            <xs:element name="images" type="xs:string"/>
                            <xs:element name="scientific_name" type="xs:string"/>
                            <xs:element name="family" type="xs:string"/>
                            <xs:element name="personal_author" type="xs:string"/>
                            <xs:element name="year" type="xs:gYear"/>
                            <xs:element name="diagnostic_features" type="xs:string"/>
                            <xs:element name="area_text" type="xs:string"/>
                            <xs:element name="habitat_bio" type="xs:string"/>
                            <xs:element name="interest_fisheries" type="xs:string"/>
                            <xs:element name="local_names" type="xs:string"/>
                            <xs:element name="factsheet_url" type="xs:anyURI"/>
                            <xs:element name="factsheet_id" type="xs:string"/>
                        </xs:sequence>
                     <xs:attribute name="xmlns:t" type="xs:string"/>
                     <xs:attribute name="t:id" type="xs:string"/>
                     <xs:attribute name="t:source" type="xs:string"/>
                 </xs:complexType>
          </xs:element>
   </xs:schema>

Example

A tree generated by FishFinder TM Plugin looks like this:

<?xml version="1.0" ?>
 
<t:root xmlns:t="http://gcube-system.org/namespaces/data/trees"	t:id="BEP" t:source="c13e3995-c85f-4cac-a026-e9e1ab6906d5">
 
	<title>Sarda chiliensis (Cuvier, 1831) - Fact sheet</title>
	<three_alpha_code>BEP</three_alpha_code>
	<name_en>Eastern Pacific bonito</name_en>
	<name_fr>Bonite du Pacifique oriental</name_fr>
	<name_es>Bonito del Pacífico oriental</name_es>
	<images>http://www.fao.org/figis/species/images/Sarda/sco_sar_chi_web_3275_0.gif</images>
	<scientific_name>Sarda chiliensis</scientific_name>
	<family>Scombridae</family>
	<personal_author>(Cuvier, 1831)</personal_author>
	<year>1831</year>
	<diagnostic_features>Upper jaw teeth 18 to 30; lower jaw teeth 14 to
		25; vomerine teeth absent; supramaxilla wide (Collette &amp; Chao,
		1975:fig. 32d) 23 to 27 gillrakers on first arch. First dorsal fin
		with 17 to 19 spines, length of fin base 26.7 to 31.4% of fork length
		; dorsal finlets usually 8; 12 to 15 rays in anal fin; anal finlets
		usually 6 or 7; pectoral fin rays 22 to 26, usually 24 or 25.
		Vertebrae 22 to 24 precaudal plus 20 to 23 caudal, total 42 to 46,
		usually 44 or 45. Colour: dorsal stripes slightly oblique.
	</diagnostic_features>
	<area_text>Restricted to the eastern Pacific Ocean (Collette &amp;
		Chao, 1975:fig. 70). Its geographical range includes a northern and a
		southern subspecies separated by a tropical population of Sarda
		orientalis . The southern subspecies S. chiliensis chiliensis, occurs
		from Mancora, Peru, just south of the Gulf of Guayaquil southward to
		Talcahuano, Chile. The northern subspecies S. chiliensis lineolata
		(Girard) occurs from off the coast of Alaska (60° 16'N, 145° 32'W)
		southward to Cabo San Lucas at the tip of Baja California (22° 20'N,
		112° 27'W and in the Revillagigedo Islands).</area_text>
	<habitat_bio>An epipelagic, neritic species attaining sexual maturity
		at about 2 years of age.</habitat_bio>
	<interest_fisheries>In California, eastern Pacific bonito is taken
		commercially by purse seiners, but is more important to the
		recreational hooks and lines fishery operating from private and party
		boats, piers and jetties, and from the shore (Yoshida, 1980:42). In
		the mid-sixties, the Chilean bonito fishery between lquique and
		Antofagasta expanded from an almost entirely artisanal activity with
		floating gillnets and small purse seines to an industrial operation
		with specialized bonito/tuna vessels (Yoshida, 1980:42). The landings
		of the northern subspecies ( S. c. lineolata ) in California and
		Mexico have fluctuated greatly over the last 50 years from less than 1
		000 metric tons to nearly 14 000 t in the early seventies, ranking in
		13th place (4 003 t worth $1 222 000) in total California landings of
		1976. The Peruvian landings of the southern subspecies ( S. c.
		chiliensis ) increased from almost nil in 1940 to a peak of 110 000 t
		per year in the early sixties, thereafter gradually dropping off to 40
		000 t in the mid-seventies (Yoshida, 1980:44). The world catch for the
		species as a whole was down to between 10 219 t in 1976 and 15 936 t
		in 1981, reaching 21 308 t in 1977 (FAO, 1983). The total catch
		reported for this species to FAO for 1999 was 3 187 t. The countries
		with the largest catches were Mexico (1 775 t) and Peru (948 t).
	</interest_fisheries>
	<local_names>Bonito (Chile),Bonito (Colombia),Bonito (Mexico),Aguadito
		(Peru),Chilensk bonit (Sweden),Pacific bonito (USA),Chilijskaya
		pelamida (Former ussr)</local_names>
	<factsheet_url>http://www.fao.org/fishery/species/3275/en
	</factsheet_url>
	<factsheet_id></factsheet_id>
 
</t:root>

Maven coordinates

The Maven coordinates of fishfinder-tm-plugin of its development versions will be:

<groupId>org.gcube.data.access</groupId>
<artifactId>fishfinder-tm-plugin</artifactId>
<version>[1.2.0-SNAPSHOT,2.0.0-SNAPSHOT)</version>

Until gCube 2.17 fishfinder-tm-plugin was called figis-tm-plugin and its coordinates were:

<groupId>org.gcube.data.access</groupId>
<artifactId>figis-tm-plugin</artifactId>
<version>[1.0.0-SNAPSHOT,1.2.0-SNAPSHOT)</version>