|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.palo.api.subsets.filter.SortingFilter
public class SortingFilter
SortingFilter
A sorting filter belongs to the category of structural filters. This filter defines different sorting criteria to influence the element sequence of the subset as well as the possibility to create an element hierarchy.
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 | |
---|---|
SortingFilter(Dimension dimension)
Deprecated. use SortingFilter(Hierarchy) instead. |
|
SortingFilter(Dimension dimension,
SortingFilterSetting setting)
Deprecated. use SortingFilter(Hierarchy, SortingFilterSetting)
instead. |
|
SortingFilter(Hierarchy hierarchy)
Creates a new SortingFilter instance for the given
hierarchy |
|
SortingFilter(Hierarchy hierarchy,
SortingFilterSetting setting)
Creates a new SortingFilter 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! |
SortingFilter |
copy()
Creates a deep copy of this subset filter |
void |
filter(java.util.List<ElementNode> hierarchy,
java.util.Set<Element> elements)
Filters the given element hierarchy represented by ElementNode s. |
Dimension |
getDimension()
|
Hierarchy |
getHierarchy()
Convenient method to access the subset hierarchy. |
SortingFilterSetting |
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. |
java.util.List<ElementNode> |
sort(java.util.Set<Element> elements)
Sorts the given subset element list using the current settings. |
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 SortingFilter(Dimension dimension)
SortingFilter(Hierarchy)
instead.
SortingFilter
instance for the given
dimension
dimension
- the dimension to create the filter forpublic SortingFilter(Hierarchy hierarchy)
SortingFilter
instance for the given
hierarchy
hierarchy
- the hierarchy to create the filter forpublic SortingFilter(Dimension dimension, SortingFilterSetting setting)
SortingFilter(Hierarchy, SortingFilterSetting)
instead.
SortingFilter
instance for the given
dimension with the given settings
dimension
- the dimension to create the filter forsetting
- the filter settings to usepublic SortingFilter(Hierarchy hierarchy, SortingFilterSetting setting)
SortingFilter
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 SortingFilter copy()
SubsetFilter
copy
in interface SubsetFilter
public final SortingFilterSetting getSettings()
SubsetFilter
getSettings
in interface SubsetFilter
public final java.util.List<ElementNode> sort(java.util.Set<Element> elements)
elements
- the subset element
public final void filter(java.util.List<ElementNode> hierarchy, java.util.Set<Element> elements)
StructuralFilter
ElementNode
s. The given list contains only the root nodes.
The second parameter contains all currently used elements.
filter
in interface StructuralFilter
elements
- the currently used Element
spublic final int getType()
SubsetFilter
getType
in interface SubsetFilter
public final void initialize()
SubsetFilter
initialize
in interface SubsetFilter
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 |