QueryCondition: QueryCondition Class

In naturalis/nbaR: R Package Client for the Netherlands Biodiversity API

QueryCondition Class

Description

For more information on the NBA object model, please refer to the official NBA documentation at https://docs.biodiversitydata.nl and the NBA model and endpoints reference at https://docs.biodiversitydata.nl/endpoints-reference.

Usage

# QueryCondition$new()

Format

R6 class

Details

Model class for QueryCondition objects. Class modeling a query condition. A condition consists of a field name, a ComparisonOperator and a value. For example: 'name', EQUALS, 'John'. A condition can optionally have a list of sibling conditions. These are joined to the containing condition using the AND or OR operator. A condition and its siblings are strongly bound together, as though surrounded by parentheses: (condition AND sibling0 AND sibling1). Because each sibling may itself also have a list of sibling conditions, this allows you to nest logical expressions like (A AND (B OR C OR (D AND E)) AND F).

Fields

not

character

field

character

operator

character

value

list

and

list(QueryCondition)

or

list(QueryCondition)

constantScore

logical

boost

numeric

Methods

$new()

Constructor QueryCondition object.

$fromList(QueryConditionList)

Create QueryCondition object from list.

$toList()

Get list representation of QueryCondition.

fromJSONString(QueryConditionJson)

Create QueryCondition object from JSON.

toJSONString(pretty=TRUE)

Get JSON representation of QueryCondition.

naturalis/nbaR documentation built on Nov. 12, 2023, 4:47 p.m.