Package org.ametys.plugins.odfweb.repository

Class OdfPageResolver

java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.plugins.odfweb.repository.OdfPageResolver
All Implemented Interfaces:
LogEnabled, Initializable, Component, Serviceable
public class OdfPageResolver extends AbstractLogEnabled implements Component, Serviceable, Initializable
Resolves an ODF page path from the associated ODF content.

  • Field Details

  • Constructor Details

  • Method Details

    • service

      public void service(ServiceManager serviceManager) throws ServiceException
      Specified by:
      service in interface Serviceable
      Throws:
      ServiceException

    • initialize

      public void initialize() throws Exception
      Specified by:
      initialize in interface Initializable
      Throws:
      Exception

    • getReferencingPages

      public Set<Page> getReferencingPages(ProgramItem programItem)
      Get all referencing pages for this program item, in all sites and all sitemaps
      Parameters:
      programItem - The program item
      Returns:
      the referencing pages

    • getReferencingPages

      public Set<Page> getReferencingPages(ProgramItem programItem, String siteName, String lang)
      Get all referencing pages for this program item
      Parameters:
      programItem - The program item
      siteName - The site name. Can be null to search on all sites
      lang - The sitemap language. Can be null to search on all sitemaps
      Returns:
      the referencing pages

    • getProgramPage

      public ProgramPage getProgramPage(Program program)
      Return the program page
      Parameters:
      program - the program
      Returns:
      the page program or null

    • getProgramPage

      public ProgramPage getProgramPage(Program program, String siteName)
      Return the program page
      Parameters:
      program - the program
      siteName - The current site name. If the no ODF root page is present in this site, the default ODF site will be used instead.
      Returns:
      the page program or null

    • getProgramPage

      public ProgramPage getProgramPage(Page odfRootPage, Program program)
      Return the program page
      Parameters:
      odfRootPage - the odf root page
      program - the program
      Returns:
      the page program or null

    • getSubProgramPage

      public ProgramPage getSubProgramPage(SubProgram subProgram, AbstractProgram parentProgram, String siteName)
      Return the subprogram page
      Parameters:
      subProgram - the subprogram
      parentProgram - The parent program
      siteName - The current site name. If the no ODF root page is present in this site, the default ODF site will be used instead.
      Returns:
      the subprogram page or null

    • getSubProgramPage

      public ProgramPage getSubProgramPage(Page odfRootPage, SubProgram subProgram, AbstractProgram parentAbstractProgram)
      Return the subprogram page
      Parameters:
      odfRootPage - the odf root page
      subProgram - the subprogram
      parentAbstractProgram - The parent program or subprogram
      Returns:
      the subprogram page or null

    • getSubProgramPage

      public ProgramPage getSubProgramPage(Page odfRootPage, SubProgram subProgram, List<String> path, boolean checkHierarchy)
      Returns the subprogram page
      Parameters:
      odfRootPage - the odf root page
      subProgram - the subprogram
      path - a full or partial path of subprogram
      checkHierarchy - set to true to check that the given path is a valid hierarchy
      Returns:
      the subprogram page or null if not found

    • getCoursePage

      public CoursePage getCoursePage(Course course, AbstractProgram parentProgram, String siteName)
      Return the course page
      Parameters:
      course - the course
      parentProgram - the parent program or subprogram. Can be null.
      siteName - The current site name. If the no ODF root page is present in this site, the default ODF site will be used instead.
      Returns:
      the course page or null if not found

    • getCoursePage

      public CoursePage getCoursePage(Page odfRootPage, Course course, AbstractProgram parentAbstractProgram)
      Return the course page
      Parameters:
      odfRootPage - the odf root page
      course - the course
      parentAbstractProgram - the parent program or subprogram. Can be null.
      Returns:
      the course page or null if not found

    • getCoursePage

      public CoursePage getCoursePage(Course course, Course parentCourse, String siteName)
      Return the course page
      Parameters:
      course - the course
      parentCourse - the parent course. Can NOT be null.
      siteName - The current site name. If the no ODF root page is present in this site, the default ODF site will be used instead.
      Returns:
      the course page or null if not found

    • getCoursePage

      public CoursePage getCoursePage(Page odfRootPage, Course course, Course parentCourse)
      Return the course page
      Parameters:
      odfRootPage - the odf root page
      course - the course
      parentCourse - the parent course. Can NOT be null.
      Returns:
      the course page or null if not found

    • getCoursePage

      public CoursePage getCoursePage(Page odfRootPage, Course course, List<String> path)
      Returns the course page in given ODF root page,
      Parameters:
      odfRootPage - the odf root page
      course - the course
      path - a (partial) education path or a (partial) sitemap path. Be careful, assume that the given path correspond to a valid path in ODF root. Use getCoursePage(Page, Course, List, boolean) with true if not sure.
      Returns:
      the course page or null if not found

    • getCoursePage

      public CoursePage getCoursePage(Page odfRootPage, Course course, List<String> path, boolean checkHierarchy)
      Returns the course page in given ODF root page,
      Parameters:
      odfRootPage - the odf root page
      course - the course
      path - a (partial) education path or a (partial) sitemap path
      checkHierarchy - set to true to check that the given path correspond to a valid hierarchy
      Returns:
      the course page or null if not found

    • isProgramPageExist

      public boolean isProgramPageExist(Page odfRootPage, Program program)
      Determines if a program page exists
      Parameters:
      odfRootPage - the ODF root page
      program - the program page
      Returns:
      true if program page existes, false otherwise

    • getOdfRootPage

      public Page getOdfRootPage(String siteName, String language, String catalog)
      Get the ODF root page, either in the given site if it exists, or in the default ODF site.
      Parameters:
      siteName - the desired site name.
      language - the sitemap language to search in.
      catalog - The ODF catalog
      Returns:
      the ODF root page, either in the given site if it exists, or in the default ODF site.

    • getPathInProgram

      public String getPathInProgram(ProgramItem programItem, AbstractProgram parentProgram)
      Get the path in sitemap of a ODF content into a Program or SubProgram
      Be careful, this is the path in sitemap, to get the path of a item into a Program, use ODFHelper.getPathInProgram(java.lang.String, java.lang.String) instead.
      Parameters:
      programItem - The program item
      parentProgram - The parent root (sub)program. Can be null.
      Returns:
      the path in sitemap from the parent program or null if no found ODF path for those program item and parent program

    • getRootProgram

      public Program getRootProgram(Page odfRootPage, ProgramItem programItem, AbstractProgram parentAbstractProgram)
      Returns the first Program ancestor matching an existing ProgramPage in given ODF root page, ensuring that the given parent content 'parentProgram' is in the hierarchy (if not null)
      If 'parentProgram' is null, the first Program ancestor will be returned regardless of parent hierarchy.
      If 'parentProgram' is a SubProgram, the first Program ancestor from this SubProgram will be returned regardless of parent hierarchy
      Parameters:
      odfRootPage - The ODf root page. Cannot be null.
      programItem - a ProgramItem
      parentAbstractProgram - The parent program or subprogram. Can be null.
      Returns:
      the parent Program into this (sub)program that matchs an existing program page, or null if not found

    • getNearestAncestorAbstractPrograms

      public List<AbstractProgram> getNearestAncestorAbstractPrograms(ProgramPart programPart)
      Returns the nearest AbstractProgram ancestors.
      Parameters:
      programPart - a ProgramPart
      Returns:
      the nearest AbstractProgram ancestors containing this program part

    • getNearestAncestorAbstractProgram

      public AbstractProgram getNearestAncestorAbstractProgram(ProgramItem programItem, AbstractProgram parentProgram)
      Returns the nearest AbstractProgram ancestor.
      Parameters:
      programItem - a ProgramItem
      parentProgram - The parent program or subprogram
      Returns:
      the nearest AbstractProgram ancestor into this (sub)program or null if not found

    • getNearestAncestorCourse

      public Course getNearestAncestorCourse(Course course, AbstractProgram parentProgram)
      Returns the nearest Course ancestor.
      Parameters:
      course - a Course
      parentProgram - The parent program or subprogram
      Returns:
      the nearest Course ancestor into this (sub)program or null if not found

    • getProgramPagePath

      public String getProgramPagePath(String siteName, String language, Program program)
      Get the path of a Program page from the Program content.
      Parameters:
      siteName - the site name.
      language - the language.
      program - the program.
      Returns:
      the page path or empty if no page matches

    • getProgramItemPagePath

      public String getProgramItemPagePath(String siteName, String language, ProgramItem programItem, Program parentProgram)
      Get the path of a ProgramItem page into the given Program
      Parameters:
      siteName - the site name
      language - the language
      programItem - the subprogram.
      parentProgram - The parent program
      Returns:
      the page path or empty if no page matches