org.openscience.cdk

Class Element

java.lang.Object

org.openscience.cdk.ChemObject

org.openscience.cdk.Element

All Implemented Interfaces:

Serializable, Cloneable, ICDKObject, IChemObject, IElement

Direct Known Subclasses:

DebugElement, Isotope

public class Element
extends ChemObject
implements Serializable, IElement, Cloneable

Implements the idea of an element in the periodic table.

Use the IsotopeFactory to get a ready-to-use elements by symbol or atomic number:

   IsotopeFactory if = IsotopeFactory.getInstance(new Element().getNewBuilder());
   Element e1 = if.getElement("C");
   Element e2 = if.getElement(12);
 

See Also:

XMLIsotopeFactory, Serialized Form

Source code:

master

Belongs to CDK module:

data

Keywords:

element

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	atomicNumber The atomic number for this element giving their position in the periodic table.
protected String	symbol The element symbol for this element as listed in the periodic table.

Constructor Summary

Constructors

Constructor and Description
Element() Constructs an empty Element.
Element(IElement element) Constructs an empty by copying the symbol, atomic number, flags, and identifier from the given IElement.
Element(String symbol) Constructs an Element with a given element symbol.
Element(String symbol, Integer atomicNumber) Constructs an Element with a given element symbol, atomic number and atomic mass.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clones this IChemObject.
boolean	compare(Object object) Compares an Element with this Element.
Integer	getAtomicNumber() Returns the atomic number of this element.
String	getSymbol() Returns the element symbol of this element.
void	setAtomicNumber(Integer atomicNumber) Sets the atomic number of this element.
void	setSymbol(String symbol) Sets the element symbol of this element.
String	toString() Returns a one line description of this IChemObject.

Methods inherited from class org.openscience.cdk.ChemObject

addListener, addProperties, getBuilder, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, notifyChanged, notifyChanged, removeListener, removeProperty, setFlag, setFlags, setID, setNotification, setProperties, setProperty, shallowCopy

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openscience.cdk.interfaces.IChemObject

addListener, addProperties, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, notifyChanged, notifyChanged, removeListener, removeProperty, setFlag, setFlags, setID, setNotification, setProperties, setProperty

Methods inherited from interface org.openscience.cdk.interfaces.ICDKObject

getBuilder

Field Detail

symbol

protected String symbol

The element symbol for this element as listed in the periodic table.

atomicNumber

protected Integer atomicNumber

The atomic number for this element giving their position in the periodic table.

Constructor Detail

Element

public Element()

Constructs an empty Element.

Element

public Element(IElement element)

Constructs an empty by copying the symbol, atomic number, flags, and identifier from the given IElement. It does not copy the listeners and properties.

Parameters:

element - IElement to copy information from

Element

public Element(String symbol)

Constructs an Element with a given element symbol.

Parameters:

symbol - The element symbol that this element should have.

Element

public Element(String symbol,
       Integer atomicNumber)

Constructs an Element with a given element symbol, atomic number and atomic mass.

Parameters:

symbol - The element symbol of this element.

atomicNumber - The atomicNumber of this element.

Method Detail

getAtomicNumber

public Integer getAtomicNumber()

Returns the atomic number of this element.

Once instantiated all field not filled by passing parameters to the constructor are null. Elements can be configured by using the IsotopeFactory.configure() method:

   Element element = new Element("C");
   IsotopeFactory if = IsotopeFactory.getInstance(element.getNewBuilder());
   if.configure(element);
 

Specified by:

getAtomicNumber in interface IElement

Returns:

The atomic number of this element

See Also:

setAtomicNumber(java.lang.Integer)

setAtomicNumber

public void setAtomicNumber(Integer atomicNumber)

Sets the atomic number of this element.

Specified by:

setAtomicNumber in interface IElement

Parameters:

atomicNumber - The atomic mass to be assigned to this element

See Also:

getAtomicNumber()

getSymbol

public String getSymbol()

Returns the element symbol of this element.

Specified by:

getSymbol in interface IElement

Returns:

The element symbol of this element. Null if unset.

See Also:

setSymbol(java.lang.String)

setSymbol

public void setSymbol(String symbol)

Sets the element symbol of this element.

Specified by:

setSymbol in interface IElement

Parameters:

symbol - The element symbol to be assigned to this atom

See Also:

getSymbol()

toString

public String toString()

Description copied from interface: IChemObject

Returns a one line description of this IChemObject.

Specified by:

toString in interface IChemObject

Overrides:

toString in class Object

Returns:

a String representation of this object

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: ChemObject

Clones this IChemObject. It clones the identifier, flags, properties and pointer vectors. The ChemObjectListeners are not cloned, and neither is the content of the pointer vectors.

Specified by:

clone in interface IChemObject

Overrides:

clone in class ChemObject

Returns:

The cloned object

Throws:

CloneNotSupportedException - if the IChemObject cannot be cloned

compare

public boolean compare(Object object)

Compares an Element with this Element.

Overrides:

compare in class ChemObject

Parameters:

object - Object of type AtomType

Returns:

true if the atom types are equal