Package org.cytoscape.model.events

Class RowsSetEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<T>

org.cytoscape.event.AbstractCyPayloadEvent<CyTable,RowSetRecord>

org.cytoscape.model.events.RowsSetEvent

All Implemented Interfaces:

CyEvent<CyTable>, CyPayloadEvent<CyTable,RowSetRecord>

public final class RowsSetEvent
extends AbstractCyPayloadEvent<CyTable,RowSetRecord>

This event signals that rows have been set.

Note: SelectedNodesAndEdgesEvent may be used instead if you just want to be signaled about node and edge selection changes.

Module: model-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>model-api</artifactId>
</dependency>

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Constructor Summary

Constructors

Constructor	Description
RowsSetEvent(CyTable source, Collection<RowSetRecord> rows)	Constructs Event.

Method Summary

Modifier and Type	Method	Description
boolean	containsColumn(String colName)	Returns true if any of the changed records' column name is colName
Collection<RowSetRecord>	getColumnRecords(String colName)	Returns all of the RowSetRecords whose specified column value is set.
Set<String>	getColumns()	Returns a unmodifiable Set of the names of the columns that are contained in this event.

Methods inherited from class org.cytoscape.event.AbstractCyPayloadEvent

getPayloadCollection

Methods inherited from class org.cytoscape.event.AbstractCyEvent

getListenerClass, getSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cytoscape.event.CyEvent

getListenerClass, getSource

Constructor Detail

RowsSetEvent

public RowsSetEvent(CyTable source,
                    Collection<RowSetRecord> rows)

Constructs Event.

Parameters:

source - the table in which the rows have been set.

rows - the rows that have been set as a Collection of type RowSetRecord.

Method Detail

containsColumn

public boolean containsColumn(String colName)

Returns true if any of the changed records' column name is colName

Parameters:

colName - Name of the column.

Returns:

getColumnRecords

public Collection<RowSetRecord> getColumnRecords(String colName)

Returns all of the RowSetRecords whose specified column value is set.

Parameters:

colName - Name of the column.

Returns:

getColumns

public Set<String> getColumns()

Returns a unmodifiable Set of the names of the columns that are contained in this event.