org.sbml.jsbml.ext.spatial.ParametricGeometry Maven / Gradle / Ivy
/*
* ----------------------------------------------------------------------------
* 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 javax.swing.tree.TreeNode;
import org.sbml.jsbml.ListOf;
import org.sbml.jsbml.PropertyUndefinedError;
/**
* @author Alex Thomas
* @author Andreas Dräger
* @author Piero Dalle Pezze
* @since 1.0
*/
public class ParametricGeometry extends GeometryDefinition {
/**
*
*/
SpatialPoints spatialPoints;
/**
*
*/
ListOf listOfParametricObjects;
/**
* Generated serial version identifier.
*/
private static final long serialVersionUID = 5947368889263003716L;
/**
*
*/
public ParametricGeometry() {
super();
}
/**
* @param pg
*/
public ParametricGeometry(ParametricGeometry pg) {
super(pg);
if (pg.isSetListOfParametricObjects()) {
setListOfParametricObjects(pg.getListOfParametricObjects().clone());
}
if (pg.isSetSpatialPoints()) {
setSpatialPoints(pg.getSpatialPoints().clone());
}
}
/**
* @param level
* @param version
*/
public ParametricGeometry(int level, int version) {
super(level, version);
}
/**
*
* @param id
* @param level
* @param version
*/
public ParametricGeometry(String id, int level, int version) {
super(id, level, version);
}
@Override
public ParametricGeometry clone() {
return new ParametricGeometry(this);
}
@Override
public boolean equals(Object object) {
boolean equal = super.equals(object);
if (equal) {
ParametricGeometry pg = (ParametricGeometry) object;
equal &= pg.isSetListOfParametricObjects() == isSetListOfParametricObjects();
if (equal && isSetListOfParametricObjects()) {
equal &= pg.getListOfParametricObjects().equals(getListOfParametricObjects());
}
equal &= pg.isSetSpatialPoints() == isSetSpatialPoints();
if (equal && isSetSpatialPoints()) {
equal &= pg.getSpatialPoints().equals(getSpatialPoints());
}
}
return equal;
}
@Override
public int hashCode() {
final int prime = 1999;
int hashCode = super.hashCode();
if (isSetListOfParametricObjects()) {
hashCode += prime * getListOfParametricObjects().hashCode();
}
if (isSetSpatialPoints()) {
hashCode += prime * getSpatialPoints().hashCode();
}
return hashCode;
}
/**
* Returns {@code true}, if listOfParametricObjects contains at least one element.
*
* @return {@code true}, if listOfParametricObjects contains at least one element,
* otherwise {@code false}
*/
public boolean isSetListOfParametricObjects() {
if (listOfParametricObjects == null) {
return false;
}
return true;
}
/**
* Returns the listOfParametricObjects. Creates it if it is not already existing.
*
* @return the listOfParametricObjects
*/
public ListOf getListOfParametricObjects() {
if (!isSetListOfParametricObjects()) {
listOfParametricObjects = new ListOf(getLevel(),
getVersion());
listOfParametricObjects.setNamespace(SpatialConstants.namespaceURI);
listOfParametricObjects.setSBaseListType(ListOf.Type.other);
registerChild(listOfParametricObjects);
}
return listOfParametricObjects;
}
/**
* Sets the given {@code ListOf}. If listOfParametricObjects
* was defined before and contains some elements, they are all unset.
*
* @param listOfParametricObjects
*/
public void setListOfParametricObjects(ListOf listOfParametricObjects) {
unsetListOfParametricObjects();
this.listOfParametricObjects = listOfParametricObjects;
registerChild(this.listOfParametricObjects);
}
/**
* Returns {@code true}, if listOfParametricObjects contain at least one element,
* otherwise {@code false}
*
* @return {@code true}, if listOfParametricObjects contain at least one element,
* otherwise {@code false}
*/
public boolean unsetListOfParametricObjects() {
if (isSetListOfParametricObjects()) {
ListOf oldParametricObjects = listOfParametricObjects;
listOfParametricObjects = null;
oldParametricObjects.fireNodeRemovedEvent();
return true;
}
return false;
}
/**
* Adds a new {@link ParametricObject} to the listOfParametricObjects.
* The listOfParametricObjects is initialized if necessary.
*
* @param parametricObject the element to add to the list
* @return {@code true} (as specified by {@link java.util.Collection#add})
*/
public boolean addParametricObject(ParametricObject parametricObject) {
return getListOfParametricObjects().add(parametricObject);
}
/**
* Removes an element from the listOfParametricObjects.
*
* @param parametricObject the element to be removed from the list
* @return {@code true} if the list contained the specified element
* @see java.util.List#remove(Object)
*/
public boolean removeParametricObject(ParametricObject parametricObject) {
if (isSetListOfParametricObjects()) {
return getListOfParametricObjects().remove(parametricObject);
}
return false;
}
/**
* Removes an element from the listOfParametricObjects at the given index.
*
* @param i the index where to remove the {@link ParametricObject}
* @throws IndexOutOfBoundsException if the listOf is not set or
* if the index is out of bound (index < 0 || index > list.size).
*/
public void removeParametricObject(int i) {
if (!isSetListOfParametricObjects()) {
throw new IndexOutOfBoundsException(Integer.toString(i));
}
// if (getListOfParametricObjects().size() == 1) {
// throw new SBMLException("There must be at least one ParametricObject defined for this list");
// }
getListOfParametricObjects().remove(i);
}
/**
* Creates a new ParametricObject element and adds it to the ListOfParametricObjects list
* @return a new {@link ParametricObject} element
*/
public ParametricObject createParametricObject() {
return createParametricObject(null);
}
/**
* Creates a new {@link ParametricObject} element and adds it to the ListOfParametricObjects list
* @param id
*
* @return a new {@link ParametricObject} element
*/
public ParametricObject createParametricObject(String id) {
ParametricObject parametricObject = new ParametricObject(id, getLevel(), getVersion());
addParametricObject(parametricObject);
return parametricObject;
}
/**
* Returns the value of {@link #spatialPoints}.
*
* @return the value of {@link #spatialPoints}.
*/
public SpatialPoints getSpatialPoints() {
if (isSetSpatialPoints()) {
return spatialPoints;
}
// This is necessary if we cannot return null here. For variables of type String return an empty String if no value is defined.
throw new PropertyUndefinedError(SpatialConstants.spatialPoints, this);
}
/**
* Returns whether {@link #spatialPoints} is set.
*
* @return whether {@link #spatialPoints} is set.
*/
public boolean isSetSpatialPoints() {
return spatialPoints != null;
}
/**
* Sets the value of spatialPoints
*
* @param spatialPoints the value of spatialPoints to be set.
*/
public void setSpatialPoints(SpatialPoints spatialPoints) {
SpatialPoints oldSpatialPoints = this.spatialPoints;
this.spatialPoints = spatialPoints;
registerChild(spatialPoints);
firePropertyChange(SpatialConstants.spatialPoints, oldSpatialPoints, this.spatialPoints);
}
/**
* Unsets the variable spatialPoints.
*
* @return {@code true} if spatialPoints was set before, otherwise {@code false}.
*/
public boolean unsetSpatialPoints() {
if (isSetSpatialPoints()) {
SpatialPoints oldSpatialPoints = spatialPoints;
spatialPoints = null;
firePropertyChange(SpatialConstants.spatialPoints, oldSpatialPoints, spatialPoints);
return true;
}
return false;
}
/* (non-Javadoc)
* @see org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase#getAllowsChildren()
*/
@Override
public boolean getAllowsChildren() {
return true;
}
/* (non-Javadoc)
* @see org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase#getChildCount()
*/
@Override
public int getChildCount() {
int count = super.getChildCount();
if (isSetListOfParametricObjects()) {
count++;
}
if (isSetSpatialPoints()) {
count++;
}
return count;
}
/* (non-Javadoc)
* @see org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase#getChildAt(int)
*/
@Override
public TreeNode getChildAt(int index) {
if (index < 0) {
throw new IndexOutOfBoundsException(MessageFormat.format(
resourceBundle.getString("IndexSurpassesBoundsException"), index, 0));
}
int count = super.getChildCount(), pos = 0;
if (index < count) {
return super.getChildAt(index);
} else {
index -= count;
}
if (isSetListOfParametricObjects()) {
if (pos == index) {
return getListOfParametricObjects();
}
pos++;
}
if (isSetSpatialPoints()) {
if (pos == index) {
return getSpatialPoints();
}
pos++;
}
throw new IndexOutOfBoundsException(MessageFormat.format(
resourceBundle.getString("IndexExceedsBoundsException"), index,
+Math.min(pos, 0)));
}
}