|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.palo.api.subsets.filter.PicklistFilter
public class PicklistFilter
PicklistFilter
A picklist filter is a restrictive filter as well as a structural filter. It is restrictive in the sense that elements which go into the subset can be selected. It is structural in the sense that those elements can be sorted if added in front or at the end of current subset elements list.
Field Summary |
---|
Fields inherited from interface org.palo.api.subsets.SubsetFilter |
---|
TYPE_ALIAS, TYPE_ATTRIBUTE, TYPE_DATA, TYPE_HIERARCHICAL, TYPE_PICKLIST, TYPE_SORTING, TYPE_TEXT |
Constructor Summary | |
---|---|
PicklistFilter(Dimension dimension)
Deprecated. use PicklistFilter(Hierarchy) instead. |
|
PicklistFilter(Dimension dimension,
PicklistFilterSetting setting)
Deprecated. use PicklistFilter(Hierarchy, PicklistFilterSetting) instead. |
|
PicklistFilter(Hierarchy hierarchy)
Creates a new PicklistFilter instance for the given
hierarchy |
|
PicklistFilter(Hierarchy hierarchy,
PicklistFilterSetting setting)
Creates a new PicklistFilter instance for the given
hierarchy with the given settings |
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! |
PicklistFilter |
copy()
Creates a deep copy of this subset filter |
void |
filter(java.util.List<ElementNode> hiers,
java.util.Set<Element> elements)
Inserts picked elements at front or back of the given element hierarchy. |
void |
filter(java.util.Set<Element> elements)
Filters the given elements list, i.e. only the picked elements of the list are kept. |
Dimension |
getDimension()
|
Hierarchy |
getHierarchy()
Convenient method to access the subset hierarchy. |
PicklistFilterSetting |
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 |
merge(java.util.Set<Element> elements)
Merges the picked elements into the given element list. |
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 |
resetInternal()
|
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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.palo.api.subsets.SubsetFilter |
---|
adapt, add, bind, getHierarchy, getSubset, remove, reset, unbind |
Constructor Detail |
---|
public PicklistFilter(Dimension dimension)
PicklistFilter(Hierarchy)
instead.
PicklistFilter
instance for the given
dimension
dimension
- the dimension to create the filter forpublic PicklistFilter(Hierarchy hierarchy)
PicklistFilter
instance for the given
hierarchy
hierarchy
- the hierarchy to create the filter forpublic PicklistFilter(Dimension dimension, PicklistFilterSetting setting)
PicklistFilter(Hierarchy, PicklistFilterSetting)
instead.
PicklistFilter
instance for the given
dimension with the given settings
dimension
- the dimension to create the filter forsetting
- the filter settings to usepublic PicklistFilter(Hierarchy hierarchy, PicklistFilterSetting setting)
PicklistFilter
instance for the given
hierarchy with the given settings
hierarchy
- the hierarchy to create the filter forsetting
- the filter settings to useMethod Detail |
---|
public final PicklistFilter copy()
SubsetFilter
copy
in interface SubsetFilter
public final PicklistFilterSetting getSettings()
SubsetFilter
getSettings
in interface SubsetFilter
public final void filter(java.util.List<ElementNode> hiers, java.util.Set<Element> elements)
PicklistFilterSetting.INSERT_MODE_BACK
or
PicklistFilterSetting.INSERT_MODE_FRONT
filter
in interface StructuralFilter
hiers
- the current subset element hierarchyelements
- the currently used Element
spublic final void filter(java.util.Set<Element> elements)
PicklistFilterSetting.INSERT_MODE_SUB
.
filter
in interface RestrictiveFilter
elements
- an element listpublic final void merge(java.util.Set<Element> elements)
PicklistFilterSetting.INSERT_MODE_MERGE
.
elements
- the element list to merge picked elements intopublic final int getType()
SubsetFilter
getType
in interface SubsetFilter
public final void initialize()
SubsetFilter
initialize
in interface SubsetFilter
public final void resetInternal()
public final void validateSettings() throws PaloIOException
SubsetFilter
validateSettings
in interface SubsetFilter
PaloIOException
- if internal subset settings are not valid.public final void add(EffectiveFilter filter)
SubsetFilter
EffectiveFilter
to the list of all affective
filters which affect this subset filter
add
in interface SubsetFilter
filter
- a filter which affects this subset filter.public final void remove(EffectiveFilter filter)
SubsetFilter
EffectiveFilter
from the list of all
affective filters which affect this subset filter
remove
in interface SubsetFilter
filter
- the affective filter to removepublic final void reset()
SubsetFilter
reset
in interface SubsetFilter
public final Subset2 getSubset()
SubsetFilter
Subset2
to which this filter belongs or
null
if this filter isn't bind to a subset yet.
getSubset
in interface SubsetFilter
Subset2
to which this filter belongs or
null
public final void bind(Subset2 subset)
SubsetFilter
Binds this filter instance to the given Subset2
bind
in interface SubsetFilter
public final void unbind()
SubsetFilter
Releases this filter instance from a previously binded Subset2
unbind
in interface SubsetFilter
public final Dimension getDimension()
public final Hierarchy getHierarchy()
SubsetFilter
getHierarchy
in interface SubsetFilter
public final void adapt(SubsetFilter from)
SubsetFilter
adapt
in interface SubsetFilter
from
- the subset filter to adapt from
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |