|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.palo.api.subsets.filter.settings.AbstractFilterSettings
org.palo.api.subsets.filter.settings.SortingFilterSetting
public class SortingFilterSetting
SortingFilterSetting
Manages the settings for the SortingFilter
.
Field Summary | |
---|---|
static int |
HIERARCHICAL_MODE_DISABLED
|
static int |
HIERARCHICAL_MODE_HIDE_CHILDREN
|
static int |
HIERARCHICAL_MODE_SHOW_CHILDREN
|
static int |
ORDER_MODE_REVERSE_DISABLED
|
static int |
ORDER_MODE_REVERSE_PER_LEVEL
|
static int |
ORDER_MODE_REVERSE_TOTAL
|
static int |
SORT_CRITERIA_ALIAS
|
static int |
SORT_CRITERIA_DATA
|
static int |
SORT_CRITERIA_DEFINITION
|
static int |
SORT_CRITERIA_LEXICAL
|
static int |
SORT_TYPE_CONSOLIDATIONS_ONLY
|
static int |
SORT_TYPE_DISABLED
|
static int |
SORT_TYPE_LEAFS_ONLY
|
Constructor Summary | |
---|---|
SortingFilterSetting()
|
Method Summary | |
---|---|
void |
adapt(FilterSetting from)
Adapt the filter setting from the given filter setting. |
void |
bind(Subset2 subset)
Binds this filter settings instance to the given Subset2
NOTE: PLEASE DON'T USE! |
boolean |
doHierarchy()
Checks if a hierarchy should be created |
boolean |
doReverseOrder()
Checks if the reverse order mode is active |
boolean |
doSortByAttribute()
Checks if the sort by attribute mode is active |
boolean |
doSortByType()
Checks if the sort by type mode is active |
boolean |
doSortPerLevel()
Checks if the sort per level mode is active |
IntegerParameter |
getHierarchicalMode()
Returns the hierarchical mode |
IntegerParameter |
getOrderMode()
Returns the reverse order mode |
IntegerParameter |
getShowDuplicates()
Returns whether duplicate Element s should be shown or not, i.e. |
StringParameter |
getSortAttribute()
Returns the attribute identifier to sort after |
IntegerParameter |
getSortCriteria()
Returns the currently set sorting criteria, i.e. one of the predefined sort criteria constants |
IntegerParameter |
getSortLevel()
Returns the level at which the elements should be sorted |
StringParameter |
getSortLevelElement()
Deprecated. use getSortLevel() |
IntegerParameter |
getSortTypeMode()
Returns the sort by type mode |
void |
reset()
Resets the filter setting to its defaults. |
void |
setHierarchicalMode(int hierarchicalMode)
Sets the hierarchical mode. |
void |
setHierarchicalMode(IntegerParameter hierarchicalMode)
Sets the hierarchical mode. |
void |
setOrderMode(int orderMode)
Sets the reverse order mode. |
void |
setOrderMode(IntegerParameter orderMode)
Sets the reverse order mode, i.e. the parameter value should be one of the predefined order mode constants. |
void |
setShowDuplicates(int showDuplicates)
Specifies whether duplicate Element s should be shown or not. |
void |
setShowDuplicates(IntegerParameter showDuplicates)
Specifies whether duplicate Element s should be shown or not. |
void |
setSortAttribute(java.lang.String attributeId)
Sets the attribute id to sort after |
void |
setSortAttribute(StringParameter sortAttribute)
Sets the identifier of attribute to sort after, i.e. the parameter value should contain the id of the attribute. |
void |
setSortCriteria(int sortCriteria)
Sets the sorting criteria, i.e. one of the predefined sort criteria constants. |
void |
setSortCriteria(IntegerParameter sortCriteria)
Sets the sorting criteria, i.e. the parameter value should be one of the predefined sort criteria constants. |
void |
setSortLevel(int level)
Sets the level to sort the elements at |
void |
setSortLevel(IntegerParameter sortLevel)
Sets the level to sort the elements at as IntegerParameter |
void |
setSortLevelElement(java.lang.String sortLevelElementId)
Deprecated. please use setSortLevel(int) |
void |
setSortLevelElement(StringParameter sortLevelElement)
Deprecated. please use setSortLevel(IntegerParameter) |
void |
setSortTypeMode(int sortTypeMode)
Sets the sort by type mode. |
void |
setSortTypeMode(IntegerParameter sortTypeMode)
Sets the sort by type mode, i.e. the parameter value should be one of the predefined sort by type mode constants. |
void |
unbind()
Releases this filter settings instance from a previously binded Subset2
NOTE: PLEASE DON'T USE! |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int HIERARCHICAL_MODE_DISABLED
public static final int HIERARCHICAL_MODE_SHOW_CHILDREN
public static final int HIERARCHICAL_MODE_HIDE_CHILDREN
public static final int SORT_TYPE_DISABLED
public static final int SORT_TYPE_LEAFS_ONLY
public static final int SORT_TYPE_CONSOLIDATIONS_ONLY
public static final int ORDER_MODE_REVERSE_DISABLED
public static final int ORDER_MODE_REVERSE_TOTAL
public static final int ORDER_MODE_REVERSE_PER_LEVEL
public static final int SORT_CRITERIA_DEFINITION
public static final int SORT_CRITERIA_DATA
public static final int SORT_CRITERIA_LEXICAL
public static final int SORT_CRITERIA_ALIAS
Constructor Detail |
---|
public SortingFilterSetting()
Method Detail |
---|
public final IntegerParameter getShowDuplicates()
Element
s should be shown or not, i.e.
if duplicates should be displayed the value of the returned
IntegerParameter
is 1
, otherwise 0
.
public final void setShowDuplicates(int showDuplicates)
Element
s should be shown or not.
showDuplicates
- pass 1
to show duplicate elements,
pass 0
to hide duplicatespublic final void setShowDuplicates(IntegerParameter showDuplicates)
Element
s should be shown or not.
showDuplicates
- to show duplicate elements the value of the passed
IntegerParameter
must be 1
. To hide duplicates
the value must be 0
.public final IntegerParameter getSortCriteria()
public final void setSortCriteria(int sortCriteria)
sortCriteria
- should be one of the predefined sort criteria
constantspublic final void setSortCriteria(IntegerParameter sortCriteria)
sortCriteria
- the new IntegerParameter
to use for the
sorting criteriapublic final boolean doReverseOrder()
true
if reverse order mode should be used,
false
otherwisepublic final IntegerParameter getOrderMode()
public final void setOrderMode(int orderMode)
orderMode
- the new order modepublic final void setOrderMode(IntegerParameter orderMode)
orderMode
- the new IntegerParameter
to use for the
order modepublic final boolean doSortByType()
true
if sort by type mode should be used,
false
otherwisepublic final IntegerParameter getSortTypeMode()
public final void setSortTypeMode(int sortTypeMode)
sortTypeMode
- the new sort by type modepublic final void setSortTypeMode(IntegerParameter sortTypeMode)
sortTypeMode
- the new IntegerParameter
to use for the
sort by type modepublic final boolean doHierarchy()
true
if a hierarchy mode is active,
false
otherwisepublic final IntegerParameter getHierarchicalMode()
public final void setHierarchicalMode(int hierarchicalMode)
hierarchicalMode
- the new hierarchical modepublic final void setHierarchicalMode(IntegerParameter hierarchicalMode)
hierarchicalMode
- the new IntegerParameter
to use for
the hierarchical modepublic final boolean doSortPerLevel()
true
if sort per level mode should be used,
false
otherwisepublic final IntegerParameter getSortLevel()
public final void setSortLevel(int level)
level
- the sort levelpublic final void setSortLevel(IntegerParameter sortLevel)
IntegerParameter
sortLevel
- the sort levelpublic final StringParameter getSortLevelElement()
getSortLevel()
public final void setSortLevelElement(java.lang.String sortLevelElementId)
setSortLevel(int)
sortLevelElementId
- the sort per level reference element idpublic final void setSortLevelElement(StringParameter sortLevelElement)
setSortLevel(IntegerParameter)
sortLevelElementId
- the new StringParameter
to use for
the sort per level modepublic final boolean doSortByAttribute()
true
if sort by attribute mode should be used,
false
otherwisepublic final StringParameter getSortAttribute()
public final void setSortAttribute(java.lang.String attributeId)
sortAttribute
- public final void setSortAttribute(StringParameter sortAttribute)
sortAttribute
- the new StringParameter
to use for
the sort by attribute modepublic final void reset()
FilterSetting
public final void bind(Subset2 subset)
FilterSetting
Binds this filter settings instance to the given Subset2
bind
in interface FilterSetting
bind
in class AbstractFilterSettings
public final void unbind()
FilterSetting
Releases this filter settings instance from a previously binded
Subset2
unbind
in interface FilterSetting
unbind
in class AbstractFilterSettings
public final void adapt(FilterSetting from)
FilterSetting
from
- the filter setting to adapt from
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |