org.josef.demo.jpa

Class Planet

java.lang.Object

org.josef.jpa.AbstractEntity

org.josef.jpa.AbstractEntityIdentifiedById

org.josef.jpa.audit.AbstractAuditTrailEntityIdentifiedById

org.josef.demo.jpa.Planet

All Implemented Interfaces:

Serializable, Auditable, Persistable

@Entity
 @Status(stage=TEST,
        unitTests=PARTIAL)
public class Planet
extends AbstractAuditTrailEntityIdentifiedById
implements Serializable

Planet entity.

Version:

1.0 $Revision: 6266 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Planet() Default constructor as required by the JPA specs for unenhanced classes.
Planet(Long id, String name) Constructs this Planet from all the supplied, mandatory fields.
Planet(Long id, String name, Set<Moon> moons) Constructs this Planet from all the supplied, mandatory fields.

Method Summary

Modifier and Type	Method and Description
void	addMoon(Moon moon) Adds the supplied Moon to this Planet.
Double	getAphelion() Gets the aphelion of this Planet in kilometers. The aphelion is the smallest distance to the star this Planet belongs to.
Double	getGravity() Gets the gravity of this Planet in meters per second2.
Double	getMass() Gets the mass of this Planet in kilograms.
Set<Moon>	getMoons() Gets all the Moons that orbit this Planet.
String	getName() Gets the name of this Planet.
Double	getPerihelion() Gets the perihelion of this Planet in kilometers. The perihelion is the smallest distance to the star this Planet belongs to.
Double	getVolume() Gets the volume of this Planet in cubic kilometers.
void	setAphelion(Double aphelion) Sets the aphelion for this Planet in kilometers. The aphelion is the smallest distance to the star this Planet belongs to.
void	setGravity(Double gravity) Sets the gravity for this Planet in meters per second2.
void	setMass(Double mass) Sets the mass for this Planet in kilograms.
void	setMoons(Set<Moon> moons) Sets all the Moons that orbit this Planet.
void	setName(String name) Sets the name for this Planet.
void	setPerihelion(Double perihelion) Sets the perihelion for this Planet in kilometers. The perihelion is the smallest distance to the star this Planet belongs to.
void	setVolume(Double volume) Sets the volume for this Planet in cubic kilometers.
String	toString() Creates a String representation of this Planet.

Methods inherited from class org.josef.jpa.audit.AbstractAuditTrailEntityIdentifiedById

getAuditTrailData, setAuditTrailData

Methods inherited from class org.josef.jpa.AbstractEntityIdentifiedById

getId, getPrimaryKey, setId

Methods inherited from class org.josef.jpa.AbstractEntity

equals, getVersion, hashCode, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

Planet

public Planet()

Default constructor as required by the JPA specs for unenhanced classes.

Planet

public Planet(Long id,
              String name)

Constructs this Planet from all the supplied, mandatory fields.

Parameters:

id - Id of this Planet.

name - Name of this Planet.

Planet

public Planet(Long id,
              String name,
              Set<Moon> moons)

Constructs this Planet from all the supplied, mandatory fields.

Parameters:

id - Id of this Planet.

name - Name of this Planet.

moons - The Moons that Orbit this Planet.

Throws:

NullPointerException - When the supplied moons is null.

Method Detail

getName

public String getName()

Gets the name of this Planet.

Returns:

The name of this Planet.

setName

public void setName(String name)

Sets the name for this Planet.

Parameters:

name - The name for this Planet.

getPerihelion

public Double getPerihelion()

Gets the perihelion of this Planet in kilometers.
The perihelion is the smallest distance to the star this Planet belongs to.

Returns:

The perihelion of this Planet in kilometers or null when no perihelion has been set for this Planet.

setPerihelion

public void setPerihelion(Double perihelion)

Sets the perihelion for this Planet in kilometers.
The perihelion is the smallest distance to the star this Planet belongs to.

Parameters:

perihelion - The perihelion for this Planet in kilometers.

getAphelion

public Double getAphelion()

Gets the aphelion of this Planet in kilometers.
The aphelion is the smallest distance to the star this Planet belongs to.

Returns:

The aphelion of this Planet in kilometers or null when no aphelion has been set for this Planet.

setAphelion

public void setAphelion(Double aphelion)

Sets the aphelion for this Planet in kilometers.
The aphelion is the smallest distance to the star this Planet belongs to.

Parameters:

aphelion - The aphelion for this Planet in kilometers.

getVolume

public Double getVolume()

Gets the volume of this Planet in cubic kilometers.

Returns:

The volume of this Planet in cubic kilometers or null when no volume has been set for this Planet.

setVolume

public void setVolume(Double volume)

Sets the volume for this Planet in cubic kilometers.

Parameters:

volume - The volume for this Planet in cubic kilometers.

getMass

public Double getMass()

Gets the mass of this Planet in kilograms.

Returns:

The mass of this Planet in kilograms or null when no mass has been specified for this Planet.

setMass

public void setMass(Double mass)

Sets the mass for this Planet in kilograms.

Parameters:

mass - The mass for this Planet in kilograms.

getGravity

public Double getGravity()

Gets the gravity of this Planet in meters per second².

Returns:

The gravity of this Planet in meters per second² or null when no gravity has been set for this PLanet.

setGravity

public void setGravity(Double gravity)

Sets the gravity for this Planet in meters per second².

Parameters:

gravity - The gravity for this Planet in meters per second ².

getMoons

public Set<Moon> getMoons()

Gets all the Moons that orbit this Planet.

Returns:

The Moons that orbit this Planet.
The returned List is possibly empty but is guaranteed not to be null.

setMoons

public void setMoons(Set<Moon> moons)

Sets all the Moons that orbit this Planet.

Parameters:

moons - The Moons that orbit this Planet.

addMoon

public void addMoon(Moon moon)

Adds the supplied Moon to this Planet.

Parameters:

moon - The Moon to add to this Planet.

toString

public String toString()

Creates a String representation of this Planet.

Overrides:

toString in class AbstractEntityIdentifiedById

Returns:

String representation of this Planet.