Module com.genologics.ri

Package com.genologics.ri.protocolconfiguration

Class Protocol

java.lang.Object

com.genologics.ri.protocolconfiguration.Protocol

All Implemented Interfaces:

Linkable<Protocol>, Locatable, Serializable

public class Protocol
extends Object
implements Linkable<Protocol>, Serializable

Detailed representation of a protocol.

A protocol represents a collection of different steps. A protocol can be a QC protocol meaning samples go through the process mostly in parallel or a normal protocol, where samples go through in series.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	ID_EXTRACTOR_PATTERN	Regular expression to extract protocol id from a protocol URI.
protected Integer	index	The index of the protocol.
protected String	name	The name of the protocol.
protected List<ProtocolProperty>	protocolProperties	The list of protocol properties.
protected List<ProtocolStep>	steps	The list of steps in this protocol.
protected URI	uri	The URI of the protocol.

Constructor Summary

Constructors

Constructor	Description
Protocol()	Default constructor.
Protocol(URI uri)	Constructor with URI.
Protocol(URI uri, String name)	Constructor with URI and name.
Protocol(URI uri, String name, Integer index)	Constructor with URI, name, and index.

Method Summary

Modifier and Type	Method	Description
Integer	getId()	Get the numeric identifier for this protocol from its URI.
Integer	getIndex()	Gets the index of the protocol.
LimsLink<Protocol>	getLink()	Get a concrete link object to this Linkable thing.
String	getName()	Gets the name of the protocol.
List<ProtocolProperty>	getProtocolProperties()	Gets the list of protocol properties.
List<ProtocolStep>	getSteps()	Gets the list of steps in this protocol.
URI	getUri()	Gets the URI of the protocol.
void	setIndex(Integer index)	Sets the index of the protocol.
void	setName(String name)	Sets the name of the protocol.
void	setUri(URI uri)	Sets the URI of the protocol.

Methods inherited from class java.lang.Object

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

Field Details

ID_EXTRACTOR_PATTERN

public static final Pattern ID_EXTRACTOR_PATTERN

Regular expression to extract protocol id from a protocol URI.

Since:

2.22

steps

protected List<ProtocolStep> steps

The list of steps in this protocol.

protocolProperties

protected List<ProtocolProperty> protocolProperties

The list of protocol properties.

name

protected String name

The name of the protocol.

index

protected Integer index

The index of the protocol.

uri

protected URI uri

The URI of the protocol.

Constructor Details

Protocol

public Protocol()

Default constructor.

Protocol

public Protocol(URI uri)

Constructor with URI.

Parameters:

uri - The URI of the protocol.

Protocol

public Protocol(URI uri,
 String name)

Constructor with URI and name.

Parameters:

uri - The URI of the protocol.

name - The name of the protocol.

Protocol

public Protocol(URI uri,
 String name,
 Integer index)

Constructor with URI, name, and index.

Parameters:

uri - The URI of the protocol.

name - The name of the protocol.

index - The index of the protocol.

Method Details

getId

public Integer getId()

Get the numeric identifier for this protocol from its URI.

Returns:

The protocol id, or null if either the URI is not set or it doesn't match the form expected for a protocol URI.

Since:

2.22

getSteps

public List<ProtocolStep> getSteps()

Gets the list of steps in this protocol.

Returns:

The list of protocol steps.

getProtocolProperties

public List<ProtocolProperty> getProtocolProperties()

Gets the list of protocol properties.

Returns:

The list of protocol properties.

getName

public String getName()

Gets the name of the protocol.

Returns:

The protocol name.

setName

public void setName(String name)

Sets the name of the protocol.

Parameters:

name - The protocol name.

getIndex

public Integer getIndex()

Gets the index of the protocol.

Returns:

The protocol index.

setIndex

public void setIndex(Integer index)

Sets the index of the protocol.

Parameters:

index - The protocol index.

getUri

public URI getUri()

Gets the URI of the protocol.

Specified by:

getUri in interface Locatable

Returns:

The protocol URI.

setUri

public void setUri(URI uri)

Sets the URI of the protocol.

Specified by:

setUri in interface Locatable

Parameters:

uri - The protocol URI.

getLink

public LimsLink<Protocol> getLink()

Get a concrete link object to this Linkable thing.

Specified by:

getLink in interface Linkable<Protocol>

Returns:

A LimsLink to this object.