Package io.goobi.viewer.model.viewer.collections

Class BrowseDcElement

java.lang.Object
io.goobi.viewer.model.viewer.collections.BrowseDcElement
All Implemented Interfaces:
Serializable, Comparable<BrowseDcElement>
Direct Known Subclasses:
HierarchicalBrowseDcElement
public class BrowseDcElement extends Object implements Comparable<BrowseDcElement>, Serializable
Collection tree element.
See Also:

  • Constructor Details

    • BrowseDcElement

      public BrowseDcElement(String name, long number, String field, String sortField, String splittingChar, int displayNumberOfVolumesLevel)

      Constructor for BrowseDcElement.

      Parameters:
      name - a String object.
      number - a long.
      field - a String object.
      sortField - a String object.
      splittingChar -
      displayNumberOfVolumesLevel -

    • BrowseDcElement

      public BrowseDcElement(BrowseDcElement blueprint)

      Constructor for BrowseDcElement.

      Parameters:
      blueprint - a BrowseDcElement object.

  • Method Details

    • compareTo

      public int compareTo(BrowseDcElement o)
      Specified by:
      compareTo in interface Comparable<BrowseDcElement>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • getName

      public String getName()

      Getter for the field name. If the CMSCollection translation is desired, use getLabel() instead.

      Returns:
      the name

    • getField

      public String getField()

    • getLabel

      public String getLabel()

      getLabel.

      Returns:
      CMSCollection translation, if ava ilable; name otherwise

    • getDescription

      public String getDescription()
      Returns the message key for the collection description.
      Returns:
      a String object.

    • getDescription

      public String getDescription(String language)
      Returns the message key for the collection description for the given language.
      Parameters:
      language - Requested language (ISO 639-1)
      Returns:
      String

    • getRepresentant

      public String getRepresentant()
      Returns the message key for the collection representative image url
      Returns:
      a String object.

    • getLuceneName

      public String getLuceneName()

      getLuceneName.

      Returns:
      the name

    • addToNumber

      public void addToNumber(long inNumber)

      addToNumber.

      Parameters:
      inNumber - a long.

    • setHasSubelements

      public void setHasSubelements(boolean hasSubelements)

      Setter for the field hasSubelements.

      Parameters:
      hasSubelements - a boolean.

    • isHasSubelements

      public boolean isHasSubelements()

      isHasSubelements.

      Returns:
      a boolean.

    • isDisplayNumberOfVolumes

      public boolean isDisplayNumberOfVolumes()

      isDisplayNumberOfVolumes.

      Returns:
      a boolean.

    • getNumberOfVolumes

      public long getNumberOfVolumes()

      getNumberOfVolumes.

      Returns:
      number of elements

    • getSingleRecordUrl

      public String getSingleRecordUrl()
      Returns:
      the singleRecordUrl

    • setSingleRecordUrl

      public void setSingleRecordUrl(String singleRecordUrl)
      Parameters:
      singleRecordUrl - the singleRecordUrl to set

    • getLevel

      public int getLevel()

      getLevel.

      Returns:
      a int.

    • getParentName

      public String getParentName()

      getParentName.

      Returns:
      a String object.

    • getSortField

      public String getSortField()

      Getter for the field sortField.

      Returns:
      the sortField

    • setSortField

      public void setSortField(String sortField)

      Setter for the field sortField.

      Parameters:
      sortField - the sortField to set

    • isShowSubElements

      public boolean isShowSubElements()

      isShowSubElements.

      Returns:
      a boolean.

    • setShowSubElements

      public void setShowSubElements(boolean showSubElements)

      Setter for the field showSubElements.

      Parameters:
      showSubElements - a boolean.

    • isShowDescription

      public boolean isShowDescription()

      isShowDescription.

      Returns:
      the showDescription

    • setShowDescription

      public void setShowDescription(boolean showDescription)

      Setter for the field showDescription.

      Parameters:
      showDescription - the showDescription to set

    • getRssUrl

      public String getRssUrl() throws ViewerConfigurationException
      Returns the RSS feed URL for this collection using the JSF context.
      Returns:
      RSS feed URL for this collection
      Throws:
      ViewerConfigurationException - if any.

    • getSolrFilterQuery

      public String getSolrFilterQuery()
      Returns:
      +({field}:{name} {field}:{name}.*) +(ISWORK:* ISANCHOR:*)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setInfo

      public void setInfo(BrowseElementInfo info)

      Setter for the field info.

      Parameters:
      info - the info to set

    • getInfo

      public BrowseElementInfo getInfo()

      Getter for the field info.

      Returns:
      the info

    • hasCMSDescription

      public boolean hasCMSDescription()

      hasCMSDescription.

      Returns:
      a boolean.

    • hasIcon

      public boolean hasIcon()

      hasIcon.

      Returns:
      a boolean.

    • getIcon

      public URI getIcon()

      getIcon.

      Returns:
      a URI object.

    • getFacetValues

      public List<String> getFacetValues()
      Returns:
      the facetValues

    • setFacetValues

      public void setFacetValues(Collection<String> facetValues)
      Parameters:
      facetValues - the facetValues to set