org.palo.api.subsets.filter.settings
Class HierarchicalFilterSetting

java.lang.Object
  extended by org.palo.api.subsets.filter.settings.AbstractFilterSettings
      extended by org.palo.api.subsets.filter.settings.HierarchicalFilterSetting
All Implemented Interfaces:
FilterSetting

public class HierarchicalFilterSetting
extends AbstractFilterSettings

HierarchicalFilterSetting

Manages the settings for the HierarchicalFilter.

Version:
$Id: HierarchicalFilterSetting.html,v 1.5 2009/07/09 11:01:46 ArndHouben Exp $

Field Summary
static int HIDE_MODE_CONSOLIDATIONS
           
static int HIDE_MODE_DISABLED
           
static int HIDE_MODE_LEAFS
           
static int REVOLVE_ADD_ABOVE
           
static int REVOLVE_ADD_BELOW
           
static int REVOLVE_ADD_DISABLED
           
 
Constructor Summary
HierarchicalFilterSetting()
           
 
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 doAboveBelowSelection()
          Checks if a reference element is specified for above/below selection
 boolean doHide()
          Checks if hide mode is active
 boolean doLevelSelection()
          Checks if start or end elements are specified for level selection
 boolean doRevolve()
          Checks if a revolve element is specified.
 BooleanParameter getAbove()
          Checks if all elements above the reference element should be used for above/below selection
 StringParameter getEndElement()
          Deprecated. please use getEndLevel()
 IntegerParameter getEndLevel()
          Returns the end level for selection based on element level
 BooleanParameter getExclusive()
          Checks if reference element should be considered for above/below selection too
 IntegerParameter getHideMode()
          Returns the hide mode to use, i.e. one of the predefined hide mode constants
 StringParameter getRefElement()
          Returns the identifier of the specified reference element for above/below selection
 IntegerParameter getRevolveCount()
          Returns the number of elements to take for revolve selection
 StringParameter getRevolveElement()
          Returns the identifier of the specified revolve element for revolve selection
 IntegerParameter getRevolveMode()
          Returns the revolve mode, i.e. one of the predefined revolve mode constants
 StringParameter getStartElement()
          Deprecated. please use getStartLevel()
 IntegerParameter getStartLevel()
          Returns the start level for selection based on element level
 void reset()
          Resets the filter setting to its defaults.
 void setAbove(boolean above)
          Specifies if all elements above the reference element should be used for above/below selection
 void setAbove(BooleanParameter above)
          Specifies if all elements above the reference element should be included in selection
 void setEndElement(java.lang.String elementId)
          Deprecated. please use setEndLevel(int)
 void setEndElement(StringParameter element)
          Deprecated. please use setEndLevel(IntegerParameter)
 void setEndLevel(int level)
          Sets the end level for selection based on element level
 void setEndLevel(IntegerParameter level)
          Sets the end level for selection based on element level
 void setExclusive(boolean exclusive)
          Specifies if reference element should be considered for above/below selection too
 void setExclusive(BooleanParameter exclusive)
          Specifies if the reference element should be included or excluded in the selection
 void setHideMode(int hideMode)
          Sets the hide mode.
 void setHideMode(IntegerParameter hideMode)
          Sets the hide mode.
 void setRefElement(java.lang.String elementId)
          Sets the identifier of the reference element for above/below selection
 void setRefElement(StringParameter element)
          Sets the identifier of the reference element for above/below selection, i.e. the parameter value should contain the id of the reference element.
 void setRevolveCount(int revolveElementsCount)
          Specifies the number of elements to take for revolve selection
 void setRevolveCount(IntegerParameter revolveElementsCount)
          Sets the revolve count, i.e. the parameter value should contain the number of elements to take for revolve selection
 void setRevolveElement(java.lang.String elementId)
          Sets the identifier of the revolve element for revolve selection
 void setRevolveElement(StringParameter elementId)
          Sets the identifier of the revolve element for revolve selection, i.e. the parameter value should contain the id of the revolve element.
 void setRevolveMode(int revolveMode)
          Sets the revolve mode.
 void setRevolveMode(IntegerParameter revolveMode)
          Sets the revolve mode, i.e. the parameter value should be one of the predefined revolve mode constants
 void setStartElement(java.lang.String elementId)
          Deprecated. please use setStartLevel(int)
 void setStartElement(StringParameter element)
          Deprecated. please use setStartLevel(IntegerParameter)
 void setStartLevel(int level)
          Sets the start level for selection based on element level
 void setStartLevel(IntegerParameter level)
          Sets the start level for selection based on element level
 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

HIDE_MODE_DISABLED

public static final int HIDE_MODE_DISABLED
See Also:
Constant Field Values

HIDE_MODE_LEAFS

public static final int HIDE_MODE_LEAFS
See Also:
Constant Field Values

HIDE_MODE_CONSOLIDATIONS

public static final int HIDE_MODE_CONSOLIDATIONS
See Also:
Constant Field Values

REVOLVE_ADD_DISABLED

public static final int REVOLVE_ADD_DISABLED
See Also:
Constant Field Values

REVOLVE_ADD_BELOW

public static final int REVOLVE_ADD_BELOW
See Also:
Constant Field Values

REVOLVE_ADD_ABOVE

public static final int REVOLVE_ADD_ABOVE
See Also:
Constant Field Values
Constructor Detail

HierarchicalFilterSetting

public HierarchicalFilterSetting()
Method Detail

reset

public final void reset()
Description copied from interface: FilterSetting
Resets the filter setting to its defaults.


doAboveBelowSelection

public final boolean doAboveBelowSelection()
Checks if a reference element is specified for above/below selection

Returns:
true if a reference element is specified, false otherwise

doLevelSelection

public final boolean doLevelSelection()
Checks if start or end elements are specified for level selection

Returns:
true if either a start or an end element is specified, false otherwise

doHide

public final boolean doHide()
Checks if hide mode is active

Returns:
true if a hide mode should be used, false otherwise

doRevolve

public final boolean doRevolve()
Checks if a revolve element is specified.

Returns:
true if a revolve element is specified, false otherwise

getRefElement

public final StringParameter getRefElement()
Returns the identifier of the specified reference element for above/below selection

Returns:
reference element id

setRefElement

public final void setRefElement(java.lang.String elementId)
Sets the identifier of the reference element for above/below selection

Parameters:
elementId - the reference element

setRefElement

public final void setRefElement(StringParameter element)
Sets the identifier of the reference element for above/below selection, i.e. the parameter value should contain the id of the reference element.

Parameters:
element - the new StringParameter to use for the above/below selection

getAbove

public final BooleanParameter getAbove()
Checks if all elements above the reference element should be used for above/below selection

Returns:
true if all elements above reference element should be used, false otherwise

setAbove

public final void setAbove(boolean above)
Specifies if all elements above the reference element should be used for above/below selection

Parameters:
above - set to true if all elements above reference elements should be used, to false otherwise

setAbove

public final void setAbove(BooleanParameter above)
Specifies if all elements above the reference element should be included in selection

Parameters:
above -

getExclusive

public final BooleanParameter getExclusive()
Checks if reference element should be considered for above/below selection too

Returns:
true if reference element should not be considered too, false otherwise

setExclusive

public final void setExclusive(boolean exclusive)
Specifies if reference element should be considered for above/below selection too

Parameters:
exclusive - set to true to exclude reference element, to false to include it

setExclusive

public final void setExclusive(BooleanParameter exclusive)
Specifies if the reference element should be included or excluded in the selection

Parameters:
exclusive -

getHideMode

public final IntegerParameter getHideMode()
Returns the hide mode to use, i.e. one of the predefined hide mode constants

Returns:
the hide mode

setHideMode

public final void setHideMode(int hideMode)
Sets the hide mode. One of the predefined hide mode constants should be used

Parameters:
hideMode - the new hide mode

setHideMode

public final void setHideMode(IntegerParameter hideMode)
Sets the hide mode. The parameter value should be one of the predefined hide mode constants.

Parameters:
hideMode - the new IntegerParameter to use for the hide mode

getStartLevel

public final IntegerParameter getStartLevel()
Returns the start level for selection based on element level

Returns:
start level

setStartLevel

public final void setStartLevel(int level)
Sets the start level for selection based on element level

Parameters:
level - the start level

setStartLevel

public final void setStartLevel(IntegerParameter level)
Sets the start level for selection based on element level

Parameters:
level - the start level

getEndLevel

public final IntegerParameter getEndLevel()
Returns the end level for selection based on element level

Returns:
end level

setEndLevel

public final void setEndLevel(int level)
Sets the end level for selection based on element level

Parameters:
level - the end level

setEndLevel

public final void setEndLevel(IntegerParameter level)
Sets the end level for selection based on element level

Parameters:
level - the end level

getStartElement

public final StringParameter getStartElement()
Deprecated. please use getStartLevel()

Returns the identifier of the specified start element for level selection

Returns:
start element id

setStartElement

public final void setStartElement(java.lang.String elementId)
Deprecated. please use setStartLevel(int)

Sets the identifier of the start element for level selection

Parameters:
elementId - the start element

setStartElement

public final void setStartElement(StringParameter element)
Deprecated. please use setStartLevel(IntegerParameter)

Sets the identifier of the start element for level selection, i.e. the parameter value should contain the id of the start element.

Parameters:
element - the new StringParameter to use as start element for the level selection

getEndElement

public final StringParameter getEndElement()
Deprecated. please use getEndLevel()

Returns the identifier of the specified end element for level selection

Returns:
end element id

setEndElement

public final void setEndElement(java.lang.String elementId)
Deprecated. please use setEndLevel(int)

Sets the identifier of the end element for level selection

Parameters:
elementId - the end element

setEndElement

public final void setEndElement(StringParameter element)
Deprecated. please use setEndLevel(IntegerParameter)

Sets the identifier of the end element for level selection, i.e. the parameter value should contain the id of the end element.

Parameters:
element - the new StringParameter to use as end element for the level selection

getRevolveElement

public final StringParameter getRevolveElement()
Returns the identifier of the specified revolve element for revolve selection

Returns:
revolve element id

setRevolveElement

public final void setRevolveElement(java.lang.String elementId)
Sets the identifier of the revolve element for revolve selection

Parameters:
elementId - the revolve element

setRevolveElement

public final void setRevolveElement(StringParameter elementId)
Sets the identifier of the revolve element for revolve selection, i.e. the parameter value should contain the id of the revolve element.

Parameters:
element - the new StringParameter to use as revolve element for revolve selection

getRevolveCount

public final IntegerParameter getRevolveCount()
Returns the number of elements to take for revolve selection

Returns:
revolve count

setRevolveCount

public final void setRevolveCount(int revolveElementsCount)
Specifies the number of elements to take for revolve selection

Parameters:
revolveElementsCount - the new revolve count

setRevolveCount

public final void setRevolveCount(IntegerParameter revolveElementsCount)
Sets the revolve count, i.e. the parameter value should contain the number of elements to take for revolve selection

Parameters:
revolveElementsCount - the new IntegerParameter to use as revolve count

getRevolveMode

public final IntegerParameter getRevolveMode()
Returns the revolve mode, i.e. one of the predefined revolve mode constants

Returns:
the revolve mode

setRevolveMode

public final void setRevolveMode(int revolveMode)
Sets the revolve mode. One of the predefined revolve mode constants should be used

Parameters:
revolveMode - the new revolve mode

setRevolveMode

public final void setRevolveMode(IntegerParameter revolveMode)
Sets the revolve mode, i.e. the parameter value should be one of the predefined revolve mode constants

Parameters:
revolveMode - the new IntegerParameter to use for revolve mode

bind

public final void bind(Subset2 subset)
Description copied from interface: FilterSetting

Binds this filter settings instance to the given Subset2

NOTE: PLEASE DON'T USE! INTERNAL METHOD

Specified by:
bind in interface FilterSetting
Overrides:
bind in class AbstractFilterSettings

unbind

public final void unbind()
Description copied from interface: FilterSetting

Releases this filter settings instance from a previously binded Subset2

NOTE: PLEASE DON'T USE! INTERNAL METHOD

Specified by:
unbind in interface FilterSetting
Overrides:
unbind in class AbstractFilterSettings

adapt

public final void adapt(FilterSetting from)
Description copied from interface: FilterSetting
Adapt the filter setting from the given filter setting. After that both settings are the same.

Parameters:
from - the filter setting to adapt from