org.wallerlab.yoink.cube.domain

Class SimpleGridPoint<String,V>

java.lang.Object

org.wallerlab.yoink.cube.domain.SimpleGridPoint<String,V>

All Implemented Interfaces:

GridPoint<String,V>

public class SimpleGridPoint<String,V>
extends java.lang.Object
implements GridPoint<String,V>

This domain model is to store information and properties of a grid point

Constructor Summary

Constructors

Constructor and Description
SimpleGridPoint()

Method Summary

Modifier and Type	Method and Description
void	addProperty(String k, V v) add one element in properties
java.util.Set<Atom>	getAtomsInTwoClosestMolecules() get atoms of two closest molecules of a grid point
Coord	getCoordinate() get the value of coordinate
int	getIndexInCube() get the index of a grid point in cube
java.util.Map<String,V>	getProperties() get the value of properties
V	getProperty(String k) get one element's value in properties by key K
java.util.Set<Atom>	getTwoClosestAtoms() get two closest atoms in properties
java.util.Set<Molecule>	getTwoClosestMolecules() get two closest molecules in properties
void	setCoordinate(Coord coordinate) set the coordinate of a grid point
void	setIndexInCube(int indexInCube) set the index of a grid point in cube
void	setProperties(java.util.Map<String,V> properties) set the value of properties

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleGridPoint

public SimpleGridPoint()

Method Detail

addProperty

public void addProperty(String k,
                        V v)

Description copied from interface: GridPoint

add one element in properties

Specified by:

addProperty in interface GridPoint<String,V>

Parameters:

k - :String , the key(name) of property

v - :Object, the value of property

getProperty

public V getProperty(String k)

Description copied from interface: GridPoint

get one element's value in properties by key K

Specified by:

getProperty in interface GridPoint<String,V>

Parameters:

k - String

Returns:

V :Object, the value of property

getCoordinate

public Coord getCoordinate()

Description copied from interface: GridPoint

get the value of coordinate

Specified by:

getCoordinate in interface GridPoint<String,V>

Returns:

Coord Coord

setCoordinate

public void setCoordinate(Coord coordinate)

Description copied from interface: GridPoint

set the coordinate of a grid point

Specified by:

setCoordinate in interface GridPoint<String,V>

Parameters:

coordinate - Coord

getProperties

public java.util.Map<String,V> getProperties()

Description copied from interface: GridPoint

get the value of properties

Specified by:

getProperties in interface GridPoint<String,V>

Returns:

properties : Map, the key is a String

setProperties

public void setProperties(java.util.Map<String,V> properties)

Description copied from interface: GridPoint

set the value of properties

Specified by:

setProperties in interface GridPoint<String,V>

Parameters:

properties - : Map, the key is a String

getIndexInCube

public int getIndexInCube()

Description copied from interface: GridPoint

get the index of a grid point in cube

Specified by:

getIndexInCube in interface GridPoint<String,V>

Returns:

int

setIndexInCube

public void setIndexInCube(int indexInCube)

Description copied from interface: GridPoint

set the index of a grid point in cube

Specified by:

setIndexInCube in interface GridPoint<String,V>

Parameters:

indexInCube - , Integer

getTwoClosestAtoms

public java.util.Set<Atom> getTwoClosestAtoms()

Description copied from interface: GridPoint

get two closest atoms in properties

Specified by:

getTwoClosestAtoms in interface GridPoint<String,V>

Returns:

a Set Set of Atoms Atom

getTwoClosestMolecules

public java.util.Set<Molecule> getTwoClosestMolecules()

Description copied from interface: GridPoint

get two closest molecules in properties

Specified by:

getTwoClosestMolecules in interface GridPoint<String,V>

Returns:

a Set Set of Molecules Molecule

getAtomsInTwoClosestMolecules

public java.util.Set<Atom> getAtomsInTwoClosestMolecules()

Description copied from interface: GridPoint

get atoms of two closest molecules of a grid point

Specified by:

getAtomsInTwoClosestMolecules in interface GridPoint<String,V>

Returns:

a Set Set of Atoms Atom