omero.gateway.model

Class ROICoordinate

java.lang.Object

omero.gateway.model.ROICoordinate

All Implemented Interfaces:

java.util.Comparator

public class ROICoordinate
extends java.lang.Object
implements java.util.Comparator

Defines a plane.

Since:

3.0-Beta4

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(java.lang.Object o1, java.lang.Object o2) Implemented as specified by the Comparator I/F.
boolean	equals(java.lang.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.
java.lang.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. (-1 == all z-sections)

t - The timepoint. (-1 == all timepoints)

Method Detail

getTimePoint

public int getTimePoint()

Returns the timepoint. (-1 == all timepoints)

Returns:

See above.

getZSection

public int getZSection()

Returns the z-section. (-1 == all z-sections)

Returns:

See above.

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)

Implemented as specified by the Comparator I/F.

Specified by:

compare in interface java.util.Comparator

See Also:

Comparator.compare(Object, Object)

equals

public boolean equals(java.lang.Object obj)

Overridden to control if the passed object equals the current one.

Specified by:

equals in interface java.util.Comparator

Overrides:

equals in class java.lang.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 java.lang.Object

Returns:

See above.

toString

public java.lang.String toString()

Returns the string of the coordinates.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()