OpenbisExperiment (Groovy Documentation)

life.qbic.datamodel.experiments.OpenbisExperiment

**************************************************************************** QBiC Project Wizard enables users to create hierarchical experiments including different study conditions using factorial design. Copyright (C) "2016" Andreas Friedrich This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . *****************************************************************************

Field Summary

Fields
Modifiers	Name	Description
`private java.lang.String`	`Q_ADDITIONAL_NOTES`
`private java.lang.String`	`Q_SECONDARY_NAME`
`private java.lang.String`	`experimentCode`
`org.apache.logging.log4j.Logger`	`logger`
`private int`	`personID`
`private java.util.Map<java.lang.String, java.lang.Object>`	`properties`
`private ExperimentType`	`type`

Properties Summary

Properties
Type	Name and description
`java.util.Map<java.lang.String, java.lang.Object>`	`metadata`

Constructor Summary

Constructors
Constructor and description
`OpenbisExperiment (java.lang.String code, ExperimentType type, java.util.Map<java.lang.String, java.lang.Object> props)` Creates a new Openbis Experiment
`OpenbisExperiment (java.lang.String code, ExperimentType type, int person, java.util.Map<java.lang.String, java.lang.Object> props)` Creates a new Openbis Experiment

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`containsProperties()`
	`private static java.lang.String`	`escapeSpecials(java.lang.String s)`
	`java.lang.String`	`getExperimentCode()`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getMetadata()`
	`int`	`getPersonID()`
	`java.lang.String`	`getPropertiesString()`
	`java.lang.String`	`getQ_ADDITIONAL_NOTES()`
	`java.lang.String`	`getQ_SECONDARY_NAME()`
	`ExperimentType`	`getType()`
	`void`	`setMetadata(java.util.Map<java.lang.String, java.lang.Object> properties)`
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - private java.lang.String Q_ADDITIONAL_NOTES
  - private java.lang.String Q_SECONDARY_NAME
  - private java.lang.String experimentCode
  - org.apache.logging.log4j.Logger logger
  - private int personID
  - private java.util.Map<java.lang.String, java.lang.Object> properties
  - private ExperimentType type
- Property Detail
  - java.util.Map<java.lang.String, java.lang.Object> metadata
- Constructor Detail
  - public OpenbisExperiment(java.lang.String code, ExperimentType type, java.util.Map<java.lang.String, java.lang.Object> props)
    
    Creates a new Openbis Experiment
    Parameters:
    code - of the experiment
    type - Experiment type
    props - Map with experimental properties
  - public OpenbisExperiment(java.lang.String code, ExperimentType type, int person, java.util.Map<java.lang.String, java.lang.Object> props)
    
    Creates a new Openbis Experiment
    Parameters:
    code - of the experiment
    type - Experiment type
- Method Detail
  - public boolean containsProperties()
  - private static java.lang.String escapeSpecials(java.lang.String s)
  - public java.lang.String getExperimentCode()
  - public java.util.Map<java.lang.String, java.lang.Object> getMetadata()
  - public int getPersonID()
  - public java.lang.String getPropertiesString()
  - public java.lang.String getQ_ADDITIONAL_NOTES()
  - public java.lang.String getQ_SECONDARY_NAME()
  - public ExperimentType getType()
  - public void setMetadata(java.util.Map<java.lang.String, java.lang.Object> properties)
  - public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class OpenbisExperiment

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private java.lang.String Q_ADDITIONAL_NOTES

private java.lang.String Q_SECONDARY_NAME

private java.lang.String experimentCode

org.apache.logging.log4j.Logger logger

private int personID

private java.util.Map<java.lang.String, java.lang.Object> properties

private ExperimentType type

Property Detail

java.util.Map<java.lang.String, java.lang.Object> metadata

Constructor Detail

public OpenbisExperiment(java.lang.String code, ExperimentType type, java.util.Map<java.lang.String, java.lang.Object> props)

public OpenbisExperiment(java.lang.String code, ExperimentType type, int person, java.util.Map<java.lang.String, java.lang.Object> props)

Method Detail

public boolean containsProperties()

private static java.lang.String escapeSpecials(java.lang.String s)

public java.lang.String getExperimentCode()

public java.util.Map<java.lang.String, java.lang.Object> getMetadata()

public int getPersonID()

public java.lang.String getPropertiesString()

public java.lang.String getQ_ADDITIONAL_NOTES()

public java.lang.String getQ_SECONDARY_NAME()

public ExperimentType getType()

public void setMetadata(java.util.Map<java.lang.String, java.lang.Object> properties)

public java.lang.String toString()