es.uvigo.esei.dgss.teamc.microstories.entities

Class Story

java.lang.Object

es.uvigo.esei.dgss.teamc.microstories.entities.Story

All Implemented Interfaces:

Serializable

@Entity(name="Story")
public class Story
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Story()
Story(Long id, String title, String content, Genre genre, Theme theme1, Theme theme2, Date date, User author, boolean published) Creates a new instance of Story with id and no views
Story(String title, String content, Genre genre, Theme theme1, Theme theme2, Date date, User author) Creates a new instance of Story

Method Summary

Modifier and Type	Method and Description
void	addView(Date date) Creates a new view for the story at the specified date
User	getAuthor() Returns the author of the story
String	getContent() Returns the content of the story
Date	getDate() Returns the date of the story
Genre	getGenre() Returns the genre of the story
Long	getId() Returns the id of the story
Theme	getTheme1() Returns the main theme of the story
Theme	getTheme2() Returns the secondary theme of the story
String	getTitle() Returns the title of the story
int	getViewCount() Returns the story's view count
protected Set<View>	getViews() Returns the story's views
boolean	isPublished() Returns whether the story is published or not
void	setAuthor(User author) Sets the author of the story.
void	setContent(String content) Sets the content of the story.
void	setDate(Date date) Sets the story's publication date.
void	setGenre(Genre genre) Sets the genre of the story.
void	setId(Long id) Sets the id of the story.
void	setPublished(boolean published) Sets the story's publication status
void	setTheme1(Theme theme1) Sets the main theme of the story.
void	setTheme2(Theme theme2) Sets the secondary theme of the story.
void	setTitle(String title) Sets the title of the story.
protected void	setViews(List<View> views)

Methods inherited from class java.lang.Object

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

Constructor Detail

Story

public Story()

Story

public Story(String title,
             String content,
             Genre genre,
             Theme theme1,
             Theme theme2,
             Date date,
             User author)

Creates a new instance of Story

Parameters:

title - the title of the story. This parameter must be a non empty and non null string with a maximun length of 100 chars

content - the content of the story. This parameter must be a non empty and non null string with a maximum length that depends on the story's genre: STORY - 1000 chars, POEM - 500 chars, NANOSTORY - 150 chars

genre - the genre of the story. Can't be null

theme1 - the main theme of the story. This parameter can't be null and can't the same as the secondary theme

theme2 - the secondary theme of the story. This parameter can't be the same as the main theme

date - the story's publication date. This parameter can't be null.

author - the author of the story. This parameter can't be null.

Throws:

NullPointerException - if a null value is passed as the value for any parameter except theme2

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

Story

public Story(Long id,
             String title,
             String content,
             Genre genre,
             Theme theme1,
             Theme theme2,
             Date date,
             User author,
             boolean published)

Creates a new instance of Story with id and no views

Parameters:

id - the id of the story. This parameter must be a non empty and non null.

title - the title of the story. This parameter must be a non empty and non null string with a maximun length of 100 chars

content - the content of the story. This parameter must be a non empty and non null string with a maximum length that depends on the story's genre: STORY - 1000 chars, POEM - 500 chars, NANOSTORY - 150 chars

genre - the genre of the story. Can't be null

theme1 - the main theme of the story. This parameter can't be null and can't the same as the secondary theme

theme2 - the secondary theme of the story. This parameter can't be the same as the main theme

date - the story's publication date. This parameter can't be null.

author - the author of the story. This parameter can't be null.

Throws:

NullPointerException - if a null value is passed as the value for any parameter except theme2

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

Method Detail

getId

public Long getId()

Returns the id of the story

Returns:

the id of the story

setId

public void setId(Long id)

Sets the id of the story.

Parameters:

id - of the story

getTitle

public String getTitle()

Returns the title of the story

Returns:

the title of the story

setTitle

public void setTitle(String title)

Sets the title of the story.

Parameters:

title - the title of the story. This parameter must be a non empty and non null string with a maximun length of 100 chars

Throws:

NullPointerException - if a null value is passed

IllegalArgumentException - if the length of the passed string is not valid

getContent

public String getContent()

Returns the content of the story

Returns:

the content of the story

setContent

public void setContent(String content)

Sets the content of the story.

Parameters:

content - the content of the story. This parameter must be a non empty and non null string with a maximum length that depends on the story's genre: STORY - 1000 chars, POEM - 500 chars, NANOSTORY - 150 chars

Throws:

NullPointerException - if a null value is passed

IllegalArgumentException - if the length of the passed string is not valid

getAuthor

public User getAuthor()

Returns the author of the story

Returns:

the author of the story

setAuthor

public void setAuthor(User author)

Sets the author of the story.

Parameters:

author - the author of the story. Can't be null

Throws:

NullPointerException - if a null value is passed

getGenre

public Genre getGenre()

Returns the genre of the story

Returns:

the genre of the story

setGenre

public void setGenre(Genre genre)

Sets the genre of the story.

Parameters:

genre - the genre of the story. Can't be null

Throws:

NullPointerException - if a null value is passed

getTheme1

public Theme getTheme1()

Returns the main theme of the story

Returns:

the main theme of the story

setTheme1

public void setTheme1(Theme theme1)

Sets the main theme of the story.

Parameters:

theme1 - the main theme of the story. This parameter can't be null and can't the same as the secondary theme

Throws:

NullPointerException - if a null value is passed

IllegalArgumentException - if the passed theme is equal to the secondary theme

getTheme2

public Theme getTheme2()

Returns the secondary theme of the story

Returns:

the secondary theme of the story

setTheme2

public void setTheme2(Theme theme2)

Sets the secondary theme of the story.

Parameters:

theme2 - the secondary theme of the story. This parameter can't be the same as the main theme

Throws:

IllegalArgumentException - if the passed theme is equal to the main theme

getDate

public Date getDate()

Returns the date of the story

Returns:

the date of the story

setDate

public void setDate(Date date)

Sets the story's publication date.

Parameters:

date - the story's publication date. This parameter can't be null.

Throws:

NullPointerException - if a null value is passed

getViews

protected Set<View> getViews()

Returns the story's views

Returns:

the story's views

addView

public void addView(Date date)

Creates a new view for the story at the specified date

Parameters:

date - the date of the view. Can't be null

getViewCount

public int getViewCount()

Returns the story's view count

Returns:

the story's view count

isPublished

public boolean isPublished()

Returns whether the story is published or not

Returns:

whether the story is published or not, true if it is, false if it's not;

setPublished

public void setPublished(boolean published)

Sets the story's publication status

Parameters:

published - the story's publication status, true if it's published, false if it's not.

setViews

protected void setViews(List<View> views)