org.eclipse.hyades.trace.ui.internal.util
Class FilterSetElement

java.lang.Object
  org.eclipse.hyades.trace.ui.internal.util.FilterSetElement

public class FilterSetElement

extends java.lang.Object

A filter set containing one or more filter criteria. Each filter set has an ID, which is either provided as a default, or a dynamic one is generated for sets added by the user. In order to translate properly, the default sets contain a key which points to the resource bundle property with the name.

Constructor Summary

FilterSetElement(java.lang.String id)
Constructs a new FilterSetElement with the given unique identifier.

Method Summary

java.util.ArrayList	getChildren() Returns the filter elements contained by this filter set.
java.lang.String	getDisplayName() Returns the string containing the name to be displayed for this filter set.
java.lang.String	getId() Returns the unique language-neutral identifier of this filter set.
java.lang.String	getKey() Returns the resource bundle key for this filter set's name.
java.lang.String	getName() Returns the name field for this filter set.
void	setChildren(java.util.ArrayList children) Assigns the given patterns and directives to this filter set.
void	setId(java.lang.String id) Sets this filter set's unique language-neutral identifier.
void	setKey(java.lang.String key) Set the resource bundle key for this filter set's name.
void	setName(java.lang.String name) Sets the filter set's name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterSetElement

public FilterSetElement(java.lang.String id)

Constructs a new FilterSetElement with the given unique identifier.

Parameters:

id - the unique language-neutral identifier.

Method Detail

getId

public java.lang.String getId()

Returns the unique language-neutral identifier of this filter set.

Returns:

the filter set's ID.

getDisplayName

public java.lang.String getDisplayName()

Returns the string containing the name to be displayed for this filter set. The difference with getName() is that this one will lookup the key for the default sets. Default filter sets must store the key to the property string, because they can be translated (unless the user renames them).

Returns:

the name to be displayed for this filter set.

getKey

public java.lang.String getKey()

Returns the resource bundle key for this filter set's name. This is used for default sets only. They must be properly translated, even when the language is changed, so it is necessary to store the key. If the key is present, the name should not be used, but looked up using this key.

Returns:

the resource bundle key for this filter's name.

getName

public java.lang.String getName()

Returns the name field for this filter set. This does not lookup the translated name for the default sets. To get the display name, use getDisplayName() instead.

Returns:

the name field for this filter set.

setId

public void setId(java.lang.String id)

Sets this filter set's unique language-neutral identifier.

Parameters:

id - the identifier to use; any string.

setKey

public void setKey(java.lang.String key)

Set the resource bundle key for this filter set's name. This should only be used if there is no name field set.

Parameters:

key - the resource bundle key for this filter set's name.

setName

public void setName(java.lang.String name)

Sets the filter set's name. This will override the default translated name for default sets. New names assigned by the user cannot be translated.

Parameters:

name - the new name for this filter set.

getChildren

public java.util.ArrayList getChildren()

Returns the filter elements contained by this filter set. This comprises the class/method patterns, and also the directive (include/exclude).

Returns:

the filter set's elements, or children.

setChildren

public void setChildren(java.util.ArrayList children)

Assigns the given patterns and directives to this filter set.

Parameters:

children - the filter set elements to assign.