.. WARNING! This file is automatically generated. Edits will be lost. Data Types in CICore -------------------- .. module:: v1_1.Types :synopsis: Catalog of data types (structures) used by the DataONE cicore. **Versions** * :doc:`Version 1.0` * :doc:`Version 1.1` * :doc:`Version 2.0` **Quick Reference** - :class:`v1_1.Types.QueryEngineDescription` - :class:`v1_1.Types.QueryEngineList` - :class:`v1_1.Types.QueryField` .. image:: images/v1_1.classes_combined.png .. @startuml images/v1_1.classes_combined.png class v1_1.QueryEngineDescription { + queryEngineVersion : xs.string[1..1] + querySchemaVersion : xs.string[0..1] + name : xs.string[1..1] + additionalInfo : NonEmptyString[0..*] + queryField : v1_1.QueryField[0..*] } v1_1.QueryEngineDescription .. xs.string v1_1.QueryEngineDescription .. NonEmptyString v1_1.QueryEngineDescription .. v1_1.QueryField class v1_1.QueryEngineList { + queryEngine : NonEmptyString[0..*] } v1_1.QueryEngineList .. NonEmptyString class v1_1.QueryField { + name : NonEmptyString[1..1] + description : xs.string[0..*] + type : NonEmptyString[1..1] + searchable : xs.boolean[1..1] + returnable : xs.boolean[1..1] + sortable : xs.boolean[1..1] + multivalued : xs.boolean[0..1] } v1_1.QueryField .. NonEmptyString v1_1.QueryField .. xs.string v1_1.QueryField .. xs.boolean @enduml .. ###### .. class:: QueryEngineDescription Describes a query engine that can be used to search content on the node. Query engines may be general purpose or specialized for particular communities or domains. .. attribute:: queryEngineVersion Type: `xs.string`_ The version of the underlying query engine. Used by clients to determine possible compatibility concerns or features available. .. attribute:: querySchemaVersion Type: `xs.string`_ Version of the schema in use by the query engine, e.g. "1.0.1" .. attribute:: name Type: `xs.string`_ The full, human readable name of the query engine. For example: "Apache SOLR" .. attribute:: additionalInfo Type: :class:`Types.NonEmptyString` An optional human readable description of the query engine. This can be used to describe any special capabilities or intended uses for the query engine. For example, a query engine may be tuned to suit a particular audience or domain as opposed to providing a general purpose discovery mechanism. This field may also contain links to additional information about the query engine, such as documentation for the search syntax provided by the query engine implemntors. .. attribute:: queryField Type: :class:`v1_1.Types.QueryField` A list of query fields supported by the query engine. .. code-block:: xml .. image:: images/class_v1_1.QueryEngineDescription.png .. @startuml images/class_v1_1.QueryEngineDescription.png class v1_1.QueryEngineDescription { + queryEngineVersion : xs.string[1..1] + querySchemaVersion : xs.string[0..1] + name : xs.string[1..1] + additionalInfo : NonEmptyString[0..*] + queryField : v1_1.QueryField[0..*] } v1_1.QueryEngineDescription .. xs.string v1_1.QueryEngineDescription .. NonEmptyString v1_1.QueryEngineDescription .. v1_1.QueryField @enduml .. ###### .. class:: QueryEngineList A list of query engine names that indicate the possible values for CNRead.getQueryEngineDescription and CNRead.query REST API endpoints. .. attribute:: queryEngine Type: :class:`Types.NonEmptyString` The name of a queryEngine. This value will be used as a path element in REST API calls and so should not contain characters that will need to be escaped. .. code-block:: xml .. image:: images/class_v1_1.QueryEngineList.png .. @startuml images/class_v1_1.QueryEngineList.png class v1_1.QueryEngineList { + queryEngine : NonEmptyString[0..*] } v1_1.QueryEngineList .. NonEmptyString @enduml .. ###### .. class:: QueryField .. attribute:: name Type: :class:`Types.NonEmptyString` The name of the field as used programmatically when constructing queries or other rferences to the field. .. attribute:: description Type: `xs.string`_ An optional, repeatable, brief description of the field that can be used to help guide developers or end users in appropriate use of the field. May for example, contain a links to additional documentation. .. attribute:: type Type: :class:`Types.NonEmptyString` The type of the field, expressed in the language peculiar to the query engine being described. .. attribute:: searchable Type: `xs.boolean`_ Indicates if the field may be used in constructing queries (as opposed to only appearing in results) .. attribute:: returnable Type: `xs.boolean`_ Indicates if the field values may be returned in search results. .. attribute:: sortable Type: `xs.boolean`_ Indicates if the field can be used for sorting results. .. attribute:: multivalued Type: `xs.boolean`_ Indicates if the field may contain multiple values. Some query engines such as SOLR support this capability. .. code-block:: xml .. image:: images/class_v1_1.QueryField.png .. @startuml images/class_v1_1.QueryField.png class v1_1.QueryField { + name : NonEmptyString[1..1] + description : xs.string[0..*] + type : NonEmptyString[1..1] + searchable : xs.boolean[1..1] + returnable : xs.boolean[1..1] + sortable : xs.boolean[1..1] + multivalued : xs.boolean[0..1] } v1_1.QueryField .. NonEmptyString v1_1.QueryField .. xs.string v1_1.QueryField .. xs.boolean @enduml .. #### .. _xs.string: http://www.w3.org/TR/xmlschema-2/#string .. _xs.boolean: http://www.w3.org/TR/xmlschema-2/#boolean .. _xs.dateTime: http://www.w3.org/TR/xmlschema-2/#dateTime .. _xs.unsignedLong: http://www.w3.org/TR/xmlschema-2/#unsignedLong .. _xs.token: http://www.w3.org/TR/xmlschema-2/#token .. _xs.int: http://www.w3.org/TR/xmlschema-2/#int .. _xs.anyURI: http://www.w3.org/TR/xmlschema-2/#anyURI