bridges::dataset::GutenbergBook Class Reference

#include <GutenbergBook.h>

Detailed Description

A Gutenberg Book object (meta data and book's full text)

This is a convenience class provided for users who wish to use this data source as part of their application. It provides an API that makes it easy to access the attributes of this data set.

Objects of this type are typically not constructed by the user but returned by a call to our Gutenberg API such as bridges::DataSource::getGutenbergBookMetaData(), with an optional book id (integer) as a parameter.

The object does not contain the text of the book itself. Though it can be obtained using bridges::DataSource::getGutenbergBookText()

See also

A tutorial of how to use the Gutenberg data in BRIDGES is available: https://bridgesuncc.github.io/tutorials/Data_Gutenberg.html

Author

Kalpathi Subramanian

Date

2/1/17, 12/28/20, 6/9/21

Public Member Functions
	GutenbergBook ()
	GutenbergBook (const string &titl, const int &book_id, const vector< string > &auth, const string &lng, const vector< string > &genr, const string &da)
vector< string >	getAuthors () const
void	setAuthors (const vector< string > &auth)
int	getId () const
void	setId (const int &id)
string	getTitle () const
void	setTitle (const string &titl)
string	getLoc () const
void	setLoc (const string &loc)
string	getLang () const
void	setLang (const string &lang)
vector< string >	getGenres () const
void	setGenres (const vector< string > &genre)
string	getDateAdded () const
void	setDateAdded (const string &da)

Constructor & Destructor Documentation

GutenbergBook() [1/2]

bridges::dataset::GutenbergBook::GutenbergBook ( )

inline

Default Constructor

GutenbergBook() [2/2]

bridges::dataset::GutenbergBook::GutenbergBook ( const string &  titl, const int &  book_id, const vector< string > &  auth, const string &  lng, const vector< string > &  genr, const string &  da  )

inline

Constructor

Parameters

titl	book title
id	book id
loc	book's library of congress class
auth	book authors
lng	language
genr	genres of book
da	date added

Member Function Documentation

getAuthors()

vector<string> bridges::dataset::GutenbergBook::getAuthors ( ) const

inline

get name of author

Returns

authorName

getDateAdded()

string bridges::dataset::GutenbergBook::getDateAdded ( ) const

inline

set book's subjects

Returns

subjects covered by the book

getGenres()

vector<string> bridges::dataset::GutenbergBook::getGenres ( ) const

inline

get book's genres

Returns

genres of book

getId()

int bridges::dataset::GutenbergBook::getId ( ) const

inline

get book id

Returns

book's id

getLang()

string bridges::dataset::GutenbergBook::getLang ( ) const

inline

get book's language

Returns

language of book

getLoc()

string bridges::dataset::GutenbergBook::getLoc ( ) const

inline

get Library of Congress class

Returns

book's LOC class

getTitle()

string bridges::dataset::GutenbergBook::getTitle ( ) const

inline

get book title

Returns

book's title

setAuthors()

void bridges::dataset::GutenbergBook::setAuthors ( const vector< string > &  auth )

inline

set names of authors

Parameters

auth	name of author

setDateAdded()

void bridges::dataset::GutenbergBook::setDateAdded ( const string &  da )

inline

set book added date

Parameters

da	date added to collection

setGenres()

void bridges::dataset::GutenbergBook::setGenres ( const vector< string > &  genre )

inline

set book's genres

Parameters

genre

genres of book to be set

setId()

void bridges::dataset::GutenbergBook::setId ( const int &  id )

inline

set book id

Parameters

id	id of book to set

setLang()

void bridges::dataset::GutenbergBook::setLang ( const string &  lang )

inline

set book's language

Parameters

lang	book's language to be set

setLoc()

void bridges::dataset::GutenbergBook::setLoc ( const string &  loc )

inline

set book's LOC class

Parameters

loc	class of book to set

setTitle()

void bridges::dataset::GutenbergBook::setTitle ( const string &  titl )

inline

set book title

Parameters

title

title of book to set

---

The documentation for this class was generated from the following file:

• /home/erik/work/bridges/bridges-cxx/src/data_src/GutenbergBook.h