gov.nih.nlm.nls.vtt.Model
Class TagFilter

java.lang.Object
  gov.nih.nlm.nls.vtt.Model.TagFilter

public class TagFilter
extends java.lang.Object

This is the Tag filter Java object class. It is used for filtering name and category.

History:

Version:

V-2010

Author:

NLM NLS Development Team, clu

Constructor Summary

TagFilter()
Create a Tag Filter Java object with default values.

TagFilter(java.lang.String name)
Create a Tag Filter Java object by specifying name.

TagFilter(java.lang.String name, boolean status)
Create a Tag Filter Java object by specifying name and filter status.

Method Summary

static void	AddToList(java.util.Vector<TagFilter> tagFilters, java.lang.String name) Add tag filter to list by specifying name
static void	AddToList(java.util.Vector<TagFilter> tagFilters, TagFilter tagFilter) Add tag filter to list by specifying tagFilter
static boolean	Contains(java.util.Vector<TagFilter> tagFilters, java.lang.String name) Check if tag filter list contains a tag filter by specifying name
static void	DeleteFromList(java.util.Vector<TagFilter> tagFilters, java.lang.String name) Delete tag filter from list by specifying name
java.lang.String	GetName() Get the tag name of Tag Filter
boolean	GetStatus() Get the filter status
static TagFilter	GetTagFilterByName(java.util.Vector<TagFilter> tagFilters, java.lang.String name) Get a tag filter from tag filter list by specifying name
void	SetName(java.lang.String name) Set the tag name for Tag Filter
void	SetStatus(boolean status) Set the filter status

Methods inherited from class java.lang.Object

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

Constructor Detail

TagFilter

public TagFilter()

Create a Tag Filter Java object with default values.

TagFilter

public TagFilter(java.lang.String name)

Create a Tag Filter Java object by specifying name.

Parameters:

name - the tag name is in interest

TagFilter

public TagFilter(java.lang.String name,
                 boolean status)

Create a Tag Filter Java object by specifying name and filter status.

Parameters:

name - the tag name is in interest

status - the filter status

Method Detail

SetName

public void SetName(java.lang.String name)

Set the tag name for Tag Filter

Parameters:

name - the tag name is in interest

SetStatus

public void SetStatus(boolean status)

Set the filter status

Parameters:

status - the filter status

GetName

public java.lang.String GetName()

Get the tag name of Tag Filter

Returns:

tag name

GetStatus

public boolean GetStatus()

Get the filter status

Returns:

boolean flag of the filter status

AddToList

public static void AddToList(java.util.Vector<TagFilter> tagFilters,
                             java.lang.String name)

Add tag filter to list by specifying name

Parameters:

tagFilters - tag filter list

name - the tag name of tag filter to be added

AddToList

public static void AddToList(java.util.Vector<TagFilter> tagFilters,
                             TagFilter tagFilter)

Add tag filter to list by specifying tagFilter

Parameters:

tagFilters - tag filter list

tagFilter - tag filter

DeleteFromList

public static void DeleteFromList(java.util.Vector<TagFilter> tagFilters,
                                  java.lang.String name)

Delete tag filter from list by specifying name

Parameters:

tagFilters - tag filter list

name - the tag name of tag filter to be added

Contains

public static boolean Contains(java.util.Vector<TagFilter> tagFilters,
                               java.lang.String name)

Check if tag filter list contains a tag filter by specifying name

Parameters:

tagFilters - tag filter list

name - the tag name of tag filter to be checked

GetTagFilterByName

public static TagFilter GetTagFilterByName(java.util.Vector<TagFilter> tagFilters,
                                           java.lang.String name)

Get a tag filter from tag filter list by specifying name

Parameters:

tagFilters - tag filter list

name - the tag name of tag filter in interest