Package org.opengrok.web

Class ProjectHelper

java.lang.Object
org.opengrok.web.ProjectHelper
public final class ProjectHelper extends Object
Preprocessing of projects, repositories and groups for the UI.
Author:
Krystof Tulinger

  • Method Details

    • getInstance

      public static ProjectHelper getInstance(PageConfig cfg)
      Object of project helper should be ONLY obtained by calling PageConfig#getProjectHelper.
      Parameters:
      cfg - current page config
      Returns:
      instance of ProjectHelper
      See Also:

    • getRepositoryInfo

      public List<RepositoryInfo> getRepositoryInfo(Project p)
      Get repository info list for particular project. A copy of the list is returned always to allow concurrent modifications of the list in the caller. The items in the list shall not be modified concurrently, though.
      Parameters:
      p - the project for which we find the repository info list
      Returns:
      Copy of a list of repository info or empty list if no info is found

    • getSortedRepositoryInfo

      public List<RepositoryInfo> getSortedRepositoryInfo(Project p)
      Get repository info list for particular project. A copy of the list is returned always to allow concurrent modifications of the list in the caller. The items in the list shall not be modified concurrently, though. This list is sorted with respect REPOSITORY_NAME_COMPARATOR.
      Parameters:
      p - the project for which we find the repository info list
      Returns:
      Copy of a list of repository info or empty list if no info is found

    • getGroups

      public Set<Group> getGroups()
      Returns:
      filtered groups

    • getProjects

      public Set<Project> getProjects()
      Returns:
      filtered ungrouped projects

    • getRepositories

      public Set<Project> getRepositories()
      Returns:
      filtered ungrouped repositories

    • getProjects

      public Set<Project> getProjects(Group g)
      Parameters:
      g - group
      Returns:
      filtered group's projects

    • getRepositories

      public Set<Project> getRepositories(Group g)
      Parameters:
      g - group
      Returns:
      filtered group's repositories

    • getGroupedProjects

      public Set<Project> getGroupedProjects()
      Returns:
      filtered grouped projects

    • getGroupedRepositories

      public Set<Project> getGroupedRepositories()
      Returns:
      filtered grouped repositories

    • getUngroupedProjects

      public Set<Project> getUngroupedProjects()
      Returns:
      filtered ungrouped projects
      See Also:

    • getUngroupedRepositories

      public Set<Project> getUngroupedRepositories()
      Returns:
      filtered ungrouped projects
      See Also:

    • getAllGrouped

      public Set<Project> getAllGrouped()
      Returns:
      filtered projects and repositories

    • getAllGrouped

      public Set<Project> getAllGrouped(Group g)
      Parameters:
      g - group
      Returns:
      filtered set of all projects and repositories in group g

    • getAllUngrouped

      public Set<Project> getAllUngrouped()
      Returns:
      filtered set of all projects and repositories without group

    • getAllProjects

      public Set<Project> getAllProjects()
      Returns:
      filtered set of all projects and repositories no matter if grouped or ungrouped

    • getSubgroups

      public Set<Group> getSubgroups(Group g)
      Parameters:
      g - group
      Returns:
      filtered set of subgroups

    • hasAllowedSubgroup

      public boolean hasAllowedSubgroup(Group group)
      Checks if given group contains a subgroup which is allowed by the AuthorizationFramework. This should be used for deciding if this group should be written in the group hierarchy in the resulting html because it contains other allowed groups.
      Parameters:
      group - group
      Returns:
      true it it has an allowed subgroup

    • hasFavourite

      public boolean hasFavourite(Group group)
      Checks if given group contains a favourite project. Favourite project is a project which is contained in the OpenGrokProject cookie, i. e. it has been searched or viewed by the user. This should by used to determine if this group should be displayed expanded or rolled up.
      Parameters:
      group - group
      Returns:
      true if it has favourite project

    • isFavourite

      public boolean isFavourite(Project project)
      Checks if the project is a favourite project.
      Parameters:
      project - project
      Returns:
      true if it is favourite

    • hasUngroupedFavourite

      public boolean hasUngroupedFavourite()
      Checks if there is a favourite project in ungrouped projects. This should by used to determine if this 'other' section should be displayed expanded or rolled up.
      Returns:
      true if there is

    • cleanup

      public static void cleanup(PageConfig cfg)