Package io.goobi.viewer.model.archives

Class ArchiveTree

java.lang.Object
io.goobi.viewer.model.archives.ArchiveTree
All Implemented Interfaces:
Serializable
public class ArchiveTree extends Object implements Serializable
Table of contents and associated functionality for a record. Instances can be either the default archive or a session-local copy.
See Also:

  • Field Details

  • Constructor Details

    • ArchiveTree

      public ArchiveTree()

      Constructor for TOC.

    • ArchiveTree

      public ArchiveTree(ArchiveTree orig)

  • Method Details

    • update

      public void update(ArchiveEntry rootElement)
      Parameters:
      rootElement -

    • generate

      public void generate(ArchiveEntry root)
      Sets the given root entry, generates a new flat list and adds it to entryMap.
      Parameters:
      root - The root entry to set

    • getViewForGroup

      public List<ArchiveEntry> getViewForGroup(String group)

      getViewForGroup.

      Parameters:
      group - a String object.
      Returns:
      a List object.

    • getTreeViewForGroup

      public List<ArchiveEntry> getTreeViewForGroup(String group)

      getTreeViewForGroup.

      Parameters:
      group - a String object.
      Returns:
      a List object.

    • getFlatView

      public List<ArchiveEntry> getFlatView()

      getFlatView.

      Returns:
      a List object.

    • getTreeView

      public List<ArchiveEntry> getTreeView()

      getTreeView.

      Returns:
      a List object.

    • getVisibleTree

      public List<ArchiveEntry> getVisibleTree(boolean searchActive)
      Parameters:
      searchActive -
      Returns:
      List

    • resetCollapseLevel

      public void resetCollapseLevel(ArchiveEntry entry, int maxDepth)
      Recursively expands and sets visible entries at or below maxDepth; hides and collapses any below.
      Parameters:
      entry -
      maxDepth -

    • getSelectedEntry

      public ArchiveEntry getSelectedEntry()
      Returns:
      the selectedEntry

    • setSelectedEntry

      public void setSelectedEntry(ArchiveEntry selectedEntry)
      Parameters:
      selectedEntry - the selectedEntry to set

    • isExpandEntryOnSelection

      public boolean isExpandEntryOnSelection()

    • toggleSelectedEntry

      public void toggleSelectedEntry(ArchiveEntry selectedEntry)
      Parameters:
      selectedEntry -

    • getTrueRootElement

      public ArchiveEntry getTrueRootElement()
      Returns:
      the trueRootElement

    • setTrueRootElement

      public void setTrueRootElement(ArchiveEntry trueRootElement)
      Parameters:
      trueRootElement - the trueRootElement to set

    • getRootElement

      public ArchiveEntry getRootElement()
      Returns:
      Root element for the default group

    • getRootElement

      public ArchiveEntry getRootElement(String group)
      Parameters:
      group -
      Returns:
      Root element for the given group

    • expandAll

      public void expandAll()

      expandAll.

    • collapseAll

      public void collapseAll()

      collapseAll.

    • collapseAll

      public void collapseAll(boolean collapseAllEntries)
      Parameters:
      collapseAllEntries - If true, all invisible child children will also be collapsed

    • getTocElements

      public List<ArchiveEntry> getTocElements()

      getTocElements.

      Returns:
      a List object.

    • getFlatEntryList

      public List<ArchiveEntry> getFlatEntryList()
      Get the hierarchical tree as a flat list
      Returns:
      List

    • getEntryById

      public ArchiveEntry getEntryById(String identifier)
      Parameters:
      identifier -
      Returns:
      the ArchiveEntry with the given identifier if it exists in the tree; null otherwise

    • search

      public void search(String searchValue)
      Parameters:
      searchValue -

    • resetSearch

      public void resetSearch()

    • isTreeFullyLoaded

      public boolean isTreeFullyLoaded()

    • isEntryVisible

      public boolean isEntryVisible(ArchiveEntry entry)
      Parameters:
      entry -
      Returns:
      true if given entry is currently visible; false otherwise

    • isEntryExpanded

      public boolean isEntryExpanded(ArchiveEntry entry)
      Parameters:
      entry -
      Returns:
      true if given entry is currently expanded; false otherwise

    • expandEntry

      public void expandEntry(ArchiveEntry entry)
      Expands this entry and sets all sub-entries visible if their immediate parent is expanded.
      Parameters:
      entry -

    • collapseEntry

      public void collapseEntry(ArchiveEntry entry)
      Collapses this entry and hides all sub-entries.
      Parameters:
      entry -

    • expandUpEntry

      public void expandUpEntry(ArchiveEntry entry)
      Expands and sets visible all ancestors of this node and expands siblings of this node.
      Parameters:
      entry -