AOpenbisSample (Groovy Documentation)

life.qbic.datamodel.samples.AOpenbisSample

**************************************************************************** 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_EXTERNALDB_ID`
`private java.lang.String`	`Q_SECONDARY_NAME`
`private java.lang.String`	`code`
`private java.lang.String`	`experiment`
`private java.util.List<life.qbic.xml.properties.Property>`	`factors`
`private java.lang.String`	`parent`
`private java.util.List<AOpenbisSample>`	`parents`
`private java.lang.String`	`sampleType`
`private java.lang.String`	`space`
`private int`	`tempID`
`private java.util.List<java.lang.Integer>`	`tempParentIDs`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`code`
`java.util.List<life.qbic.xml.properties.Property>`	`factors`
`java.lang.String`	`parent`
`java.lang.String`	`q_ADDITIONAL_NOTES`
`java.lang.String`	`q_EXTERNALDB_ID`
`java.lang.String`	`q_SECONDARY_NAME`
`java.lang.String`	`space`

Constructor Summary

Constructors
Constructor and description
`AOpenbisSample (java.lang.String code, java.lang.String space, java.lang.String experiment, java.lang.String secondaryName, java.lang.String additionalNotes, java.util.List<life.qbic.xml.properties.Property> factors, java.lang.String parent, java.lang.String externalID, java.lang.String sampleType)` Constructor of an abstract openbis sample
`AOpenbisSample (int tempID, java.lang.String secondaryName, java.lang.String additionalNotes, java.util.List<life.qbic.xml.properties.Property> factors, java.lang.String externalID, java.util.List<java.lang.Integer> tempParentIDs, java.lang.String sampleType)`
`AOpenbisSample (int tempID, java.util.List<AOpenbisSample> parents, java.lang.String sampleType, java.lang.String secondaryName, java.lang.String externalID, java.util.List<life.qbic.xml.properties.Property> newFactors, java.lang.String additionalNotes)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addFactor(life.qbic.xml.properties.Property factor)`
	`private void`	`fillInFactors(java.util.Map<java.lang.String, java.lang.String> map)` Parses XML properties to the right format
	`java.lang.String`	`getCode()`
	`java.util.List<java.lang.String>`	`getFactorLabels()`
	`java.util.List<java.lang.String>`	`getFactorStrings()`
	`java.util.List<java.lang.String>`	`getFactorStringsWithoutLabel()`
	`java.util.List<life.qbic.xml.properties.Property>`	`getFactors()`
	`java.lang.String`	`getParent()`
	`java.util.List<AOpenbisSample>`	`getParents()`
	`java.lang.String`	`getQ_ADDITIONAL_NOTES()`
	`java.lang.String`	`getQ_EXTERNALDB_ID()`
	`java.lang.String`	`getQ_SECONDARY_NAME()`
	`java.lang.String`	`getSpace()`
	`java.lang.Integer`	`getTempID()`
	`java.util.List<java.lang.Integer>`	`getTempParentIDs()`
	`java.util.Map<java.lang.String, java.lang.String>`	`getValueMap()` Returns a map of all metadata fields and values of this sample
	`void`	`setCode(java.lang.String code)`
	`void`	`setExperiment(java.lang.String experiment)`
	`void`	`setFactors(java.util.List<life.qbic.xml.properties.Property> factors)`
	`void`	`setParent(java.lang.String parent)`
	`void`	`setQ_ADDITIONAL_NOTES(java.lang.String q_ADDITIONAL_NOTES)`
	`void`	`setQ_EXTERNALDB_ID(java.lang.String extID)`
	`void`	`setQ_SECONDARY_NAME(java.lang.String q_SECONDARY_NAME)`
	`void`	`setSampleType(java.lang.String sampleType)`
	`void`	`setSpace(java.lang.String space)`
	`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_EXTERNALDB_ID
  - private java.lang.String Q_SECONDARY_NAME
  - private java.lang.String code
  - private java.lang.String experiment
  - private java.util.List<life.qbic.xml.properties.Property> factors
  - private java.lang.String parent
  - private java.util.List<AOpenbisSample> parents
  - private java.lang.String sampleType
  - private java.lang.String space
  - private int tempID
  - private java.util.List<java.lang.Integer> tempParentIDs
- Property Detail
  - java.lang.String code
  - java.util.List<life.qbic.xml.properties.Property> factors
  - java.lang.String parent
  - java.lang.String q_ADDITIONAL_NOTES
  - java.lang.String q_EXTERNALDB_ID
  - java.lang.String q_SECONDARY_NAME
  - java.lang.String space
- Constructor Detail
  - AOpenbisSample(java.lang.String code, java.lang.String space, java.lang.String experiment, java.lang.String secondaryName, java.lang.String additionalNotes, java.util.List<life.qbic.xml.properties.Property> factors, java.lang.String parent, java.lang.String externalID, java.lang.String sampleType)
    
    Constructor of an abstract openbis sample
    Parameters:
    code - The sample code of the sample
    experiment - The experiment the sample is attached to
    secondaryName - A secondary name the sample might have
    additionalNotes - Free text additional notes
    factors - A list of conditions of this sample
    parent - A parent sample code this sample is attached to
  - AOpenbisSample(int tempID, java.lang.String secondaryName, java.lang.String additionalNotes, java.util.List<life.qbic.xml.properties.Property> factors, java.lang.String externalID, java.util.List<java.lang.Integer> tempParentIDs, java.lang.String sampleType)
  - AOpenbisSample(int tempID, java.util.List<AOpenbisSample> parents, java.lang.String sampleType, java.lang.String secondaryName, java.lang.String externalID, java.util.List<life.qbic.xml.properties.Property> newFactors, java.lang.String additionalNotes)
- Method Detail
  - public void addFactor(life.qbic.xml.properties.Property factor)
  - private void fillInFactors(java.util.Map<java.lang.String, java.lang.String> map)
    
    Parses XML properties to the right format
    Parameters:
    map
  - public java.lang.String getCode()
  - public java.util.List<java.lang.String> getFactorLabels()
  - public java.util.List<java.lang.String> getFactorStrings()
  - public java.util.List<java.lang.String> getFactorStringsWithoutLabel()
  - public java.util.List<life.qbic.xml.properties.Property> getFactors()
  - public java.lang.String getParent()
  - public java.util.List<AOpenbisSample> getParents()
  - public java.lang.String getQ_ADDITIONAL_NOTES()
  - public java.lang.String getQ_EXTERNALDB_ID()
  - public java.lang.String getQ_SECONDARY_NAME()
  - public java.lang.String getSpace()
  - public java.lang.Integer getTempID()
  - public java.util.List<java.lang.Integer> getTempParentIDs()
  - public java.util.Map<java.lang.String, java.lang.String> getValueMap()
    
    Returns a map of all metadata fields and values of this sample
    Returns:
  - public void setCode(java.lang.String code)
  - public void setExperiment(java.lang.String experiment)
  - public void setFactors(java.util.List<life.qbic.xml.properties.Property> factors)
  - public void setParent(java.lang.String parent)
  - public void setQ_ADDITIONAL_NOTES(java.lang.String q_ADDITIONAL_NOTES)
  - public void setQ_EXTERNALDB_ID(java.lang.String extID)
  - public void setQ_SECONDARY_NAME(java.lang.String q_SECONDARY_NAME)
  - public void setSampleType(java.lang.String sampleType)
  - public void setSpace(java.lang.String space)
  - public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class AOpenbisSample

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_EXTERNALDB_ID

private java.lang.String Q_SECONDARY_NAME

private java.lang.String code

private java.lang.String experiment

private java.util.List<life.qbic.xml.properties.Property> factors

private java.lang.String parent

private java.util.List<AOpenbisSample> parents

private java.lang.String sampleType

private java.lang.String space

private int tempID

private java.util.List<java.lang.Integer> tempParentIDs

Property Detail

java.lang.String code

java.util.List<life.qbic.xml.properties.Property> factors

java.lang.String parent

java.lang.String q_ADDITIONAL_NOTES

java.lang.String q_EXTERNALDB_ID

java.lang.String q_SECONDARY_NAME

java.lang.String space

Constructor Detail

AOpenbisSample(java.lang.String code, java.lang.String space, java.lang.String experiment, java.lang.String secondaryName, java.lang.String additionalNotes, java.util.List<life.qbic.xml.properties.Property> factors, java.lang.String parent, java.lang.String externalID, java.lang.String sampleType)

AOpenbisSample(int tempID, java.lang.String secondaryName, java.lang.String additionalNotes, java.util.List<life.qbic.xml.properties.Property> factors, java.lang.String externalID, java.util.List<java.lang.Integer> tempParentIDs, java.lang.String sampleType)

AOpenbisSample(int tempID, java.util.List<AOpenbisSample> parents, java.lang.String sampleType, java.lang.String secondaryName, java.lang.String externalID, java.util.List<life.qbic.xml.properties.Property> newFactors, java.lang.String additionalNotes)

Method Detail

public void addFactor(life.qbic.xml.properties.Property factor)

private void fillInFactors(java.util.Map<java.lang.String, java.lang.String> map)

public java.lang.String getCode()

public java.util.List<java.lang.String> getFactorLabels()

public java.util.List<java.lang.String> getFactorStrings()

public java.util.List<java.lang.String> getFactorStringsWithoutLabel()

public java.util.List<life.qbic.xml.properties.Property> getFactors()

public java.lang.String getParent()

public java.util.List<AOpenbisSample> getParents()

public java.lang.String getQ_ADDITIONAL_NOTES()

public java.lang.String getQ_EXTERNALDB_ID()

public java.lang.String getQ_SECONDARY_NAME()

public java.lang.String getSpace()

public java.lang.Integer getTempID()

public java.util.List<java.lang.Integer> getTempParentIDs()

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

public void setCode(java.lang.String code)

public void setExperiment(java.lang.String experiment)

public void setFactors(java.util.List<life.qbic.xml.properties.Property> factors)

public void setParent(java.lang.String parent)

public void setQ_ADDITIONAL_NOTES(java.lang.String q_ADDITIONAL_NOTES)

public void setQ_EXTERNALDB_ID(java.lang.String extID)

public void setQ_SECONDARY_NAME(java.lang.String q_SECONDARY_NAME)

public void setSampleType(java.lang.String sampleType)

public void setSpace(java.lang.String space)

public java.lang.String toString()