org.weda.store
Interface QueryFilter

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
QueryFilterImpl

public interface QueryFilter
extends java.io.Serializable

Цель: предоставить QL выражение позволяющее ограничить набор данных в результате выполнения Query.

Author:
tim

Method Summary
 void addFilterElement(QueryFilterElement filterElement)
          Метод добавляет элемент фильтра.
 void addObjectAlias(ObjectAlias objectAlias)
          Метод добавляет информацию о псевдониме объекта.
 void addStaticFilterElement(QueryFilterElement filterElement)
          Метод добавляет статический элемент фильтра.
 void clearFiltersExpressions()
          Метод устанавливает в null выражения во всех нестатических элементах фильтра.
 java.lang.Object clone()
           
 QueryFilter cloneFilter()
           
 java.lang.String createFilterElementId(java.lang.String propertyPath, java.lang.String objectAlias)
           
 void disableFilterElements()
          Метод устанавливает свойство enabled каждого QueryFilterElement в FALSE
 void enableFilterElements()
          Метод устанавливает свойство enabled каждого QueryFilterElement в TRUE
 QueryFilterElement getFilterElement(java.lang.String id)
          Метод возвращает элемент фильтра по его идентификатору.
 java.util.Collection<QueryFilterElement> getFilterElements()
          метод возвращает список элементов фильтра.
 QueryFilterElement getStaticFilterElement(java.lang.String id)
          Метод возвращает элемент фильтра по его идентификатору.
 java.util.Collection<QueryFilterElement> getStaticFilterElements()
          метод возвращает статический список элементов фильтра.
 void init()
           
 void initQueryFilterElement(QueryFilterElement filterElement, boolean isStaticElement)
          Метод инициализирует элемент фильтра переданный в параметре.
 void removeFilterElement(QueryFilterElement filterElement)
          Метод удаляет элемент фильтра.
 void removeStaticFilterElement(QueryFilterElement filterElement)
          Метод удаляет статический элемент фильтра.
 void setDefaultObjectAlias(ObjectAlias objectAlias)
          Метод псевдоним объекта по умолчанию.
 void setExpression(java.lang.String elementId, java.lang.String expression)
          Метод задает выражение поиска для заданного элемента фильтра.
 

Method Detail

init

void init()
          throws QueryFilterException
Throws:
QueryFilterException

createFilterElementId

java.lang.String createFilterElementId(java.lang.String propertyPath,
                                       java.lang.String objectAlias)

initQueryFilterElement

void initQueryFilterElement(QueryFilterElement filterElement,
                            boolean isStaticElement)
                            throws QueryFilterException
Метод инициализирует элемент фильтра переданный в параметре.

Throws:
QueryFilterException

setExpression

void setExpression(java.lang.String elementId,
                   java.lang.String expression)
                   throws QueryFilterException
Метод задает выражение поиска для заданного элемента фильтра.

Throws:
QueryFilterException

getFilterElements

java.util.Collection<QueryFilterElement> getFilterElements()
метод возвращает список элементов фильтра.


addFilterElement

void addFilterElement(QueryFilterElement filterElement)
Метод добавляет элемент фильтра.


getFilterElement

QueryFilterElement getFilterElement(java.lang.String id)
Метод возвращает элемент фильтра по его идентификатору.

See Also:
QueryFilterElement.getId()

getStaticFilterElement

QueryFilterElement getStaticFilterElement(java.lang.String id)
Метод возвращает элемент фильтра по его идентификатору.

See Also:
QueryFilterElement.getId()

removeFilterElement

void removeFilterElement(QueryFilterElement filterElement)
Метод удаляет элемент фильтра.


disableFilterElements

void disableFilterElements()
Метод устанавливает свойство enabled каждого QueryFilterElement в FALSE


enableFilterElements

void enableFilterElements()
Метод устанавливает свойство enabled каждого QueryFilterElement в TRUE


clearFiltersExpressions

void clearFiltersExpressions()
                             throws QueryFilterException
Метод устанавливает в null выражения во всех нестатических элементах фильтра.

Throws:
QueryFilterException
See Also:
QueryFilterElement.setExpression(String), getFilterElements()

getStaticFilterElements

java.util.Collection<QueryFilterElement> getStaticFilterElements()
метод возвращает статический список элементов фильтра.


addStaticFilterElement

void addStaticFilterElement(QueryFilterElement filterElement)
Метод добавляет статический элемент фильтра.


removeStaticFilterElement

void removeStaticFilterElement(QueryFilterElement filterElement)
Метод удаляет статический элемент фильтра.


setDefaultObjectAlias

void setDefaultObjectAlias(ObjectAlias objectAlias)
Метод псевдоним объекта по умолчанию. Псевдоним по умолчанию будет устанавливаться для тех элементов фильтра у которых не установлено свойство objectAlias


addObjectAlias

void addObjectAlias(ObjectAlias objectAlias)
Метод добавляет информацию о псевдониме объекта.


cloneFilter

QueryFilter cloneFilter()
                        throws QueryFilterException
Throws:
QueryFilterException

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Throws:
java.lang.CloneNotSupportedException


Copyright © 2005-2006 . All Rights Reserved.