Package io.goobi.viewer.model.archives

Class ArchiveEntry

java.lang.Object

io.goobi.viewer.model.archives.ArchiveEntry

All Implemented Interfaces:

Serializable

public class ArchiveEntry
extends Object
implements Serializable

Single archive tree node.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ArchiveEntry(ArchiveEntry orig, ArchiveEntry parent)
ArchiveEntry(Integer order, Integer hierarchy, org.apache.solr.common.SolrDocument doc)

Method Summary

Modifier and Type	Method	Description
void	addSubEntry(ArchiveEntry other)
boolean	equals(Object obj)
List<String>	getAccessConditions()
List<ArchiveEntry>	getAncestors(boolean includeSelf)	Get the parent node hierarchy of this node, optionally including the node itself The list is sorted with hightest hierarchy level first, so the node itself will always be the last element, if included
List<ArchiveEntry>	getAsFlatList(boolean ignoreDisplayChildren)
String	getAssociatedRecordPi()
String	getDescriptionLevel()
org.apache.solr.common.SolrDocument	getDoc()
Integer	getHierarchyLevel()
String	getId()
String	getLabel()
String	getLogId()
String	getNodeType()
Integer	getOrderNumber()
ArchiveEntry	getParentNode()
ArchiveEntry	getRootNode()
List<ArchiveEntry>	getSearchList()
List<ArchiveEntry>	getSubEntryList()
String	getTopstructPi()
String	getUnitdate()
int	hashCode()
boolean	isAccessAllowed()	Checks whether access to the given node is allowed due to set access conditions.
boolean	isChildrenFound()
boolean	isChildrenLoaded()
boolean	isContainsImage()
boolean	isDisplaySearch()
boolean	isHasChild()
boolean	isHasChildren()
boolean	isImageAccessAllowed()	Checks whether access to the given node is allowed due to set access conditions.
boolean	isSearchHit()
boolean	isValid()
void	markAsFound(boolean keepChildrenVisible)
void	removeSubEntry(ArchiveEntry other)
void	reOrderElements()
void	resetFoundList()
void	setAccessConditions(List<String> accessConditions)
void	setAssociatedRecordPi(String associatedRecordPi)
void	setChildrenFound(boolean childrenFound)
void	setChildrenLoaded(boolean childrenLoaded)
void	setContainsImage(boolean containsImage)
void	setDescriptionLevel(String descriptionLevel)
void	setDisplaySearch(boolean displaySearch)
void	setDisplaySearch(boolean displaySearch, boolean recursive)
void	setHierarchyLevel(Integer hierarchyLevel)
void	setId(String id)
void	setLabel(String label)
void	setLogId(String logId)
void	setNodeType(String nodeType)
void	setOrderNumber(Integer orderNumber)
void	setParentNode(ArchiveEntry parentNode)
void	setSearchHit(boolean searchHit)
void	setSubEntryList(List<ArchiveEntry> subEntryList)
void	setTopstructPi(String topstructPi)
void	setUnitdate(String unitdate)
void	setValid(boolean valid)
void	shiftHierarchy(int offset)
String	toString()
void	updateHierarchy()

Methods inherited from class java.lang.Object

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

Constructor Details

ArchiveEntry

public ArchiveEntry(Integer order,
 Integer hierarchy,
 org.apache.solr.common.SolrDocument doc)

Parameters:

order -

hierarchy -

doc -

ArchiveEntry

public ArchiveEntry(ArchiveEntry orig,
 ArchiveEntry parent)

Parameters:

orig -

parent -

Method Details

addSubEntry

public void addSubEntry(ArchiveEntry other)

removeSubEntry

public void removeSubEntry(ArchiveEntry other)

reOrderElements

public void reOrderElements()

getAsFlatList

public List<ArchiveEntry> getAsFlatList(boolean ignoreDisplayChildren)

Parameters:

ignoreDisplayChildren -

Returns:

List LinkedList containing all nodes

isHasChildren

public boolean isHasChildren()

updateHierarchy

public void updateHierarchy()

markAsFound

public void markAsFound(boolean keepChildrenVisible)

resetFoundList

public void resetFoundList()

getSearchList

public List<ArchiveEntry> getSearchList()

shiftHierarchy

public void shiftHierarchy(int offset)

Parameters:

offset -

getRootNode

public ArchiveEntry getRootNode()

Returns:

Root node

getParentNode

public ArchiveEntry getParentNode()

Returns:

the parentNode

setParentNode

public void setParentNode(ArchiveEntry parentNode)

Parameters:

parentNode - the parentNode to set

getSubEntryList

public List<ArchiveEntry> getSubEntryList()

Returns:

the subEntryList

setSubEntryList

public void setSubEntryList(List<ArchiveEntry> subEntryList)

Parameters:

subEntryList - the subEntryList to set

getOrderNumber

public Integer getOrderNumber()

Returns:

the orderNumber

setOrderNumber

public void setOrderNumber(Integer orderNumber)

Parameters:

orderNumber - the orderNumber to set

getHierarchyLevel

public Integer getHierarchyLevel()

Returns:

the hierarchyLevel

setHierarchyLevel

public void setHierarchyLevel(Integer hierarchyLevel)

Parameters:

hierarchyLevel - the hierarchyLevel to set

getId

public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - the id to set

getLabel

public String getLabel()

Returns:

the label

setLabel

public void setLabel(String label)

Parameters:

label - the label to set

getTopstructPi

public String getTopstructPi()

Returns:

the topstructPi

setTopstructPi

public void setTopstructPi(String topstructPi)

Parameters:

topstructPi - the topstructPi to set

getLogId

public String getLogId()

Returns:

the logId

setLogId

public void setLogId(String logId)

Parameters:

logId - the logId to set

isSearchHit

public boolean isSearchHit()

Returns:

the searchHit

setSearchHit

public void setSearchHit(boolean searchHit)

Parameters:

searchHit - the searchHit to set

getNodeType

public String getNodeType()

Returns:

the nodeType

setNodeType

public void setNodeType(String nodeType)

Parameters:

nodeType - the nodeType to set

isDisplaySearch

public boolean isDisplaySearch()

Returns:

the displaySearch

setDisplaySearch

public void setDisplaySearch(boolean displaySearch)

Parameters:

displaySearch - the displaySearch to set

setDisplaySearch

public void setDisplaySearch(boolean displaySearch,
 boolean recursive)

Parameters:

displaySearch -

recursive -

isAccessAllowed

public boolean isAccessAllowed()

Checks whether access to the given node is allowed due to set access conditions.

Returns:

true if access granted; false otherwise

isImageAccessAllowed

public boolean isImageAccessAllowed()

Checks whether access to the given node is allowed due to set access conditions.

Returns:

true if access granted; false otherwise

isValid

public boolean isValid()

Returns:

the valid

setValid

public void setValid(boolean valid)

Parameters:

valid - the valid to set

getDescriptionLevel

public String getDescriptionLevel()

Returns:

the descriptionLevel

setDescriptionLevel

public void setDescriptionLevel(String descriptionLevel)

Parameters:

descriptionLevel - the descriptionLevel to set

getUnitdate

public String getUnitdate()

Returns:

the unitdate

setUnitdate

public void setUnitdate(String unitdate)

getAccessConditions

public List<String> getAccessConditions()

Returns:

the accessConditions

setAccessConditions

public void setAccessConditions(List<String> accessConditions)

Parameters:

accessConditions - the accessConditions to set

isHasChild

public boolean isHasChild()

Returns:

the hasChild

getAssociatedRecordPi

public String getAssociatedRecordPi()

Returns:

the associatedRecordPi

setAssociatedRecordPi

public void setAssociatedRecordPi(String associatedRecordPi)

Parameters:

associatedRecordPi - the associatedRecordPi to set

getAncestors

public List<ArchiveEntry> getAncestors(boolean includeSelf)

Get the parent node hierarchy of this node, optionally including the node itself The list is sorted with hightest hierarchy level first, so the node itself will always be the last element, if included

Parameters:

includeSelf -

Returns:

List

isContainsImage

public boolean isContainsImage()

setContainsImage

public void setContainsImage(boolean containsImage)

getDoc

public org.apache.solr.common.SolrDocument getDoc()

Returns:

the doc

isChildrenFound

public boolean isChildrenFound()

Returns:

the childrenFound

setChildrenFound

public void setChildrenFound(boolean childrenFound)

Parameters:

childrenFound - the childrenFound to set

isChildrenLoaded

public boolean isChildrenLoaded()

Returns:

the childrenLoaded

setChildrenLoaded

public void setChildrenLoaded(boolean childrenLoaded)

Parameters:

childrenLoaded - the childrenLoaded to set

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object