org.openscience.nmrshiftdb.om
Class DBLiterature

java.lang.Object
  org.apache.torque.om.BaseObject
      org.openscience.nmrshiftdb.om.BaseDBLiterature
          org.openscience.nmrshiftdb.om.DBLiterature

All Implemented Interfaces:

java.io.Serializable, org.apache.torque.om.Persistent

public class DBLiterature
extends BaseDBLiterature
implements org.apache.torque.om.Persistent

You should add additional methods to this class to meet the application requirements. This class will only be generated as long as it does not already exist in the output directory.

Author:

shk3

See Also:

Serialized Form

Field Summary

private java.lang.String	author The authors like s.
private java.lang.String	authorbook In case it's an article in a book: The author like a.
int	choosenJournal In case it's a journal article: The id of a journal already in DB
int	choosenPublisher In case it's a book: The id of publisher already in DB
boolean	etalbook In case it's an article in a book more authors than stated
boolean	etalprov More authors than stated
int	from In case it's an article the page it starts at
int	issue In case it's a journal article: The issue
java.lang.String	ita In case it's a journal article: The title abbreviation
java.lang.String	journalsubtitle In case it's a journal article: The subtitle of the journal
java.lang.String	journaltitle In case it's a journal article: The title of the journal
java.lang.String	place In case it's a book: The publishing place
java.lang.String	publisher In case it's a book: The publisher name
private java.lang.String	subtitlebook In case it's an article in a book: The subtitle
private java.lang.String	titlebook In case it's an article in a book: The title
int	to In case it's an article the page it end at
java.lang.String	type Type of literature as in NmrshiftdbConstants
int	volume In case it's a journal article: The volume
int	year In case it's a journal article: The year

Fields inherited from class org.openscience.nmrshiftdb.om.BaseDBLiterature

collDBArticlesRelatedByLiteratureId, collDBArticlesRelatedByPublishedInBook, collDBBookDBPublishers, collDBBooks, collDBIdentifiers, collDBSpectrumDBLiteratures, collIsAuthors, collIsEditors

Fields inherited from class org.apache.torque.om.BaseObject

NEW_ID

Constructor Summary

DBLiterature()
Constructor for the DBLiterature object

DBLiterature(java.lang.String type)
Constructor for the DBLiterature object.

Method Summary

static java.util.List	analyzeAuthor(java.lang.String author) Analyses an author string like a.
DBArticle	getArticle() Returns this literature item as an article, in case it is one.
java.lang.String	getAuthor() Gets the author attribute of the DBLiterature object
java.lang.String	getAuthorbook() Gets the authorbook attribute of the DBLiterature object
java.util.List	getAuthorsAndEditors() Gets the authors and editors of thise DBLiterature object.
java.lang.String	getAuthorsFromDB() Gets all authors of the DBLiterature object.
boolean	getEtalbook() Gets the etalbook attribute of the DBLiterature object
boolean	getEtalprov() Gets the etalprov attribute of the DBLiterature object
int	getFrom() Gets the from attribute of the DBLiterature object
int	getIssue() Gets the issue attribute of the DBLiterature object
java.lang.String	getIta() Gets the ita attribute of the DBLiterature object
java.lang.String	getJournalsubtitle() Gets the journalsubtitle attribute of the DBLiterature object
java.lang.String	getJournaltitle() Gets the journaltitle attribute of the DBLiterature object
java.lang.String	getPlace() Gets the place attribute of the DBLiterature object
java.lang.String	getPlaceFromDB() Gets the place the DBLiterature object has been published.
DBLiterature	getPublishedInBook() Tells which book this item is published in.
java.lang.String	getPublisher() Gets the publisher attribute of the DBLiterature object
DBPublisher	getPublisherFromDB() Gets the name of the publisher the DBLiterature has been published by.
java.lang.String	getPublisherNameFromDB() Gets the name of the publisher the DBLiterature has been published by.
java.lang.String	getSubtitlebook() Gets the subtitlebook attribute of the DBLiterature object
java.lang.String	getSubtitlebookForHtml() Gets the subtitlebook with " escaped for html.
java.lang.String	getSubtitleForHtml() Gets the subtitle with " escaped for html.
java.lang.String	getTitlebook() Gets the titlebook attribute of the DBLiterature object
java.lang.String	getTitlebookForHtml() Gets the titlebook with " escaped for html.
java.lang.String	getTitleForHtml() Gets the title with " esacped for html
int	getTo() Gets the to attribute of the DBLiterature object
java.lang.String	getType() Gets the type attribute of the DBLiterature object.
int	getVolume() Gets the volume attribute of the DBLiterature object
int	getYear() Gets the year attribute of the DBLiterature object
int	getYearFromDB() Gets the publishing year the DBLiterature has been published in.
boolean	isMonograph() Tells if this a monograph or not.
boolean	isPublishedInJournal() Tells if this literature item is published in a journal.
DBLiterature	literatureAlreadyExists(java.sql.Connection dbconn) Looks if a literature item alreay exists in db.
DBLiterature	read() Reads the attributes from db.
void	save(int spectrumid, java.sql.Connection dbconn) Saves this literature object to the db.
void	setAuthor(java.lang.String author)
void	setAuthorbook(java.lang.String authorbook)
void	setSubtitle(java.lang.String v) Set the value of Title
void	setSubtitleBook(java.lang.String v) Set the value of Title
void	setTitle(java.lang.String v) Set the value of Title
void	setTitleBook(java.lang.String v) Set the value of Title
java.lang.String	toString() Gives a nicly formatted string.

Methods inherited from class org.openscience.nmrshiftdb.om.BaseDBLiterature

addDBArticleRelatedByLiteratureId, addDBArticleRelatedByPublishedInBook, addDBBook, addDBBookDBPublisher, addDBIdentifier, addDBSpectrumDBLiterature, addIsAuthor, addIsEditor, copy, copyInto, getByName, getByPeerName, getByPosition, getDBArticlesRelatedByLiteratureId, getDBArticlesRelatedByLiteratureId, getDBArticlesRelatedByLiteratureId, getDBArticlesRelatedByLiteratureId, getDBArticlesRelatedByLiteratureIdJoinDBJournalVolume, getDBArticlesRelatedByLiteratureIdJoinDBLiteratureRelatedByPublishedInBook, getDBArticlesRelatedByPublishedInBook, getDBArticlesRelatedByPublishedInBook, getDBArticlesRelatedByPublishedInBook, getDBArticlesRelatedByPublishedInBook, getDBArticlesRelatedByPublishedInBookJoinDBJournalVolume, getDBArticlesRelatedByPublishedInBookJoinDBLiteratureRelatedByLiteratureId, getDBBookDBPublishers, getDBBookDBPublishers, getDBBookDBPublishers, getDBBookDBPublishers, getDBBookDBPublishersJoinDBLiterature, getDBBookDBPublishersJoinDBPublisher, getDBBooks, getDBBooks, getDBBooks, getDBBooks, getDBBooksJoinDBLiterature, getDBIdentifiers, getDBIdentifiers, getDBIdentifiers, getDBIdentifiers, getDBIdentifiersJoinDBAtom, getDBIdentifiersJoinDBLiterature, getDBSpectrumDBLiteratures, getDBSpectrumDBLiteratures, getDBSpectrumDBLiteratures, getDBSpectrumDBLiteratures, getDBSpectrumDBLiteraturesJoinDBLiterature, getDBSpectrumDBLiteraturesJoinDBSpectrum, getDoi, getEtAl, getFieldNames, getIsAuthors, getIsAuthors, getIsAuthors, getIsAuthors, getIsAuthorsJoinDBAuthor, getIsAuthorsJoinDBLiterature, getIsEditors, getIsEditors, getIsEditors, getIsEditors, getIsEditorsJoinDBAuthor, getIsEditorsJoinDBLiterature, getLiteratureId, getPeer, getPrimaryKey, getSubtitle, getTitle, getTitleTotal, getTitleTotalSoundex, getUrl, initDBArticlesRelatedByLiteratureId, initDBArticlesRelatedByPublishedInBook, initDBBookDBPublishers, initDBBooks, initDBIdentifiers, initDBSpectrumDBLiteratures, initIsAuthors, initIsEditors, save, save, save, setDoi, setEtAl, setLiteratureId, setPrimaryKey, setPrimaryKey, setTitleTotal, setTitleTotalSoundex, setUrl

Methods inherited from class org.apache.torque.om.BaseObject

equals, equals, getLog, hashCode, isModified, isNew, log, resetModified, setModified, setNew, setPrimaryKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.torque.om.Persistent

getPrimaryKey, isModified, isNew, save, save, save, setModified, setNew, setPrimaryKey, setPrimaryKey

Field Detail

type

public java.lang.String type

Type of literature as in NmrshiftdbConstants

author

private java.lang.String author

The authors like s. a; b. c

etalprov

public boolean etalprov

More authors than stated

etalbook

public boolean etalbook

In case it's an article in a book more authors than stated

from

public int from

In case it's an article the page it starts at

to

public int to

In case it's an article the page it end at

journaltitle

public java.lang.String journaltitle

In case it's a journal article: The title of the journal

journalsubtitle

public java.lang.String journalsubtitle

In case it's a journal article: The subtitle of the journal

choosenJournal

public int choosenJournal

In case it's a journal article: The id of a journal already in DB

ita

public java.lang.String ita

In case it's a journal article: The title abbreviation

volume

public int volume

In case it's a journal article: The volume

year

public int year

In case it's a journal article: The year

issue

public int issue

In case it's a journal article: The issue

place

public java.lang.String place

In case it's a book: The publishing place

publisher

public java.lang.String publisher

In case it's a book: The publisher name

choosenPublisher

public int choosenPublisher

In case it's a book: The id of publisher already in DB

authorbook

private java.lang.String authorbook

In case it's an article in a book: The author like a. b; c. d

titlebook

private java.lang.String titlebook

In case it's an article in a book: The title

subtitlebook

private java.lang.String subtitlebook

In case it's an article in a book: The subtitle

Constructor Detail

DBLiterature

public DBLiterature()

Constructor for the DBLiterature object

DBLiterature

public DBLiterature(java.lang.String type)

Constructor for the DBLiterature object.

Parameters:

type - The type of Literature.

Method Detail

getType

public java.lang.String getType()

Gets the type attribute of the DBLiterature object.

Returns:

The type value

getAuthor

public java.lang.String getAuthor()

Gets the author attribute of the DBLiterature object

Returns:

The author value

getEtalprov

public boolean getEtalprov()

Gets the etalprov attribute of the DBLiterature object

Returns:

The etalprov value

getEtalbook

public boolean getEtalbook()

Gets the etalbook attribute of the DBLiterature object

Returns:

The etalbook value

getJournalsubtitle

public java.lang.String getJournalsubtitle()

Gets the journalsubtitle attribute of the DBLiterature object

Returns:

The journalsubtitle value

getJournaltitle

public java.lang.String getJournaltitle()

Gets the journaltitle attribute of the DBLiterature object

Returns:

The journaltitle value

getSubtitlebook

public java.lang.String getSubtitlebook()

Gets the subtitlebook attribute of the DBLiterature object

Returns:

The subtitlebook value

getIta

public java.lang.String getIta()

Gets the ita attribute of the DBLiterature object

Returns:

The ita value

getTitlebook

public java.lang.String getTitlebook()

Gets the titlebook attribute of the DBLiterature object

Returns:

The titlebook value

getTitleForHtml

public java.lang.String getTitleForHtml()

Gets the title with " esacped for html

Returns:

The titleForHtml value

getSubtitleForHtml

public java.lang.String getSubtitleForHtml()

Gets the subtitle with " escaped for html.

Returns:

The subtitleForHtml value.

getTitlebookForHtml

public java.lang.String getTitlebookForHtml()

Gets the titlebook with " escaped for html.

Returns:

The titlebookForHtml value.

getSubtitlebookForHtml

public java.lang.String getSubtitlebookForHtml()

Gets the subtitlebook with " escaped for html.

Returns:

The subtitlebookForHtml value.

getPlace

public java.lang.String getPlace()

Gets the place attribute of the DBLiterature object

Returns:

The place value

getPublisher

public java.lang.String getPublisher()

Gets the publisher attribute of the DBLiterature object

Returns:

The publisher value

getYear

public int getYear()

Gets the year attribute of the DBLiterature object

Returns:

The year value

getVolume

public int getVolume()

Gets the volume attribute of the DBLiterature object

Returns:

The volume value

getIssue

public int getIssue()

Gets the issue attribute of the DBLiterature object

Returns:

The issue value

getFrom

public int getFrom()

Gets the from attribute of the DBLiterature object

Returns:

The from value

getTo

public int getTo()

Gets the to attribute of the DBLiterature object

Returns:

The to value

getAuthorbook

public java.lang.String getAuthorbook()

Gets the authorbook attribute of the DBLiterature object

Returns:

The authorbook value

getAuthorsAndEditors

public java.util.List getAuthorsAndEditors()
                                    throws NmrshiftdbException,
                                           java.lang.Exception

Gets the authors and editors of thise DBLiterature object.

Returns:

The authorsAndEditors value.

Throws:

NmrshiftdbException - Unique problems.

java.lang.Exception - Database problems.

getPublishedInBook

public DBLiterature getPublishedInBook()
                                throws NmrshiftdbException,
                                       java.lang.Exception

Tells which book this item is published in.

Returns:

The publishedInBook value, null=no book.

Throws:

NmrshiftdbException - Unique problems

java.lang.Exception - Database problems.

getArticle

public DBArticle getArticle()
                     throws java.lang.Exception

Returns this literature item as an article, in case it is one.

Returns:

The article value, null=no article.

Throws:

java.lang.Exception - Database problems.

isMonograph

public boolean isMonograph()
                    throws NmrshiftdbException,
                           java.lang.Exception

Tells if this a monograph or not.

Returns:

True or false.

Throws:

NmrshiftdbException - Problems with unique columns.

java.lang.Exception - Database problems.

isPublishedInJournal

public boolean isPublishedInJournal()
                             throws java.lang.Exception

Tells if this literature item is published in a journal.

Returns:

True or false.

Throws:

java.lang.Exception - Database problems.

getAuthorsFromDB

public java.lang.String getAuthorsFromDB()
                                  throws java.lang.Exception

Gets all authors of the DBLiterature object.

Returns:

The authorsFromDB value.

Throws:

java.lang.Exception - Database problems.

getPlaceFromDB

public java.lang.String getPlaceFromDB()
                                throws org.apache.torque.TorqueException

Gets the place the DBLiterature object has been published.

Returns:

The placeFromDB value.

Throws:

java.lang.Exception - Database problems.

org.apache.torque.TorqueException

getPublisherFromDB

public DBPublisher getPublisherFromDB()
                               throws org.apache.torque.TorqueException

Gets the name of the publisher the DBLiterature has been published by.

Returns:

The publisherNameFromDB value.

Throws:

java.lang.Exception - Database problems.

org.apache.torque.TorqueException

getPublisherNameFromDB

public java.lang.String getPublisherNameFromDB()
                                        throws org.apache.torque.TorqueException

Gets the name of the publisher the DBLiterature has been published by.

Returns:

The publisherNameFromDB value.

Throws:

java.lang.Exception - Database problems.

org.apache.torque.TorqueException

getYearFromDB

public int getYearFromDB()
                  throws org.apache.torque.TorqueException

Gets the publishing year the DBLiterature has been published in.

Returns:

The publisherNameFromDB value.

Throws:

java.lang.Exception - Database problems.

org.apache.torque.TorqueException

save

public void save(int spectrumid,
                 java.sql.Connection dbconn)
          throws java.lang.Exception

Saves this literature object to the db. The relevant flags need to be set.

Parameters:

spectrum - The spectrum this literature is of.

dbconn - Description of Parameter

Throws:

java.lang.Exception - Database problems.

read

public DBLiterature read()
                  throws NmrshiftdbException,
                         java.lang.Exception

Reads the attributes from db.

Returns:

This object itself.

Throws:

NmrshiftdbException - Problems with unique columns.

java.lang.Exception - Database problems.

toString

public java.lang.String toString()

Gives a nicly formatted string.

Overrides:

toString in class BaseDBLiterature

Returns:

The citation of this literature.

literatureAlreadyExists

public DBLiterature literatureAlreadyExists(java.sql.Connection dbconn)
                                     throws org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException

Looks if a literature item alreay exists in db.

Returns:

The pk of the entry or null if not yet existing.

Throws:

java.lang.Exception - Database problems.

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

analyzeAuthor

public static java.util.List analyzeAuthor(java.lang.String author)

Analyses an author string like a. b; c. d and return a list with name-surname pairs.

Parameters:

author - The string to analyze.

Returns:

The map.

setTitle

public void setTitle(java.lang.String v)

Set the value of Title

Overrides:

setTitle in class BaseDBLiterature

Parameters:

v - new value

setSubtitle

public void setSubtitle(java.lang.String v)

Set the value of Title

Overrides:

setSubtitle in class BaseDBLiterature

Parameters:

v - new value

setTitleBook

public void setTitleBook(java.lang.String v)

Set the value of Title

setSubtitleBook

public void setSubtitleBook(java.lang.String v)

Set the value of Title

setAuthor

public void setAuthor(java.lang.String author)

setAuthorbook

public void setAuthorbook(java.lang.String authorbook)