org.sbml.jsbml

Class Creator

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AnnotationElement

org.sbml.jsbml.Creator

All Implemented Interfaces:

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

public class Creator
extends AnnotationElement

Contains all the information about a creator of a Model (or other SBase in level 3).

Since:

0.8

Version:

$Rev: 1650 $

Author:

Marine Dumousseau, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	email email of the creator
private java.lang.String	familyName Family name of the creator
private java.lang.String	givenName Given name of the creator
private static org.apache.log4j.Logger	logger A Logger for this class.
private java.lang.String	organisation Organisation name of the creator.
private java.util.Map<java.lang.String,java.lang.String>	otherAttributes Holding any additional vCard elements.
private static long	serialVersionUID Generated serial version identifier.
static java.lang.String	URI_RDF_VCARD_NS URI for the RDF syntax name space definition for VCards.

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
Creator() Creates a Creator instance.
Creator(Creator creator) Creates a Creator instance from a given Creator.
Creator(java.lang.String givenName, java.lang.String familyName, java.lang.String organization, java.lang.String email) Creates a Creator instance.

Method Summary

Methods

Modifier and Type	Method and Description
Creator	clone()
boolean	equals(java.lang.Object object)
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int childIndex)
int	getChildCount()
java.lang.String	getEmail() Returns the email from the Creator.
java.lang.String	getFamilyName() Returns the familyName from the Creator.
java.lang.String	getGivenName() Returns the givenName from the Creator.
java.lang.String	getOrganisation() Returns the organisation from the Creator.
java.lang.String	getOrganization() Returns the organisation from the Creator.
java.lang.String	getOtherAttribute(java.lang.String attributeName) Deprecated. those other attributes are not saved when writing the model
java.util.Map<java.lang.String,java.lang.String>	getOtherAttributes() Deprecated. those other attributes are not saved when writing the model
int	hashCode()
boolean	isSetEmail() Returns true or false depending on whether this Creator's email has been set.
boolean	isSetFamilyName() Returns true or false depending on whether this Creator's familyName has been set.
boolean	isSetGivenName() Returns true or false depending on whether this Creator's givenName has been set.
boolean	isSetOrganisation() Returns true or false depending on whether this Creator's organisation has been set.
boolean	isSetOrganization() Returns true or false depending on whether this Creator's organisation has been set.
boolean	isSetOtherAttributes() Deprecated. those other attributes are not saved when writing the model
boolean	readAttribute(java.lang.String elementName, java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Returns true if the XML attribute is known by this Creator.
int	setEmail(java.lang.String email) Sets the email if it follows the syntax rules of valid e-mail addresses according to http://en.wikipedia.org/wiki/E-mail_address.
int	setFamilyName(java.lang.String familyName) Sets the family name
int	setGivenName(java.lang.String givenName) Sets the given name
void	setOrganisation(java.lang.String organisation) Sets the organisation
void	setOrganization(java.lang.String organization) Sets the organisation
void	setOtherAttribute(java.lang.String attributeName, java.lang.String attributeValue) Deprecated. those other attributes are not saved when writing the model
java.lang.String	toString() Returns the information about the Creator as a String.
int	unsetEmail() Unsets the email of this Creator.
int	unsetFamilyName() Unsets the familyName of this Creator.
int	unsetGivenName() Unsets the givenName of this Creator.
void	unsetOrganization() Unsets the organisation of this Creator.

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

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

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final transient org.apache.log4j.Logger logger

A Logger for this class.

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

URI_RDF_VCARD_NS

public static final transient java.lang.String URI_RDF_VCARD_NS

URI for the RDF syntax name space definition for VCards.

See Also:

Constant Field Values

email

private java.lang.String email

email of the creator

familyName

private java.lang.String familyName

Family name of the creator

givenName

private java.lang.String givenName

Given name of the creator

organisation

private java.lang.String organisation

Organisation name of the creator.

otherAttributes

private java.util.Map<java.lang.String,java.lang.String> otherAttributes

Holding any additional vCard elements. This is a quick and dirty solution as the vCard can contain many elements that have sub-elements. TODO: use an XMLNode to hold all the additional informations

Constructor Detail

Creator

public Creator()

Creates a Creator instance. By default, the email, familyName, givenName, organisation are null.

Creator

public Creator(Creator creator)

Creates a Creator instance from a given Creator.

Parameters:

creator -

Creator

public Creator(java.lang.String givenName,
       java.lang.String familyName,
       java.lang.String organization,
       java.lang.String email)

Creates a Creator instance.

Parameters:

givenName -

familyName -

organization -

email -

Method Detail

clone

public Creator 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()

getEmail

public java.lang.String getEmail()

Returns the email from the Creator. Returns an empty String if it is not set.

Returns:

the email from the Creator. Returns an empty String if it is not set.

getFamilyName

public java.lang.String getFamilyName()

Returns the familyName from the Creator. Returns an empty String if it is not set.

Returns:

the familyName from the Creator. Returns an empty String if it is not set.

getGivenName

public java.lang.String getGivenName()

Returns the givenName from the Creator. Returns an empty String if it is not set.

Returns:

the givenName from the Creator. Returns an empty String if it is not set.

getOrganisation

public java.lang.String getOrganisation()

Returns the organisation from the Creator. Returns an empty String if it is not set.

Returns:

the organisation from the Creator. Returns an empty String if it is not set.

getOrganization

public java.lang.String getOrganization()

Returns the organisation from the Creator. Returns an empty String if it is not set.

Equal to getOrganisation()

Returns:

the organisation from the Creator. Returns an empty String if it is not set.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTreeNode

isSetEmail

public boolean isSetEmail()

Returns true or false depending on whether this Creator's email has been set.

Returns:

true if the email of this Creator is not null.

isSetFamilyName

public boolean isSetFamilyName()

Returns true or false depending on whether this Creator's familyName has been set.

Returns:

true if the familyName of this Creator is not null.

isSetGivenName

public boolean isSetGivenName()

Returns true or false depending on whether this Creator's givenName has been set.

Returns:

true if the givenName of this Creator is not null.

isSetOrganisation

public boolean isSetOrganisation()

Returns true or false depending on whether this Creator's organisation has been set.

Returns:

true if the organisation of this Creator is not null.

isSetOrganization

public boolean isSetOrganization()

Returns true or false depending on whether this Creator's organisation has been set.

Equal to isSetOrganisation()

Returns:

true or false depending on whether this Creator's organisation has been set.

readAttribute

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

Returns true if the XML attribute is known by this Creator.

Returns:

true if the XML attribute is known by this Creator.

setEmail

public int setEmail(java.lang.String email)

Sets the email if it follows the syntax rules of valid e-mail addresses according to http://en.wikipedia.org/wiki/E-mail_address.

Parameters:

email -

Returns:

JSBML.OPERATION_SUCCESS

setFamilyName

public int setFamilyName(java.lang.String familyName)

Sets the family name

Parameters:

familyName -

Returns:

JSBML.OPERATION_SUCCESS

setGivenName

public int setGivenName(java.lang.String givenName)

Sets the given name

Parameters:

givenName -

Returns:

JSBML.OPERATION_SUCCESS

setOrganisation

public void setOrganisation(java.lang.String organisation)

Sets the organisation

Parameters:

organisation -

setOrganization

public void setOrganization(java.lang.String organization)

Sets the organisation

Equal to setOrganisation(String).

Parameters:

organization -

setOtherAttribute

public void setOtherAttribute(java.lang.String attributeName,
                     java.lang.String attributeValue)

Deprecated. those other attributes are not saved when writing the model

Parameters:

attributeName -

attributeValue -

getOtherAttributes

public java.util.Map<java.lang.String,java.lang.String> getOtherAttributes()

Deprecated. those other attributes are not saved when writing the model

Returns:

isSetOtherAttributes

public boolean isSetOtherAttributes()

Deprecated. those other attributes are not saved when writing the model

Returns:

getOtherAttribute

public java.lang.String getOtherAttribute(java.lang.String attributeName)

Deprecated. those other attributes are not saved when writing the model

Parameters:

attributeName -

Returns:

toString

public java.lang.String toString()

Returns the information about the Creator as a String.

Overrides:

toString in class AbstractTreeNode

Returns:

the information about the Creator as a String.

unsetEmail

public int unsetEmail()

Unsets the email of this Creator.

Returns:

JSBML.OPERATION_SUCCESS

unsetFamilyName

public int unsetFamilyName()

Unsets the familyName of this Creator.

Returns:

JSBML.OPERATION_SUCCESS

unsetGivenName

public int unsetGivenName()

Unsets the givenName of this Creator.

Returns:

JSBML.OPERATION_SUCCESS

unsetOrganization

public void unsetOrganization()

Unsets the organisation of this Creator.