Module org.cruk.clarity.api

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
protected String	name
protected List<ProtocolProperty>	protocolProperties
protected List<ProtocolStep>	steps
protected URI	uri

Constructor Summary

Constructors

Constructor	Description
Protocol()
Protocol(URI uri)
Protocol(URI uri, String name)
Protocol(URI uri, String name, Integer index)

Method Summary

Modifier and Type	Method	Description
Integer	getId()	Get the numeric identifier for this protocol from its URI.
Integer	getIndex()
String	getName()
List<ProtocolProperty>	getProtocolProperties()
List<ProtocolStep>	getSteps()
URI	getUri()	Get the URI of this object.
void	setIndex(Integer index)
void	setName(String name)
void	setUri(URI uri)	Set the URI of this object.

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

protocolProperties

protected List<ProtocolProperty> protocolProperties

name

protected String name

index

protected Integer index

uri

protected URI uri

Constructor Details

Protocol

public Protocol()

Protocol

public Protocol(URI uri)

Protocol

public Protocol(URI uri,
 String name)

Protocol

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

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()

getProtocolProperties

public List<ProtocolProperty> getProtocolProperties()

getName

public String getName()

setName

public void setName(String name)

getIndex

public Integer getIndex()

setIndex

public void setIndex(Integer index)

getUri

public URI getUri()

Description copied from interface: Locatable

Get the URI of this object.

Specified by:

getUri in interface Locatable

Returns:

The URI.

setUri

public void setUri(URI uri)

Description copied from interface: Locatable

Set the URI of this object.

Specified by:

setUri in interface Locatable

Parameters:

uri - The new URI.