Package io.goobi.viewer.managedbeans

Class HighlightsBean

java.lang.Object

io.goobi.viewer.managedbeans.HighlightsBean

All Implemented Interfaces:

Serializable

@Named
@SessionScoped
public class HighlightsBean
extends Object
implements Serializable

Managed bean handling Highlight objects

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HighlightsBean.EditStatus	Status of editing the selected highlight in the administration backend

Constructor Summary

Constructors

Constructor	Description
HighlightsBean()	Empty defaul constructor.
HighlightsBean(IDAO dao, NavigationHelper navigationHelper, ImageDeliveryBean imaging)	Testing constructor explicitly initializing required properties

Method Summary

Modifier and Type	Method	Description
void	deleteObject(Highlight object)	Delete a Highlight
TableDataProvider<Highlight>	getAllObjectsProvider()	Get a TableDataProvider to all saved highlights
Highlight	getCurrentHighlight()	Get the currently displayed highlight.
List<Highlight>	getCurrentObjects()	Get all objected contained in getCurrentObjectsProvider()
TableDataProvider<Highlight>	getCurrentObjectsProvider()	Get a TableDataProvider to all current highlights.
HighlightsBean.EditStatus	getEditStatus()	Get the current HighlightsBean.EditStatus
List<Highlight>	getHighlightsBefore(LocalDate date)	Get all Highlights which are not valid for the given date but were before.
MetadataElement	getMetadataElement()	If a Highlight has been selected and it points to a record (rather than a URL), retrieve the metadata for this record
URI	getRecordRepresentativeURI()	Get the URL of a representative image for the record related to the currently selected highlight if a highlight is selected and it refers to a record.
URI	getRecordRepresentativeURI(int width, int height)	Get the URL of a representative image for the record related to the currently selected highlight if a highlight is selected and it refers to a record.
Highlight	getSelectedObject()	Get the currently selected Highlight
String	getUrl(Highlight object)	Get the URL to the highlighted object.
void	init()	called after initialization to load listing of existing highlights
boolean	isNewObject()	Check if the currently selected highlight has been persisted already
void	saveObject(Highlight object)	Persist the given Highlight to the database
void	setEditStatus(HighlightsBean.EditStatus editStatus)	Set the getEditStatus()
void	setNewSelectedObject()	Create a new Highlight and set as the selected highlight
void	setSelectedObject(Highlight selectedObject)	Set the Highlight selected for editing
void	setSelectedObjectId(long id)	Set the Highlight selected for editing via its database id

Methods inherited from class java.lang.Object

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

Constructor Details

HighlightsBean

public HighlightsBean()

Empty defaul constructor. The required properties are being injected automatically

HighlightsBean

public HighlightsBean(IDAO dao,
 NavigationHelper navigationHelper,
 ImageDeliveryBean imaging)

Testing constructor explicitly initializing required properties

Parameters:

dao - The IDAO in which to store the highlight data

navigationHelper - NavigationHelper to handle URL resolving

imaging - ImageDeliveryBean to handle image URL creation

Method Details

init

@PostConstruct
public void init()

called after initialization to load listing of existing highlights

getAllObjectsProvider

public TableDataProvider<Highlight> getAllObjectsProvider()

Get a TableDataProvider to all saved highlights

Returns:

a TableDataProvider

getCurrentObjectsProvider

public TableDataProvider<Highlight> getCurrentObjectsProvider()

Get a TableDataProvider to all current highlights. That is all highlights which are valid for the current date and set to active

Returns:

a TableDataProvider

getUrl

public String getUrl(Highlight object)

Get the URL to the highlighted object. Either the record page URL of the URL given in highlight creation

Parameters:

object - the highlight object

Returns:

the URL

deleteObject

public void deleteObject(Highlight object)

Delete a Highlight

Parameters:

object -

getSelectedObject

public Highlight getSelectedObject()

Get the currently selected Highlight

Returns:

a Highlight

setSelectedObject

public void setSelectedObject(Highlight selectedObject)

Set the Highlight selected for editing

Parameters:

selectedObject -

setSelectedObjectId

public void setSelectedObjectId(long id)

Set the Highlight selected for editing via its database id

Parameters:

id -

setNewSelectedObject

public void setNewSelectedObject()

Create a new Highlight and set as the selected highlight

isNewObject

public boolean isNewObject()

Check if the currently selected highlight has been persisted already

Returns:

true if getSelectedObject() has no database id and has thus not been persisted yet

saveObject

public void saveObject(Highlight object)
                throws DAOException

Persist the given Highlight to the database

Parameters:

object -

Throws:

DAOException

getMetadataElement

public MetadataElement getMetadataElement()

If a Highlight has been selected and it points to a record (rather than a URL), retrieve the metadata for this record

Returns:

A MetadataElement with metadata for the related record if one exists. Otherwise null

getCurrentHighlight

public Highlight getCurrentHighlight()
                              throws DAOException

Get the currently displayed highlight. This highlight is randomly chosen from all highlights valid for the current day which are set to enabled

Returns:

a Highlight

Throws:

DAOException

getRecordRepresentativeURI

public URI getRecordRepresentativeURI()
                               throws IndexUnreachableException,
PresentationException,
ViewerConfigurationException

Get the URL of a representative image for the record related to the currently selected highlight if a highlight is selected and it refers to a record. Otherwise return null

Returns:

A URL to the record for the selected highlight if one exists. Otherwise null

Throws:

IndexUnreachableException

PresentationException

ViewerConfigurationException

getRecordRepresentativeURI

public URI getRecordRepresentativeURI(int width,
 int height)
                               throws IndexUnreachableException,
PresentationException,
ViewerConfigurationException

Get the URL of a representative image for the record related to the currently selected highlight if a highlight is selected and it refers to a record. Otherwise return null

Parameters:

width - the desired width of the image. Chose '0' for original image width

height - the desired height of the image. Chose '0' for original image height

Returns:

A URL to the record for the selected highlight if one exists. Otherwise null

Throws:

IndexUnreachableException

PresentationException

ViewerConfigurationException

getCurrentObjects

public List<Highlight> getCurrentObjects()

Get all objected contained in getCurrentObjectsProvider()

Returns:

A list of all currently active Highlights

getEditStatus

public HighlightsBean.EditStatus getEditStatus()

Get the current HighlightsBean.EditStatus

Returns:

a HighlightsBean.EditStatus

setEditStatus

public void setEditStatus(HighlightsBean.EditStatus editStatus)

Set the getEditStatus()

Parameters:

editStatus -

getHighlightsBefore

public List<Highlight> getHighlightsBefore(LocalDate date)
                                    throws DAOException

Get all Highlights which are not valid for the given date but were before. Only hightlights with Highlight.isEnabled() true are included

Parameters:

date - the date up to which to return the highlights (exclusively)

Returns:

A list of Highlights

Throws:

DAOException