Package com.atlassian.confluence.labels

Class DefaultLabelManager

java.lang.Object
com.atlassian.confluence.labels.DefaultLabelManager
All Implemented Interfaces:
LabelManagerInternal, LabelManager
public class DefaultLabelManager extends Object implements LabelManagerInternal
Default implementation of the label manager interface. This implementation uses the LabelDao to access the label persistent store.

  • Constructor Details

    • DefaultLabelManager

      public DefaultLabelManager(LabelDaoInternal dao, com.atlassian.event.api.EventPublisher eventPublisher, Clock clock)

  • Method Details

    • addLabel

      public int addLabel(Labelable labelable, Label label)
      Description copied from interface: LabelManager
      Add a label to the specified content.

      Note: the specified label does not need to be persistent. A persistent instance of the label will be created if necessary. eg: you can write code like: labelManager.addLabel(page, new Label("name", "namespace", "owner"));

      Specified by:
      addLabel in interface LabelManager
      Parameters:
      labelable -
      label -
      Returns:
      one of NO_CHANGE, LABEL_ADDED or LABEL_CREATED

    • removeLabel

      public int removeLabel(Labelable content, Label label)
      Description copied from interface: LabelManager
      Remove a label from the specified content.
      Specified by:
      removeLabel in interface LabelManager
      Parameters:
      content -
      label -
      Returns:
      one of NO_CHANGE, LABEL_DELETED, LABEL_REMOVED

    • removeLabels

      public void removeLabels(Labelable content, List<Label> labels)
      Description copied from interface: LabelManager
      removes a list of labels from the labelable object
      Specified by:
      removeLabels in interface LabelManager

    • removeAllLabels

      public void removeAllLabels(Labelable content)
      Description copied from interface: LabelManager
      Remove all of the labels from the specified content. Any labels that then no longer label content will be deleted.
      Specified by:
      removeAllLabels in interface LabelManager
      Parameters:
      content -

    • getLabel

      public Label getLabel(long id)
      Retrieve a label based on its id.
      Specified by:
      getLabel in interface LabelManager
      Parameters:
      id -
      Returns:
      the label instance.

    • getSuggestedLabels

      public List<Label> getSuggestedLabels(Labelable content)
      Description copied from interface: LabelManager
      Retrieve the DEFAULT_LABEL_COUNT suggested labels for the specified content. The process used to identify 'suggested' labels may change and therefore is not defined here.
      Specified by:
      getSuggestedLabels in interface LabelManager
      Parameters:
      content -
      Returns:
      a list of label instances. The order of these labels is undefined.
      See Also:

    • getSuggestedLabels

      public List<Label> getSuggestedLabels(Labelable content, int count)
      Description copied from interface: LabelManager
      Retrieve the suggested labels for the specified content. The process used to identify 'suggested' labels may change and therefore is not defined here.
      Specified by:
      getSuggestedLabels in interface LabelManager
      Parameters:
      count - is the maximum number of labels to be returned.
      Returns:
      a list of label instances. The order of these labels is undefined.

    • getSuggestedLabelsInSpace

      public List<Label> getSuggestedLabelsInSpace(Labelable content, String spaceKey)
      Description copied from interface: LabelManager
      Retrieve the DEFAULT_LABEL_COUNT suggested labels for the specified content bound to the specified space.
      Specified by:
      getSuggestedLabelsInSpace in interface LabelManager
      Parameters:
      content -
      spaceKey -
      Returns:
      a list of label instances. The order of these labels is undefined.
      See Also:

    • getSuggestedLabelsInSpace

      public List<Label> getSuggestedLabelsInSpace(Labelable content, String spaceKey, int maxResults)
      Description copied from interface: LabelManager
      Retrieve the suggested labels for the specified content bound to the specified space.
      Specified by:
      getSuggestedLabelsInSpace in interface LabelManager
      Parameters:
      content -
      spaceKey -
      maxResults - is the maximum number of labels to be returned.
      Returns:
      a list of label instances. The order of these labels is undefined.

    • getRelatedLabels

      public List<Label> getRelatedLabels(Label label)
      Description copied from interface: LabelManager
      Retrieve the DEFAULT_LABEL_COUNT labels that are 'related' to the specified label. The process used to identify 'related' labels may change and therefore is not define here.
      Specified by:
      getRelatedLabels in interface LabelManager
      Parameters:
      label -
      Returns:
      a list of label instances. The order of these labels is undefined.
      See Also:

    • getRelatedLabels

      public List<Label> getRelatedLabels(Label label, int count)
      Description copied from interface: LabelManager
      Retrieve the labels that are 'related' to the specified label. The process used to identify 'related' labels may change and therefore is not defined here.
      Specified by:
      getRelatedLabels in interface LabelManager
      Parameters:
      count - is the maximum number of labels to be returned.
      Returns:
      a list of label instances. The order of these labels is undefined.

    • getRelatedLabels

      public List<Label> getRelatedLabels(List<? extends Label> labels, String spaceKey, int maxResultsPerLabel)
      Description copied from interface: LabelManager
      Retrieve the labels that are 'related' to the labels in the list. The process used to identify 'related' labels may change and therefore is not defined here.
      Specified by:
      getRelatedLabels in interface LabelManager
      Parameters:
      spaceKey - - may be null to search globally
      maxResultsPerLabel - is the maximum number of labels to be returned for each label.
      Returns:
      a list of label instances. The order of these labels is undefined.

    • getRelatedLabelsInSpace

      public List<Label> getRelatedLabelsInSpace(Label label, String spaceKey)
      Description copied from interface: LabelManager
      Retrieve the DEFAULT_LABEL_COUNT labels that are 'related' to the specified label and that are used to label content within the specified space.
      Specified by:
      getRelatedLabelsInSpace in interface LabelManager
      Parameters:
      label -
      spaceKey -
      Returns:
      a list of label instances. The order of these labels is undefined.
      See Also:

    • getRelatedLabelsInSpace

      public List<Label> getRelatedLabelsInSpace(Label label, String spaceKey, int maxResults)
      Description copied from interface: LabelManager
      Retrieve the labels that are 'related' to the specified label and that are used to to label content within the specified space.
      Specified by:
      getRelatedLabelsInSpace in interface LabelManager
      Parameters:
      label -
      spaceKey -
      maxResults -
      Returns:
      a list of label instance. The order of these labels is undefined.

    • getSpacesContainingContentWithLabel

      public List<Space> getSpacesContainingContentWithLabel(Label label)
      Description copied from interface: LabelManager
      Look up the spaces that have been labelled by the specific label.
      Specified by:
      getSpacesContainingContentWithLabel in interface LabelManager
      Parameters:
      label -
      Returns:
      a list of Spaces. The order of these labels is undefined.

    • getUsersLabels

      public List<Label> getUsersLabels(String name)
      Description copied from interface: LabelManager
      Retrieve the personal labels that belong to the specified user.
      Specified by:
      getUsersLabels in interface LabelManager
      Parameters:
      name -

    • getTeamLabels

      public List<Label> getTeamLabels()
      Description copied from interface: LabelManager
      Retrieve all of the team labels in the system.
      Specified by:
      getTeamLabels in interface LabelManager
      Returns:
      a list of labels with the namespace Namespace.TEAM

    • getTeamLabels

      public List<Label> getTeamLabels(String name)
      Description copied from interface: LabelManager
      Retrieve all of the team labels in the system with name.
      Specified by:
      getTeamLabels in interface LabelManager
      Returns:
      a list of labels with the namespace Namespace.TEAM

    • getTeamLabelsForSpace

      public List<Label> getTeamLabelsForSpace(String spaceKey)
      Description copied from interface: LabelManager
      Retrieve all of the team labels used to label content in the specified space.
      Specified by:
      getTeamLabelsForSpace in interface LabelManager
      Parameters:
      spaceKey -
      Returns:
      a list of team labels with the namespace Namespace.TEAM. The order of the list is undefined.

    • getTeamLabelsForSpaces

      public List<Label> getTeamLabelsForSpaces(Collection<Space> spaces)
      Description copied from interface: LabelManager
      Retrieve all of the team labels used to label content in the specified spaces.
      Specified by:
      getTeamLabelsForSpaces in interface LabelManager
      Parameters:
      spaces - collection of spaces whose labels to get
      Returns:
      a list of team labels with the namespace Namespace.TEAM. The order of the list is undefined.

    • getRecentlyUsedLabelsInSpace

      public List<Label> getRecentlyUsedLabelsInSpace(String key)
      Description copied from interface: LabelManager
      Retrieve the DEFAULT_LABEL_COUNT most recently used labels within the specified space.
      Specified by:
      getRecentlyUsedLabelsInSpace in interface LabelManager
      Parameters:
      key - identifies the space to which the results are restricted.
      Returns:
      a list of label instances in order of most recently used to least recently used.
      See Also:

    • getRecentlyUsedLabelsInSpace

      public List<Label> getRecentlyUsedLabelsInSpace(String key, int maxResults)
      Description copied from interface: LabelManager
      Retrieve the most recently used labels within the specified spae.
      Specified by:
      getRecentlyUsedLabelsInSpace in interface LabelManager
      Parameters:
      key -
      maxResults - is the maximum number of labels to be returned.
      Returns:
      a list of label instances in order of the most recently used to least recently used.

    • getRecentlyUsedLabelsInSpace

      public PageResponse<Label> getRecentlyUsedLabelsInSpace(String key, LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Retrieve the most recently used labels within the specified space.
      Specified by:
      getRecentlyUsedLabelsInSpace in interface LabelManagerInternal
      Parameters:
      key - is the space key.
      limitedRequest - defines pagination parameters.
      Returns:
      a paginated response with label instances in order of the most recently used to least recently used.
      See Also:

    • getRecentlyUsedLabels

      public List<Label> getRecentlyUsedLabels(int maxResults)
      Description copied from interface: LabelManager
      Retrieve the x most recently used labels.
      Specified by:
      getRecentlyUsedLabels in interface LabelManager
      Parameters:
      maxResults - is the maximum number of labels to be returned.
      Returns:
      a list of label instances in order of most recently used to least recently used.

    • getRecentlyUsedLabels

      public List<Label> getRecentlyUsedLabels()
      Description copied from interface: LabelManager
      Retrieve the DEFAULT_LABEL_COUNT most recently used labels within the system.
      Specified by:
      getRecentlyUsedLabels in interface LabelManager
      Returns:
      a list of label instances in order of most recently used to least recently used.
      See Also:

    • getRecentlyUsedPersonalLabels

      public List<Label> getRecentlyUsedPersonalLabels(String username)
      Description copied from interface: LabelManager
      Retrieve the labels that were recently used by currently authenticated user. 'Recently Used' includes labels that the user recently added, created, removed and deleted.

      Note: labels in this list may or may not exist.

      The UserHistory can be retrieved from the session via the ActionContext (if using an action) or the Execution Context (DWR)

      Specified by:
      getRecentlyUsedPersonalLabels in interface LabelManager
      Parameters:
      username - the user history from the session
      Returns:
      a list of labels

    • getRecentlyUsedPersonalLabels

      public List<Label> getRecentlyUsedPersonalLabels(String username, int maxResults)
      Description copied from interface: LabelManager
      Retrieve the labels that were recently used by currently authenticated user. 'Recently Used' includes labels that the user recently added, created, removed and deleted.

      Note: labels in this list may or may not exist.

      The UserHistory can be retrieved from the session via the ActionContext (if using an action) or the Execution Context (DWR)

      Specified by:
      getRecentlyUsedPersonalLabels in interface LabelManager
      Parameters:
      username - the user history from the session
      maxResults - the maximum number of results to return to the user
      Returns:
      a list of labels

    • getRecentlyUsedPersonalLabels

      public PageResponse<Label> getRecentlyUsedPersonalLabels(String username, LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Retrieve the labels that were recently used by currently authenticated user. 'Recently Used' includes labels that the user recently added, created, removed and deleted.

      Note: labels in this list may or may not exist.

      The UserHistory can be retrieved from the session via the ActionContext (if using an action) or the Execution Context (DWR)

      Specified by:
      getRecentlyUsedPersonalLabels in interface LabelManagerInternal
      Parameters:
      username - the user history from the session
      limitedRequest - defines pagination parameters.
      Returns:
      a paginated response with list of labels

    • getRecentlyUsedPersonalLabellings

      public List<Labelling> getRecentlyUsedPersonalLabellings(String username, int maxResults)
      Specified by:
      getRecentlyUsedPersonalLabellings in interface LabelManager

    • getRecentlyUsedPersonalLabellings

      public PageResponse<Labelling> getRecentlyUsedPersonalLabellings(String username, LimitedRequest limitedRequest)
      Specified by:
      getRecentlyUsedPersonalLabellings in interface LabelManagerInternal

    • getCurrentContentForLabel

      public List<? extends Labelable> getCurrentContentForLabel(Label label)
      Description copied from interface: LabelManager
      Get all content associated with a label and space Get all current content associated with a label and any space. Content in the trash will not be returned.
      Specified by:
      getCurrentContentForLabel in interface LabelManager
      Returns:
      a list of Labelables, sorted by last modification date

    • getContentForAllLabels

      public List<? extends Labelable> getContentForAllLabels(Collection<Label> labels, int maxResults, int offset)
      Specified by:
      getContentForAllLabels in interface LabelManager

    • getContentForLabel

      public PartialList<ContentEntityObject> getContentForLabel(int offset, int maxResults, Label label)
      Description copied from interface: LabelManager
      Retrieve current ContentEntityObjects which are labelled with the provided label.

      ContentEntityObjects in the Trash will *not* be returned.

      Specified by:
      getContentForLabel in interface LabelManager
      Parameters:
      offset - the offset into the results
      maxResults - the maximum number of results to return
      label - label which must appear on ContentEntityObjects
      Returns:
      a partial list of ContentEntityObjects labelled with the labels provided

    • getContentForAllLabels

      public PartialList<ContentEntityObject> getContentForAllLabels(int offset, int maxResults, Label... labels)
      Description copied from interface: LabelManager
      Retrieve current ContentEntityObjects which are labelled with ALL provided labels.

      ContentEntityObjects in the Trash will *not* be returned.

      Specified by:
      getContentForAllLabels in interface LabelManager
      Parameters:
      offset - the offset into the results
      maxResults - the maximum number of results to return
      labels - labels which must appear on ContentEntityObjects
      Returns:
      a partial list of ContentEntityObjects labelled with the labels provided

    • getForLabel

      public <T extends EditableLabelable> PartialList<T> getForLabel(Class<T> labelableClass, int offset, int maxResults, Label label)
      Description copied from interface: LabelManager
      Retrieve EditableLabelables of the supplied type which are labelled with the provided label.

      ContentEntityObjects in the Trash *will* be returned.

      Specified by:
      getForLabel in interface LabelManager
      Parameters:
      labelableClass - the type of labelable to return. Use one of these values:
      • ContentEntityObject.class - all CEO labelings except Attachments
      • Attachment.class - all attachment labellings
      • PageTemplate.class - all page template labellings
      offset - the offset into the results
      maxResults - the maximum number of results to return
      label - label which must appear on labelables
      Returns:
      a partial list of EditableLabelables labelled with the labels provided

    • getForLabels

      public <T extends EditableLabelable> PartialList<T> getForLabels(Class<T> labelableClass, int offset, int maxResults, Label... labels)
      Description copied from interface: LabelManager
      Retrieve EditableLabelables of the supplied type which are labelled with the provided labels.

      ContentEntityObjects in the Trash will *not* be returned.

      Specified by:
      getForLabels in interface LabelManager
      Parameters:
      labelableClass - the type of labelable to return. Use one of these values:
      • ContentEntityObject.class - all CEO labelings except Attachments
      • Attachment.class - all attachment labellings
      • PageTemplate.class - all page template labellings
      offset - the offset into the results
      maxResults - the maximum number of results to return
      labels - labels which must all appear on labelables
      Returns:
      a partial list of EditableLabelables labelled with the labels provided

    • getForLabels

      public PartialList<EditableLabelable> getForLabels(int offset, int maxResults, Label... labels)
      Description copied from interface: LabelManager
      Retrieve EditableLabelables of any type which are labelled with the provided labels.

      ContentEntityObjects in the Trash *will* be returned.

      Specified by:
      getForLabels in interface LabelManager
      Parameters:
      offset - the offset into the results
      maxResults - the maximum number of results to return
      labels - labels which must all appear on labelables
      Returns:
      a partial list of EditableLabelables labelled with the labels provided

    • getContentInSpaceForLabel

      public PartialList<ContentEntityObject> getContentInSpaceForLabel(int offset, int maxResults, String spaceKey, Label label)
      Description copied from interface: LabelManager
      Retrieve current ContentEntityObjects in the given space which are labelled with the provided label.

      ContentEntityObjects in the Trash will *not* be returned.

      Specified by:
      getContentInSpaceForLabel in interface LabelManager
      Parameters:
      offset - the offset into the results
      maxResults - the maximum number of results to return
      spaceKey - the key of the space to search content in
      label - label which must appear on ContentEntityObjects
      Returns:
      a partial list of ContentEntityObjects labelled with the labels provided

    • getContentInSpaceForAllLabels

      public PartialList<ContentEntityObject> getContentInSpaceForAllLabels(int offset, int maxResults, String spaceKey, Label... labels)
      Description copied from interface: LabelManager
      Retrieve current ContentEntityObjects in the given space which are labelled with ALL provided labels.

      ContentEntityObjects in the Trash will *not* be returned.

      Specified by:
      getContentInSpaceForAllLabels in interface LabelManager
      Parameters:
      offset - the offset into the results
      maxResults - the maximum number of results to return
      spaceKey - the key of the space to search content in
      labels - labels which must appear on ContentEntityObjects
      Returns:
      a partial list of ContentEntityObjects labelled with the labels provided

    • getContentInSpacesForAllLabels

      public PartialList<ContentEntityObject> getContentInSpacesForAllLabels(int offset, int maxResults, Set<String> spaceKeys, Label... labels)
      Description copied from interface: LabelManager
      Retrieve current ContentEntityObjects in the given spaces which are labelled with ALL provided labels.

      ContentEntityObjects in the Trash will *not* be returned.

      Specified by:
      getContentInSpacesForAllLabels in interface LabelManager
      Parameters:
      offset - the offset into the results
      maxResults - the maximum number of results to return
      spaceKeys - the keys of the spaces to search content in
      labels - labels which must appear on ContentEntityObjects
      Returns:
      a partial list of ContentEntityObjects labelled with the labels provided

    • getAllContentForLabel

      public PartialList<ContentEntityObject> getAllContentForLabel(int offset, int maxResults, Label label)
      Description copied from interface: LabelManager
      Retrieve all ContentEntityObjects, current or deleted which are labelled with the provided label.

      ContentEntityObjects in the Trash *will* be returned.

      Specified by:
      getAllContentForLabel in interface LabelManager
      Parameters:
      offset - the offset into the results
      maxResults - the maximum number of results to return
      label - label which must appear on ContentEntityObjects
      Returns:
      a partial list of ContentEntityObjects labelled with the labels provided

    • getAllContentForAllLabels

      public PartialList<ContentEntityObject> getAllContentForAllLabels(int offset, int maxResults, Label... labels)
      Description copied from interface: LabelManager
      Retrieve all ContentEntityObjects, current or deleted which are labelled with ALL provided labels.

      ContentEntityObjects in the Trash *will* be returned.

      Specified by:
      getAllContentForAllLabels in interface LabelManager
      Parameters:
      offset - the offset into the results
      maxResults - the maximum number of results to return
      labels - labels which must appear on ContentEntityObjects
      Returns:
      a partial list of ContentEntityObjects labelled with the labels provided

    • getCurrentContentForLabelAndSpace

      public List<? extends Labelable> getCurrentContentForLabelAndSpace(Label label, String spaceKey)
      Description copied from interface: LabelManager
      Get all current content associated with a label and space. Content in the trash will not be returned.
      Specified by:
      getCurrentContentForLabelAndSpace in interface LabelManager
      Returns:
      a list of Labelable

    • getCurrentContentWithPersonalLabel

      public List<? extends Labelable> getCurrentContentWithPersonalLabel(String username)
      Description copied from interface: LabelManager
      Get all current content labelled by a user
      Specified by:
      getCurrentContentWithPersonalLabel in interface LabelManager

    • getSpacesWithLabel

      public List<Space> getSpacesWithLabel(Label label)
      Description copied from interface: LabelManager
      Spaces cannot be directly labelled. Howevever, their space descriptions can. This method searches for all space descriptions with the label passed in
      Specified by:
      getSpacesWithLabel in interface LabelManager
      Parameters:
      label -
      Returns:
      list of spaces associated with matching space descriptions

    • deleteLabel

      public boolean deleteLabel(long id)
      Description copied from interface: LabelManager
      Delete the label with the specified id.
      Specified by:
      deleteLabel in interface LabelManager
      Parameters:
      id -
      Returns:
      true if the label was deleted, false otherwise.

    • getFavouriteSpaces

      public List<Space> getFavouriteSpaces(String username)
      Specified by:
      getFavouriteSpaces in interface LabelManager
      Parameters:
      username - username of label owner

    • getFavouriteLabellingsByContentIds

      public List<Labelling> getFavouriteLabellingsByContentIds(Collection<ContentId> contentIds, com.atlassian.sal.api.user.UserKey userKey)
      Description copied from interface: LabelManager
      Get the labellings that represent the favourite labellings for the given user on the given content.
      Specified by:
      getFavouriteLabellingsByContentIds in interface LabelManager
      Parameters:
      contentIds - the contentIds to get favourite labellings for
      userKey - the key of the user to get favourite labellings for
      Returns:
      the labellings that represent the favourite labellings for the given user on the given content.

    • deleteLabel

      public boolean deleteLabel(Label label)
      Description copied from interface: LabelManager
      Delete the specified label.

      NOTE: The specified label does note need to be the persistent instance of the label, it simply needs to uniquely identify the label.

      Specified by:
      deleteLabel in interface LabelManager
      Parameters:
      label -
      Returns:
      true if the label was deleted, false otherwise.

    • getLabel

      public Label getLabel(ParsedLabelName parsedLabelName)
      Description copied from interface: LabelManager
      Retrieve the label by name.
      Specified by:
      getLabel in interface LabelManager
      Parameters:
      parsedLabelName -
      Returns:
      a persistent instance of the label or null if it can not be found.
      See Also:

    • getLabel

      public Label getLabel(String unparsedLabelName)
      Description copied from interface: LabelManager
      convenience method to fetch a label without having to call the label parser
      Specified by:
      getLabel in interface LabelManager
      Parameters:
      unparsedLabelName - - example - my:foo

    • getLabels

      public List<Label> getLabels(Collection<String> unparsedLabelNames)
      Description copied from interface: LabelManager
      convenience method to fetch labels without having to call the label parser
      Specified by:
      getLabels in interface LabelManager
      Parameters:
      unparsedLabelNames - - example - my:foo, bar

    • getLabel

      public Label getLabel(Label label)
      Description copied from interface: LabelManager
      Retrieve the persistent instance of the label with the exact same details as the specified label. Note, the specified label does not need to contain an id.
      Specified by:
      getLabel in interface LabelManager
      Parameters:
      label -
      Returns:
      a persistent instance of the label, or null if it does not exist.

    • getLabel

      public Label getLabel(String labelName, Namespace namespace)
      Description copied from interface: LabelManager
      Convenience method to fetch a label without having to create a Label object
      Specified by:
      getLabel in interface LabelManager
      Parameters:
      labelName - The label name
      namespace - The namespace of the label
      Returns:
      a label instance or null if no such label exists

    • getLabelsByDetail

      public List<Label> getLabelsByDetail(String labelName, String namespace, String spaceKey, String owner)
      Description copied from interface: LabelManager
      Retrieves the labels matching the given labelName, namespace or owner
      Specified by:
      getLabelsByDetail in interface LabelManager
      Parameters:
      labelName - The name of the label (null to ignore)
      namespace - The namespace of the labels (null to ignore)
      spaceKey - The spaceKey to restrict by (null to ignore)
      owner - The owner of the labels (null to ignore)
      Returns:
      a list of Label instances

    • getLabelsInSpace

      public List<Label> getLabelsInSpace(String key)
      Description copied from interface: LabelManager
      Retrieve all of the labels that label content within the specified space.
      Specified by:
      getLabelsInSpace in interface LabelManager
      Parameters:
      key - identifying the space to be queried.
      Returns:
      a list of labels that appear in the space.

    • getLabelsInSpace

      public PageResponse<Label> getLabelsInSpace(String key, LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Get all labels in Space with pagination
      Specified by:
      getLabelsInSpace in interface LabelManagerInternal
      Parameters:
      key -
      limitedRequest -
      Returns:

    • getRelatedLabelsInSpace

      public PageResponse<Label> getRelatedLabelsInSpace(Label label, String spaceKey, LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Get related labels in Space with pagination
      Specified by:
      getRelatedLabelsInSpace in interface LabelManagerInternal
      Parameters:
      label -
      spaceKey -
      limitedRequest -
      Returns:

    • getTotalLabelInSpace

      public long getTotalLabelInSpace(String key)
      Description copied from interface: LabelManagerInternal
      Get total label in a particular space
      Specified by:
      getTotalLabelInSpace in interface LabelManagerInternal
      Parameters:
      key -
      Returns:

    • getMostPopularLabels

      public List<LabelSearchResult> getMostPopularLabels()
      Description copied from interface: LabelManager
      Retrieve the list of the DEFAULT_LABEL_COUNT most popular labels within the system.
      Specified by:
      getMostPopularLabels in interface LabelManager
      Returns:
      a list of label search result instances in order of their popularity.
      See Also:

    • getMostPopularLabels

      public List<LabelSearchResult> getMostPopularLabels(int count)
      Description copied from interface: LabelManager
      Retrieve the most popular labels within the system. The number of labels returned can be specified through the count parameter. If the count value is greater than the number of labels, then all labels will be returned.

      This function does not return the labels itself, but wrapped into a search result with a count!

      Specified by:
      getMostPopularLabels in interface LabelManager
      Parameters:
      count - is the maximum number of labels to be returned.
      Returns:
      a list of label search result instances in order of their popularity.
      See Also:

    • getMostPopularLabelsInSpace

      public List<LabelSearchResult> getMostPopularLabelsInSpace(String key)
      Description copied from interface: LabelManager
      Retrieve the list of the DEFAULT_LABEL_COUNT most used labels in the specific space, ordered from most popular to least popular.

      This function does not return the labels itself, but wrapped into a search result with a count!

      Specified by:
      getMostPopularLabelsInSpace in interface LabelManager
      Parameters:
      key - the space key
      Returns:
      a list of label search result instances in order of their popularity.
      See Also:

    • getMostPopularLabelsInSpace

      public List<LabelSearchResult> getMostPopularLabelsInSpace(String key, int count)
      Description copied from interface: LabelManager
      Retrieve a list of the 'n' most used labels in the specified space, ordered from most popular to least popular.

      This function does not return the labels itself, but wrapped into a search result with a count!

      Specified by:
      getMostPopularLabelsInSpace in interface LabelManager
      Parameters:
      key - is the space key
      count - is the maximum number of labels to be returned.
      Returns:
      a list of label search result instances in order of their popularity.
      See Also:

    • getMostPopularLabelsInSpace

      public PageResponse<LabelSearchResult> getMostPopularLabelsInSpace(String key, LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Retrieve a list of the 'n' most used labels in the specified space, ordered from most popular to least popular.

      This function does not return the labels itself, but wrapped into a search result with a count!

      Specified by:
      getMostPopularLabelsInSpace in interface LabelManagerInternal
      Parameters:
      key - is the space key.
      limitedRequest - defines pagination parameters.
      Returns:
      a list of label search result instances in order of their popularity.
      See Also:

    • getMostPopularLabelsWithRanks

      public Set<RankedLabelSearchResult> getMostPopularLabelsWithRanks(Comparator<? super RankedLabelSearchResult> comparator)
      Description copied from interface: LabelManager
      Retrieve a set of the DEFAULT_LABEL_COUNT most popular labels within the system, including their ranks and ordered using the compartor provided.
      Specified by:
      getMostPopularLabelsWithRanks in interface LabelManager
      Returns:
      an ordered set of ranked label search result instances
      See Also:

    • getMostPopularLabelsWithRanks

      public Set<RankedLabelSearchResult> getMostPopularLabelsWithRanks(int maxResults, Comparator<? super RankedLabelSearchResult> comparator)
      Description copied from interface: LabelManager
      Retrieve the most popular labels within the system, including their ranks and ordered using the comparator provided. The number of labels returned can be specified through the count parameter. If the count value is greater than the number of labels, then all labels will be returned.

      This function does not return the labels itself, but wrapped into a search result with a count!

      Specified by:
      getMostPopularLabelsWithRanks in interface LabelManager
      Parameters:
      maxResults - is the maximum number of labels to be returned.
      Returns:
      an ordered set of ranked label search result instances
      See Also:

    • getMostPopularLabelsWithRanksInSpace

      public Set<RankedLabelSearchResult> getMostPopularLabelsWithRanksInSpace(String key, int maxResults, Comparator<? super RankedLabelSearchResult> comparator)
      Description copied from interface: LabelManager
      Retrieve a set of the 'n' most used labels in the specified space, ordered using the compartor given.

      This function does not return the labels itself, but wrapped into a search result with a count!

      Specified by:
      getMostPopularLabelsWithRanksInSpace in interface LabelManager
      Parameters:
      key - is the space key
      maxResults - is the maximum number of labels to be returned.
      Returns:
      an ordered set of rankded label search result instances
      See Also:

    • getRankedLabels

      public Set<RankedLabelSearchResult> getRankedLabels(List<LabelSearchResult> labelList, Comparator<? super RankedLabelSearchResult> comparator)
      Description copied from interface: LabelManager
      Calculate ranks for input labels. Ranks reflect the frequency of labels. Rank 1 is used for the most popular labels. Rank 10 is used for the least popular labels
      Specified by:
      getRankedLabels in interface LabelManager
      Parameters:
      labelList - - list of labels
      comparator - - comparator
      Returns:
      list of labels with calculated ranks

    • getContent

      public List<? extends Labelable> getContent(Label label)
      Description copied from interface: LabelManager
      Get all content associated with a label Get all versions of content associated with a label and any space. Content in the trash WILL be returned.
      Specified by:
      getContent in interface LabelManager
      Returns:
      a list of Labelables

    • getContentCount

      public int getContentCount(Label label)
      Specified by:
      getContentCount in interface LabelManager

    • createLabel

      public Label createLabel(Label label)
      Specified by:
      createLabel in interface LabelManager

    • getRecentlyUsedLabellings

      public List<Labelling> getRecentlyUsedLabellings(int maxResults)
      Specified by:
      getRecentlyUsedLabellings in interface LabelManager

    • getRecentlyUsedLabellings

      public PageResponse<Labelling> getRecentlyUsedLabellings(LimitedRequest limitedRequest)
      Specified by:
      getRecentlyUsedLabellings in interface LabelManagerInternal

    • getRecentlyUsedLabellingsInSpace

      public List<Labelling> getRecentlyUsedLabellingsInSpace(String spaceKey, int maxResults)
      Specified by:
      getRecentlyUsedLabellingsInSpace in interface LabelManager

    • getRecentlyUsedLabellingsInSpace

      public PageResponse<Labelling> getRecentlyUsedLabellingsInSpace(String spaceKey, LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Retrieve the most recently used labellings within the specified space.
      Specified by:
      getRecentlyUsedLabellingsInSpace in interface LabelManagerInternal
      Parameters:
      spaceKey - is the space key.
      limitedRequest - defines pagination parameters.
      Returns:
      a paginated response with list of labelling instances in order of the most recently used to least recently used.
      See Also:

    • getRelatedLabels

      public PageResponse<Label> getRelatedLabels(Label label, LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Retrieve the labels which are related (i.e. used together) with the specified label.
      Specified by:
      getRelatedLabels in interface LabelManagerInternal

    • getRecentlyUsedLabels

      public PageResponse<Label> getRecentlyUsedLabels(LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Returns the most recently used global labels in the system. The labels are ordered in descending order of the last time it was modified
      Specified by:
      getRecentlyUsedLabels in interface LabelManagerInternal

    • getMostPopularLabels

      public PageResponse<LabelSearchResult> getMostPopularLabels(LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Returns the most popular global labels in the system. The labels are ordered in descending order of popularity.
      Specified by:
      getMostPopularLabels in interface LabelManagerInternal

    • findGlobalLabelsByNamePrefix

      public PageResponse<Label> findGlobalLabelsByNamePrefix(String namePrefix, LimitedRequest pageRequest)
      Description copied from interface: LabelManagerInternal
      Returns global-namespaced labels starting with the given string.
      Specified by:
      findGlobalLabelsByNamePrefix in interface LabelManagerInternal

    • findTeamLabelsByNamePrefix

      public PageResponse<Label> findTeamLabelsByNamePrefix(String namePrefix, LimitedRequest pageRequest)
      Description copied from interface: LabelManagerInternal
      Returns team-namespaced labels starting with the given string.
      Specified by:
      findTeamLabelsByNamePrefix in interface LabelManagerInternal

    • getMostPopularLabelsInSpaceLite

      public List<LiteLabelSearchResult> getMostPopularLabelsInSpaceLite(String spaceKey, int maxResults)
      Returns most used labels. Similar to getMostPopularLabelsInSpace, but returns lite objects (no references to hibernate objects).
      Specified by:
      getMostPopularLabelsInSpaceLite in interface LabelManager
      Parameters:
      spaceKey - - space key
      maxResults - - limit
      Returns:
      list of LiteLabelSearchResult

    • getMostPopularLabelsInSpaceLite

      public PageResponse<LiteLabelSearchResult> getMostPopularLabelsInSpaceLite(String spaceKey, LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Returns most used labels. Similar to getMostPopularLabelsInSpace, but returns lite objects (no references to hibernate objects).
      Specified by:
      getMostPopularLabelsInSpaceLite in interface LabelManagerInternal
      Parameters:
      spaceKey - - space key
      limitedRequest - defines pagination parameters.
      Returns:
      list of LiteLabelSearchResult

    • getMostPopularLabelsInSiteLite

      public List<LiteLabelSearchResult> getMostPopularLabelsInSiteLite(int maxResults)
      Description copied from interface: LabelManager
      Returns most used labels across the site. Similar to getMostPopularLabels, but returns lite objects (no references to hibernate objects). Note: implementation would limit the amount of labels.
      Specified by:
      getMostPopularLabelsInSiteLite in interface LabelManager
      Parameters:
      maxResults - - max results
      Returns:
      list of LiteLabelSearchResult

    • getMostPopularLabelsInSiteLite

      public PageResponse<LiteLabelSearchResult> getMostPopularLabelsInSiteLite(LimitedRequest limitedRequest)
      Description copied from interface: LabelManagerInternal
      Returns most used labels across the site. Similar to getMostPopularLabels, but returns lite objects (no references to hibernate objects). Note: implementation would limit the amount of labels.
      Specified by:
      getMostPopularLabelsInSiteLite in interface LabelManagerInternal
      Parameters:
      limitedRequest - defines pagination parameters.
      Returns:
      list of LiteLabelSearchResult

    • calculateRanksForLiteLabels

      public Set<RankedLiteLabelSearchResult> calculateRanksForLiteLabels(List<LiteLabelSearchResult> labelList, Comparator<? super RankedLiteLabelSearchResult> comparator)
      Description copied from interface: LabelManager
      Calculate ranks for input labels. Ranks reflect the frequency of labels. Rank 1 is used for the most popular labels. Rank 10 is used for the least popular labels
      Specified by:
      calculateRanksForLiteLabels in interface LabelManager
      Parameters:
      labelList - - list of labels
      comparator - - comparator
      Returns:
      list of labels with calculated ranks

    • getLabelsByDetail

      public PageResponse<Label> getLabelsByDetail(LimitedRequest limitedRequest, String labelName, String namespace, String spaceKey, String owner)
      Description copied from interface: LabelManagerInternal
      Returns labels filtered by the given parameters.
      Specified by:
      getLabelsByDetail in interface LabelManagerInternal