Package org.jfree.data.flow

Class FlowKey<K extends java.lang.Comparable<K>>

  • Type Parameters:
    K - the type for the keys used to identify sources and destinations (String is a good default choice).
    All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, PublicCloneable
    public class FlowKey<K extends java.lang.Comparable<K>>
extends java.lang.Object
implements PublicCloneable, java.io.Serializable
    A key that identifies a flow within a dataset.
    Since:
    1.5.3
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private K destination  
      static java.lang.String SELECTED_PROPERTY_KEY
      The key for a flow property that, if defined (at the dataset level), contains a Boolean value for the selection status of the flow.
      private K source  
      private int stage
      The stage.

    • Constructor Summary

      Constructors 
      Constructor Description
      FlowKey​(int stage, K source, K destination)
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      Returns a clone of the object.
      boolean equals​(java.lang.Object obj)
      Tests this instance for equality with an arbitrary object.
      K getDestination()
      Returns the destination identifier.
      K getSource()
      Returns the source identifier.
      int getStage()
      Returns the stage number for the flow.
      int hashCode()
      Returns a hashcode for this instance.
      java.lang.String toString()
      Returns a string representation of this instance, primarily for debugging purposes.

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • SELECTED_PROPERTY_KEY

        public static final java.lang.String SELECTED_PROPERTY_KEY
        The key for a flow property that, if defined (at the dataset level), contains a Boolean value for the selection status of the flow.
        See Also:
        Constant Field Values

      • stage

        private final int stage
        The stage.

      • source

        private final K extends java.lang.Comparable<K> source

      • destination

        private final K extends java.lang.Comparable<K> destination

    • Constructor Detail

      • FlowKey

        public FlowKey​(int stage,
               K source,
               K destination)
        Creates a new instance.
        Parameters:
        stage - the stage.
        source - the source identifier (null not permitted).
        destination - the destination identifier (null not permitted).

    • Method Detail

      • getStage

        public int getStage()
        Returns the stage number for the flow.
        Returns:
        The stage number.

      • getSource

        public K getSource()
        Returns the source identifier.
        Returns:
        The source identifier (never null).

      • getDestination

        public K getDestination()
        Returns the destination identifier.
        Returns:
        The destination identifier (never null).

      • toString

        public java.lang.String toString()
        Returns a string representation of this instance, primarily for debugging purposes.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string.

      • equals

        public boolean equals​(java.lang.Object obj)
        Tests this instance for equality with an arbitrary object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.

      • hashCode

        public int hashCode()
        Returns a hashcode for this instance.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hashcode.

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Description copied from interface: PublicCloneable
        Returns a clone of the object.
        Specified by:
        clone in interface PublicCloneable
        Overrides:
        clone in class java.lang.Object
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - if cloning is not supported for some reason.