### Examples

Search all the products about the scientific name 'sarda sarda' in all available datasources.

SEARCH BY SN 'sarda sarda' RETURN Occurrence

Search all the products about 'sarda sarda' and its synonyms in WoRMS, in all available datasources.

SEARCH BY SN 'sarda sarda' EXPAND WITH WoRMS RETURN Occurrence

Search all the products about 'sarda sarda' and its synonyms found in WoRMS, in GBIF datasource.

SEARCH BY SN 'sarda sarda' EXPAND WITH WoRMS IN GBIF RETURN Occurrence

Search all the Taxa about 'sarda sarda' and its synonyms found in WoRMS, in ITIS datasource.

SEARCH BY SN 'sarda sarda' EXPAND WITH WoRMS IN ITIS RETURN TAXON

Search all the products about the scientific names retrieved searching the common 'shark' in the datasource WoRMS 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 WoRMS EXPAND WITH ITIS WHERE coordinate <= 15.12, 16.12 RETURN Occurrence

Search all the products about the scientific names 'sarda sarda' and 'Carcharodon carcharias' expanded with synonyms from datasource WoRMS, found in ITIS and with an event date between 2000 and 2005.

SEARCH BY SN 'sarda sarda', 'Carcharodon carcharias' EXPAND WITH WoRMS 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 Occurrence HAVING xpath("//product[type='TAXON' and counter>0]")

Search all the Taxa in CatalogueOfLife, OBIS, WoRDSS, WoRMS unfolding 'cervidae' using CatalogueOfLife and expanding the results with synonyms retrieved from datasource WoRMS

SEARCH BY SN 'cervidae' UNFOLD WITH CatalogueOfLife EXPAND WITH WoRMS IN CatalogueOfLife, OBIS, WoRDSS, WoRMS RETURN Taxon

### Synopsis

`

    SEARCH BY term [, ...]
          [ IN datasource [, ...] ]
          [ WHERE condition [AND condition] ]
          RETURN {OCCURRENCE | TAXON}
          [ HAVING having expression ]

`

Where term can be one of:

`

    CN 'common name' [, ...] RESOLVE [ WITH datasource [, ...] ] [EXPAND [ WITH datasource [, ...] ] ]
    SN 'scientific name' [, ...] [UNFOLD [ WITH datasource ]] [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)

`

### Description

The Search by query retrieves all the available elements from the species service. The general processing of Search by is as follows:

1. All the term are elaborated depending on the specified type:
   - CN case:
     - all the specified common names are mapped into scientific names using the specified datasources or all the available datasources if no one as been specified
     - if the EXPAND clause is specified the scientific names are expanded using the synonyms provided by the specified datasources or using all the available datasources if no one as been specified
   - SN case:
     - if the UNFOLD clause is specified all the specified scientific names are expanded using their descendants provided by the specified datasource (only one)
     - if the EXPAND clause is specified all the specified scientific names are expanded using the synonyms provided by the specified datasources or using all the available datasources if no one as been specified
2. The scientific names retrieved from the term elaboration are used for the retrieving of the specified elements in the RETURN clause (if no element is specified PRODUCT are returned).
3. If the WHERE clause is specified, all the elements that do not satisfy the condition are eliminated from the output (filtering made inside the Datasource).
4. If the HAVING clause is specified, all the elements that do not satisfy the having expression are eliminated from the output (the filtering is made outside the Datasource).

#### Date format

Accepted DATE formats are:

- "yyyy"
- "MM-yyyy"
- "MM/yyyy"
- "yyyyMMdd"
- "dd-MM-yyyy"
- "yyyy-MM-dd"
- "MM/dd/yyyy"
- "yyyy/MM/dd"
- "dd MMM yyyy"
- "dd MMMM yyyy"
- "yyyyMMddHHmm"
- "yyyyMMdd HHmm"
- "dd-MM-yyyy HH:mm"
- "yyyy-MM-dd HH:mm"
- "MM/dd/yyyy HH:mm"
- "yyyy/MM/dd HH:mm"
- "dd MMM yyyy HH:mm"
- "dd MMMM yyyy HH:mm"
- "yyyyMMddHHmmss"
- "yyyyMMdd HHmmss"
- "dd-MM-yyyy HH:mm:ss"
- "yyyy-MM-dd HH:mm:ss"
- "MM/dd/yyyy HH:mm:ss"
- "yyyy/MM/dd HH:mm:ss"
- "dd MMM yyyy HH:mm:ss"
- "dd MMMM yyyy HH:mm:ss"

#### Item properties

Based on query returns type the post-filtering expression can access single item properties.

##### Taxon

Property name | Value Type
--- | ---
author | String
citation | String
credits | String
id | String
lsid | String
parent | Taxon
rank | String
scientificName | String

##### Occurrence

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

###### DataSet

Property name | Value Type
--- | ---
citation | String
dataProvider | DataProvider
id | String
name | String

###### DataProvider

Property name | Value Type
--- | ---
id | String
name | String

##### Product

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

###### CommonName

Property name | Value Type
--- | ---
language | String
locality | String
name | String

###### Product

Property name | Value Type
--- | ---
count | int
key | String
type | enumeration {Classification, NamesMapping, Occurences, Synonims}

###### ElementProperty

Property name | Value Type
--- | ---
name | String
value | String

#### Functions

Currently the supported functions are:

- xpath: a XPath expression returning a boolean value;
- exl: a JExl expression returning a boolean value.