Class FragmentAtom
- All Implemented Interfaces:
Serializable, Cloneable, IAtom, IAtomType, ICDKObject, IChemObject, IElement, IFragmentAtom, IIsotope, IPseudoAtom
- Direct Known Subclasses:
DebugFragmentAtom
Class to represent an IPseudoAtom which embeds an IAtomContainer. Very much
like the MDL Molfile
Group concept.- Author:
- egonw
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface IAtomType
IAtomType.HybridizationModifier and TypeInterfaceDescriptionstatic enumAn enum for the different hybridization states. -
Field Summary
Fields inherited from class Atom
charge, fractionalPoint3d, hydrogenCount, point2d, point3d, stereoParityModifier and TypeFieldDescriptionprotected DoubleThe partial charge of the atom.protected javax.vecmath.Point3dA 3 point specifying the location of this atom in a crystal unit cell.protected IntegerThe number of implicitly bound hydrogen atoms for this atom.protected javax.vecmath.Point2dA 2D point specifying the location of this atom in a 2D coordinate space.protected javax.vecmath.Point3dA 3 point specifying the location of this atom in a 3D coordinate space.protected IntegerA stereo parity descriptor for the stereochemistry of this atom.Fields inherited from class AtomType
electronValency, formalCharge, formalNeighbourCount, hybridizationModifier and TypeFieldDescriptionprotected IntegerThe electron Valency of this atom with CDKConstants.UNSET as default.protected IntegerThe formal charge of the atom with CDKConstants.UNSET as default.protected IntegerThe formal number of neighbours this atom type can have with CDKConstants_UNSET as default.protected IAtomType.HybridizationThe hybridization state of this atom with CDKConstants.HYBRIDIZATION_UNSET as default.Fields inherited from class Isotope
exactMass, naturalAbundanceModifier and TypeFieldDescriptionExact mass of this isotope.Natural abundance of this isotope.Fields inherited from class Element
atomicNumberModifier and TypeFieldDescriptionprotected IntegerThe atomic number for this element giving their position in the periodic table.Fields inherited from interface IChemObject
ALIPHATIC, AROMATIC, CONJUGATED, HIDDEN, HYDROGEN_BOND_ACCEPTOR, HYDROGEN_BOND_DONOR, IN_RING, MAPPED, MARKUSH, NOT_IN_RING, PLACED, REACTIVE_CENTER, SINGLE_OR_DOUBLE, TYPEABLE, VISITEDModifier and TypeFieldDescriptionstatic final intFlag that is set if a ChemObject is part of an aliphatic chain.static final intFlag is set if ChemObject is part of an aromatic system.static final intFlag is set if ChemObject is part of a conjugated system.static final intThis flag can be used when depicted structures to hide certain parts, for example the things are abbreviated (display shortcuts).static final intSets to true if the atom is a hydrogen bond acceptor.static final intSets to true if the atom is a hydrogen bond donor.static final intFlag that is set when the ChemObject is part of a ring.static final intFlag is set if a ChemObject is mapped to another ChemObject.static final intFlag to indicate a flattened molecule holds a Markush structure, you can work on it as is or it might make more sense to repack into something sensible like a RGroupQuery.static final intFlag that is set when the ChemObject is part of a ring.static final intFlag that is set if the ChemObject is placed when calculating 2D/3D layouts.static final intFlag is set if a ChemObject has reactive center.static final intFlag used for marking uncertainty of the bond order.static final intFlag is set if an atom could be typed.static final intFlag is set if ChemObject has been visited.Fields inherited from interface IElement
Ac, Ag, Al, Am, Ar, As, At, Au, B, Ba, Be, Bh, Bi, Bk, Br, C, Ca, Cd, Ce, Cf, Cl, Cm, Cn, Co, Cr, Cs, Cu, Db, Ds, Dy, Er, Es, Eu, F, Fe, Fl, Fm, Fr, Ga, Gd, Ge, H, He, Hf, Hg, Ho, Hs, I, In, Ir, K, Kr, La, Li, Lr, Lu, Lv, Mc, Md, Mg, Mn, Mo, Mt, N, Na, Nb, Nd, Ne, Nh, Ni, No, Np, O, Og, Os, P, Pa, Pb, Pd, Pm, Po, Pr, Pt, Pu, Ra, Rb, Re, Rf, Rg, Rh, Rn, Ru, S, Sb, Sc, Se, Sg, Si, Sm, Sn, Sr, Ta, Tb, Tc, Te, Th, Ti, Tl, Tm, Ts, U, V, W, Wildcard, Xe, Y, Yb, Zn, ZrModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intCarbon atomic numberstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intHydrogen atomic numberstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intNitrogen atomic numberstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intOxygen atomic numberstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intWildcard atom is atomic number 0static final intstatic final intstatic final intstatic final intstatic final int -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Clones this atom object and its content.The exact mass of an FragmentAtom is defined as the sum of exact masses of the IAtom's in the fragment.Returns the fully expended form of the IFragmentAtom.booleanHelper method to indicate that the method should be drawn fully, and not just the abbreviated form.voidsetExactMass(Double mass) Sets the ExactMass attribute of the Isotope object.voidsetExpanded(boolean bool) Sets whether this atom is to be fully drawn and not just in the abbreviated form.voidsetFragment(IAtomContainer fragment) Sets the fully expended form of the IFragmentAtom.toString()Returns a one line string representation of this Atom.Methods inherited from class PseudoAtom
getAttachPointNum, getLabel, setAttachPointNum, setLabel, setStereoParityModifier and TypeMethodDescriptionintAccess the attachment point number.getLabel()Returns the label of this PseudoAtom.voidsetAttachPointNum(int attachPoint) Set the attachment point number.voidSets the label of this PseudoAtom.voidsetStereoParity(Integer stereoParity) Dummy method: the stereo parity is undefined, final.Methods inherited from class Atom
bonds, compare, equals, getBond, getBondCount, getCharge, getContainer, getFractionalPoint3d, getImplicitHydrogenCount, getIndex, getMapIdx, getPoint2d, getPoint3d, getStereoParity, hashCode, setCharge, setFractionalPoint3d, setImplicitHydrogenCount, setMapIdx, setPoint2d, setPoint3dModifier and TypeMethodDescriptionbonds()Returns the bonds connected to this atom.booleanCompares a atom with this atom.booleanReturns the bond connecting 'this' atom to the provided atom.intGet the number of explicit bonds connected to this atom.Returns the partial charge of this atom.Access theIAtomContainerof which this atom is a member of.javax.vecmath.Point3dReturns a point specifying the location of this atom in a Crystal unit cell.Returns the hydrogen count of this atom.intgetIndex()Acces the index of an atom in the context of anIAtomContainer.intAccess the map index for this atom.javax.vecmath.Point2dReturns a point specifying the location of this atom in a 2D space.javax.vecmath.Point3dReturns a point specifying the location of this atom in a 3D space.Returns the stereo parity of this atom.inthashCode()voidSets the partial charge of this atom.voidsetFractionalPoint3d(javax.vecmath.Point3d point3d) Sets a point specifying the location of this atom in a Crystal unit cell.voidsetImplicitHydrogenCount(Integer hydrogenCount) Sets the number of implicit hydrogen count of this atom.voidsetMapIdx(int mapidx) Set the map index for this atom.voidsetPoint2d(javax.vecmath.Point2d point2d) Sets a point specifying the location of this atom in a 2D space.voidsetPoint3d(javax.vecmath.Point3d point3d) Sets a point specifying the location of this atom in 3D space.Methods inherited from class AtomType
getAtomTypeName, getBondOrderSum, getCovalentRadius, getFormalCharge, getFormalNeighbourCount, getHybridization, getMaxBondOrder, getValency, setAtomTypeName, setBondOrderSum, setCovalentRadius, setFormalCharge, setFormalNeighbourCount, setHybridization, setMaxBondOrder, setValencyModifier and TypeMethodDescriptionGets the id attribute of the AtomType object.Gets the bondOrderSum attribute of the AtomType object.Returns the covalent radius for this AtomType.Returns the formal charge of this atom.Returns the formal neighbour count of this atom.Returns the hybridization of this atom.Gets the MaxBondOrder attribute of the AtomType object.Gets the the exact electron valency of the AtomType object.voidsetAtomTypeName(String identifier) Sets the if attribute of the AtomType object.voidsetBondOrderSum(Double bondOrderSum) Sets the the exact bond order sum attribute of the AtomType object.voidsetCovalentRadius(Double radius) Sets the covalent radius for this AtomType.voidsetFormalCharge(Integer charge) Sets the formal charge of this atom.voidsetFormalNeighbourCount(Integer count) Sets the formal neighbour count of this atom.voidsetHybridization(IAtomType.Hybridization hybridization) Sets the hybridization of this atom.voidsetMaxBondOrder(IBond.Order maxBondOrder) Sets the MaxBondOrder attribute of the AtomType object.voidsetValency(Integer valency) Sets the the exact electron valency of the AtomType object.Methods inherited from class Isotope
getMassNumber, getNaturalAbundance, setMassNumber, setNaturalAbundanceModifier and TypeMethodDescriptionReturns the atomic mass of this element.Gets the NaturalAbundance attribute of the Isotope object.voidsetMassNumber(Integer massNumber) Sets the atomic mass of this element.voidsetNaturalAbundance(Double naturalAbundance) Sets the NaturalAbundance attribute of the Isotope object.Methods inherited from class Element
getAtomicNumber, getSymbol, setAtomicNumber, setSymbolModifier and TypeMethodDescriptionReturns the atomic number of this element.Returns the element symbol of this element.voidsetAtomicNumber(Integer atomicNumber) Sets the atomic number of this element.voidSets the element symbol of this element.Methods inherited from class ChemObject
addListener, addProperties, clear, flags, getBuilder, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, is, notifyChanged, notifyChanged, removeListener, removeProperty, set, setFlag, setFlags, setID, setNotification, setProperties, setProperty, shallowCopyModifier and TypeMethodDescriptionvoidUse this to add yourself to this IChemObject as a listener.voidaddProperties(Map<Object, Object> properties) Sets the properties of this object.voidclear(int flags) Clear the provided flags.intflags()Access the current value of the flags for this ChemObject.Returns aIChemObjectBuilderfor the data classes that extend this class.booleangetFlag(int mask) Returns the value of a given flag.boolean[]getFlags()Returns the whole set of flags.Access the internal value used to store the flags.getID()Returns the identifier (ID) of this object.intReturns the number of ChemObjectListeners registered with this object.booleanReturns the flag that indicates whether notification messages are sent around.Returns a Map with the IChemObject's properties.<T> TgetProperty(Object description) Returns a property for the IChemObject.<T> TgetProperty(Object description, Class<T> c) Access a property of the given description and cast the specified class.booleanis(int flags) Test if a flag(s) are set on this ChemObject.voidThis should be triggered by an method that changes the content of an object to that the registered listeners can react to it.voidThis should be triggered by an method that changes the content of an object to that the registered listeners can react to it.voidUse this to remove a ChemObjectListener from the ListenerList of this IChemObject.voidremoveProperty(Object description) Removes a property for a IChemObject.voidset(int flags) Set the provided flags.voidsetFlag(int mask, boolean value) Sets the value of some flag.voidsetFlags(boolean[] flagsNew) Sets the whole set of flags.voidSets the identifier (ID) of this object.voidsetNotification(boolean bool) Set a flag to use or not use notification.voidsetProperties(Map<Object, Object> properties) Set the properties of this object to the provided map (shallow copy).voidsetProperty(Object description, Object property) Sets a property for a IChemObject.Clones thisIChemObject, but preserves references toObjects.Methods inherited from interface IAtom
getTotalHydrogenCount, isAromatic, isInRing, neighbors, setIsAromatic, setIsInRingModifier and TypeMethodDescriptiondefault IntegerCalculates the total number of hydrogens connected to this atom.default booleanAccess whether this atom has been marked as aromatic.default booleanisInRing()Access whether this atom has been flagged as in a ring.Iterable over the atoms connected to this atom (the neighbors).default voidsetIsAromatic(boolean arom) Mark this atom as being aromatic.default voidsetIsInRing(boolean ring) Mark this atom as being in a ring.
-
Constructor Details
-
FragmentAtom
public FragmentAtom()
-
-
Method Details
-
isExpanded
public boolean isExpanded()Description copied from interface:IFragmentAtomHelper method to indicate that the method should be drawn fully, and not just the abbreviated form.- Specified by:
isExpandedin interfaceIFragmentAtom- Returns:
- true, if it should be considered in expended form
-
setExpanded
public void setExpanded(boolean bool) Description copied from interface:IFragmentAtomSets whether this atom is to be fully drawn and not just in the abbreviated form.- Specified by:
setExpandedin interfaceIFragmentAtom- Parameters:
bool- true if the full structure should be drawn
-
getFragment
Description copied from interface:IFragmentAtomReturns the fully expended form of the IFragmentAtom.- Specified by:
getFragmentin interfaceIFragmentAtom- Returns:
- the fully expanded form as an IAtomContainer object
-
setFragment
Description copied from interface:IFragmentAtomSets the fully expended form of the IFragmentAtom.- Specified by:
setFragmentin interfaceIFragmentAtom- Parameters:
fragment- The fragment
-
setExactMass
Description copied from class:IsotopeSets the ExactMass attribute of the Isotope object.- Specified by:
setExactMassin interfaceIIsotope- Overrides:
setExactMassin classIsotope- Parameters:
mass- The new ExactMass value- See Also:
-
getExactMass
The exact mass of an FragmentAtom is defined as the sum of exact masses of the IAtom's in the fragment.- Specified by:
getExactMassin interfaceIIsotope- Overrides:
getExactMassin classIsotope- Returns:
- The ExactMass value
- See Also:
-
toString
Description copied from class:PseudoAtomReturns a one line string representation of this Atom. Methods is conform RFC #9.- Specified by:
toStringin interfaceIChemObject- Overrides:
toStringin classPseudoAtom- Returns:
- The string representation of this Atom
-
clone
Description copied from class:AtomClones this atom object and its content.- Specified by:
clonein interfaceIAtom- Specified by:
clonein interfaceIChemObject- Specified by:
clonein interfaceIPseudoAtom- Overrides:
clonein classPseudoAtom- Returns:
- The cloned object
- Throws:
CloneNotSupportedException- if the IChemObject cannot be cloned
-