org.knime.core.node.property.hilite
Class KeyEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.knime.core.node.property.hilite.KeyEvent
All Implemented Interfaces:
Serializable

public class KeyEvent
extends EventObject

Event object that is fired when registered listener need to update its properties. An event keeps an unmodifiable set of row keys as RowKey.

Author:
Thomas Gabriel, University of Konstanz
See Also:
HiLiteHandler, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
KeyEvent(Object src)
          Creates an empty key event with the given source.
KeyEvent(Object src, RowKey... ids)
          Creates a new event with the underlying source and one data cell.
KeyEvent(Object src, Set<RowKey> ids)
          Creates a new event with the underlying source and a set of row keys.
 
Method Summary
 boolean isEmpty()
           
 Set<RowKey> keys()
          Returns the set of RowKey row keys on which the event initially occurred.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

KeyEvent

public KeyEvent(Object src)
Creates an empty key event with the given source.

Parameters:
src - the source of this key event

KeyEvent

public KeyEvent(Object src,
                RowKey... ids)
Creates a new event with the underlying source and one data cell.

Parameters:
src - the object on which the event initially occurred
ids - an array of RowKey elements for which this event is created.
Throws:
NullPointerException - if the key array is null
IllegalArgumentException - if key array contains null elements
See Also:
EventObject.EventObject(Object)

KeyEvent

public KeyEvent(Object src,
                Set<RowKey> ids)
Creates a new event with the underlying source and a set of row keys.

Parameters:
src - the object on which the event initially occurred
ids - a set of RowKey row IDs for which the event is created.
Throws:
NullPointerException - if the key set is null
IllegalArgumentException - if key array contains null elements
See Also:
EventObject.EventObject(Object)
Method Detail

keys

public Set<RowKey> keys()
Returns the set of RowKey row keys on which the event initially occurred.

Returns:
a set of row IDs

isEmpty

public boolean isEmpty()
Returns:
true, if the key event does not contain any keys


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.