org.sbml.jsbml

Class History

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AnnotationElement

org.sbml.jsbml.History

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, TreeNodeWithChangeSupport

public class History
extends AnnotationElement

Contains all the history information about a Model (or other SBase if level >= 3).

Since:

0.8

Version:

$Rev$

Author:

Marine Dumousseau, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Date	creation Date of creation
private java.util.List<Creator>	listOfCreators Contains all the Creator instances of this History.
private java.util.List<java.util.Date>	listOfModification Contains all the modified date instances of this History.
private java.util.Date	modified Last date of modification
private static long	serialVersionUID Generated serial version identifier.

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
History() Creates a History instance.
History(History history) Creates a History instance from a given History.

Method Summary

Modifier and Type	Method and Description
void	addCreator(Creator mc) Adds a Creator instance to this History.
void	addModifiedDate(java.util.Date date) Adds a Date of modification to this History.
History	clone()
boolean	equals(java.lang.Object object)
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int childIndex)
int	getChildCount()
java.util.Date	getCreatedDate() Returns the createdDate from the History.
Creator	getCreator(int i) Get the nth Creator object in this History.
int	getCreatorCount() Get the number of Creator objects in this History.
java.util.List<Creator>	getListOfCreators() Get the list of Creator objects in this History.
java.util.List<java.util.Date>	getListOfModifiedDates() Get the list of modifiedDate objects in this History.
java.util.Date	getModifiedDate() Returns the modifiedDate from the History.
java.util.Date	getModifiedDate(int n) Get the nth Date object in the list of ModifiedDates in this History.
int	getModifiedDateCount() Get the number of ModifiedDate objects in this History.
int	getNumCreators() Get the number of Creator objects in this History.
int	getNumModifiedDates() Get the number of ModifiedDate objects in this History.
int	hashCode()
boolean	isEmpty() Checks whether at least one attribute has been set for this History.
boolean	isSetCreatedDate() Predicate returning true or false depending on whether this History's createdDate has been set.
boolean	isSetListOfCreators()
boolean	isSetListOfModification()
boolean	isSetModifiedDate() Predicate returning true or false depending on whether this History's modifiedDate has been set.
boolean	readAttribute(java.lang.String nodeName, java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
Creator	removeCreator(int i) If there is no ith Creator, it returns null.
java.util.Date	removeModifiedDate(int i) If there is no ith modified Date, it returns null.
void	setCreatedDate(java.util.Date date) Sets the createdDate.
void	setModifiedDate(java.util.Date date) Sets the modifiedDate.
void	unsetCreatedDate() Sets the created of this History to null.
void	unsetListOfModifiedDates() Sets the created of this History to null.

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getParent, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, notifyChildChange, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

creation

private java.util.Date creation

Date of creation

listOfCreators

private java.util.List<Creator> listOfCreators

Contains all the Creator instances of this History.

listOfModification

private java.util.List<java.util.Date> listOfModification

Contains all the modified date instances of this History.

modified

private java.util.Date modified

Last date of modification

Constructor Detail

History

public History()

Creates a History instance. By default, the creation and modified are null. The listOfModification and listOfCreators are empty.

History

public History(History history)

Creates a History instance from a given History.

Parameters:

history -

Method Detail

addCreator

public void addCreator(Creator mc)

Adds a Creator instance to this History.

Parameters:

mc -

addModifiedDate

public void addModifiedDate(java.util.Date date)

Adds a Date of modification to this History.

Parameters:

date -

clone

public History clone()

Specified by:

clone in class AbstractTreeNode

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class AbstractTreeNode

getAllowsChildren

public boolean getAllowsChildren()

getChildAt

public javax.swing.tree.TreeNode getChildAt(int childIndex)

getChildCount

public int getChildCount()

getCreatedDate

public java.util.Date getCreatedDate()

Returns the createdDate from the History.

Returns:

Date object representing the createdDate from the History. Can be null if it is not set.

getCreator

public Creator getCreator(int i)

Get the nth Creator object in this History.

Parameters:

i -

Returns:

the nth Creator of this History. Can be null.

getListOfCreators

public java.util.List<Creator> getListOfCreators()

Get the list of Creator objects in this History.

Returns:

the list of Creators for this History.

getListOfModifiedDates

public java.util.List<java.util.Date> getListOfModifiedDates()

Get the list of modifiedDate objects in this History.

Returns:

the list of modifiedDate for this History.

getModifiedDate

public java.util.Date getModifiedDate()

Returns the modifiedDate from the History.

Returns:

Date object representing the modifiedDate from the History. Can be null if it is not set.

getModifiedDate

public java.util.Date getModifiedDate(int n)

Get the nth Date object in the list of ModifiedDates in this History.

Parameters:

n - the nth Date in the list of ModifiedDates of this History.

Returns:

the nth Date object in the list of ModifiedDates in this History. Can be null if it is not set.

getNumCreators

public int getNumCreators()

Get the number of Creator objects in this History.

Returns:

the number of Creators in this History.

getCreatorCount

public int getCreatorCount()

Get the number of Creator objects in this History.

Returns:

the number of Creators in this History.

getNumModifiedDates

public int getNumModifiedDates()

Get the number of ModifiedDate objects in this History.

Returns:

the number of ModifiedDates in this History.

getModifiedDateCount

public int getModifiedDateCount()

Get the number of ModifiedDate objects in this History.

Returns:

the number of ModifiedDates in this History.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTreeNode

isEmpty

public boolean isEmpty()

Checks whether at least one attribute has been set for this History.

Returns:

true if at least one of the possible attributes is set, i.e., not null:

• creation date
• listOfCreators is not null and contains at least one element
• listOfModification is not null and contains at least one element.
• modified is not null.

isSetCreatedDate

public boolean isSetCreatedDate()

Predicate returning true or false depending on whether this History's createdDate has been set.

Returns:

true if the createdDate of this History has been set, false otherwise.

isSetListOfCreators

public boolean isSetListOfCreators()

Returns:

isSetListOfModification

public boolean isSetListOfModification()

Returns:

isSetModifiedDate

public boolean isSetModifiedDate()

Predicate returning true or false depending on whether this History's modifiedDate has been set.

Returns:

true if the modifiedDate of this History has been set, false otherwise.

readAttribute

public boolean readAttribute(java.lang.String nodeName,
                             java.lang.String attributeName,
                             java.lang.String prefix,
                             java.lang.String value)

Parameters:

nodeName -

attributeName -

prefix -

value -

Returns:

true if the XML attribute is known by this History.

removeCreator

public Creator removeCreator(int i)

If there is no i^th Creator, it returns null.

Parameters:

i -

Returns:

the Creator removed from the listOfCreators.

removeModifiedDate

public java.util.Date removeModifiedDate(int i)

If there is no i^th modified Date, it returns null.

Parameters:

i -

Returns:

the modified Date removed from the listOfModification.

setCreatedDate

public void setCreatedDate(java.util.Date date)

Sets the createdDate.

Parameters:

date - a Date object representing the date the History was created.

setModifiedDate

public void setModifiedDate(java.util.Date date)

Sets the modifiedDate.

Parameters:

date - a Date object representing the date the History was modified.

unsetCreatedDate

public void unsetCreatedDate()

Sets the created of this History to null.

unsetListOfModifiedDates

public void unsetListOfModifiedDates()

Sets the created of this History to null.