C# Class Lucene.Net.QueryParsers.Xml.QueryTemplateManager

Provides utilities for turning query form input (such as from a web page or Swing gui) into Lucene XML queries by using XSL templates. This approach offers a convenient way of externalizing and changing how user input is turned into Lucene queries. Database applications often adopt similar practices by externalizing SQL in template files that can be easily changed/optimized by a DBA. The static methods can be used on their own or by creating an instance of this class you can store and re-use compiled stylesheets for fast use (e.g. in a server environment)

Show file Open project: apache/lucenenet Class Usage Examples

Public Methods

Method	Description
AddDefaultQueryTemplate ( Stream xslIs ) : void
AddQueryTemplate ( string name, Stream xslIs ) : void
GetQueryAsDOM ( string>.IDictionary formProperties ) : XmlDocument
GetQueryAsDOM ( string>.IDictionary formProperties, Stream xslIs ) : XmlDocument	Slow means of constructing query - parses stylesheet from input stream
GetQueryAsDOM ( string>.IDictionary formProperties, XslCompiledTransform template ) : XmlDocument	Fast means of constructing query using a cached,precompiled stylesheet
GetQueryAsDOM ( string>.IDictionary formProperties, string queryTemplateName ) : XmlDocument
GetQueryAsXmlString ( string>.IDictionary formProperties ) : string
GetQueryAsXmlString ( string>.IDictionary formProperties, Stream xslIs ) : string	Slow means of constructing query parsing a stylesheet from an input stream
GetQueryAsXmlString ( string>.IDictionary formProperties, XslCompiledTransform template ) : string	Fast means of constructing query using a precompiled stylesheet
GetQueryAsXmlString ( string>.IDictionary formProperties, string queryTemplateName ) : string
GetTemplates ( Stream xslIs ) : XslCompiledTransform	Parses a query stylesheet for repeated use
QueryTemplateManager ( ) : System.Collections.Generic
QueryTemplateManager ( Stream xslIs ) : System.Collections.Generic
TransformCriteria ( string>.IDictionary formProperties, Stream xslIs, Stream result ) : void	Slower transformation using an uncompiled stylesheet (suitable for development environment)
TransformCriteria ( string>.IDictionary formProperties, XslCompiledTransform transformer, Stream result ) : void	Fast transformation using a pre-compiled stylesheet (suitable for production environments)

Method Details

AddDefaultQueryTemplate() public method

public AddDefaultQueryTemplate ( Stream xslIs ) : void
xslIs	System.IO.Stream
return	void

AddQueryTemplate() public method

public AddQueryTemplate ( string name, Stream xslIs ) : void
name	string
xslIs	System.IO.Stream
return	void

GetQueryAsDOM() public method

public GetQueryAsDOM ( string>.IDictionary formProperties ) : XmlDocument
formProperties	string>.IDictionary
return	System.Xml.XmlDocument

GetQueryAsDOM() public static method

Slow means of constructing query - parses stylesheet from input stream

public static GetQueryAsDOM ( string>.IDictionary formProperties, Stream xslIs ) : XmlDocument
formProperties	string>.IDictionary
xslIs	System.IO.Stream
return	System.Xml.XmlDocument

GetQueryAsDOM() public static method

Fast means of constructing query using a cached,precompiled stylesheet

public static GetQueryAsDOM ( string>.IDictionary formProperties, XslCompiledTransform template ) : XmlDocument
formProperties	string>.IDictionary
template	System.Xml.Xsl.XslCompiledTransform
return	System.Xml.XmlDocument

GetQueryAsDOM() public method

public GetQueryAsDOM ( string>.IDictionary formProperties, string queryTemplateName ) : XmlDocument
formProperties	string>.IDictionary
queryTemplateName	string
return	System.Xml.XmlDocument

GetQueryAsXmlString() public method

public GetQueryAsXmlString ( string>.IDictionary formProperties ) : string
formProperties	string>.IDictionary
return	string

GetQueryAsXmlString() public static method

Slow means of constructing query parsing a stylesheet from an input stream

public static GetQueryAsXmlString ( string>.IDictionary formProperties, Stream xslIs ) : string
formProperties	string>.IDictionary
xslIs	System.IO.Stream
return	string

GetQueryAsXmlString() public static method

Fast means of constructing query using a precompiled stylesheet

public static GetQueryAsXmlString ( string>.IDictionary formProperties, XslCompiledTransform template ) : string
formProperties	string>.IDictionary
template	System.Xml.Xsl.XslCompiledTransform
return	string

GetQueryAsXmlString() public method

public GetQueryAsXmlString ( string>.IDictionary formProperties, string queryTemplateName ) : string
formProperties	string>.IDictionary
queryTemplateName	string
return	string

GetTemplates() public static method

Parses a query stylesheet for repeated use

public static GetTemplates ( Stream xslIs ) : XslCompiledTransform
xslIs	System.IO.Stream
return	System.Xml.Xsl.XslCompiledTransform

QueryTemplateManager() public method

public QueryTemplateManager ( ) : System.Collections.Generic
return	System.Collections.Generic

QueryTemplateManager() public method

public QueryTemplateManager ( Stream xslIs ) : System.Collections.Generic
xslIs	System.IO.Stream
return	System.Collections.Generic

TransformCriteria() public static method

Slower transformation using an uncompiled stylesheet (suitable for development environment)

public static TransformCriteria ( string>.IDictionary formProperties, Stream xslIs, Stream result ) : void
formProperties	string>.IDictionary
xslIs	System.IO.Stream
result	System.IO.Stream
return	void

TransformCriteria() public static method

Fast transformation using a pre-compiled stylesheet (suitable for production environments)

public static TransformCriteria ( string>.IDictionary formProperties, XslCompiledTransform transformer, Stream result ) : void
formProperties	string>.IDictionary
transformer	System.Xml.Xsl.XslCompiledTransform
result	System.IO.Stream
return	void