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

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

public class AliasFilterSetting
extends AbstractFilterSettings

AliasFilterSetting

Manages the settings for the AliasFilter.

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

Constructor Summary
AliasFilterSetting()
           
 
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!
 StringParameter getAlias(int number)
          Returns the StringParameter of the n.th alias.
 void reset()
          Resets the filter setting to its defaults.
 void setAlias(int number, java.lang.String id)
          Sets the id for the n.th alias
 void setAlias(int number, StringParameter alias)
           
 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

AliasFilterSetting

public AliasFilterSetting()
Method Detail

getAlias

public final StringParameter getAlias(int number)
Returns the StringParameter of the n.th alias. The returned StringParmeter contains the alias identifier as its value or null if no id was defined.

Parameters:
number - either 1 or 2 to get the first or second alias
Returns:
the StringParmeter of the alias to use

setAlias

public final void setAlias(int number,
                           java.lang.String id)
Sets the id for the n.th alias

Parameters:
number - either 1 or 2 to specify the first or second alias
id - the alias identifier

setAlias

public final void setAlias(int number,
                           StringParameter alias)

reset

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


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