jgromacs.data
Class FrameIndexSet

java.lang.Object
  extended by jgromacs.data.FrameIndexSet
All Implemented Interfaces:
java.lang.Cloneable

public class FrameIndexSet
extends java.lang.Object
implements java.lang.Cloneable

Objects of this class represent a single frame index set


Constructor Summary
FrameIndexSet()
          Constructs a new FrameIndexSet object
FrameIndexSet(java.util.ArrayList<java.lang.Integer> list)
          Constructs a new FrameIndexSet object and loads data from an ArrayList
FrameIndexSet(java.util.ArrayList<java.lang.Integer> list, java.lang.String name)
          Constructs a new FrameIndexSet object of a given name and loads data from an ArrayList
FrameIndexSet(FrameIndexSet set)
          Constructs a new FrameIndexSet object identical to a given FrameIndexSet
FrameIndexSet(java.lang.String name)
          Constructs a new FrameIndexSet object of a given name
FrameIndexSet(java.util.TreeSet<java.lang.Integer> set)
          Constructs a new FrameIndexSet object and loads data from a TreeSet
FrameIndexSet(java.util.TreeSet<java.lang.Integer> set, java.lang.String name)
          Constructs a new FrameIndexSet object of a given name and loads data from a TreeSet
 
Method Summary
 void addFrame(int frame_index)
          Adds a new frame to the frame index set
 java.lang.Object clone()
          Returns an identical FrameIndexSet object
 boolean equals(java.lang.Object other)
          Returns true if this frame index set is identical to another
 java.util.ArrayList<java.lang.Integer> getAsArrayList()
          Returns frame index set as an ArrayList
 java.util.TreeSet<java.lang.Integer> getAsTreeSet()
          Returns frame index set as a TreeSet
 java.lang.String getName()
          Returns the name of frame index set
 int getNumberOfFrames()
          Returns the number of frames in this frame index set
 int hashCode()
          Returns hash code
 FrameIndexSet intersect(FrameIndexSet other)
          Returns the intersection of this frame index set and another
 boolean isFrameIn(int frame_index)
          Returns true if the frame index set contains a given frame index
 void removeFrame(int frame_index)
          Removes a frame from the frame index set
 void setName(java.lang.String name)
          Sets the name of frame index set
 FrameIndexSet subtract(FrameIndexSet other)
          Returns the subtraction of another frame index set from this frame index set
 java.lang.String toString()
          Returns the String representation of frame index set
 java.lang.String toStringInfo()
          Returns summary information about the frame index set
 FrameIndexSet union(FrameIndexSet other)
          Returns the union of this frame index set and another
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FrameIndexSet

public FrameIndexSet()
Constructs a new FrameIndexSet object


FrameIndexSet

public FrameIndexSet(java.lang.String name)
Constructs a new FrameIndexSet object of a given name


FrameIndexSet

public FrameIndexSet(java.util.ArrayList<java.lang.Integer> list)
Constructs a new FrameIndexSet object and loads data from an ArrayList


FrameIndexSet

public FrameIndexSet(java.util.ArrayList<java.lang.Integer> list,
                     java.lang.String name)
Constructs a new FrameIndexSet object of a given name and loads data from an ArrayList


FrameIndexSet

public FrameIndexSet(java.util.TreeSet<java.lang.Integer> set)
Constructs a new FrameIndexSet object and loads data from a TreeSet


FrameIndexSet

public FrameIndexSet(java.util.TreeSet<java.lang.Integer> set,
                     java.lang.String name)
Constructs a new FrameIndexSet object of a given name and loads data from a TreeSet


FrameIndexSet

public FrameIndexSet(FrameIndexSet set)
Constructs a new FrameIndexSet object identical to a given FrameIndexSet

Method Detail

getName

public java.lang.String getName()
Returns the name of frame index set

Returns:
Name of frame index set

setName

public void setName(java.lang.String name)
Sets the name of frame index set


getAsTreeSet

public java.util.TreeSet<java.lang.Integer> getAsTreeSet()
Returns frame index set as a TreeSet

Returns:
frame index set as a TreeSet

getAsArrayList

public java.util.ArrayList<java.lang.Integer> getAsArrayList()
Returns frame index set as an ArrayList

Returns:
frame index set as an ArrayList

getNumberOfFrames

public int getNumberOfFrames()
Returns the number of frames in this frame index set

Returns:
number of frames

isFrameIn

public boolean isFrameIn(int frame_index)
Returns true if the frame index set contains a given frame index


addFrame

public void addFrame(int frame_index)
Adds a new frame to the frame index set


removeFrame

public void removeFrame(int frame_index)
Removes a frame from the frame index set


intersect

public FrameIndexSet intersect(FrameIndexSet other)
Returns the intersection of this frame index set and another

Returns:
intersection of two frame index sets

subtract

public FrameIndexSet subtract(FrameIndexSet other)
Returns the subtraction of another frame index set from this frame index set

Returns:
subtraction of two frame index sets

union

public FrameIndexSet union(FrameIndexSet other)
Returns the union of this frame index set and another

Returns:
union of two frame index sets

toString

public java.lang.String toString()
Returns the String representation of frame index set

Overrides:
toString in class java.lang.Object
Returns:
String representation

toStringInfo

public java.lang.String toStringInfo()
Returns summary information about the frame index set

Returns:
summary information

equals

public boolean equals(java.lang.Object other)
Returns true if this frame index set is identical to another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Returns hash code

Overrides:
hashCode in class java.lang.Object

clone

public java.lang.Object clone()
Returns an identical FrameIndexSet object

Overrides:
clone in class java.lang.Object
Returns:
clone of the frame index set