Module com.genologics.ri

Package com.genologics.ri.container

Class Placement

java.lang.Object

com.genologics.ri.LimsLinkBase<E>

com.genologics.ri.LimsEntityLinkBase<Artifact>

com.genologics.ri.container.Placement

All Implemented Interfaces:

LimsEntityLink<Artifact>, LimsEntityLinkable<Artifact>, LimsLink<Artifact>, Linkable<Artifact>, Locatable, Serializable, Comparable<Placement>

public class Placement
extends LimsEntityLinkBase<Artifact>
implements Comparable<Placement>

Placement is a child element of container and provides a URI linking to the detailed representation of the artifact that is located in a specific well of the container.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	limsid	The LIMS id of the artifact.
protected URI	uri	The URI of the artifact.
protected String	wellPosition	The well position in the container.

Constructor Summary

Constructors

Constructor	Description
Placement()	Default constructor.
Placement(Artifact artifact)	Constructor from an artifact.
Placement(LimsEntityLinkable<Artifact> artifact)	Constructor from a LIMS entity linkable artifact.
Placement(LimsEntityLinkable<Artifact> artifact, String wellPosition)	Constructor from a LIMS entity linkable artifact with well position.
Placement(URI uri)	Constructor with URI.
Placement(URI uri, String wellPosition)	Constructor with URI and well position.
Placement(URI uri, String limsid, String wellPosition)	Constructor with URI, LIMS id, and well position.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Placement o)	Compares this placement to another based on well position.
Class<Artifact>	getEntityClass()	Gets the entity class for this placement.
String	getLimsid()	Gets the LIMS id of the artifact.
URI	getUri()	Gets the URI of the artifact.
String	getWellPosition()	Gets the well position in the container.
void	setLimsid(String limsid)	Sets the LIMS id of the artifact.
void	setUri(URI uri)	Sets the URI of the artifact.
void	setWellPosition(String wellPosition)	Sets the well position in the container.
String	toString()	Returns a string representation of the placement.

Methods inherited from class com.genologics.ri.LimsLinkBase

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.genologics.ri.LimsEntityLink

getLink

Methods inherited from interface com.genologics.ri.LimsEntityLinkable

getLimsId, setLimsId

Field Details

uri

protected URI uri

The URI of the artifact.

limsid

protected String limsid

The LIMS id of the artifact.

wellPosition

protected String wellPosition

The well position in the container.

Constructor Details

Placement

public Placement()

Default constructor.

Placement

public Placement(URI uri)

Constructor with URI.

Parameters:

uri - The URI.

Placement

public Placement(URI uri,
 String wellPosition)

Constructor with URI and well position.

Parameters:

uri - The URI.

wellPosition - The well position.

Placement

public Placement(URI uri,
 String limsid,
 String wellPosition)

Constructor with URI, LIMS id, and well position.

Parameters:

uri - The URI.

limsid - The LIMS id.

wellPosition - The well position.

Placement

public Placement(LimsEntityLinkable<Artifact> artifact)

Constructor from a LIMS entity linkable artifact.

Parameters:

artifact - The artifact.

Placement

public Placement(LimsEntityLinkable<Artifact> artifact,
 String wellPosition)

Constructor from a LIMS entity linkable artifact with well position.

Parameters:

artifact - The artifact.

wellPosition - The well position.

Placement

public Placement(Artifact artifact)

Constructor from an artifact. Extracts the well position from the artifact's location if available.

Parameters:

artifact - The artifact.

Method Details

getEntityClass

public Class<Artifact> getEntityClass()

Gets the entity class for this placement.

Specified by:

getEntityClass in interface LimsLink<Artifact>

Returns:

The Artifact class.

getUri

public URI getUri()

Gets the URI of the artifact.

Specified by:

getUri in interface LimsLink<Artifact>

Specified by:

getUri in interface Locatable

Returns:

The URI.

setUri

public void setUri(URI uri)

Sets the URI of the artifact.

Specified by:

setUri in interface Locatable

Parameters:

uri - The URI.

getLimsid

public String getLimsid()

Gets the LIMS id of the artifact.

Specified by:

getLimsid in interface LimsEntityLinkable<Artifact>

Returns:

The LIMS id.

setLimsid

public void setLimsid(String limsid)

Sets the LIMS id of the artifact.

Specified by:

setLimsid in interface LimsEntityLinkable<Artifact>

Parameters:

limsid - The LIMS id.

getWellPosition

public String getWellPosition()

Gets the well position in the container.

Returns:

The well position.

setWellPosition

public void setWellPosition(String wellPosition)

Sets the well position in the container.

Parameters:

wellPosition - The well position.

compareTo

public int compareTo(Placement o)

Compares this placement to another based on well position. Well positions are compared intelligently, taking into account numeric and alphabetic parts.

Specified by:

compareTo in interface Comparable<Placement>

Parameters:

o - The other placement to compare to.

Returns:

A negative integer, zero, or a positive integer as this placement is less than, equal to, or greater than the specified placement.

toString

public String toString()

Returns a string representation of the placement.

Overrides:

toString in class LimsLinkBase<Artifact>

Returns:

A string representation containing the LIMS id and well position.

See Also:

• LimsLink.toString(LimsLink)