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

Class CMSContent

java.lang.Object
io.goobi.viewer.model.cms.pages.content.CMSContent
Direct Known Subclasses:
CMSAdvancedSearchContent, CMSArchiveContent, CMSBrowseContent, CMSCollectionContent, CMSGeomapContent, CMSImageListContent, CMSMediaContent, CMSMediumTextContent, CMSMetadataContent, CMSPageListContent, CMSRecordListContent, CMSRSSContent, CMSSearchContent, CMSSearchFacetsContent, CMSShortTextContent, CMSSliderContent
@Entity public abstract class CMSContent extends Object
Interface for all classes containing a specific kind of content for a CMSPage. Each CMSContent on a CMSPage is wrapped in a CMSContentItem which itself is contained in a CMSComponent.
Author:
Florian Alpers

  • Constructor Details

    • CMSContent

      protected CMSContent()

    • CMSContent

      protected CMSContent(CMSContent orig)

  • Method Details

    • getBackendComponentName

      public abstract String getBackendComponentName()

    • getBackendComponentLibrary

      public String getBackendComponentLibrary()

    • getItemId

      public String getItemId()

    • setItemId

      public void setItemId(String itemId)

    • getOwningComponent

      public PersistentCMSComponent getOwningComponent()

    • setOwningComponent

      public void setOwningComponent(PersistentCMSComponent owningComponent)

    • getOwningPage

      public CMSPage getOwningPage()

    • copy

      public abstract CMSContent copy()

    • exportHtmlFragment

      public abstract List<File> exportHtmlFragment(String outputFolderPath, String namingScheme) throws IOException, ViewerConfigurationException
      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.
      Parameters:
      outputFolderPath - filesystem path to the export output folder
      namingScheme - base filename scheme for exported files
      Returns:
      Exported Files
      Throws:
      IOException - if any.
      ViewerConfigurationException

    • handlePageLoad

      public abstract String handlePageLoad(boolean resetResults, CMSComponent component) throws PresentationException
      Method to call when loading a CMSPage including this content item.
      Parameters:
      resetResults - if true, any cached results should be discarded and reloaded
      component - the enclosing CMS component triggering the page load
      Returns:
      a JSF action response
      Throws:
      PresentationException

    • isEmpty

      public abstract boolean isEmpty()

    • getId

      public Long getId()

    • setId

      public void setId(Long id)
      Parameters:
      id - the database id to set

    • getData

      public abstract String getData(Integer width, Integer height)
      Parameters:
      width - optional target width in pixels
      height - optional target height in pixels
      Returns:
      a string representing this contentItem for use in frontend-components. May be an empty string for content with no clear String representation

    • getData

      public String getData()

    • isRequired

      public boolean isRequired()

    • setRequired

      public void setRequired(boolean required)
      Parameters:
      required - true if this content item must not be empty