org.sbml.jsbml.ext.spatial.SpatialParameterPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsbml-spatial Show documentation
The newest version!
/*
 * ----------------------------------------------------------------------------
 * This file is part of JSBML. Please visit 
 * for the latest version of JSBML and more information about SBML.
 *
 * Copyright (C) 2009-2022 jointly by the following organizations:
 * 1. The University of Tuebingen, Germany
 * 2. EMBL European Bioinformatics Institute (EBML-EBI), Hinxton, UK
 * 3. The California Institute of Technology, Pasadena, CA, USA
 * 4. The University of California, San Diego, La Jolla, CA, USA
 * 5. The Babraham Institute, Cambridge, UK
 * 
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation. A copy of the license agreement is provided
 * in the file named "LICENSE.txt" included with this software distribution
 * and also available online as .
 * ----------------------------------------------------------------------------
 */
package org.sbml.jsbml.ext.spatial;

import java.text.MessageFormat;

import org.sbml.jsbml.Parameter;

/**
 * @author Alex Thomas
 * @author Andreas Dräger
 * @since 1.0
 */
public class SpatialParameterPlugin extends AbstractSpatialSBasePlugin {


  /**
   * Generated serial version identifier.
   */
  private static final long serialVersionUID = -3766260342134204275L;

  /**
   * 
   */
  private ParameterType param;

  // TODO - event firing are missing
  // TODO - create, unset methods missing

  // TODO - from the 0.85 spatial specs, there are more children defined and the parameter type was dropped

  /*
   * (non-Javadoc)
   * @see org.sbml.jsbml.ext.AbstractSBasePlugin#getExtendedSBase()
   */
  @Override
  public Parameter getExtendedSBase() {
    if (isSetExtendedSBase()) {
      return (Parameter) super.getExtendedSBase();
    }

    return null;
  }

  /**
   * 
   */
  public SpatialParameterPlugin() {
    super();
  }

  /**
   * @param sb
   */
  public SpatialParameterPlugin(SpatialParameterPlugin sb) {
    super(sb);

    if (sb.isSetParamType()) {
      setParamType(sb.getParamType().clone());
    }
  }

  /**
   * @param parameter
   */
  public SpatialParameterPlugin(Parameter parameter) {
    super(parameter);
  }

  /**
   * 
   * @return
   */
  public ParameterType getParamType() {
    return isSetParamType() ? param : null;
  }

  /**
   * 
   * @return
   */
  public boolean isSetParamType() {
    return param != null ? true : false;
  }

  /**
   * @param param the qualifier to set
   */
  public void setParamType(ParameterType param) {
    this.param = param;

    if (isSetExtendedSBase()) {
      extendedSBase.registerChild(param);
    }
  }

  /* (non-Javadoc)
   * @see org.sbml.jsbml.AbstractSBase#clone()
   */
  @Override
  public SpatialParameterPlugin clone() {
    return new SpatialParameterPlugin(this);
  }

  /* (non-Javadoc)
   * This will force people to cast to the different forms of parameter types
   * @see javax.swing.tree.TreeNode#getChildAt(int)
   */
  @Override
  public ParameterType getChildAt(int index) {
    if (index < 0) {
      throw new IndexOutOfBoundsException(MessageFormat.format(
        resourceBundle.getString("IndexSurpassesBoundsException"), index, 0));
    }

    int pos = 0;

    if (isSetParamType()) {
      if (pos==index) {
        return getParamType();
      }
      pos++;
    }

    throw new IndexOutOfBoundsException(MessageFormat.format(
      resourceBundle.getString("IndexExceedsBoundsException"), index,pos));
  }

  /* (non-Javadoc)
   * @see org.sbml.jsbml.AbstractSBase#getChildCount()
   */
  @Override
  public int getChildCount() {
    return isSetParamType() ? 1 : 0;
  }

  /*
   * (non-Javadoc)
   * @see javax.swing.tree.TreeNode#getAllowsChildren()
   */
  @Override
  public boolean getAllowsChildren() {
    return true;
  }

}