org.weda.store
Interface QueryFilterElement

All Known Implementing Classes:

QueryFilterElementImpl

public interface QueryFilterElement

Цель: предоставить QL выражение вида: название_поля(свойства) оператор значение

Author:

tim

Nested Class Summary

static class	QueryFilterElement.ExpressionType
static class	QueryFilterElement.OperatorType

Method Summary

java.lang.Object	clone()
java.lang.String	getExpression() Метод возвращает последнее установленное выражение для элемента фильтра.
QueryFilterElement.ExpressionType	getExpressionType() Метод возвращает тип текущего выражения элемента фильтра.
java.lang.String	getId() Метод возвращает уникальный идентификатор элемента фильтра в пределах запроса.
java.lang.String	getObjectAlias() Метод возвразает псевдоним объекта в QL над свойством которого будет осуществена фильтрация.
java.lang.String	getOperator() Метод возвращает оператор.
QueryFilterElement.OperatorType	getOperatorType() Метод возвращает тип оператора.
java.lang.String	getParameterName() Метод возвращает имя параметра в QL запросе.
java.lang.Object	getParameterValue() Метод возвращает значение параметра.
java.lang.String	getProperty() Метод возвращает имя свойства по которому будет осуществляться фильтрация.
PropertyDescriptor	getPropertyDescriptor() Метод возвращает описание свойства.
java.lang.String	getStaticExpression() Метод возвращает статическую связку оператор значение в строковом виде.
java.lang.Object	getValue() Метод возвращает текущее занчение элемента.
boolean	isEnabled() Метод вернет FALSE если элемент не должен участвовать при формировании результирующего запроса.
boolean	isUseAliasAsProperty() Если метод вернет TRUE тогда элемент использует alias в качестве свойства.
void	setEnabled(boolean enabled) Если в параметре передать TRUE тогда элемент будет участвовать при формировании результирующего запроса.
void	setExpression(java.lang.String value) Метод устанавливает связку оператор значение в строковом виде.
void	setExpressionType(QueryFilterElement.ExpressionType expressionType) Метод устанавилвает тип текущего выражения элемента фильтра.
void	setId(java.lang.String id)
void	setObjectAlias(java.lang.String objectAlias) Метод устанавливает псевдоним объекта в QL над свойством которого будет осуществена фильтрация.
void	setOperator(java.lang.String operator) Метод устанавливает оператор.
void	setOperatorType(QueryFilterElement.OperatorType operatorType)
void	setPattern(java.lang.String pattern) Метод уставливает шаблон с помощью которого строковое значение в выражении будет преобразовано к объекту.
void	setProperty(java.lang.String name) Метод устанавливает имя свойства по которому будет осуществляться фильтрация.
void	setPropertyDescriptor(PropertyDescriptor propertyDescriptor) Метод устанавливает описание свойства.
void	setStaticExpression(java.lang.String value) Метод устанавливает статическую связку оператор значение в строковом виде.
void	setUseAliasAsProperty(boolean value) Если установить в TRUE тогда элемент использует alias в качестве свойства.
void	setValue(java.lang.Object value) Метод устанавливает текущее занчение элемента.

Method Detail

isUseAliasAsProperty

boolean isUseAliasAsProperty()

Если метод вернет TRUE тогда элемент использует alias в качестве свойства.

setUseAliasAsProperty

void setUseAliasAsProperty(boolean value)

Если установить в TRUE тогда элемент использует alias в качестве свойства.

isEnabled

boolean isEnabled()

Метод вернет FALSE если элемент не должен участвовать при формировании результирующего запроса.

setEnabled

void setEnabled(boolean enabled)

Если в параметре передать TRUE тогда элемент будет участвовать при формировании результирующего запроса.

getValue

java.lang.Object getValue()

Метод возвращает текущее занчение элемента.

setValue

void setValue(java.lang.Object value)

Метод устанавливает текущее занчение элемента.

getParameterName

java.lang.String getParameterName()

Метод возвращает имя параметра в QL запросе. Значение элемента данного фильтра будет установлено в качестве значения для параметра имя которого возвращает данный метод. Если метод возвращает null значит выражение для фильтра будет формироваться по стандартной схеме.

getParameterValue

java.lang.Object getParameterValue()

Метод возвращает значение параметра.

See Also:

#getFilter()

getOperatorType

QueryFilterElement.OperatorType getOperatorType()

Метод возвращает тип оператора. Актуально только если getExpressionType() возвращает QueryFilterElement.ExpressionType.OPERATOR

setOperatorType

void setOperatorType(QueryFilterElement.OperatorType operatorType)

getOperator

java.lang.String getOperator()

Метод возвращает оператор.

setOperator

void setOperator(java.lang.String operator)

Метод устанавливает оператор.

getExpression

java.lang.String getExpression()

Метод возвращает последнее установленное выражение для элемента фильтра.

setExpression

void setExpression(java.lang.String value)
                   throws QueryFilterElementException

Метод устанавливает связку оператор значение в строковом виде.

Throws:

QueryFilterElementException

getStaticExpression

java.lang.String getStaticExpression()

Метод возвращает статическую связку оператор значение в строковом виде.

setStaticExpression

void setStaticExpression(java.lang.String value)

Метод устанавливает статическую связку оператор значение в строковом виде.

getExpressionType

QueryFilterElement.ExpressionType getExpressionType()

Метод возвращает тип текущего выражения элемента фильтра.

setExpressionType

void setExpressionType(QueryFilterElement.ExpressionType expressionType)

Метод устанавилвает тип текущего выражения элемента фильтра.

getProperty

java.lang.String getProperty()

Метод возвращает имя свойства по которому будет осуществляться фильтрация.

setProperty

void setProperty(java.lang.String name)

Метод устанавливает имя свойства по которому будет осуществляться фильтрация.

setPropertyDescriptor

void setPropertyDescriptor(PropertyDescriptor propertyDescriptor)

Метод устанавливает описание свойства.

getPropertyDescriptor

PropertyDescriptor getPropertyDescriptor()

Метод возвращает описание свойства.

getObjectAlias

java.lang.String getObjectAlias()

Метод возвразает псевдоним объекта в QL над свойством которого будет осуществена фильтрация.

setObjectAlias

void setObjectAlias(java.lang.String objectAlias)

Метод устанавливает псевдоним объекта в QL над свойством которого будет осуществена фильтрация.

getId

java.lang.String getId()

Метод возвращает уникальный идентификатор элемента фильтра в пределах запроса. Рекомендуемый формат идентификатора: objectAlias.property

setId

void setId(java.lang.String id)

setPattern

void setPattern(java.lang.String pattern)

Метод уставливает шаблон с помощью которого строковое значение в выражении будет преобразовано к объекту.

See Also:

setExpression(String)

clone

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

Throws:

java.lang.CloneNotSupportedException