org.sbml.jsbml.util.filters

Class NameFilter

java.lang.Object

org.sbml.jsbml.util.filters.NameFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

SpeciesReferenceFilter

public class NameFilter
extends java.lang.Object
implements Filter

This filter only accepts instances of SBase with the id or name as given in the constructor of this object.

Since:

0.8

Author:

Andreas Dräger

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	id The desired identifier.
(package private) java.lang.String	name The desired name.

Constructor Summary

Constructors

Constructor and Description
NameFilter() Creates a new NameFilter instance
NameFilter(java.lang.String id) Creates a new NameFilter instance with the given id to search for.
NameFilter(java.lang.String id, java.lang.String name) Creates a new NameFilter instance with the given id and/or name to search for.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(java.lang.Object o) This method checks whether the given object is of the correct type and has the desired properties set to be acceptable.
java.lang.String	getId() Returns the id.
java.lang.String	getName() Returns the name.
void	setId(java.lang.String id) Sets the id to search for.
void	setName(java.lang.String name) Sets the name to search for.

Methods inherited from class java.lang.Object

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

Field Detail

id

java.lang.String id

The desired identifier.

name

java.lang.String name

The desired name.

Constructor Detail

NameFilter

public NameFilter()

Creates a new NameFilter instance

NameFilter

public NameFilter(java.lang.String id)

Creates a new NameFilter instance with the given id to search for.

Parameters:

id - the id to search for

NameFilter

public NameFilter(java.lang.String id,
                  java.lang.String name)

Creates a new NameFilter instance with the given id and/or name to search for.

Parameters:

id - the id to search for (can be null, then we search only for name).

name - the name to search for (can be null, then we search only for id)

Method Detail

accepts

public boolean accepts(java.lang.Object o)

Description copied from interface: Filter

This method checks whether the given object is of the correct type and has the desired properties set to be acceptable.

Specified by:

accepts in interface Filter

Parameters:

o - some object whose properties are to be checked.

Returns:

True if the object is sufficient to be acceptable or false if at least one of its properties or its class name does not fit into this filter criterion.

getId

public java.lang.String getId()

Returns the id.

Returns:

the id

getName

public java.lang.String getName()

Returns the name.

Returns:

the name

setId

public void setId(java.lang.String id)

Sets the id to search for.

Parameters:

id - the id to set

setName

public void setName(java.lang.String name)

Sets the name to search for.

Parameters:

name - the name to set