org.sbml.jsbml.ext.layout

Class NamedSBaseReferenceFilter

java.lang.Object

org.sbml.jsbml.util.filters.NameFilter

org.sbml.jsbml.ext.layout.NamedSBaseReferenceFilter

All Implemented Interfaces:

Filter

public class NamedSBaseReferenceFilter
extends NameFilter

This is a special NameFilter that allows users to search for a AbstractReferenceGlyph that refers to a NamedSBase with the given identifier attribute. The boolean switch filterForReference that can be changed using the setFilterForReference(boolean) method decides whether this NamedSBaseReferenceFilter should use the given identifier to filter for the actual AbstractReferenceGlyph or for the referenced NamedSBase.

Since:

1.0

Version:

$Rev: 1639 $

Author:

Andreas Dräger

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

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	setFilterForReference(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

filterForReference

private boolean filterForReference

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

Constructor Detail

NamedSBaseReferenceFilter

public NamedSBaseReferenceFilter()

Creates a new SpeciesReferenceFilter with undefined properties.

NamedSBaseReferenceFilter

public NamedSBaseReferenceFilter(NamedSBase glyph)

Creates a new NamedSBaseReferenceFilter that only accepts instances of AbstractReferenceGlyph pointing to the id of the given NamedSBase.

Parameters:

glyph - the NamedSBase of interest.

NamedSBaseReferenceFilter

public NamedSBaseReferenceFilter(java.lang.String id)

Parameters:

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

See Also:

setFilterForReference(boolean)

NamedSBaseReferenceFilter

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

Parameters:

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

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

See Also:

setFilterForReference(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

setFilterForReference

public void setFilterForReference(boolean filterForSpecies)

Parameters:

filterForSpecies - the filterForSpecies to set