omero.gateway.model

Class ROICoordinate

java.lang.Object

omero.gateway.model.ROICoordinate

All Implemented Interfaces:

Comparator

public class ROICoordinate
extends Object
implements Comparator

Defines a plane.

Since:

3.0-Beta4

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
ROICoordinate() Creates a default instance.
ROICoordinate(int z, int t) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
int	compare(Object o1, Object o2) Implemented as specified by the Comparator I/F.
boolean	equals(Object obj) Overridden to control if the passed object equals the current one.
int	getTimePoint() Returns the timepoint.
int	getZSection() Returns the z-section.
int	hashCode() Calculate the hashCode for the data, The hashcode is generated by bitshifting z by ZTBITSPLIT bits and adding t.
String	toString() Returns the string of the coordinates.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

ROICoordinate

public ROICoordinate()

Creates a default instance.

ROICoordinate

public ROICoordinate(int z,
                     int t)

Creates a new instance.

Parameters:

z - The z-section.

t - The timepoint.

Method Detail

getTimePoint

public int getTimePoint()

Returns the timepoint.

Returns:

See above.

getZSection

public int getZSection()

Returns the z-section.

Returns:

See above.

compare

public int compare(Object o1,
                   Object o2)

Implemented as specified by the Comparator I/F.

Specified by:

compare in interface Comparator

See Also:

If any attribute == -1 it is not included in comparison.

equals

public boolean equals(Object obj)

Overridden to control if the passed object equals the current one. If any attribute == -1 it is not included in comparison.

Specified by:

equals in interface Comparator

Overrides:

equals in class Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Calculate the hashCode for the data, The hashcode is generated by bitshifting z by ZTBITSPLIT bits and adding t.

Overrides:

hashCode in class Object

Returns:

See above.

toString

public String toString()

Returns the string of the coordinates.

Overrides:

toString in class Object

See Also:

Object.toString()