Interface IURLBuilder

All Known Implementing Classes:
DefaultURLBuilder

public interface IURLBuilder
Interface for creating module-specific urls for viewer pages
Author:
Florian Alpers
  • Method Details

    • generateURL

      String generateURL(BrowseElement browseElement)

      generateURL.

      Parameters:
      browseElement - The browseElement for which we want to build a url
      Returns:
      The url the the given BrowseElement should link to
    • buildPageUrl

      String buildPageUrl(String pi, int imageNo, String logId, PageType pageType, boolean topStruct)

      buildPageUrl.

      Parameters:
      pi - The record persistent identifier
      imageNo - the page number (1-based)
      logId - The METS identifier of the logical struct element
      pageType - the type of viewer page the url should open
      topStruct - if false, the url should point to a page or struct element within the record, so imageNo and logId must be considered
      Returns:
      A URL to the object in the view given by pageType
    • buildPageUrl

      default String buildPageUrl(String pi, int imageNo, String logId, PageType pageType)
      Parameters:
      pi -
      imageNo -
      logId -
      pageType -
      Returns:
      Generated URL