/*
 * mzTab-M reference implementation and validation API.
 * This is the mzTab-M reference implementation and validation API service.
 *
 * OpenAPI spec version: 2.0.0
 * Contact: nils.hoffmann@isas.de
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */


package de.isas.mztab2.model;

import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import de.isas.mztab2.model.MsRun;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.*;
import javax.xml.bind.annotation.*;
import javax.validation.constraints.*;
import javax.validation.Valid;
import de.isas.lipidomics.mztab2.validation.constraints.*;
/**
 * 
 * Reference to a spectrum in a spectrum file, for example a fragmentation spectrum has been used to support the identification. If a separate spectrum file has been used for fragmentation spectrum, this MUST be reported in the metadata section as additional ms_runs. The reference must be in the format ms_run[1-n]:{SPECTRA_REF} where SPECTRA_REF MUST follow the format defined in 5.2 (including references to chromatograms where these are used to inform identification). Multiple spectra MUST be referenced using a “|” delimited list for the (rare) cases in which search engines have combined or aggregated multiple spectra in advance of the search to make identifications.

If a fragmentation spectrum has not been used, the value should indicate the ms_run to which is identification is mapped e.g. “ms_run[1]”.

 * 
 *
 * <p>mzTab-M specification example(s):</p>
 * <pre><code>SEH       SME_ID  …       spectra_ref     …
SME     1                       ms_run[1]:index=5       …
</code></pre>
 * 
 *
 */
@ApiModel(description = "Reference to a spectrum in a spectrum file, for example a fragmentation spectrum has been used to support the identification. If a separate spectrum file has been used for fragmentation spectrum, this MUST be reported in the metadata section as additional ms_runs. The reference must be in the format ms_run[1-n]:{SPECTRA_REF} where SPECTRA_REF MUST follow the format defined in 5.2 (including references to chromatograms where these are used to inform identification). Multiple spectra MUST be referenced using a “|” delimited list for the (rare) cases in which search engines have combined or aggregated multiple spectra in advance of the search to make identifications.  If a fragmentation spectrum has not been used, the value should indicate the ms_run to which is identification is mapped e.g. “ms_run[1]”. ")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-02-11T15:11:41.249+01:00")
@XmlRootElement(name = "SpectraRef")
@XmlAccessorType(XmlAccessType.FIELD)
@JacksonXmlRootElement(localName = "SpectraRef")
public class SpectraRef {

  /**
   * Property enumeration for SpectraRef.
   */
  public static enum Properties {
      msRun("ms_run"), 
      reference("reference");

    private final String propertyName;

    private Properties(String propertyName) {
      this.propertyName = propertyName;
    }

    public String getPropertyName() {
      return propertyName;
    }

    public String toString() {
      return propertyName;
    }

    public String toUpper() {
      return propertyName.toUpperCase();
    }

    public static Properties of(String value) {
      if(value==null) {
        throw new NullPointerException("Argument value must not be null!");
      }
      return Arrays.asList(Properties.values()).stream().filter(m -> m.propertyName.equals(value.toLowerCase())).findAny().orElseThrow(IllegalArgumentException::new);
    }
  };
  
  @JsonProperty("ms_run")
  @JacksonXmlProperty(localName = "ms_run")
  @XmlElement(name = "ms_run")
  private MsRun msRun = null;
  @JsonProperty("reference")
  @JacksonXmlProperty(localName = "reference")
  @XmlElement(name = "reference")
  private String reference = null;

 /**
   * Builder method for msRun.
   *
   * @see SpectraRef#setMsRun SpectraRef#setMsRun for specification examples
   * @see SpectraRef#getMsRun SpectraRef#getMsRun for validation constraints
   * @param msRun a {@code MsRun} parameter.
   * @return SpectraRef
  **/
  public SpectraRef msRun(MsRun msRun) {
   this.msRun = msRun;
   return this;
  }

   /**
   * The ms run object reference by this spectral reference.

   *
   * @return msRun
  **/
  @NotNull
  @Valid
  @ApiModelProperty(required = true, value = "The ms run object reference by this spectral reference. ")
  public MsRun getMsRun() {
    return msRun;
  }

 /**
   * Set msRun.
   *
   * 
   * 
   * @see #getMsRun SpectraRef#getMsRun for validation constraints
   * @param msRun a {@code MsRun} parameter.
  **/
  public void setMsRun(MsRun msRun) {
    this.msRun = msRun;
  }


 /**
   * Builder method for reference.
   *
   * @see SpectraRef#setReference SpectraRef#setReference for specification examples
   * @see SpectraRef#getReference SpectraRef#getReference for validation constraints
   * @param reference a {@code String} parameter.
   * @return SpectraRef
  **/
  public SpectraRef reference(String reference) {
   this.reference = reference;
   return this;
  }

   /**
   * The (vendor-dependendent) reference string to the actual mass spectrum.

   *
   * @return reference
  **/
  @NotNull
  @ApiModelProperty(required = true, value = "The (vendor-dependendent) reference string to the actual mass spectrum. ")
  public String getReference() {
    return reference;
  }

 /**
   * Set reference.
   *
   * 
   * 
   * @see #getReference SpectraRef#getReference for validation constraints
   * @param reference a {@code String} parameter.
  **/
  public void setReference(String reference) {
    this.reference = reference;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    SpectraRef spectraRef = (SpectraRef) o;
    return Objects.equals(this.msRun, spectraRef.msRun) &&
        Objects.equals(this.reference, spectraRef.reference);
  }

  @Override
  public int hashCode() {
    return Objects.hash(msRun, reference);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class SpectraRef {\n");
    
    sb.append("    msRun: ").append(toIndentedString(msRun)).append("\n");
    sb.append("    reference: ").append(toIndentedString(reference)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces
   * (except the first line).
   */
  private String toIndentedString(java.lang.Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }

}