cytoscape.data
Interface AttributeFilter

public interface AttributeFilter

Interface for defining CyEdge-based filters used for determining which Edges should be used for a particular operation, such as CyAttributesUtils.copyAttributes().

See Also:

CyAttributesUtils.copyAttributes(java.lang.String, java.lang.String, cytoscape.data.CyAttributes, boolean)

Method Summary

boolean

includeAttribute(CyAttributes attrs, String objID, String attrName) Return true iff a given attribute should be included in some operation, such as CyAttributesUtils.copyAttributes().

Method Detail

includeAttribute

boolean includeAttribute(CyAttributes attrs,
                         String objID,
                         String attrName)

Return true iff a given attribute should be included in some operation, such as CyAttributesUtils.copyAttributes().

Parameters:

CyAttributes - attrs the CyAttributes where attrName is stored.

objID - the identifer of the object whose attrName attribute is stored in attrs.

attrName - the name of the Attribute to test. For example, if we were performing a CyAttributesUtils.copyAttributes(), returning true would mean to copy the attribute attrName for the object with key objID, within the CyAttributes attrs.

See Also:

CyAttributesUtils.copyAttributes(java.lang.String, java.lang.String, cytoscape.data.CyAttributes, boolean)