pairwise-logo.gif (1266 bytes)

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class PairwiseComparativeMap.PairwiseLocus

java.lang.Object
   |
   +----PairwiseComparativeMap.PairwiseLocus

public class PairwiseLocus
extends Object
This class is a data structure class that describes the concept of a locus on a pairwise comparative map. Each locus has a name, the position on the map to which it belongs and a database class from which it was derived, e.g. "Locus".

Version:
1.0

Author:
Written by Jeremy Dickson for the UK Crop Plant Bioinformatics Network, October 1998.

See Also:
PCM_FileParser, PairwiseMap, PairwiseComparativeMapData, PairwiseHomologys

Constructor Index

 o PairwiseLocus(String, float)
Default constructor describing the minimum amount of data needed to create class
 o PairwiseLocus(String, float, String)
This constructor takes in a bit more information.

Method Index

 o getLabelScreenPsn()
Gets the area of the label on screen.
 o getLocusDatabaseClass()
Return the database class of the locus.
 o getLocusName()
Returns the name of the locus.
 o getLocusPosition()
Returns the position of the locus on the map.
 o getLocusTickScreenPsn()
Gets the screen position of the tick on the map sausage.
 o getPosition_AsString()
Returns a string representation of the locus position.
 o isHighlighted()
Returns whether the locus is highlighted or not.
 o isMouseInLocus(int, int)
Returns true if the x and y co-ordinates are within the rectangular area in which the label is found.
 o setHighlighted(boolean)
Sets whether the locus is highlighted or not.
 o setLabelScreenPsn(Rectangle)
Sets the area of the label on screen.
 o setLocusTickScreenPsn(int)
Sets the screen position of the tick on the map sausage.

Constructors

 o PairwiseLocus
 public PairwiseLocus(String locusName,
                      float locusPosition)
Default constructor describing the minimum amount of data needed to create class

Parameters:
locusName - The name of the locus.
locusPosition - The position of the locus on the map.
 o PairwiseLocus
 public PairwiseLocus(String locusName,
                      float locusPosition,
                      String locusDatabaseClass)
This constructor takes in a bit more information.

Parameters:
locusDatabaseClass - The database class to which the locus belongs, e.g. Locus or Clone.

Methods

 o isMouseInLocus
 public boolean isMouseInLocus(int x,
                               int y)
Returns true if the x and y co-ordinates are within the rectangular area in which the label is found.

 o getPosition_AsString
 public String getPosition_AsString()
Returns a string representation of the locus position.

 o getLocusName
 public String getLocusName()
Returns the name of the locus.

 o getLocusPosition
 public float getLocusPosition()
Returns the position of the locus on the map.

 o getLocusDatabaseClass
 public String getLocusDatabaseClass()
Return the database class of the locus.

 o setLabelScreenPsn
 public void setLabelScreenPsn(Rectangle labelScreenPsn)
Sets the area of the label on screen.

 o getLabelScreenPsn
 public Rectangle getLabelScreenPsn()
Gets the area of the label on screen.

 o setLocusTickScreenPsn
 public void setLocusTickScreenPsn(int locusTickScreenPsn)
Sets the screen position of the tick on the map sausage.

 o getLocusTickScreenPsn
 public int getLocusTickScreenPsn()
Gets the screen position of the tick on the map sausage.

 o setHighlighted
 public void setHighlighted(boolean highlighted)
Sets whether the locus is highlighted or not.

 o isHighlighted
 public boolean isHighlighted()
Returns whether the locus is highlighted or not.


All Packages  Class Hierarchy  This Package  Previous  Next  Index