Package io.goobi.viewer.model.bookmark

Class Bookmark

java.lang.Object

io.goobi.viewer.model.bookmark.Bookmark

All Implemented Interfaces:

Serializable

@Entity
public class Bookmark
extends Object
implements Serializable

Bookmark class.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Bookmark()	Empty constructor.
Bookmark(String pi, String logId, Integer order)	Creates a new bookmark based in book pi, section logId and page order logId and order my be empty or null, if only the book itself is references.
Bookmark(String pi, String logId, Integer order, boolean ignoreMissingSolrDoc)	Creates a new bookmark based in book pi, section logId and page order logId and order my be empty or null, if only the book itself is references.
Bookmark(String pi, String mainTitle, String name)	Constructor for Bookmark.

Method Summary

Modifier and Type	Method	Description
boolean	bothEqualOrBlank(String o1, String o2)	bothEqualOrBlank.
boolean	bothEqualOrNull(Object o1, Object o2)	bothEqualOrNull.
boolean	equals(Object obj)
BookmarkList	getBookmarkList()	Getter for the field bookmarkList.
BrowseElement	getBrowseElement()
LocalDateTime	getDateAdded()	Getter for the field dateAdded.
String	getDescription()	Getter for the field description.
String	getDocumentTitle()	Retrieves the documents title from the Solr index using the stored pi and - if nonempty - the logId
Long	getId()	Getter for the field id.
String	getLogId()	Getter for the field logId.
MetadataElement	getMetadataElement()
String	getName()	Getter for the field name.
Integer	getOrder()	Getter for the field order.
String	getPi()	Getter for the field pi.
String	getRepresentativeImageUrl()	Returns the URL to the representative image thumbnail for the record represented by this item.
String	getRepresentativeImageUrl(int width, int height)	Returns the URL to the representative image thumbnail for the record represented by this item.
String	getSolrQueryForDocument()	0
String	getUrl()	Returns the image view URL for this bookmark.
String	getUrn()	Getter for the field urn.
int	hashCode()
boolean	isHasImages()
void	setBookmarkList(BookmarkList bookmarkList)	Setter for the field bookmarkList.
void	setDateAdded(LocalDateTime dateAdded)	Setter for the field dateAdded.
void	setDescription(String description)	Setter for the field description.
void	setId(Long id)	Setter for the field id.
void	setLogId(String logId)	Setter for the field logId.
void	setName(String name)	Setter for the field name.
void	setOrder(Integer order)	Setter for the field order.
void	setPi(String pi)	Setter for the field pi.
void	setUrn(String urn)	Setter for the field urn.

Methods inherited from class java.lang.Object

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

Constructor Details

Bookmark

public Bookmark()

Empty constructor.

Bookmark

public Bookmark(String pi,
 String mainTitle,
 String name)

Constructor for Bookmark.

Parameters:

pi - a String object.

mainTitle - a String object.

name - a String object.

Bookmark

public Bookmark(String pi,
 String logId,
 Integer order)
         throws IndexUnreachableException,
PresentationException

Creates a new bookmark based in book pi, section logId and page order logId and order my be empty or null, if only the book itself is references. PI must be non-empty, otherwise a NullPointerException is thrown The item name will be inferred from the book/section title from Solr. If that fails, an IndexUnreachableException or PresentationException is thrown

Parameters:

pi - a String object.

logId - a String object.

order - a Integer object.

Throws:

NullPointerException - if pi is null or blank

IndexUnreachableException - if any.

PresentationException - if any.

Bookmark

public Bookmark(String pi,
 String logId,
 Integer order,
 boolean ignoreMissingSolrDoc)
         throws IndexUnreachableException,
PresentationException

Creates a new bookmark based in book pi, section logId and page order logId and order my be empty or null, if only the book itself is references. PI must be non-empty, otherwise a NullPointerException is thrown The item name will be inferred from the book/section title from Solr. If that fails, an IndexUnreachableException or PresentationException is thrown

Parameters:

pi - a String object.

logId - a String object.

order - a Integer object.

ignoreMissingSolrDoc - should be false, unless arbitrary pi/logid values should be allowed (e.g. for testing)

Throws:

NullPointerException - if pi is null or blank

IndexUnreachableException - if any.

PresentationException - if any.

Method Details

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

bothEqualOrNull

public boolean bothEqualOrNull(Object o1,
 Object o2)

bothEqualOrNull.

Parameters:

o1 - a Object object.

o2 - a Object object.

Returns:

a boolean.

bothEqualOrBlank

public boolean bothEqualOrBlank(String o1,
 String o2)

bothEqualOrBlank.

Parameters:

o1 - a String object.

o2 - a String object.

Returns:

a boolean.

getUrl

public String getUrl()
              throws PresentationException,
IndexUnreachableException

Returns the image view URL for this bookmark. If this is the first call, the url is constructed first.

Returns:

The URL as string.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getRepresentativeImageUrl

public String getRepresentativeImageUrl()
                                 throws PresentationException,
IndexUnreachableException,
ViewerConfigurationException,
DAOException

Returns the URL to the representative image thumbnail for the record represented by this item.

Returns:

a String object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

ViewerConfigurationException - if any.

DAOException - if any.

getRepresentativeImageUrl

public String getRepresentativeImageUrl(int width,
 int height)
                                 throws PresentationException,
IndexUnreachableException,
ViewerConfigurationException,
DAOException

Returns the URL to the representative image thumbnail for the record represented by this item.

Parameters:

width - a int.

height - a int.

Returns:

a String object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

ViewerConfigurationException - if any.

DAOException - if any.

getDocumentTitle

public String getDocumentTitle()
                        throws IndexUnreachableException,
PresentationException

Retrieves the documents title from the Solr index using the stored pi and - if nonempty - the logId

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

getId

public Long getId()

Getter for the field id.

Returns:

the id

setId

public void setId(Long id)

Setter for the field id.

Parameters:

id - the id to set

getBookmarkList

public BookmarkList getBookmarkList()

Getter for the field bookmarkList.

Returns:

the bookmarkList

setBookmarkList

public void setBookmarkList(BookmarkList bookmarkList)

Setter for the field bookmarkList.

Parameters:

bookmarkList - the bookmarkList to set

getPi

public String getPi()

Getter for the field pi.

Returns:

the pi

setPi

public void setPi(String pi)

Setter for the field pi.

Parameters:

pi - the pi to set

getLogId

public String getLogId()

Getter for the field logId.

Returns:

the logId

setLogId

public void setLogId(String logId)

Setter for the field logId.

Parameters:

logId - the logId to set

getUrn

public String getUrn()

Getter for the field urn.

Returns:

the urn

setUrn

public void setUrn(String urn)

Setter for the field urn.

Parameters:

urn - the urn to set

getName

public String getName()

Getter for the field name.

Returns:

the name

setName

public void setName(String name)

Setter for the field name.

Parameters:

name - the name to set

getDescription

public String getDescription()

Getter for the field description.

Returns:

the description

setDescription

public void setDescription(String description)

Setter for the field description.

Parameters:

description - the description to set

getDateAdded

public LocalDateTime getDateAdded()

Getter for the field dateAdded.

Returns:

the dateAdded

setDateAdded

public void setDateAdded(LocalDateTime dateAdded)

Setter for the field dateAdded.

Parameters:

dateAdded - the dateAdded to set

getOrder

public Integer getOrder()

Getter for the field order.

Returns:

the order

setOrder

public void setOrder(Integer order)

Setter for the field order.

Parameters:

order - the order to set

getMetadataElement

public MetadataElement getMetadataElement()
                                   throws IndexUnreachableException

Throws:

IndexUnreachableException

getSolrQueryForDocument

public String getSolrQueryForDocument()

0

Returns:

Generated Solr query

getBrowseElement

public BrowseElement getBrowseElement()
                               throws IndexUnreachableException

Throws:

IndexUnreachableException

isHasImages

public boolean isHasImages()