Package org.opencms.ade.publish

Class A_CmsPublishGroupHelper<RESOURCE,GROUP>

java.lang.Object
org.opencms.ade.publish.A_CmsPublishGroupHelper<RESOURCE,GROUP>
Type Parameters:
RESOURCE - the resource class type
GROUP - the resource group class type
Direct Known Subclasses:
CmsDefaultPublishGroupHelper, CmsSinglePublishGroupHelper
public abstract class A_CmsPublishGroupHelper<RESOURCE,GROUP> extends Object
Helper class for splitting a publish list into publish groups.

Since:
8.0.0

  • Field Details

  • Constructor Details

    • A_CmsPublishGroupHelper

      public A_CmsPublishGroupHelper(Locale locale)
      Creates a new publish group helper for a given locale.

      Parameters:
      locale - the locale to use

  • Method Details

    • computeDays

      public Map<Long,Integer> computeDays(List<Long> sortedDates)
      Given a descending list of dates represented as longs, this method computes a map from the dates to their age in (local) days.

      Parameters:
      sortedDates - a descending list of dates represented as longs
      Returns:
      a map from dates to ages (measured in days)

    • computeDaysForResources

      public Map<Long,Integer> computeDaysForResources(List<RESOURCE> resources)
      Computes a map from modification date to number of (local) days since the modification date.

      Parameters:
      resources - a list of resources
      Returns:
      a map from modification dates to the number of days since the modification date

    • getDayDifference

      public int getDayDifference(long first, long second)
      Gets the difference in days between to dates given as longs.

      The first date must be later than the second date.

      Parameters:
      first - the first date
      second - the second date
      Returns:
      the difference between the two dates in days

    • getGroups

      public List<GROUP> getGroups(List<RESOURCE> resources)
      Splits a list of resources into groups.

      Parameters:
      resources - the list of resources
      Returns:
      the list of groups

    • getModificationDates

      public List<Long> getModificationDates(List<RESOURCE> resources)
      Given a list of resources, this method returns a list of their modification dates.

      Parameters:
      resources - a list of resources
      Returns:
      the modification dates of the resources, in the same order as the resources

    • getPublishGroupName

      public String getPublishGroupName(List<RESOURCE> resources, A_CmsPublishGroupHelper.GroupAge age)
      Returns the localized name for a given publish group based on its age.

      Parameters:
      resources - the resources of the publish group
      age - the age of the publish group
      Returns:
      the localized name of the publish group

    • getStartOfDay

      public Calendar getStartOfDay(long time)
      Returns a calendar object representing the start of the day in which a given time lies.

      Parameters:
      time - a long representing a time
      Returns:
      a calendar object which represents the day in which the time lies

    • partitionMediumResources

      public List<List<RESOURCE>> partitionMediumResources(List<RESOURCE> resources, Map<Long,Integer> days)
      Computes publish groups for a list of resources with age "medium".

      Parameters:
      resources - the list of resources
      days - a map from modification dates to the number of days since the modification
      Returns:
      a list of publish groups

    • partitionPublishResourcesByAge

      public Map<A_CmsPublishGroupHelper.GroupAge,List<RESOURCE>> partitionPublishResourcesByAge(List<RESOURCE> resources, Map<Long,Integer> days)
      Partitions a list of resources by their age in (local) days since the last modification.

      Parameters:
      resources - the list of resources to partition
      days - the map from modification dates to the number of (local) days since the modification
      Returns:
      a map from age enum values to the list of resources which fall into the corresponding age group

    • partitionYoungResources

      public List<List<RESOURCE>> partitionYoungResources(List<RESOURCE> resources)
      Partitions the list of young resources into publish groups.

      Parameters:
      resources - the list of resources to partition
      Returns:
      a partition of the resources into publish groups

    • createGroup

      protected abstract GROUP createGroup(String name, List<RESOURCE> resources)
      Creates a named group of resources.

      Parameters:
      name - the name of the group
      resources - the resources which should be put in the group
      Returns:
      the named group

    • getDateLastModified

      protected abstract long getDateLastModified(RESOURCE res)
      Gets the last modification date of a resource.

      Parameters:
      res - the resource
      Returns:
      the last modification date of res

    • getRootPath

      protected abstract String getRootPath(RESOURCE res)
      Gets the root path of a resource.

      Parameters:
      res - the resource
      Returns:
      the root path of res