diff --git a/src/main/java/org/gcube/portlets/user/speciesdiscovery/client/resources/Resources.java b/src/main/java/org/gcube/portlets/user/speciesdiscovery/client/resources/Resources.java index 62b6a1b..b3b84d0 100644 --- a/src/main/java/org/gcube/portlets/user/speciesdiscovery/client/resources/Resources.java +++ b/src/main/java/org/gcube/portlets/user/speciesdiscovery/client/resources/Resources.java @@ -160,5 +160,9 @@ public interface Resources extends ClientBundle { @Source("attention.png") ImageResource getAttention(); + + @Source("help.html") + TextResource help(); + } diff --git a/src/main/java/org/gcube/portlets/user/speciesdiscovery/client/resources/help.html b/src/main/java/org/gcube/portlets/user/speciesdiscovery/client/resources/help.html new file mode 100644 index 0000000..ab07352 --- /dev/null +++ b/src/main/java/org/gcube/portlets/user/speciesdiscovery/client/resources/help.html @@ -0,0 +1,343 @@ +
Search all the products about the scientific name 'sarda sarda' in all available datasources.
+SEARCH BY SN 'sarda sarda'
+ +Search all the products about 'sarda sarda' and his synonyms in OBIS, in all available datasources.
+SEARCH BY SN 'sarda sarda' EXPAND WITH OBIS
+ +Search all the products about 'sarda sarda' and his synonyms found in OBIS, in ITIS datasource.
+SEARCH BY SN 'sarda sarda' EXPAND WITH OBIS IN ITIS
+ +Search all the Taxa about 'sarda sarda' and his synonyms found in OBIS, in ITIS datasource.
+SEARCH BY SN 'sarda sarda' EXPAND WITH OBIS IN ITIS RETURN TAXON
+ +Search all the products about the scientific names retrieved searching the common 'shark' in the datasource OBIS and mapping it into a scientific name using ITIS. Accept only the results with coordinate less or equals to (15.12, 16.12).
+SEARCH BY CN 'shark' RESOLVE WITH OBIS EXPAND WITH ITIS WHERE coordinate <= 15.12, 16.12 RETURN Product
+ +Search all the occurrence points about the scientific names 'sarda sarda' and 'Carcharodon carcharias' expanded with synonyms from datasource OBIS, found in ITIS and with an event date between 2000 and 2005.
+SEARCH BY SN 'sarda sarda', 'Carcharodon carcharias' EXPAND WITH OBIS IN ITIS WHERE eventDate >= '2000' AND eventDate <= '2005' RETURN Occurrence
+ +Search all the products about the scientific names retrieved searching the common 'shark' in the datasource OBIS and mapping it into a scientific name using ITIS. Accept only the results with coordinate less or equals to (15.12, 16.12). Results are post filtered using the xpath expression "//product[type='TAXON' and counter>0]".
+SEARCH BY CN 'shark' RESOLVE WITH OBIS EXPAND WITH ITIS WHERE coordinate <= 15.12, 16.12 RETURN Product HAVING xpath("//product[type='TAXON' and counter>0]")
+ + +
+SEARCH BY term [, ...]
+ [ IN datasource [, ...] ]
+ [ WHERE condition [AND condition] ]
+ [ RETURN {PRODUCT | OCCURRENCE | TAXON} ]
+ [ HAVING having expression ]
+
+
+Where term can be one of:
+ +
+CN common name [, ...] RESOLVE [ WITH datasource [, ...] ] [EXPAND [ WITH datasource [, ...] ] ]
+SN scientific name [, ...] [EXPAND [ WITH datasource [, ...] ] ]
+
+
+
+Where condition can be one of:
+
+coordinate {< | <= | == | => | >} LAT, LONG
+eventDate {< | <= | == | => | >} DATE
+
+
+
+Where having condition is a boolean expression composed by those elements:
+
+item expression : item property {< | <= | == | != | => | >} value
+function call: xpath(xpath expression) | exl(exl expression)
+
+
+
+The Search by query retrieves all the available elements from the species service. +The general processing of Search by is as follows: +
+ +Accepted DATE formats are:
+Based on query returns type the post-filtering expression can access single item properties. +
+Property name | Value Type + |
---|---|
author | String + |
citation | String + |
credits | String + |
id | String + |
lsid | String + |
parent | Taxon |
rank | String + |
scientificName | String + |
Property name | Value Type + |
---|---|
author | String + |
basisOfRecord | enumeration {PreservedSpecimen, FossilSpecimen, LivingSpecimen, HumanObservation, MachineObservation} + |
catalogueNumber | String + |
citation | String + |
collectionCode | String + |
coordinateUncertaintyInMeters | String + |
country | String + |
credits | String + |
dataSet | DataSet |
decimalLatitude | double + |
decimalLongitude | double + |
eventDate | Calendar + |
family | String + |
id | String + |
institutionCode | String + |
kingdom | String + |
locality | String + |
maxDepth | double + |
minDepth | double + |
modified | Calendar + |
properties | List + |
provider | String + |
recordedBy | String + |
scientificName | String + |
Property name | Value Type + |
---|---|
citation | String + |
dataProvider | DataProvider |
id | String + |
name | String + |
Property name | Value Type + |
---|---|
id | String + |
name | String + |
+
Property name | Value Type + |
---|---|
author | String + |
citation | String + |
commonNames | List of CommonName |
credits | String |
dataSet | DataSet |
id | String + |
lsid | String + |
parent | Taxon |
products | List of Product |
properties | List of ElementProperty |
provider | String + |
rank | String + |
scientificName | String + |
Property name | Value Type + |
---|---|
language | String + |
locality | String + |
name | String + |
Property name | Value Type + |
---|---|
count | int + |
key | String + |
type | enumeration {Classification, NamesMapping, Occurences, Synonims} + |
+
Property name | Value Type + |
---|---|
name | String + |
value | String + |
Currently the supported functions are: +
+