Difference between revisions of "OpenSearch Framework"
(→Extensibility Points) |
(→Extensibility Points) |
||
| Line 3: | Line 3: | ||
==Extensibility Points== | ==Extensibility Points== | ||
| − | The operator introduces and makes use of a set of functionalities beyond those of the standard OpenSearch specification. These extensions are supported by the introduction of a special [[OpenSearch Resource]] structure and by the internal logic of the operator, the latter using standard OpenSearch functionality provided by a general-purpose OpenSearch library. The extra functionalities are summarized as follows: | + | The operator introduces and makes use of a set of functionalities beyond those of the standard OpenSearch specification. These extensions are supported by the introduction of a special [[#OpenSearch Resource]] structure and by the internal logic of the operator, the latter using standard OpenSearch functionality provided by a general-purpose OpenSearch library. The extra functionalities are summarized as follows: |
*The support of data transformation by the operator. Provided that an XSLT for one of the MIME types of the results returned by an OpenSearch-enabled search service is available, the operator is able to return the obtained results in a form suitable for further processing. | *The support of data transformation by the operator. Provided that an XSLT for one of the MIME types of the results returned by an OpenSearch-enabled search service is available, the operator is able to return the obtained results in a form suitable for further processing. | ||
*Both direct and brokered result processing is supported. Some OpenSearch-enabled services diverge from the common case of returning a set of direct results and instead provide their results indirectly, by returning a set of links to other OpenSearch-enabled services. Provided that an XSLT used to extract those links from the returned results is made available, the operator will be able to return the full set of results provided by the brokered OpenSearch services. | *Both direct and brokered result processing is supported. Some OpenSearch-enabled services diverge from the common case of returning a set of direct results and instead provide their results indirectly, by returning a set of links to other OpenSearch-enabled services. Provided that an XSLT used to extract those links from the returned results is made available, the operator will be able to return the full set of results provided by the brokered OpenSearch services. | ||
Revision as of 12:48, 31 May 2010
Description
The role of the OpenSearch operator is to provide support for querying and retrieval of search results via OpenSearch from resources which expose an OpenSearch description document. The operator accepts a set of query terms and parameters, the URL of an OpenSearch description document and an #OpenSearch Resource reference. After performing the number of OpenSearch queries required to obtain the desired results, it returns these results wrapping them in a ResultSet.
Extensibility Points
The operator introduces and makes use of a set of functionalities beyond those of the standard OpenSearch specification. These extensions are supported by the introduction of a special #OpenSearch Resource structure and by the internal logic of the operator, the latter using standard OpenSearch functionality provided by a general-purpose OpenSearch library. The extra functionalities are summarized as follows:
- The support of data transformation by the operator. Provided that an XSLT for one of the MIME types of the results returned by an OpenSearch-enabled search service is available, the operator is able to return the obtained results in a form suitable for further processing.
- Both direct and brokered result processing is supported. Some OpenSearch-enabled services diverge from the common case of returning a set of direct results and instead provide their results indirectly, by returning a set of links to other OpenSearch-enabled services. Provided that an XSLT used to extract those links from the returned results is made available, the operator will be able to return the full set of results provided by the brokered OpenSearch services.
- The operator will support one or more security schemes.
OpenSearch Resource
The purpose of an OpenSearch resource object is to describe the specifications of an OpenSearch resource. It encapsulates the extensions described in the Extensibility Points section. Among the attributes included are:
- The name of the resource
- Whether the resource provides direct or brokered results
- Transformation specifications
- Security specifications
