com.objex.progeny.anywhere.data
Class ChromosomeLegendItem

java.lang.Object
  com.objex.progeny.anywhere.data.ChromosomeLegendItem

All Implemented Interfaces:

java.io.Serializable

public class ChromosomeLegendItem
extends java.lang.Object
implements java.io.Serializable

A ChromosomeLegendItem contains a list of marker legend items.

See Also:

MarkerLegend, MarkerLegendItem, Serialized Form

Constructor Summary

ChromosomeLegendItem()
Creates a new Chromosome legend item

Method Summary

void	addMarkerItem(MarkerLegendItem marker) Add a new marker legend item to the current map/list
int	getId()
MarkerLegendItem	getMarkerItem(int ai_fieldid)
MarkerLegendItem	getMarkerItem(java.lang.String name)
java.util.Map<java.lang.String,MarkerLegendItem>	getMarkerItems()
int	getMarkerItemsCount()
java.lang.String	getName() Getter for property name.
int	getNextMarkerSequence() Getter for property nextMarkerSequence.
java.util.Iterator<MarkerLegendItem>	iterator()
void	setId(int id) Set the ID of the chromosome legend item.
void	setMarkerItems(java.util.Map<java.lang.String,MarkerLegendItem> rhs) Set a new map/list of marker legend items
void	setName(java.lang.String rhs) Setter for property name.
void	setNextMarkerSequence(int rhs) Setter for property nextMarkerSequence.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChromosomeLegendItem

public ChromosomeLegendItem()

Creates a new Chromosome legend item

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMarkerItem

public MarkerLegendItem getMarkerItem(int ai_fieldid)

Parameters:

ai_fieldid - The fieldid of the marker linked to the marker legend item to be retrieved

Returns:

The marker legend item linked to marker of the same fieldid as one specified

getMarkerItem

public MarkerLegendItem getMarkerItem(java.lang.String name)

Parameters:

name - The name of the marker linked to the marker legend item to be retrieved

Returns:

The marker legend item linked to marker of the same name as one specified

addMarkerItem

public void addMarkerItem(MarkerLegendItem marker)

Add a new marker legend item to the current map/list

Parameters:

marker - The new marker legend item.

getMarkerItems

public java.util.Map<java.lang.String,MarkerLegendItem> getMarkerItems()

Returns:

The current map of marker legend items keyed by marker name

setMarkerItems

public void setMarkerItems(java.util.Map<java.lang.String,MarkerLegendItem> rhs)

Set a new map/list of marker legend items

Parameters:

rhs - The new map of marker legend items keyed by marker name

getName

public java.lang.String getName()

Getter for property name. Default ID/Name for chromosome is "1"

Returns:

Value of property name. The name of the Chromosome e.g. X, Y or some other ID

setName

public void setName(java.lang.String rhs)

Setter for property name. Sets the name of the Chromosome e.g. X, Y or some other ID. Default ID/Name for chromosome is "1"

Parameters:

rhs - New value of property name.

getNextMarkerSequence

public int getNextMarkerSequence()

Getter for property nextMarkerSequence.

Returns:

Value of property nextMarkerSequence.

setNextMarkerSequence

public void setNextMarkerSequence(int rhs)

Setter for property nextMarkerSequence.

Parameters:

rhs - New value of property nextMarkerSequence.

getMarkerItemsCount

public int getMarkerItemsCount()

Returns:

The number of marker items on this chromosome legend item

iterator

public java.util.Iterator<MarkerLegendItem> iterator()

Returns:

An iterator of marker legend items in marker sequence order

getId

public int getId()

Returns:

The ID of the chromosome legend item. This is equivalent to the chromosome ID

setId

public void setId(int id)

Set the ID of the chromosome legend item. This is equivalent to the chromosome ID

Parameters:

id - The ID of the chromosome legend item. This is equivalent to the chromosome ID