Gephi Toolkit Javadoc

org.gephi.ranking.api
Interface RankingEvent

All Known Implementing Classes:
RankingEventImpl

public interface RankingEvent

Event generated by the RankingModel and sent to listeners registered by the model.

The types of events:

Author:
Mathieu Bastian
See Also:
RankingListener

Nested Class Summary
static class RankingEvent.EventType
           REFRESH_RANKING: The list of available ranking has been updated.
 
Method Summary
 RankingEvent.EventType getEventType()
          Returns the type of event.
 Ranking getRanking()
          Returns the ranking associated to the event, or null.
 RankingModel getSource()
          Returns the ranking model that generated the event.
 Transformer getTransformer()
          Returns the transformer associated to the event, or null.
 boolean is(RankingEvent.EventType... type)
          Returns true if this event is one of these in parameters.
 

Method Detail

getEventType

RankingEvent.EventType getEventType()
Returns the type of event.

Returns:
the type of this event

getSource

RankingModel getSource()
Returns the ranking model that generated the event.

Returns:
the source of the event

getRanking

Ranking getRanking()
Returns the ranking associated to the event, or null.

Returns:
the ranking associated to the event or null

getTransformer

Transformer getTransformer()
Returns the transformer associated to the event, or null.

Returns:
the ranking associated to the event or null

is

boolean is(RankingEvent.EventType... type)
Returns true if this event is one of these in parameters.

Parameters:
type - the event types that are to be compared with this event
Returns:
true if this event is type, false otherwise

Gephi Toolkit Javadoc