C# Класс Castle.MonoRail.ActiveRecordSupport.Pagination.AbstractPaginableQuery

Base class for all paginable queries, including custom ones.

Extenders should override the BuildHQL. Optionally, the methods SetQueryParameters and ExecuteQuery can also be overriden.

Наследование: Castle.ActiveRecord.ActiveRecordBaseQuery, IARPaginableDataSource

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство	Тип	Описание
pageSize	int

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

Метод	Описание
AbstractPaginableQuery ( Type targetType ) : System
ListAll ( ) : IEnumerable
ObtainCount ( ) : int	Executes a query to return the record count
Paginate ( int pageSize, int currentPage ) : IEnumerable	Returns the page items. Actually, the implementation just sets the protected fields pageSize and currentPage, gets an ISession from `SessionFactoryHolder` and calls InternalExecute in order to execute the custom query and fetch only the page items.

Защищенные методы

Метод	Описание
BuildCountHQL ( ) : string
BuildHQL ( ) : string	Should be overriden to return the custom HQL to be ran.
CreateQuery ( ISession session ) : IQuery
ExecuteQuery ( IQuery query ) : IEnumerable	Override to provide a custom query execution. The default behaviour is to just call IQuery.List().
InternalEnumerate ( ISession session ) : IEnumerable	The implementation of the InternalEnumerate method, as required by ActiveRecordBaseQuery. Should not be overriden.
InternalExecute ( ISession session ) : object	The implementation of the InternalExecute method, as required by ActiveRecordBaseQuery. Should not be overriden.
SetQueryParameters ( IQuery query ) : void	May be overriden, in order to set custom query parameters.

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

Метод	Описание
InternalPaginate ( ISession session, bool skipPagination ) : IEnumerable
PrepareQueryForPagination ( IQuery query ) : void	For internal use only.

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

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

public AbstractPaginableQuery ( Type targetType ) : System
targetType	System.Type
Результат	System

BuildCountHQL() защищенный Метод

protected BuildCountHQL ( ) : string
Результат	string

BuildHQL() защищенный абстрактный Метод

Should be overriden to return the custom HQL to be ran.

protected abstract BuildHQL ( ) : string
Результат	string

CreateQuery() защищенный закрытый Метод

protected final CreateQuery ( ISession session ) : IQuery
session	ISession
Результат	IQuery

ExecuteQuery() защищенный Метод

Override to provide a custom query execution. The default behaviour is to just call IQuery.List().

protected ExecuteQuery ( IQuery query ) : IEnumerable
query	IQuery	The query
Результат	IEnumerable

InternalEnumerate() защищенный закрытый Метод

The implementation of the InternalEnumerate method, as required by ActiveRecordBaseQuery. Should not be overriden.

protected final InternalEnumerate ( ISession session ) : IEnumerable
session	ISession	The NHibernate Session
Результат	IEnumerable

InternalExecute() защищенный закрытый Метод

The implementation of the InternalExecute method, as required by ActiveRecordBaseQuery. Should not be overriden.

protected final InternalExecute ( ISession session ) : object
session	ISession	The NHibernate Session
Результат	object

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

public ListAll ( ) : IEnumerable
Результат	IEnumerable

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

Executes a query to return the record count

public ObtainCount ( ) : int
Результат	int

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

Returns the page items. Actually, the implementation just sets the protected fields pageSize and currentPage, gets an ISession from SessionFactoryHolder and calls InternalExecute in order to execute the custom query and fetch only the page items.

public Paginate ( int pageSize, int currentPage ) : IEnumerable
pageSize	int	The page size
currentPage	int	The current page
Результат	IEnumerable

SetQueryParameters() защищенный Метод

May be overriden, in order to set custom query parameters.

protected SetQueryParameters ( IQuery query ) : void
query	IQuery	The query
Результат	void

Описание свойств

pageSize защищенное свойство

protected int pageSize
Результат	int