|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object lumis.doui.table.filter.AbstractTableSourceFilter lumis.doui.table.filter.TableSourceFilter
@StableMinor(version="5.5", sinceVersion="4.0") public class TableSourceFilter
Represents a source filter. Interacts with source fields to generate IQueryFilter
.
Constructor Summary | |
---|---|
TableSourceFilter()
|
Method Summary | |
---|---|
protected String |
calculateFilterOperator(Node filterNode)
Analyzes this filter and returns the operator that should be used with it. |
protected IQueryValue |
calculateFilterValue(Node filterNode)
Analyzes this filter and returns the value that should be used with it. |
protected Object |
convertFilterStandardValue(String value,
Node filterNode)
Checks and converts the filter "standard" value to real value. |
protected String |
convertOperatorStandardValue(String operator)
|
String |
getFieldId()
|
IQueryValue |
getFilterValue()
|
String |
getInputControlType()
Returns the input control type for this filter doui frontend. |
String |
getOperator()
|
IParameters |
getParameters()
|
IQueryFilter |
getQueryFilter(QueryBase queryBase,
IParameters params)
Returns a query filter corresponding to this source filter definition. |
IQueryFilter |
getQueryFilter(QueryField queryField,
IQueryValue queryValue)
Creates a query filter, filtering the query field by the value, according to this filter definitions. |
void |
init(TableSource source,
Node filterNode)
Initialization method, called before any other method on the filter instance. |
void |
init(TableSource source,
String fieldId,
String operator,
IQueryValue filterValue)
|
boolean |
isOrNull()
|
boolean |
isRequired()
|
boolean |
isValueInLookup()
|
void |
setDefinition(Node filterDefinitionNode)
|
void |
setFieldId(String fieldId)
|
void |
setFilterValue(IQueryValue value)
|
void |
setOperator(String operator)
|
void |
setOrNull(boolean orNull)
|
void |
setParameters(IParameters parameters)
|
void |
setRequired(boolean required)
|
void |
setValueInLookup(boolean valueInLookup)
|
boolean |
shouldHideAllResults()
|
Methods inherited from class lumis.doui.table.filter.AbstractTableSourceFilter |
---|
getFilter, getId, getSource, setId, setSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TableSourceFilter()
Method Detail |
---|
public void init(TableSource source, Node filterNode) throws PortalException
ISourceFilter
init
in interface ISourceFilter<TableSource>
init
in class AbstractTableSourceFilter
source
- the source the filter belongs to.filterNode
- the filter definition node.
PortalException
- if the filter could not initialize itself.public void init(TableSource source, String fieldId, String operator, IQueryValue filterValue) throws PortalException
PortalException
public void setDefinition(Node filterDefinitionNode) throws PortalException
PortalException
public IQueryFilter getQueryFilter(QueryBase queryBase, IParameters params) throws PortalException, RequiredFilterValueException
queryBase
- the query base the query filter will be applied to.parameters
- parameters to be used in the query filter.
PortalException
RequiredFilterValueException
- when a required value for the filter
was not given. No results should be shown when this happen.public IQueryFilter getQueryFilter(QueryField queryField, IQueryValue queryValue) throws PortalException
queryField
- the query field.queryValue
- the query value.
PortalException
public String getInputControlType() throws PortalException
ISourceFilter
getInputControlType
in interface ISourceFilter<TableSource>
getInputControlType
in class AbstractTableSourceFilter
PortalException
protected String calculateFilterOperator(Node filterNode) throws PortalException
filterNode
- the filter definition node.
PortalException
protected String convertOperatorStandardValue(String operator)
protected IQueryValue calculateFilterValue(Node filterNode) throws PortalException
filterNode
- the filter definition node.
PortalException
protected Object convertFilterStandardValue(String value, Node filterNode) throws PortalException
value
- filterNode
-
PortalException
public boolean shouldHideAllResults()
public String getFieldId()
public void setFieldId(String fieldId)
public String getOperator()
public void setOperator(String operator)
public boolean isOrNull()
public void setOrNull(boolean orNull)
public IParameters getParameters()
public void setParameters(IParameters parameters)
public boolean isRequired()
public void setRequired(boolean required)
public IQueryValue getFilterValue()
public void setFilterValue(IQueryValue value)
public boolean isValueInLookup()
public void setValueInLookup(boolean valueInLookup)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |