Apply a filter to a persistent collection.

Namespace:  NHibernate
Assembly:  NHibernate (in NHibernate.dll)

Syntax

Visual Basic (Declaration)
<ObsoleteAttribute("Use ISession.CreateFilter().List()")> _
Function Filter ( _
	collection As Object, _
	filter As String _
) As ICollection
C#
[ObsoleteAttribute("Use ISession.CreateFilter().List()")]
ICollection Filter(
	Object collection,
	string filter
)
Visual C++
[ObsoleteAttribute(L"Use ISession.CreateFilter().List()")]
ICollection^ Filter(
	Object^ collection, 
	String^ filter
)
JavaScript
function filter(collection, filter);

Parameters

collection
Type: System..::.Object
A persistent collection to filter
filter
Type: System..::.String
A filter query string

Return Value

The resulting collection

Remarks

A filter is a Hibernate query that may refer to this, the collection element. Filters allow efficient access to very large lazy collections. (Executing the filter does not initialize the collection.)

See Also