|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SubsetFilter
SubsetFilter
A subset filter defines certain settings and criteria to determine the
elements within a subset. There exists three main filter categories namely
EffectiveFilter
which influences other filters,
RestrictiveFilter
which filters out subset elements and finally
StructuralFilter
which sorts the subset elements.
AliasFilter}, {@link AttributeFilter}, {@link DataFilter},
{@link HierarchicalFilter}, {@link PicklistFilter},
{@link SortingFilter}, {@link TextFilter}
Field Summary | |
---|---|
static int |
TYPE_ALIAS
type constant for alias filter |
static int |
TYPE_ATTRIBUTE
type constant for attribute filter |
static int |
TYPE_DATA
type constant for data filter |
static int |
TYPE_HIERARCHICAL
type constant for hierarchical filter |
static int |
TYPE_PICKLIST
type constant for picklist filter |
static int |
TYPE_SORTING
type constant for sorting filter |
static int |
TYPE_TEXT
type constant for textual filter |
Method Summary | |
---|---|
void |
adapt(SubsetFilter from)
Adapts this subset filter from the given one. |
void |
add(EffectiveFilter filter)
Adds the given EffectiveFilter to the list of all affective
filters which affect this subset filter |
void |
bind(Subset2 subset)
Binds this filter instance to the given Subset2
NOTE: PLEASE DON'T USE! |
SubsetFilter |
copy()
Creates a deep copy of this subset filter |
Hierarchy |
getHierarchy()
Convenient method to access the subset hierarchy. |
FilterSetting |
getSettings()
Returns the internal settings of this filter. |
Subset2 |
getSubset()
Returns the Subset2 to which this filter belongs or
null if this filter isn't bind to a subset yet. |
int |
getType()
Returns the filter type which is one of the defined type constants. |
void |
initialize()
Initializes this filter. |
void |
remove(EffectiveFilter filter)
Removes the given EffectiveFilter from the list of all
affective filters which affect this subset filter |
void |
reset()
Resets this filter, i.e. its internal setting is switched back to its default. |
void |
unbind()
Releases this filter instance from a previously binded Subset2
NOTE: PLEASE DON'T USE! |
void |
validateSettings()
Checks if the internal subset settings are valid. |
Field Detail |
---|
static final int TYPE_TEXT
static final int TYPE_HIERARCHICAL
static final int TYPE_PICKLIST
static final int TYPE_DATA
static final int TYPE_SORTING
static final int TYPE_ATTRIBUTE
static final int TYPE_ALIAS
Method Detail |
---|
int getType()
void reset()
FilterSetting getSettings()
void initialize()
Hierarchy getHierarchy()
void add(EffectiveFilter filter)
EffectiveFilter
to the list of all affective
filters which affect this subset filter
filter
- a filter which affects this subset filter.void remove(EffectiveFilter filter)
EffectiveFilter
from the list of all
affective filters which affect this subset filter
filter
- the affective filter to removevoid adapt(SubsetFilter from)
from
- the subset filter to adapt fromSubsetFilter copy()
Subset2 getSubset()
Subset2
to which this filter belongs or
null
if this filter isn't bind to a subset yet.
Subset2
to which this filter belongs or
null
void bind(Subset2 subset)
Binds this filter instance to the given Subset2
subset
- void unbind()
Releases this filter instance from a previously binded Subset2
void validateSettings() throws PaloIOException
PaloIOException
- if internal subset settings are not valid.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |