com.atlassian.confluence.labels.persistence.dao.hibernate
Class HibernateLabelDao

java.lang.Object
  org.springframework.dao.support.DaoSupport
      org.springframework.orm.hibernate.support.HibernateDaoSupport
          com.atlassian.hibernate.HibernateObjectDao
              com.atlassian.confluence.labels.persistence.dao.hibernate.HibernateLabelDao

All Implemented Interfaces:

bucket.core.persistence.ObjectDao, LabelDao, org.springframework.beans.factory.InitializingBean

public class HibernateLabelDao
extends com.atlassian.hibernate.HibernateObjectDao
implements LabelDao

Field Summary

Fields inherited from class com.atlassian.hibernate.HibernateObjectDao

log

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface com.atlassian.confluence.labels.persistence.dao.LabelDao

UNLIMITED

Constructor Summary

HibernateLabelDao()

Method Summary

void	deleteLabellingBySpace(java.lang.String key)
java.util.List	findAllUserLabelledContent(java.lang.String username)
java.util.List	findByDetails(java.lang.String name, java.lang.String namespace, java.lang.String owner) Find all labels based on the details passed in.
java.util.List	findByDetailsInSpace(java.lang.String name, java.lang.String namespace, java.lang.String owner, java.lang.String spaceKey) Find all labels for a specific space, based on the details passed in.
Label	findById(long id) Find the label by its id.
Label	findByLabel(Label label)
java.util.List	findBySingleDegreeSeparation(ContentEntityObject content, int maxResults) Find the labels that are a single degree of separation away from the specified content.
java.util.List	findBySingleDegreeSeparation(ContentEntityObject content, java.lang.String spaceKey, int maxResults)
java.util.List	findBySingleDegreeSeparation(Label label, int maxResults) Find the labels that are a single degree of separation away from the specified label.
java.util.List	findBySingleDegreeSeparation(Label label, java.lang.String spaceKey, int maxResults)
java.util.List	findBySpace(java.lang.String spaceKey, java.lang.String namespace) Find the labels used to label the content with the specified space.
java.util.List	findContentByLabel(Label label)
int	findContentCountForLabel(Label label)
java.util.List	findContentForLabel(Label label)
java.util.List	findCurrentContentForLabel(Label label)
java.util.List	findCurrentContentForLabelAndSpace(Label label, java.lang.String spaceKey) Returns current content with the specified label and spaceKey.
Labelling	findLabellingByContentAndLabel(ContentEntityObject content, Label label)
Labelling	findLabellingById(long id)
java.util.List	findMostPopular(java.lang.String namespace, int maxResults) Find the most popular labels.
java.util.List	findMostPopularBySpace(java.lang.String namespace, java.lang.String spaceKey, int maxResults) Find the most popular labels in the specified space.
java.util.List	findRecentlyUsed(int maxResults)
java.util.List	findRecentlyUsedBySpace(java.lang.String spaceKey, int maxResults)
java.util.List	findRecentlyUsedLabelling(int maxResults)
java.util.List	findRecentlyUsedLabellingsBySpace(java.lang.String spaceKey, int maxResults)
java.util.List	findRecentlyUsedUserLabellings(java.lang.String username, int maxResults)
java.util.List	findRecentlyUsedUserLabels(java.lang.String username, int maxResults)
java.util.List	findSpacesContainingContentWithLabel(Label label)
java.util.List	findSpacesWithLabel(Label label)
java.util.List	findUnusedLabels()
java.util.List	getFavouriteSpaces(java.lang.String username)
java.lang.Class	getPersistentClass()
boolean	isDB2()
boolean	isMySQL() The problems are specific to MySQl v 4, but unfortunately we can't tell that without hitting the database.
void	setForceSQL(boolean forceSQL)

Methods inherited from class com.atlassian.hibernate.HibernateObjectDao

findAll, findAllSorted, findNamedQuery, findNamedQuery, findNamedQuery, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParam, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findNamedQueryStringParams, findSingleObject, getByClassId, index, refresh, reIndex, remove, replicate, save, saveRaw, setIndexer, unIndex, updateModificationData

Methods inherited from class org.springframework.orm.hibernate.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface bucket.core.persistence.ObjectDao

findAll, findAllSorted, refresh, remove, replicate, save, saveRaw

Constructor Detail

HibernateLabelDao

public HibernateLabelDao()

Method Detail

isDB2

public boolean isDB2()

setForceSQL

public void setForceSQL(boolean forceSQL)

isMySQL

public boolean isMySQL()

The problems are specific to MySQl v 4, but unfortunately we can't tell that without hitting the database.

Returns:

true if the database is MySQL

getPersistentClass

public java.lang.Class getPersistentClass()

Specified by:

getPersistentClass in interface bucket.core.persistence.ObjectDao

findById

public Label findById(long id)

Description copied from interface: LabelDao

Find the label by its id.

Specified by:

findById in interface LabelDao

Returns:

a label instance, or null if the label does not exist.

findByLabel

public Label findByLabel(Label label)

Specified by:

findByLabel in interface LabelDao

findByDetails

public java.util.List findByDetails(java.lang.String name,
                                    java.lang.String namespace,
                                    java.lang.String owner)

Description copied from interface: LabelDao

Find all labels based on the details passed in. If a parameter is null, it will not be considered in the search.

The list of labels returned will be ordered by name.

Specified by:

findByDetails in interface LabelDao

Returns:

List

findByDetailsInSpace

public java.util.List findByDetailsInSpace(java.lang.String name,
                                           java.lang.String namespace,
                                           java.lang.String owner,
                                           java.lang.String spaceKey)

Description copied from interface: LabelDao

Find all labels for a specific space, based on the details passed in. If a parameter is null, it will not be considered in the search.

The list of labels returned will be ordered by name.

Specified by:

findByDetailsInSpace in interface LabelDao

Returns:

List

findBySpace

public java.util.List findBySpace(java.lang.String spaceKey,
                                  java.lang.String namespace)

Description copied from interface: LabelDao

Find the labels used to label the content with the specified space.

Specified by:

findBySpace in interface LabelDao

Returns:

a list of labels, or an empty list if non exist.

findRecentlyUsedBySpace

public java.util.List findRecentlyUsedBySpace(java.lang.String spaceKey,
                                              int maxResults)

Specified by:

findRecentlyUsedBySpace in interface LabelDao

findRecentlyUsed

public java.util.List findRecentlyUsed(int maxResults)

Specified by:

findRecentlyUsed in interface LabelDao

findRecentlyUsedLabelling

public java.util.List findRecentlyUsedLabelling(int maxResults)

Specified by:

findRecentlyUsedLabelling in interface LabelDao

findRecentlyUsedLabellingsBySpace

public java.util.List findRecentlyUsedLabellingsBySpace(java.lang.String spaceKey,
                                                        int maxResults)

Specified by:

findRecentlyUsedLabellingsBySpace in interface LabelDao

findRecentlyUsedUserLabels

public java.util.List findRecentlyUsedUserLabels(java.lang.String username,
                                                 int maxResults)

Specified by:

findRecentlyUsedUserLabels in interface LabelDao

findRecentlyUsedUserLabellings

public java.util.List findRecentlyUsedUserLabellings(java.lang.String username,
                                                     int maxResults)

Specified by:

findRecentlyUsedUserLabellings in interface LabelDao

findMostPopular

public java.util.List findMostPopular(java.lang.String namespace,
                                      int maxResults)

Description copied from interface: LabelDao

Find the most popular labels. Label popularity is defined by the number of times a label has been used / applied to content.

Specified by:

findMostPopular in interface LabelDao

Returns:

a list of label instances, or an empty list if non exist.

findMostPopularBySpace

public java.util.List findMostPopularBySpace(java.lang.String namespace,
                                             java.lang.String spaceKey,
                                             int maxResults)

Description copied from interface: LabelDao

Find the most popular labels in the specified space. You can restrict the number of results returned by this query by setting the maxResults parameter.

Specified by:

findMostPopularBySpace in interface LabelDao

maxResults - allows you to specify the maximum number of results returned by this method. Leaving max results at zero will return all of the results.

Returns:

a list of LabelSearchResult objects that map the label to the number of times it appears in the space.

findBySingleDegreeSeparation

public java.util.List findBySingleDegreeSeparation(ContentEntityObject content,
                                                   int maxResults)

Description copied from interface: LabelDao

Find the labels that are a single degree of separation away from the specified content. This query will retrieve the labels on the given content object and find any content with those labels. The labels that are used on the second "level" of content will be returned. e.g. Page H is passed in as the content object, which is labelled with A and B. All pages labelled with A and B are retrieved (J, K, L, M), and the labels on those four pages are returned in order of frequency.

Specified by:

findBySingleDegreeSeparation in interface LabelDao

Parameters:

content - the content object used to search for related labels

maxResults - specifies the number of labels to be returned.

Returns:

a list of labels, ordered by their frequency of occurance.

findBySingleDegreeSeparation

public java.util.List findBySingleDegreeSeparation(ContentEntityObject content,
                                                   java.lang.String spaceKey,
                                                   int maxResults)

Specified by:

findBySingleDegreeSeparation in interface LabelDao

findBySingleDegreeSeparation

public java.util.List findBySingleDegreeSeparation(Label label,
                                                   int maxResults)

Description copied from interface: LabelDao

Find the labels that are a single degree of separation away from the specified label. This query will return the labels located on the same pages with the given label, in order of frequency e.g. Page A has labels ABCX, Page B has labels ABX. A query for X will return A (2 uses) then B (1 use)

Specified by:

findBySingleDegreeSeparation in interface LabelDao

Parameters:

label - the label to look for on pages

maxResults - the maximum number of results to return

Returns:

a list of labels, ordered by their frequency of occurance.

findBySingleDegreeSeparation

public java.util.List findBySingleDegreeSeparation(Label label,
                                                   java.lang.String spaceKey,
                                                   int maxResults)

Specified by:

findBySingleDegreeSeparation in interface LabelDao

findContentForLabel

public java.util.List findContentForLabel(Label label)

findAllUserLabelledContent

public java.util.List findAllUserLabelledContent(java.lang.String username)

Specified by:

findAllUserLabelledContent in interface LabelDao

findCurrentContentForLabel

public java.util.List findCurrentContentForLabel(Label label)

Specified by:

findCurrentContentForLabel in interface LabelDao

findContentCountForLabel

public int findContentCountForLabel(Label label)

Specified by:

findContentCountForLabel in interface LabelDao

findCurrentContentForLabelAndSpace

public java.util.List findCurrentContentForLabelAndSpace(Label label,
                                                         java.lang.String spaceKey)

Description copied from interface: LabelDao

Returns current content with the specified label and spaceKey. If no spaceKey is specified, a search will be performed against the label only.

Specified by:

findCurrentContentForLabelAndSpace in interface LabelDao

Parameters:

label - search for content with this label

spaceKey - (optional) search for content belonging to the space with this spaceKey

Returns:

current content with the specified label and spaceKey.

findSpacesContainingContentWithLabel

public java.util.List findSpacesContainingContentWithLabel(Label label)

Specified by:

findSpacesContainingContentWithLabel in interface LabelDao

findSpacesWithLabel

public java.util.List findSpacesWithLabel(Label label)

Specified by:

findSpacesWithLabel in interface LabelDao

findLabellingByContentAndLabel

public Labelling findLabellingByContentAndLabel(ContentEntityObject content,
                                                Label label)

Specified by:

findLabellingByContentAndLabel in interface LabelDao

findLabellingById

public Labelling findLabellingById(long id)

Specified by:

findLabellingById in interface LabelDao

deleteLabellingBySpace

public void deleteLabellingBySpace(java.lang.String key)

Specified by:

deleteLabellingBySpace in interface LabelDao

getFavouriteSpaces

public java.util.List getFavouriteSpaces(java.lang.String username)

Specified by:

getFavouriteSpaces in interface LabelDao

Parameters:

username - username of label owner

findUnusedLabels

public java.util.List findUnusedLabels()

Specified by:

findUnusedLabels in interface LabelDao

findContentByLabel

public java.util.List findContentByLabel(Label label)