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

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

public class TextFilterSetting
extends AbstractFilterSettings

TextFilterSetting

Manages the settings for the TextFilter.

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

Constructor Summary
TextFilterSetting()
          Creates a new TextFilterSetting instance.
 
Method Summary
 void adapt(FilterSetting from)
          Adapt the filter setting from the given filter setting.
 void addExpression(java.lang.String expr)
          Adds the given expression to the list of all expressions used for textual filter
 void bind(Subset2 subset)
          Binds this filter settings instance to the given Subset2 NOTE: PLEASE DON'T USE!
 ObjectParameter getExpressions()
          Returns the expression parameter which contains all added expressions.
 BooleanParameter getExtended()
          Checks if the expressions should be handled as regular expressions.
 void removeExpression(java.lang.String expr)
          Removes the given expression from the list of all expression used for textual filter
 void reset()
          Resets the filter setting to its defaults.
 void setExpressions(ObjectParameter expressions)
          Sets the new expression parameter.
 void setExtended(boolean extended)
          Determines if the expressions should be handled as regular expressions.
 void setExtended(BooleanParameter extended)
          Sets the extended flag.
 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
 

Constructor Detail

TextFilterSetting

public TextFilterSetting()
Creates a new TextFilterSetting instance.

Method Detail

addExpression

public final void addExpression(java.lang.String expr)
Adds the given expression to the list of all expressions used for textual filter

Parameters:
expr - the expression to add

removeExpression

public final void removeExpression(java.lang.String expr)
Removes the given expression from the list of all expression used for textual filter

Parameters:
expr - the expression to remove

setExpressions

public final void setExpressions(ObjectParameter expressions)
Sets the new expression parameter. Note that the parameter value should be of type HashSet, otherwise calling this method has no effect. The HashSet should contain the String expressions to use for filtering.

Parameters:
expressions - the expression parameter

getExpressions

public final ObjectParameter getExpressions()
Returns the expression parameter which contains all added expressions.

Returns:
the expression parameter

getExtended

public final BooleanParameter getExtended()
Checks if the expressions should be handled as regular expressions.

Returns:
true if the expressions should be handled as regulars expressions, false otherwise

setExtended

public final void setExtended(boolean extended)
Determines if the expressions should be handled as regular expressions.

Parameters:
extended - specify true if the expressions should be handled as regular expressions, false otherwise

setExtended

public final void setExtended(BooleanParameter extended)
Sets the extended flag.

Parameters:
extended - the new BooleanParameter to use for the extended flag

reset

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


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

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