edu.wright.hendrix11.familyTree.entity.place

Class Place

java.lang.Object

edu.wright.hendrix11.familyTree.entity.place.Place

All Implemented Interfaces:

Iterable<Place>

Direct Known Subclasses:

Cemetery, City, Country, County, State

@Entity
public abstract class Place
extends Object
implements Iterable<Place>

Author:

Joe Hendrix

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIND_ALL Specifies the String that represents the NamedQuery to create a TypedQuery to get all places.
static String	FIND_BY_NAME Specifies the String that represents the NamedQuery to create a TypedQuery to get all places by name.

Constructor Summary

Constructors

Constructor and Description
Place() No-argument constructor for JPA.
Place(String name) Creates a new place with the specified name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getId() Return the unique identifier or primary key of the place.
abstract String	getLink() Returns a URL String, typically either a Google query or Google map link.
String	getName() Returns the name of the place.
List<Place>	getPlaces() Returns a list containing this place and all regions it is in.
Place	getRegion() Return the region of the place.
int	hashCode()
Iterator<Place>	iterator() Returns an iterator containing this place and all regions it is in.
void	setId(int id) Sets the unique identifier or primary key of the place.
void	setName(String name) Sets the name of the place.
void	setRegion(Place region) Sets the region of the place.
String	toString() Returns a string representation of the place.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

FIND_ALL

public static final String FIND_ALL

Specifies the String that represents the NamedQuery to create a TypedQuery to get all places.

For example:

 TypedQuery<Place> query = em.createNamedQuery(Place.FIND_ALL,
 Place.class);

See Also:

Constant Field Values

FIND_BY_NAME

public static final String FIND_BY_NAME

Specifies the String that represents the NamedQuery to create a TypedQuery to get all places by name.

For example:

 TypedQuery<Place> query = em.createNamedQuery(Place.FIND_BY_NAME, Place.class);
 query.setParameter("name", name);

See Also:

Constant Field Values

Constructor Detail

Place

public Place()

No-argument constructor for JPA.

Place

public Place(String name)

Creates a new place with the specified name.

Parameters:

name - the name of the place

Method Detail

getId

public int getId()

Return the unique identifier or primary key of the place. This value is autogenerated by the database.

Returns:

the unique identifier

setId

public void setId(int id)

Sets the unique identifier or primary key of the place. This value is autogenerated by the database.

Parameters:

id - the unique identifier

getName

public String getName()

Returns the name of the place. For instance, "Dayton", "Ohio", or "Germany".

Returns:

the name of the place

setName

public void setName(String name)

Sets the name of the place. For instance, "Dayton", "Ohio", or "Germany".

Parameters:

name - the name of the place

getRegion

public Place getRegion()

Return the region of the place. The region is defined as a more general place. The chain of regions goes from Cemetery → City → County → State → Country. A City's region does not have to be a County, it could also be a State or Country.

Returns:

the region of the place

setRegion

public void setRegion(Place region)

Sets the region of the place. The region is defined as a more general place. The chain of regions goes from Cemetery → City → County → State → Country. A City's region does not have to be a County, it could also be a State or Country.

Parameters:

region - the region of the place

getPlaces

public List<Place> getPlaces()

Returns a list containing this place and all regions it is in.

Returns:

a list of place

iterator

public Iterator<Place> iterator()

Returns an iterator containing this place and all regions it is in. This is just the iterator returned by getPlaces().

Specified by:

iterator in interface Iterable<Place>

Returns:

a list of place

getLink

public abstract String getLink()

Returns a URL String, typically either a Google query or Google map link. A Google query follows the format "https://www.google.com/search?q=" while a Google map link follows the format "https://www.google.com/maps/place/".

Returns:

a URL String, typically either a Google query or Google map link.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Returns a string representation of the place. This is the "fully qualified" name, which is a concatination of this place's name and the name of all regions this place is in, seperated by commas. For example, "Dayton, Ohio, USA".

Overrides:

toString in class Object

Returns:

A string representation of the person, which is just the person's name.

See Also:

getName(), getRegion()