|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.sciplore.resources.Resource
org.sciplore.resources.Document
@Entity public class Document
Resource class for documents.
Resource| Constructor Summary | |
|---|---|
Document()
Generate an empty Document. |
|
Document(Integer id)
Generate a Document with an identifier. |
|
Document(Integer id,
String title)
Generate a Document with identifier and title. |
|
Document(String title)
Generate a Document with title. |
|
| Method Summary | |
|---|---|
void |
addAlert(Alert a)
Add an Alert to the Document. |
void |
addChild(Document c)
Add a child to the Document. |
void |
addCitation(Citation c)
Add a Citation from this document. |
void |
addKeyword(Keyword k)
Add a Keyword to the document. |
void |
addPerson(DocumentPerson p)
Add a person to the document using a DocumentPerson object. |
void |
addPerson(Person p)
Add a person to the document using a Person object to construct the
DocumentPerson. |
void |
addRcvdCitation(Citation c)
Add a received Citation of this Document. |
void |
addXref(DocumentXref x)
Add a cross reference to the Document. |
static String |
generateCleanTitle(String title)
Cleans a title by removing all characters apart from A-Z,
a-z and 0-9 and makes it all lower case so the title can
be compared more tolerantly. |
String |
getAbstract()
Returns the abstract |
Set<Alert> |
getAlerts()
Returns the Alerts |
Set<Document> |
getChildren()
Returns the children. |
Set<Citation> |
getCitations()
Returns the Citations by this Document. |
String |
getCleantitle()
Returns the clean title. |
static Document |
getDocument(Document d)
Returns a Document from the database for a Document object. |
static Document |
getDocument(Integer id)
Returns the Document for an identifier. |
static Document |
getDocument(String title)
Returns a Document for a title. |
static Document |
getDocumentBySourceId(String source,
String id)
Returns a document for a source id. |
static List<Document> |
getDocuments()
Returns a list of all Documents. |
static List<Document> |
getDocuments(Short max)
Returns a list of all Documents with a limiter of the result number as parameter. |
static List<Document> |
getDocuments(String search)
Returns a list of Documents for a search string. |
static List<Document> |
getDocuments(String search,
Short start,
Short maxresults)
Returns a list of Document for a search string. |
String |
getDoi()
Returns the digital object identifier. |
Short |
getEdition()
Returns the edition. |
Set<Feedback> |
getFeedbacks()
Returns the feedbacks. |
Set<DocumentFulltext> |
getFulltexts()
Returns the fulltext elements. |
Set<FulltextUrl> |
getFulltextUrls()
Returns the fulltext URLs. |
String |
getHash()
Returns the hash. |
Integer |
getId()
Returns the identifier. |
Institution |
getInstitution()
Returns the institution. |
String |
getIsbn()
Returns the ISBN. |
String |
getIssn()
Returns the ISSN. |
Set<Keyword> |
getKeywords()
Returns the keywords. |
String |
getLanguage()
Returns the langugae. |
String |
getNumber()
Returns the number of the collection this document was published in. |
String |
getPages()
Returns the pages this document was published at in the collection. |
Document |
getParent()
Returns the parent document. |
Set<DocumentPerson> |
getPersons()
Returns the persons. |
Short |
getPublishedDay()
Returns the day of publication. |
String |
getPublishedMonth()
Returns the month of publication. |
String |
getPublishedPlace()
Returns the place of publication. |
Short |
getPublishedYear()
Returns the year of publication. |
String |
getPublisher()
Returns the publisher. |
Set<Citation> |
getRcvdCitations()
Returns the citations this document received. |
String |
getSeries()
Returns the series of the collection this document was published in. |
String |
getTitle()
Returns the title. |
String |
getType()
Returns the type. |
Short |
getValid()
Returns information about the validity of the record. |
Venue |
getVenue()
Returns the venue. |
String |
getVolume()
Returns the volume of the collection this document was published in. |
StringBuffer |
getXML()
Some XML stuff for the web service. |
Set<DocumentXref> |
getXrefs()
Returns the cross references. |
void |
setAbstract(String documentAbstract)
Sets the abstract. |
void |
setAlerts(Set<Alert> alerts)
Sets the alerts. |
void |
setChildren(Set<Document> children)
Sets the children. |
void |
setCitations(Set<Citation> citations)
Sets the citations by this document. |
void |
setCleantitle(String cleantitle)
Sets the clean title. |
void |
setDoi(String doi)
Sets the digital object identifier. |
void |
setEdition(Short edition)
Sets the edition of the collection this document was published in. |
void |
setFeedbacks(Set<Feedback> feedbacks)
Sets the feedbacks. |
void |
setFulltexts(Set<DocumentFulltext> fulltexts)
Sets the fulltexts. |
void |
setFulltextUrls(Set<FulltextUrl> fulltextUrls)
Sets the fulltext URLs. |
void |
setHash(String hash)
Sets the hash. |
void |
setId(Integer id)
Sets the identifier. |
void |
setInstitution(Institution institution)
Sets the institution. |
void |
setIsbn(String isbn)
Sets the ISBN. |
void |
setIssn(String issn)
Sets the ISSN. |
void |
setKeywords(Set<Keyword> keywords)
Sets the keywords. |
void |
setLanguage(String language)
Sets the language. |
void |
setNumber(String number)
Sets the number of the collection this document was published in. |
void |
setPages(String pages)
Sets the pages where this document has been published in the collection. |
void |
setParent(Document parent)
Sets the parent document. |
void |
setPersons(Set<DocumentPerson> persons)
Sets the persons. |
void |
setPublishedDay(Short publishedDay)
Sets the day of publication. |
void |
setPublishedMonth(String publishedMonth)
Sets the month of publication. |
void |
setPublishedPlace(String publishedPlace)
Sets the place of publication. |
void |
setPublishedYear(Short publishedYear)
Sets the year of publication. |
void |
setPublisher(String publisher)
Sets the publisher. |
void |
setRcvdCitations(Set<Citation> rcvdCitations)
Sets the citations received by this document. |
void |
setSeries(String series)
Sets the series of the collection where this document has been published. |
void |
setTitle(String title)
Sets the title. |
void |
setType(String type)
Sets the type. |
void |
setValid(Short valid)
Sets information about the validity of the record. |
void |
setVenue(Venue venue)
Sets the venue. |
void |
setVolume(String volume)
Sets the volume of the collection this document has been published in. |
void |
setXrefs(Set<DocumentXref> xrefs)
Sets the cross references. |
static Document |
sync(Document d)
Synchronizes a Document object with a record from the database. |
String |
toString()
Returns a string representation of this document. |
| Methods inherited from class org.sciplore.resources.Resource |
|---|
save |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public Document()
public Document(Integer id,
String title)
id - the identifiertitle - the titlepublic Document(Integer id)
Document with an identifier.
id - the identifierpublic Document(String title)
Document with title.
title - the title| Method Detail |
|---|
public static String generateCleanTitle(String title)
A-Z,
a-z and 0-9 and makes it all lower case so the title can
be compared more tolerantly.
The cleaned title should always be used for title comparison instead of
the real title.
title - the title
public static Document getDocument(Document d)
d - the Document
public static Document getDocument(Integer id)
id - the identifier
public static Document getDocument(String title)
title - the title
public static Document getDocumentBySourceId(String source,
String id)
source - the sourceid - the sources id
public static List<Document> getDocuments()
public static List<Document> getDocuments(Short max)
max - maximum number of documents returned
public static List<Document> getDocuments(String search)
search - the search string
public static List<Document> getDocuments(String search,
Short start,
Short maxresults)
maxresults
matches are returned starting at start. This function is
intended to be used for pagination.
The current implementation only matches the beginning of the (clean)title.
search - the search stringstart - the starting offsetmaxresults - the number of results to return at most
public static Document sync(Document d)
d - the document
public void addAlert(Alert a)
Alert to the Document.
a - the alertAlertpublic void addChild(Document c)
Document.
c - the childpublic void addCitation(Citation c)
Citation from this document.
c - the CitationCitationpublic void addKeyword(Keyword k)
Keyword to the document.
k - the KeywordKeywordpublic void addPerson(DocumentPerson p)
DocumentPerson object.
p - the DocumentPerson objectDocumentPersonpublic void addPerson(Person p)
Person object to construct the
DocumentPerson.
p - the Person objectPerson,
DocumentPersonpublic void addRcvdCitation(Citation c)
Citation of this Document.
c - the received CitationCitationpublic void addXref(DocumentXref x)
cross reference to the Document.
x - the cross referenceDocumentXrefpublic String getAbstract()
public Set<Alert> getAlerts()
Alerts
AlertsAlertpublic Set<Document> getChildren()
public Set<Citation> getCitations()
Citations by this Document.
CitationsCitationpublic String getCleantitle()
public String getDoi()
public Short getEdition()
public Set<Feedback> getFeedbacks()
Feedbackpublic Set<DocumentFulltext> getFulltexts()
DocumentFulltextpublic Set<FulltextUrl> getFulltextUrls()
FulltextUrlpublic String getHash()
public Integer getId()
public Institution getInstitution()
Institutionpublic String getIsbn()
public String getIssn()
public Set<Keyword> getKeywords()
public String getLanguage()
public String getNumber()
public String getPages()
public Document getParent()
public Set<DocumentPerson> getPersons()
DocumentPersonpublic Short getPublishedDay()
public String getPublishedMonth()
public String getPublishedPlace()
public Short getPublishedYear()
public String getPublisher()
public Set<Citation> getRcvdCitations()
Citationpublic String getSeries()
public String getTitle()
public String getType()
public Short getValid()
public Venue getVenue()
Venuepublic String getVolume()
public StringBuffer getXML()
throws JAXBException
JAXBExceptionpublic Set<DocumentXref> getXrefs()
DocumentXrefpublic void setAbstract(String documentAbstract)
documentAbstract - the abstractpublic void setAlerts(Set<Alert> alerts)
alerts - the alertsAlertpublic void setChildren(Set<Document> children)
children - the childrenpublic void setCitations(Set<Citation> citations)
citations - the citations by this documentCitationpublic void setCleantitle(String cleantitle)
cleantitle - the cleantitlepublic void setDoi(String doi)
doi - the digital object identifierpublic void setEdition(Short edition)
edition - the edition of the collectionpublic void setFeedbacks(Set<Feedback> feedbacks)
feedbacks - the feedbacksFeedbackpublic void setFulltexts(Set<DocumentFulltext> fulltexts)
fulltexts - the fulltextsDocumentFulltextpublic void setFulltextUrls(Set<FulltextUrl> fulltextUrls)
fulltextUrls - the fulltext URLsFulltextUrlpublic void setHash(String hash)
hash - the hashpublic void setId(Integer id)
id - the identifierpublic void setInstitution(Institution institution)
institution - the institutionInstitutionpublic void setIsbn(String isbn)
isbn - the isbnpublic void setIssn(String issn)
issn - the issnpublic void setKeywords(Set<Keyword> keywords)
keywords - the keywordsKeywordpublic void setLanguage(String language)
language - the languagepublic void setNumber(String number)
number - the number of the collectionpublic void setPages(String pages)
pages - the pages in the collectionpublic void setParent(Document parent)
parent - the parent documentpublic void setPersons(Set<DocumentPerson> persons)
persons - the personsDocumentPersonpublic void setPublishedDay(Short publishedDay)
publishedDay - the day of publicationpublic void setPublishedMonth(String publishedMonth)
publishedMonth - the month of publicationpublic void setPublishedPlace(String publishedPlace)
publishedPlace - the place of publicationpublic void setPublishedYear(Short publishedYear)
publishedYear - the year of publicationpublic void setPublisher(String publisher)
publisher - the publisherpublic void setRcvdCitations(Set<Citation> rcvdCitations)
rcvdCitations - the received citationsCitationpublic void setSeries(String series)
series - the series of the collectionpublic void setTitle(String title)
title - the titlepublic void setType(String type)
type - the typepublic void setValid(Short valid)
valid - the validitypublic void setVenue(Venue venue)
venue - the venueVenuepublic void setVolume(String volume)
volume - the volume of the collectionpublic void setXrefs(Set<DocumentXref> xrefs)
xrefs - the cross references.DocumentXrefpublic String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||