org.sbml.jsbml.util.filters

Class SpeciesReferenceFilter

java.lang.Object

org.sbml.jsbml.util.filters.NameFilter

org.sbml.jsbml.util.filters.SpeciesReferenceFilter

All Implemented Interfaces:

Filter

public class SpeciesReferenceFilter
extends NameFilter

This is a special NameFilter that allows users to search for a SimpleSpeciesReference that refers to a Species with the given identifier attribute. The boolean switch filterForSpecies that can be changed using the setFilterForSpecies(boolean) method decides whether this SpeciesReferenceFilter should use the given identifier to filter for the actual SimpleSpeciesReference or for the referenced Species.

Since:

0.8

Version:

$Rev$

Author:

Andreas Dräger

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	filterForSpecies Decides whether to filter for the identifier of the referenced Species or if to use id and name to filter for the instance of SimpleSpeciesReference itself.

Fields inherited from class org.sbml.jsbml.util.filters.NameFilter

id, name

Constructor Summary

Constructors

Constructor and Description
SpeciesReferenceFilter() Creates a new SpeciesReferenceFilter with undefined properties.
SpeciesReferenceFilter(Species species) Creates a new SpeciesReferenceFilter that only accepts instances of SpeciesReference pointing to the id of the given Species.
SpeciesReferenceFilter(java.lang.String id)
SpeciesReferenceFilter(java.lang.String id, java.lang.String name)

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.
boolean	isFilterForSpecies()
void	setFilterForSpecies(boolean filterForSpecies)

Methods inherited from class org.sbml.jsbml.util.filters.NameFilter

getId, getName, setId, setName

Methods inherited from class java.lang.Object

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

Field Detail

filterForSpecies

private boolean filterForSpecies

Decides whether to filter for the identifier of the referenced Species or if to use id and name to filter for the instance of SimpleSpeciesReference itself.

Constructor Detail

SpeciesReferenceFilter

public SpeciesReferenceFilter()

Creates a new SpeciesReferenceFilter with undefined properties.

SpeciesReferenceFilter

public SpeciesReferenceFilter(Species species)

Creates a new SpeciesReferenceFilter that only accepts instances of SpeciesReference pointing to the id of the given Species.

Parameters:

species - the Species of interest.

SpeciesReferenceFilter

public SpeciesReferenceFilter(java.lang.String id)

Parameters:

id - the identifier of a Species or SpeciesReference we are interested in. Whether we accept the id of a Species or a SpeciesReference depends on the flag that can be defined with setFilterForSpecies(boolean).

See Also:

setFilterForSpecies(boolean)

SpeciesReferenceFilter

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

Parameters:

id - the identifier of a Species or SpeciesReference we are interested in. Whether we accept the id of a Species or a SpeciesReference depends on the flag that can be defined with setFilterForSpecies(boolean).

name - the name of the element we are interested in.

See Also:

setFilterForSpecies(boolean)

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

Overrides:

accepts in class NameFilter

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.

isFilterForSpecies

public boolean isFilterForSpecies()

Returns:

the filterForSpecies

setFilterForSpecies

public void setFilterForSpecies(boolean filterForSpecies)

Parameters:

filterForSpecies - the filterForSpecies to set