001/* ---------------------------------------------------------------------------- 002 * This file was automatically generated by SWIG (http://www.swig.org). 003 * Version 2.0.11 004 * 005 * Do not make changes to this file unless you know what you are doing--modify 006 * the SWIG interface file instead. 007 * ----------------------------------------------------------------------------- */ 008 009package org.sbml.libsbml; 010 011public class ListOfGraphicalObjects extends ListOf { 012 private long swigCPtr; 013 014 protected ListOfGraphicalObjects(long cPtr, boolean cMemoryOwn) 015 { 016 super(libsbmlJNI.ListOfGraphicalObjects_SWIGUpcast(cPtr), cMemoryOwn); 017 swigCPtr = cPtr; 018 } 019 020 protected static long getCPtr(ListOfGraphicalObjects obj) 021 { 022 return (obj == null) ? 0 : obj.swigCPtr; 023 } 024 025 protected static long getCPtrAndDisown (ListOfGraphicalObjects obj) 026 { 027 long ptr = 0; 028 029 if (obj != null) 030 { 031 ptr = obj.swigCPtr; 032 obj.swigCMemOwn = false; 033 } 034 035 return ptr; 036 } 037 038 protected void finalize() { 039 delete(); 040 } 041 042 public synchronized void delete() { 043 if (swigCPtr != 0) { 044 if (swigCMemOwn) { 045 swigCMemOwn = false; 046 libsbmlJNI.delete_ListOfGraphicalObjects(swigCPtr); 047 } 048 swigCPtr = 0; 049 } 050 super.delete(); 051 } 052 053 054/** 055 * Creates and returns a deep copy of this {@link ListOf}. 056 * <p> 057 * @return a (deep) copy of this {@link ListOf}. 058 */ public 059 ListOfGraphicalObjects cloneObject() { 060 long cPtr = libsbmlJNI.ListOfGraphicalObjects_cloneObject(swigCPtr, this); 061 return (cPtr == 0) ? null : new ListOfGraphicalObjects(cPtr, true); 062 } 063 064 public ListOfGraphicalObjects(long level, long version, long pkgVersion) throws org.sbml.libsbml.SBMLConstructorException { 065 this(libsbmlJNI.new_ListOfGraphicalObjects__SWIG_0(level, version, pkgVersion), true); 066 } 067 068 public ListOfGraphicalObjects(long level, long version) throws org.sbml.libsbml.SBMLConstructorException { 069 this(libsbmlJNI.new_ListOfGraphicalObjects__SWIG_1(level, version), true); 070 } 071 072 public ListOfGraphicalObjects(long level) throws org.sbml.libsbml.SBMLConstructorException { 073 this(libsbmlJNI.new_ListOfGraphicalObjects__SWIG_2(level), true); 074 } 075 076 public ListOfGraphicalObjects() throws org.sbml.libsbml.SBMLConstructorException { 077 this(libsbmlJNI.new_ListOfGraphicalObjects__SWIG_3(), true); 078 } 079 080 public ListOfGraphicalObjects(LayoutPkgNamespaces layoutns) throws org.sbml.libsbml.SBMLConstructorException { 081 this(libsbmlJNI.new_ListOfGraphicalObjects__SWIG_4(LayoutPkgNamespaces.getCPtr(layoutns), layoutns), true); 082 } 083 084 085/** 086 * Get the type code of the objects contained in this {@link ListOf}. 087 * <p> 088 * LibSBML attaches an identifying code to every 089 * kind of SBML object. These are known as <em>SBML type codes</em>. In 090 * other languages, the set of type codes is stored in an enumeration; in 091 * the Java language interface for libSBML, the type codes are defined as 092 * static integer constants in the interface class {@link 093 * libsbmlConstants}. The names of the type codes all begin with the 094 * characters <code>SBML_.</code> 095 * <p> 096 * @return the SBML type code for the objects contained in this {@link ListOf} 097 * instance, or {@link libsbmlConstants#SBML_UNKNOWN SBML_UNKNOWN} (default). 098 */ public 099 int getItemTypeCode() { 100 return libsbmlJNI.ListOfGraphicalObjects_getItemTypeCode(swigCPtr, this); 101 } 102 103 104/** 105 * Returns the XML element name of this object, which for {@link ListOf}, is 106 * always <code>'listOf'.</code> 107 * <p> 108 * @return the XML name of this element. 109 */ public 110 String getElementName() { 111 return libsbmlJNI.ListOfGraphicalObjects_getElementName(swigCPtr, this); 112 } 113 114 public void setElementName(String elementName) { 115 libsbmlJNI.ListOfGraphicalObjects_setElementName(swigCPtr, this, elementName); 116 } 117 118 119/** 120 * Get an item from the list. 121 * <p> 122 * @param n the index number of the item to get. 123 * <p> 124 * @return the nth item in this {@link ListOf} items. 125 * <p> 126 * @see #size() 127 */ public 128 GraphicalObject get(long n) { 129 return (GraphicalObject) libsbml.DowncastSBase(libsbmlJNI.ListOfGraphicalObjects_get__SWIG_0(swigCPtr, this, n), false); 130} 131 132 133/** 134 * Get an item from the list based on its identifier. 135 * <p> 136 * @param sid a string representing the the identifier of the item to get. 137 * <p> 138 * @return item in this {@link ListOf} items with the given <code>sid</code> or <code>null</code> if no such 139 * item exists. 140 * <p> 141 * @see #get(long n) 142 * @see #size() 143 */ public 144 GraphicalObject get(String sid) { 145 return (GraphicalObject) libsbml.DowncastSBase(libsbmlJNI.ListOfGraphicalObjects_get__SWIG_2(swigCPtr, this, sid), false); 146} 147 148 149/** 150 * Removes the <em>n</em>th item from this {@link ListOf} items and returns a 151 * pointer to it. 152 * <p> 153 * The caller owns the returned item and is responsible for deleting it. 154 * <p> 155 * @param n the index of the item to remove 156 * <p> 157 * @see #size() 158 */ public 159 GraphicalObject remove(long n) { 160 return (GraphicalObject) libsbml.DowncastSBase(libsbmlJNI.ListOfGraphicalObjects_remove__SWIG_0(swigCPtr, this, n), true); 161} 162 163 164/** 165 * Removes item in this {@link ListOf} items with the given identifier. 166 * <p> 167 * The caller owns the returned item and is responsible for deleting it. 168 * If none of the items in this list have the identifier <code>sid</code>, then 169 * <code>null</code> is returned. 170 * <p> 171 * @param sid the identifier of the item to remove 172 * <p> 173 * @return the item removed. As mentioned above, the caller owns the 174 * returned item. 175 */ public 176 GraphicalObject remove(String sid) { 177 return (GraphicalObject) libsbml.DowncastSBase(libsbmlJNI.ListOfGraphicalObjects_remove__SWIG_1(swigCPtr, this, sid), true); 178} 179 180 public XMLNode toXML() { 181 return new XMLNode(libsbmlJNI.ListOfGraphicalObjects_toXML(swigCPtr, this), true); 182 } 183 184}