Package io.goobi.viewer.model.cms.pages.content.types

Class CMSCollectionContent

java.lang.Object
io.goobi.viewer.model.cms.pages.content.CMSContent
io.goobi.viewer.model.cms.pages.content.types.CMSCollectionContent
@Entity public class CMSCollectionContent extends CMSContent

  • Constructor Details

    • CMSCollectionContent

      public CMSCollectionContent()

  • Method Details

    • getSolrField

      public String getSolrField()

    • setSolrField

      public void setSolrField(String solrField)

    • getCollectionName

      public String getCollectionName()

    • setCollectionName

      public void setCollectionName(String collectionName)

    • getFilterQuery

      public String getFilterQuery()

    • setFilterQuery

      public void setFilterQuery(String filterQuery)

    • getSorting

      public Sorting getSorting()

    • setSorting

      public void setSorting(Sorting sorting)

    • getGroupingField

      public String getGroupingField()

    • setGroupingField

      public void setGroupingField(String groupingSolrField)

    • getIgnoreCollections

      public String getIgnoreCollections()

    • setIgnoreCollections

      public void setIgnoreCollections(String ignoreCollections)

    • isOpenExpanded

      public boolean isOpenExpanded()

    • setOpenExpanded

      public void setOpenExpanded(boolean openExpanded)

    • getIgnoreCollectionsAsList

      public List<String> getIgnoreCollectionsAsList()

      getIgnoreCollectionsAsList.

      Returns:
      a List object.

    • getIgnoreCollectionsAsJsonArray

      public String getIgnoreCollectionsAsJsonArray()

    • setIgnoreCollectionsAsList

      public void setIgnoreCollectionsAsList(List<String> toIgnore)

      setIgnoreCollectionsAsList.

      Parameters:
      toIgnore - a List object.

    • getBackendComponentName

      public String getBackendComponentName()
      Specified by:
      getBackendComponentName in class CMSContent

    • copy

      public CMSContent copy()
      Specified by:
      copy in class CMSContent

    • exportHtmlFragment

      public List<File> exportHtmlFragment(String outputFolderPath, String namingScheme) throws IOException, ViewerConfigurationException
      Description copied from class: CMSContent
      Writes HTML fragment value as file for re-indexing. HTML/text fragments are exported directly. Attached media items are exported as long as their content type is one of the supported text document formats.
      Specified by:
      exportHtmlFragment in class CMSContent
      Parameters:
      outputFolderPath - a String object.
      namingScheme - a String object.
      Returns:
      Exported Files
      Throws:
      IOException - if any.
      ViewerConfigurationException

    • handlePageLoad

      public String handlePageLoad(boolean resetResults, CMSComponent component)
      call CollectionView#reset(true) on the CollectionView stored in the cmsBean for this item, if any
      Specified by:
      handlePageLoad in class CMSContent
      Parameters:
      resetResults -
      component -
      Returns:
      String

    • getCombinedFilterQuery

      public String getCombinedFilterQuery()
      Returns:
      String

    • getPossibleBaseCollectionList

      public List<String> getPossibleBaseCollectionList() throws IndexUnreachableException
      Queries Solr for a list of all values of the set collectionField which my serve as a collection.
      Returns:
      a List object.
      Throws:
      IndexUnreachableException - if any.

    • getColletionMap

      public Map<String,CollectionResult> getColletionMap() throws IndexUnreachableException
      Returns:
      Map<String, CollectionResult>
      Throws:
      IndexUnreachableException

    • getBaseCollection

      public String getBaseCollection()
      Alias for getCollectionName(). Used in legacy templates
      Returns:
      String

    • getCollectionField

      public String getCollectionField()
      Alias for getSolrField(). Used in legacy templates
      Returns:
      String

    • getGroupBy

      public String getGroupBy()
      Alias for getGroupingField(). Used in legacy templates
      Returns:
      String

    • getData

      public String getData(Integer w, Integer h)
      Specified by:
      getData in class CMSContent
      Returns:
      a string representing this contentItem for use in frontend-components. May be an empty string for content with no clear String representation

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in class CMSContent