Package io.goobi.viewer.model.cms

Class Highlight

java.lang.Object

io.goobi.viewer.model.cms.Highlight

All Implemented Interfaces:

CMSMediaHolder, IPolyglott

public class Highlight
extends Object
implements CMSMediaHolder, IPolyglott

Wraps a HighlightData entity to provide a view-layer object for a highlighted content item, including thumbnail generation, metadata loading, and multilingual label support.

Constructor Summary

Constructors

Constructor	Description
Highlight(HighlightData data)
Highlight(HighlightData data, ThumbnailHandler thumbs, Configuration config)

Method Summary

Modifier and Type	Method	Description
HighlightData	getData()
URI	getImageURI()
URI	getImageURI(int width, int height)	Gets the URI to the image representing the object.
String	getMediaFilter()	A regular expression determining which filenames are shown in the media list and may be uploaded.
CMSMediaItem	getMediaItem()	getMediaItem.
CategorizableTranslatedSelectable<CMSMediaItem>	getMediaItemWrapper()	getMediaItemWrapper.
String	getMediaTypes()	A string representing the allowed media formates for a user.
MetadataElement	getMetadataElement()
List<Metadata>	getMetadataForField(String field, Locale locale)
List<Metadata>	getMetadataList()
List<Metadata>	getMetadataList(Locale locale)
Locale	getSelectedLocale()
boolean	hasImageURI()	Checks whether an image is set for this object.
boolean	hasMediaItem()	hasMediaItem.
boolean	isComplete(Locale locale)	If this returns true, an associated language tab should have the 'already-translated' class, otherwise the '-partly-translated' class unless IPolyglott.isEmpty(Locale) also returns true.
boolean	isCurrent()	Check if the object is active now.
boolean	isCurrent(LocalDateTime date)	Checks if the object is active at the given date.
boolean	isEmpty(Locale locale)	If this returns true, an associated language tab should have neither the 'already-translated' nor the '-partly-translated' class.
boolean	isEnabled()	Checks if this object may be active at all.
boolean	isFuture()	Check if this object is not currently active but will be active in the future.
boolean	isFuture(LocalDateTime date)	Check if this object is not currently active but will be active in the future of the given date.
boolean	isPast()	Check if this object is no longer active.
boolean	isPast(LocalDateTime date)	Check if this object was only active before the given date.
boolean	isPresent()	alias for isCurrent().
boolean	isValid(Locale locale)	Only meaningful for the default language for which all required fields must be filled.
void	setMediaItem(CMSMediaItem item)	setMediaItem.
void	setSelectedLocale(Locale locale)	Sets the locale to use for display and editing.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.goobi.viewer.model.translations.IPolyglott

getLocales, isDefaultLocaleSelected, isSelected, setSelectedLocale

Constructor Details

Highlight

public Highlight(HighlightData data,
 ThumbnailHandler thumbs,
 Configuration config)

Highlight

public Highlight(HighlightData data)

Method Details

isComplete

public boolean isComplete(Locale locale)

Description copied from interface: IPolyglott

If this returns true, an associated language tab should have the 'already-translated' class, otherwise the '-partly-translated' class unless IPolyglott.isEmpty(Locale) also returns true.

Specified by:

isComplete in interface IPolyglott

Parameters:

locale - the locale to check translation completeness for

Returns:

true if IPolyglott.isValid(Locale) returns true for the given locale and all fields contain a value which have a value in the default locale. For the default locale, IPolyglott.isComplete(Locale) and IPolyglott.isValid(Locale) are identical. For implementations with only one field, both methods are also always identical

isValid

public boolean isValid(Locale locale)

Description copied from interface: IPolyglott

Only meaningful for the default language for which all required fields must be filled.

Specified by:

isValid in interface IPolyglott

Parameters:

locale - the locale to validate required fields for

Returns:

true if all required fields contain a value in the given locale

isEmpty

public boolean isEmpty(Locale locale)

Description copied from interface: IPolyglott

If this returns true, an associated language tab should have neither the 'already-translated' nor the '-partly-translated' class.

Specified by:

isEmpty in interface IPolyglott

Parameters:

locale - the locale to check for empty fields

Returns:

true if no fields are filled for the given locale

getSelectedLocale

public Locale getSelectedLocale()

Specified by:

getSelectedLocale in interface IPolyglott

Returns:

the locale currently set by IPolyglott.setSelectedLocale(Locale)

setSelectedLocale

public void setSelectedLocale(Locale locale)

Description copied from interface: IPolyglott

Sets the locale to use for display and editing.

Specified by:

setSelectedLocale in interface IPolyglott

Parameters:

locale - the locale to select

getMediaFilter

public String getMediaFilter()

Description copied from interface: CMSMediaHolder

A regular expression determining which filenames are shown in the media list and may be uploaded.

Specified by:

getMediaFilter in interface CMSMediaHolder

Returns:

the regex pattern used to filter acceptable media filenames for this holder

getMediaTypes

public String getMediaTypes()

Description copied from interface: CMSMediaHolder

A string representing the allowed media formates for a user. Should be a comma separated list of format names or filename suffixes

Specified by:

getMediaTypes in interface CMSMediaHolder

Returns:

String

hasMediaItem

public boolean hasMediaItem()

Description copied from interface: CMSMediaHolder

hasMediaItem.

Specified by:

hasMediaItem in interface CMSMediaHolder

Returns:

true if this holder has an associated CMS media item, false otherwise

getMediaItem

public CMSMediaItem getMediaItem()

Description copied from interface: CMSMediaHolder

getMediaItem.

Specified by:

getMediaItem in interface CMSMediaHolder

Returns:

the associated CMS media item, or null if none is set

setMediaItem

public void setMediaItem(CMSMediaItem item)

Description copied from interface: CMSMediaHolder

setMediaItem.

Specified by:

setMediaItem in interface CMSMediaHolder

Parameters:

item - a CMSMediaItem object.

getMediaItemWrapper

public CategorizableTranslatedSelectable<CMSMediaItem> getMediaItemWrapper()

Description copied from interface: CMSMediaHolder

getMediaItemWrapper.

Specified by:

getMediaItemWrapper in interface CMSMediaHolder

Returns:

the CMS media item wrapped with category and selection state information

getData

public HighlightData getData()

hasImageURI

public boolean hasImageURI()

Checks whether an image is set for this object.

Returns:

true if the image is taken from the record identifier or if it is taken from a media item and the media item is set

getImageURI

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

Gets the URI to the image representing the object.

Parameters:

width - desired image width in pixels

height - desired image height in pixels

Returns:

true if hasImageURI() returns true and, if the image is taken from the record identifier, the record identifier points to a records which has a representative image

Throws:

IndexUnreachableException

PresentationException

ViewerConfigurationException

getImageURI

public URI getImageURI()
                throws IndexUnreachableException,
PresentationException,
ViewerConfigurationException

Throws:

IndexUnreachableException

PresentationException

ViewerConfigurationException

isPresent

public boolean isPresent()

alias for isCurrent().

Returns:

true if startTime is before now (or null) and endTime is after now (or null)

isCurrent

public boolean isCurrent()

Check if the object is active now. Mutually exclusive with isPast() and isFuture()

Returns:

true if startTime is before now (or null) and endTime is after now (or null)

isCurrent

public boolean isCurrent(LocalDateTime date)

Checks if the object is active at the given date.

Parameters:

date - the point in time to check activity against

Returns:

true if startTime is before now (or null) and endTime is after now (or null)

isPast

public boolean isPast()

Check if this object is no longer active. Mutually exclusive with isCurrent() and isFuture()

Returns:

true if timeEnd is not null and before now

isPast

public boolean isPast(LocalDateTime date)

Check if this object was only active before the given date.

Parameters:

date - the point in time to evaluate past status against

Returns:

true if timeEnd is not null and before now

isFuture

public boolean isFuture()

Check if this object is not currently active but will be active in the future. Mutually exclusive with isCurrent() and isPast()

Returns:

true if startTime is not null and after now and timeEnd is either null or after now

isFuture

public boolean isFuture(LocalDateTime date)

Check if this object is not currently active but will be active in the future of the given date.

Parameters:

date - the point in time to evaluate future status against

Returns:

true if startTime is not null and after now and timeEnd is either null or after now

isEnabled

public boolean isEnabled()

Checks if this object may be active at all.

Returns:

true if data enabled; false otherwise

toString

public String toString()

Overrides:

toString in class Object

getMetadataList

public List<Metadata> getMetadataList()

getMetadataList

public List<Metadata> getMetadataList(Locale locale)
                               throws IndexUnreachableException,
PresentationException

Parameters:

locale - locale for which to retrieve the metadata list

Returns:

List

Throws:

IndexUnreachableException

PresentationException

getMetadataForField

public List<Metadata> getMetadataForField(String field,
 Locale locale)
                                   throws IndexUnreachableException,
PresentationException

Parameters:

field - Solr field name to filter metadata entries by

locale - locale used for language-specific field suffixes and metadata retrieval

Returns:

List

Throws:

IndexUnreachableException

PresentationException

getMetadataElement

public MetadataElement getMetadataElement()
                                   throws IndexUnreachableException,
PresentationException

Throws:

IndexUnreachableException

PresentationException