ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto

Class ExperimentIdentifier

java.lang.Object

ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto.PermanentIdentifier

ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto.ExperimentIdentifier

All Implemented Interfaces:

IPermanentIdentifier, java.io.Serializable

@JsonObject(value="ExperimentIdentifier")
public class ExperimentIdentifier
extends PermanentIdentifier

Unique identifier for an experiment in openBIS.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExperimentIdentifier(java.lang.String experimentCode, java.lang.String projectCode, java.lang.String spaceCode, java.lang.String permId) An spaceCode == null is interpreted as the home space.

Method Summary

Methods

Modifier and Type	Method and Description
static ExperimentIdentifier	createFromAugmentedCode(java.lang.String augmentedCode) Creates an ExperimentIdentifier from the given augmentedCode.
static ExperimentIdentifier	createFromPermId(java.lang.String permId) Creates an ExperimentIdentifier from the given permId.
java.lang.String	getAugmentedCode() Returns the augmented (full) code of this experiment.
java.lang.String	getExperimentCode()
java.lang.String	getProjectCode() The code of the project of this experiment.
java.lang.String	getSpaceCode() The code of the space of this experiment.
java.lang.String	toString()

Methods inherited from class ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto.PermanentIdentifier

equals, getPermId, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExperimentIdentifier

public ExperimentIdentifier(java.lang.String experimentCode,
                    java.lang.String projectCode,
                    java.lang.String spaceCode,
                    java.lang.String permId)

An spaceCode == null is interpreted as the home space.

Method Detail

createFromAugmentedCode

public static ExperimentIdentifier createFromAugmentedCode(java.lang.String augmentedCode)
                                                    throws java.lang.IllegalArgumentException

Creates an ExperimentIdentifier from the given augmentedCode.

Parameters:

augmentedCode - The augmentedCode in the form /SPACE/PROJECT/EXPERIMENT

Returns:

An experiment identifer corresponding to augmentedCode. Note that this experiment identifier has no perm id set.

Throws:

java.lang.IllegalArgumentException - If the augmentedCode is not in the form /SPACE/PROJECT/EXPERIMENT or PROJECT/EXPERIMENT.

createFromPermId

public static ExperimentIdentifier createFromPermId(java.lang.String permId)
                                             throws java.lang.IllegalArgumentException

Creates an ExperimentIdentifier from the given permId.

Parameters:

permId - The permId

Returns:

An experiment identifer corresponding to permId. Note that this experiment identifier has no code, project or space information.

Throws:

java.lang.IllegalArgumentException

getSpaceCode

public java.lang.String getSpaceCode()

The code of the space of this experiment.

getProjectCode

public java.lang.String getProjectCode()

The code of the project of this experiment.

getExperimentCode

public java.lang.String getExperimentCode()

getAugmentedCode

public java.lang.String getAugmentedCode()

Returns the augmented (full) code of this experiment.

toString

public java.lang.String toString()

Overrides:

toString in class PermanentIdentifier