C# Class Terradue.OpenSearch.Engine.OpenSearchEngine

The engine for making OpenSearch request
Inheritance: IOpenSearchableFactory
Afficher le fichier Open project: Terradue/DotNetOpenSearch Class Usage Examples

Méthodes publiques

Méthode Description
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.

Private Methods

Méthode Description
ApplyPostSearchFilters ( OpenSearchRequest request, IOpenSearchResponse &response ) : void

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

Applies the pre search filters.

Method Details

ApplyOpenSearchElements() public méthode

public ApplyOpenSearchElements ( IOpenSearchResultCollection &newResults, OpenSearchRequest request, IOpenSearchResponse response ) : void
newResults IOpenSearchResultCollection
request Terradue.OpenSearch.Request.OpenSearchRequest
response IOpenSearchResponse
Résultat void

AutoDiscoverFromQueryUrl() public méthode

Try to discover the OpenSearchDescription from an URL.
public AutoDiscoverFromQueryUrl ( OpenSearchUrl url ) : OpenSearchDescription
url OpenSearchUrl URL.
Résultat Terradue.OpenSearch.Schema.OpenSearchDescription

Create() public méthode

Create an IOpenSearchable from an OpenSearchUrl
public Create ( OpenSearchDescription osd ) : IOpenSearchable
osd Terradue.OpenSearch.Schema.OpenSearchDescription Osd.
Résultat IOpenSearchable

Create() public méthode

Create an IOpenSearchable from an OpenSearchUrl
public Create ( OpenSearchUrl url ) : IOpenSearchable
url OpenSearchUrl URL to either a search or a description
Résultat IOpenSearchable

GetEnclosures() public méthode

Gets the enclosures.
public GetEnclosures ( IOpenSearchResultCollection result ) : SyndicationLink[]
result IOpenSearchResultCollection Result.
Résultat SyndicationLink[]

GetExtensionByContentTypeAbility() public méthode

Gets the first extension by content type ability.
public GetExtensionByContentTypeAbility ( string contentType ) : IOpenSearchEngineExtension
contentType string Content type.
Résultat IOpenSearchEngineExtension

GetExtensionByExtensionName() public méthode

public GetExtensionByExtensionName ( string resultName ) : IOpenSearchEngineExtension
resultName string
Résultat IOpenSearchEngineExtension

GetFirstExtensionByTypeAbility() public méthode

public GetFirstExtensionByTypeAbility ( Type type ) : IOpenSearchEngineExtension
type System.Type
Résultat IOpenSearchEngineExtension

GetTypeByExtensionName() public méthode

Gets the name of the type by extension's result name
public GetTypeByExtensionName ( string resultName ) : Type
resultName string Result name.
Résultat System.Type

LoadOpenSearchDescriptionDocument() public méthode

Loads an OpenSearchDescription document from an Url.
public LoadOpenSearchDescriptionDocument ( OpenSearchUrl url ) : OpenSearchDescription
url OpenSearchUrl URL.
Résultat Terradue.OpenSearch.Schema.OpenSearchDescription

LoadPlugins() public méthode

Loads the plugins automatically based on Mono.Addins
public LoadPlugins ( ) : void
Résultat void

OpenSearchEngine() public méthode

Initializes a new instance of the Terradue.OpenSearch.OpenSearchEngine class.
public OpenSearchEngine ( ) : System
Résultat System

Query() public méthode

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.
Résultat IOpenSearchResultCollection

Query() public méthode

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.
Résultat IOpenSearchResultCollection

Query() public méthode

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.
Résultat IOpenSearchResultCollection

RegisterExtension() public méthode

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
Résultat void

RegisterPostSearchFilter() public méthode

Registers a post search filter.
public RegisterPostSearchFilter ( PostFilterAction filter ) : void
filter PostFilterAction Filter.
Résultat void

RegisterPreSearchFilter() public méthode

Registers a pre search filter.
public RegisterPreSearchFilter ( PreFilterAction filter ) : void
filter PreFilterAction Filter.
Résultat void