C# Класс Terradue.OpenSearch.Engine.OpenSearchEngine

The engine for making OpenSearch request
Наследование: IOpenSearchableFactory
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
ApplyOpenSearchElements ( IOpenSearchResultCollection &newResults, OpenSearchRequest request, IOpenSearchResponse response ) : void
AutoDiscoverFromQueryUrl ( OpenSearchUrl url ) : OpenSearchDescription

Try to discover the OpenSearchDescription from an URL.
Create ( OpenSearchDescription osd ) : IOpenSearchable

Create an IOpenSearchable from an OpenSearchUrl
Create ( OpenSearchUrl url ) : IOpenSearchable

Create an IOpenSearchable from an OpenSearchUrl
GetEnclosures ( IOpenSearchResultCollection result ) : SyndicationLink[]

Gets the enclosures.
GetExtensionByContentTypeAbility ( string contentType ) : IOpenSearchEngineExtension

Gets the first extension by content type ability.
GetExtensionByExtensionName ( string resultName ) : IOpenSearchEngineExtension
GetFirstExtensionByTypeAbility ( Type type ) : IOpenSearchEngineExtension
GetTypeByExtensionName ( string resultName ) : Type

Gets the name of the type by extension's result name
LoadOpenSearchDescriptionDocument ( OpenSearchUrl url ) : OpenSearchDescription

Loads an OpenSearchDescription document from an Url.
LoadPlugins ( ) : void

Loads the plugins automatically based on Mono.Addins
OpenSearchEngine ( ) : System

Initializes a new instance of the Terradue.OpenSearch.OpenSearchEngine class.
Query ( IOpenSearchable entity, NameValueCollection parameters ) : IOpenSearchResultCollection

Query the specified IOpenSearchable entity with specific parameters and returns result in native format.
Query ( IOpenSearchable entity, NameValueCollection parameters, Type resultType ) : IOpenSearchResultCollection

Query the specified IOpenSearchable entity with specific parameters and result with the specific result type.
Query ( IOpenSearchable entity, NameValueCollection parameters, string resultName ) : IOpenSearchResultCollection

Query the specified IOpenSearchable entity with specific parameters and result based on the extension's result name.
RegisterExtension ( IOpenSearchEngineExtension extension ) : void

Registers an extension for a specific type.
RegisterPostSearchFilter ( PostFilterAction filter ) : void

Registers a post search filter.
RegisterPreSearchFilter ( PreFilterAction filter ) : void

Registers a pre search filter.

Приватные методы

Метод Описание
ApplyPostSearchFilters ( OpenSearchRequest request, IOpenSearchResponse &response ) : void

Applies the post search filters.
ApplyPreSearchFilters ( OpenSearchRequest &request ) : void

Applies the pre search filters.

Описание методов

ApplyOpenSearchElements() публичный Метод

public ApplyOpenSearchElements ( IOpenSearchResultCollection &newResults, OpenSearchRequest request, IOpenSearchResponse response ) : void
newResults IOpenSearchResultCollection
request Terradue.OpenSearch.Request.OpenSearchRequest
response IOpenSearchResponse
Результат void

AutoDiscoverFromQueryUrl() публичный Метод

Try to discover the OpenSearchDescription from an URL.
public AutoDiscoverFromQueryUrl ( OpenSearchUrl url ) : OpenSearchDescription
url OpenSearchUrl URL.
Результат Terradue.OpenSearch.Schema.OpenSearchDescription

Create() публичный Метод

Create an IOpenSearchable from an OpenSearchUrl
public Create ( OpenSearchDescription osd ) : IOpenSearchable
osd Terradue.OpenSearch.Schema.OpenSearchDescription Osd.
Результат IOpenSearchable

Create() публичный Метод

Create an IOpenSearchable from an OpenSearchUrl
public Create ( OpenSearchUrl url ) : IOpenSearchable
url OpenSearchUrl URL to either a search or a description
Результат IOpenSearchable

GetEnclosures() публичный Метод

Gets the enclosures.
public GetEnclosures ( IOpenSearchResultCollection result ) : SyndicationLink[]
result IOpenSearchResultCollection Result.
Результат SyndicationLink[]

GetExtensionByContentTypeAbility() публичный Метод

Gets the first extension by content type ability.
public GetExtensionByContentTypeAbility ( string contentType ) : IOpenSearchEngineExtension
contentType string Content type.
Результат IOpenSearchEngineExtension

GetExtensionByExtensionName() публичный Метод

public GetExtensionByExtensionName ( string resultName ) : IOpenSearchEngineExtension
resultName string
Результат IOpenSearchEngineExtension

GetFirstExtensionByTypeAbility() публичный Метод

public GetFirstExtensionByTypeAbility ( Type type ) : IOpenSearchEngineExtension
type System.Type
Результат IOpenSearchEngineExtension

GetTypeByExtensionName() публичный Метод

Gets the name of the type by extension's result name
public GetTypeByExtensionName ( string resultName ) : Type
resultName string Result name.
Результат System.Type

LoadOpenSearchDescriptionDocument() публичный Метод

Loads an OpenSearchDescription document from an Url.
public LoadOpenSearchDescriptionDocument ( OpenSearchUrl url ) : OpenSearchDescription
url OpenSearchUrl URL.
Результат Terradue.OpenSearch.Schema.OpenSearchDescription

LoadPlugins() публичный Метод

Loads the plugins automatically based on Mono.Addins
public LoadPlugins ( ) : void
Результат void

OpenSearchEngine() публичный Метод

Initializes a new instance of the Terradue.OpenSearch.OpenSearchEngine class.
public OpenSearchEngine ( ) : System
Результат System

Query() публичный Метод

Query the specified IOpenSearchable entity with specific parameters and returns result in native format.
public Query ( IOpenSearchable entity, NameValueCollection parameters ) : IOpenSearchResultCollection
entity IOpenSearchable Entity.
parameters System.Collections.Specialized.NameValueCollection Parameters.
Результат IOpenSearchResultCollection

Query() публичный Метод

Query the specified IOpenSearchable entity with specific parameters and result with the specific result type.
public Query ( IOpenSearchable entity, NameValueCollection parameters, Type resultType ) : IOpenSearchResultCollection
entity IOpenSearchable Entity.
parameters System.Collections.Specialized.NameValueCollection Parameters.
resultType System.Type Result type.
Результат IOpenSearchResultCollection

Query() публичный Метод

Query the specified IOpenSearchable entity with specific parameters and result based on the extension's result name.
public Query ( IOpenSearchable entity, NameValueCollection parameters, string resultName ) : IOpenSearchResultCollection
entity IOpenSearchable Entity.
parameters System.Collections.Specialized.NameValueCollection Parameters.
resultName string Result name.
Результат IOpenSearchResultCollection

RegisterExtension() публичный Метод

Registers an extension for a specific type.
An extension with the same typoe already registered.
public RegisterExtension ( IOpenSearchEngineExtension extension ) : void
extension IOpenSearchEngineExtension Extension associated with the type
Результат void

RegisterPostSearchFilter() публичный Метод

Registers a post search filter.
public RegisterPostSearchFilter ( PostFilterAction filter ) : void
filter PostFilterAction Filter.
Результат void

RegisterPreSearchFilter() публичный Метод

Registers a pre search filter.
public RegisterPreSearchFilter ( PreFilterAction filter ) : void
filter PreFilterAction Filter.
Результат void