Package io.goobi.viewer.model.toc

Class TOCElement

java.lang.Object

io.goobi.viewer.model.toc.TOCElement

All Implemented Interfaces:

Serializable

public class TOCElement
extends Object
implements Serializable

Single TOC entry.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TOCElement(de.intranda.metadata.multilanguage.IMetadataValue label, String pageNo, String pageNoLabel, String iddoc, String logId, int level, String topStructPi, String thumbnailUrl, boolean accessPermissionPdf, boolean anchorOrGroup, boolean hasImages, String recordMimeType, String docStructType, String footerId)	Constructor for TOCElement.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getContentServerPdfUrl()	getContentServerPdfUrl.
String	getFullscreenUrl()	getFullscreenUrl.
List<String>	getGroupIds()	Getter for the field groupIds.
int	getID()	getID.
String	getIddoc()	Getter for the field iddoc.
String	getLabel()	Getter for the field label.
String	getLabel(String locale)	Getter for the field label.
String	getLabel(Locale locale)	Getter for the field label.
int	getLevel()	Getter for the field level.
String	getLogId()	gibt die logID aus der Mets Datei zurück
Map<String,String>	getMetadata()	Getter for the field metadata.
String	getMetadataValue(String key)	getMetadataValue.
String	getPageNo()	Getter for the field pageNo.
String	getPageNoLabel()	Getter for the field pageNoLabel.
int	getParentId()	Getter for the field parentId.
String	getReadingModeUrl()	Deprecated. renamed to fullscreen
String	getRecordMimeType()	Getter for the field recordMimeType.
String	getSubLabel()	Deprecated.
String	getThumbnailUrl()	Getter for the field thumbnailUrl.
String	getThumbnailUrl(int width, int height)	Getter for the field thumbnailUrl.
String	getTopStructPi()	Getter for the field topStructPi.
String	getUrl()	getUrl.
String	getUrl(String viewType)	Returns the URL for this element that links to the requested view type.
int	hashCode()
boolean	isAccessPermissionPdf()	Checks whether the current user has permissions to download a PDFs for this element.
boolean	isEmpty()	isEmpty.
boolean	isExpanded()	isExpanded.
boolean	isHasChild()	isHasChild.
boolean	isVisible()	isVisible.
void	setExpanded(boolean expanded)	Setter for the field expanded.
void	setGroupIds(List<String> groupIds)	Setter for the field groupIds.
void	setHasChild(boolean hasChild)	Setter for the field hasChild.
void	setID(int iD)	setID.
void	setParentId(int parentId)	Setter for the field parentId.
void	setVisible(boolean visible)	Setter for the field visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

TOCElement

public TOCElement(de.intranda.metadata.multilanguage.IMetadataValue label,
                  String pageNo,
                  String pageNoLabel,
                  String iddoc,
                  String logId,
                  int level,
                  String topStructPi,
                  String thumbnailUrl,
                  boolean accessPermissionPdf,
                  boolean anchorOrGroup,
                  boolean hasImages,
                  String recordMimeType,
                  String docStructType,
                  String footerId)

Constructor for TOCElement.

Parameters:

label - a IMetadataValue object.

pageNo - a String object.

pageNoLabel - a String object.

iddoc - a String object.

logId - a String object.

level - a int.

topStructPi - a String object.

thumbnailUrl - a String object.

accessPermissionPdf - a boolean.

anchorOrGroup - a boolean.

hasImages - a boolean.

recordMimeType - a String object.

docStructType - a String object.

footerId - a String object.

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getContentServerPdfUrl

public String getContentServerPdfUrl()
                              throws ViewerConfigurationException

getContentServerPdfUrl.

Returns:

String

Throws:

ViewerConfigurationException - if any.

isAccessPermissionPdf

public boolean isAccessPermissionPdf()

Checks whether the current user has permissions to download a PDFs for this element.

Returns:

a boolean.

getThumbnailUrl

public String getThumbnailUrl()

Getter for the field thumbnailUrl.

Returns:

a String object.

getThumbnailUrl

public String getThumbnailUrl(int width,
                              int height)

Getter for the field thumbnailUrl.

Parameters:

width - a int.

height - a int.

Returns:

a String object.

getLabel

public String getLabel()

Getter for the field label.

Returns:

the label

getLabel

public String getLabel(Locale locale)

Getter for the field label.

Parameters:

locale - a Locale object.

Returns:

the label

getLabel

public String getLabel(String locale)

Getter for the field label.

Parameters:

locale - a String object.

Returns:

the label

getMetadata

public Map<String,String> getMetadata()

Getter for the field metadata.

Returns:

the metadata

getMetadataValue

public String getMetadataValue(String key)

getMetadataValue.

Parameters:

key - a String object.

Returns:

a String object.

getPageNo

public String getPageNo()

Getter for the field pageNo.

Returns:

the pageNo

getIddoc

public String getIddoc()

Getter for the field iddoc.

Returns:

the iddoc

getPageNoLabel

public String getPageNoLabel()

Getter for the field pageNoLabel.

Returns:

the pageNoLabel

getTopStructPi

public String getTopStructPi()

Getter for the field topStructPi.

Returns:

the topStructPi

getLogId

public String getLogId()

gibt die logID aus der Mets Datei zurück

Returns:

the logID

getLevel

public int getLevel()

Getter for the field level.

Returns:

a int.

getSubLabel

@Deprecated
public String getSubLabel()

Deprecated.

getSubLabel.

Returns:

the subLabel

getUrl

public String getUrl()

getUrl.

Returns:

a String object.

getUrl

public String getUrl(String viewType)

Returns the URL for this element that links to the requested view type.

Parameters:

viewType - a String object.

Returns:

a String object.

getFullscreenUrl

public String getFullscreenUrl()

getFullscreenUrl.

Returns:

the fullscreenUrl

getReadingModeUrl

@Deprecated
public String getReadingModeUrl()

Deprecated.

renamed to fullscreen

getReadingModeUrl.

Returns:

the fullscreenUrl

isVisible

public boolean isVisible()

isVisible.

Returns:

a boolean.

setVisible

public void setVisible(boolean visible)

Setter for the field visible.

Parameters:

visible - a boolean.

getParentId

public int getParentId()

Getter for the field parentId.

Returns:

a int.

setParentId

public void setParentId(int parentId)

Setter for the field parentId.

Parameters:

parentId - a int.

getID

public int getID()

getID.

Returns:

a int.

setID

public void setID(int iD)

setID.

Parameters:

iD - a int.

isExpanded

public boolean isExpanded()

isExpanded.

Returns:

a boolean.

setExpanded

public void setExpanded(boolean expanded)

Setter for the field expanded.

Parameters:

expanded - a boolean.

isHasChild

public boolean isHasChild()

isHasChild.

Returns:

a boolean.

setHasChild

public void setHasChild(boolean hasChild)

Setter for the field hasChild.

Parameters:

hasChild - a boolean.

getGroupIds

public List<String> getGroupIds()

Getter for the field groupIds.

Returns:

the groupIds

setGroupIds

public void setGroupIds(List<String> groupIds)

Setter for the field groupIds.

Parameters:

groupIds - the groupIds to set

getRecordMimeType

public String getRecordMimeType()

Getter for the field recordMimeType.

Returns:

the recordMimeType

isEmpty

public boolean isEmpty()

isEmpty.

Returns:

true if label is null, empty or blank