com.atlassian.confluence.internal.relations.dao.hibernate

Class User2ContentHibernateRelationDao

java.lang.Object

com.atlassian.confluence.internal.relations.dao.hibernate.HibernateRelationDao<ConfluenceUser,ContentEntityObject>

com.atlassian.confluence.internal.relations.dao.hibernate.User2ContentHibernateRelationDao

All Implemented Interfaces:

RelationDao<ConfluenceUser,ContentEntityObject>

public class User2ContentHibernateRelationDao
extends HibernateRelationDao<ConfluenceUser,ContentEntityObject>

Since:

5.9

Field Summary

Fields inherited from class com.atlassian.confluence.internal.relations.dao.hibernate.HibernateRelationDao

hibernate, RELATION_PARAM_NAME, SOURCE_PARAM_NAME, TARGET_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
User2ContentHibernateRelationDao(net.sf.hibernate.SessionFactory sessionFactory)

Method Summary

Modifier and Type	Method and Description
List<Long>	getAllRelationIdsForContentInSpace(String spaceKey, Collection<ConfluenceEntityObject> exclusions, int start, int limit) This method returns ids of all content relation entities in space.
User2ContentRelationEntity	getRelationEntity(ConfluenceUser source, ContentEntityObject target, RelationDescriptor relationDescriptor) Get relation for given content, type and name.
int	getRelationsCount(ConfluenceUser source, ContentEntityObject target, RelationDescriptor relationDescriptor) Get total number of relations for given content, type and name.
List<ConfluenceUser>	getSources(RelationQuery<ContentEntityObject> request, int start, int limit) Fetch all related sources for the entity.
int	getSourcesCount(RelationQuery<ContentEntityObject> request) Count of all related sources for the entity.
List<ContentEntityObject>	getTargets(RelationQuery<ConfluenceUser> request, int start, int limit) Fetch all related targets for the entity.
int	getTargetsCount(RelationQuery<ConfluenceUser> request) Count of all related targets for the entity.
protected User2ContentRelationEntity	newRelationEntity(ConfluenceUser source, ContentEntityObject target)
int	removeAllRelations(RelatableEntity relatableEntity) This method removes all relations (across all names and types), where given entity participates.

Methods inherited from class com.atlassian.confluence.internal.relations.dao.hibernate.HibernateRelationDao

createRelationEntity, getRelationEntities, removeRelationEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

User2ContentHibernateRelationDao

public User2ContentHibernateRelationDao(net.sf.hibernate.SessionFactory sessionFactory)

Method Detail

getRelationsCount

public int getRelationsCount(ConfluenceUser source,
                             ContentEntityObject target,
                             RelationDescriptor relationDescriptor)

Description copied from interface: RelationDao

Get total number of relations for given content, type and name.

relationDescriptor - specifies relation metadata, such as type and name

Returns:

total number of relations for given entities, relation type and name.

See Also:

RelationDescriptor

getRelationEntity

@Nullable
public User2ContentRelationEntity getRelationEntity(ConfluenceUser source,
                                                              ContentEntityObject target,
                                                              RelationDescriptor relationDescriptor)

Description copied from interface: RelationDao

Get relation for given content, type and name.

relationDescriptor - specifies relation metadata, such as type and name

Returns:

RelationEntity or null if no relations found

getSources

@Nonnull
public List<ConfluenceUser> getSources(RelationQuery<ContentEntityObject> request,
                                                int start,
                                                int limit)

Description copied from interface: RelationDao

Fetch all related sources for the entity. Fetching parameters (relation name, filtering etc.) is provided by request argument

Returns:

list of RelatableEntity

See Also:

RelationQuery

getTargets

@Nonnull
public List<ContentEntityObject> getTargets(RelationQuery<ConfluenceUser> request,
                                                     int start,
                                                     int limit)

Description copied from interface: RelationDao

Fetch all related targets for the entity. Fetching parameters (relation name, filtering etc.) is provided by request argument

Returns:

list of RelatableEntity

See Also:

RelationQuery

getSourcesCount

public int getSourcesCount(RelationQuery<ContentEntityObject> request)

Description copied from interface: RelationDao

Count of all related sources for the entity. Fetching parameters (relation name, filtering etc.) is provided by request argument

Returns:

total number of all sources

getTargetsCount

public int getTargetsCount(RelationQuery<ConfluenceUser> request)

Description copied from interface: RelationDao

Count of all related targets for the entity. Fetching parameters (relation name, filtering etc.) is provided by request argument

Returns:

total number of all targets

removeAllRelations

public int removeAllRelations(RelatableEntity relatableEntity)

Description copied from interface: RelationDao

This method removes all relations (across all names and types), where given entity participates.

Returns:

number of relations which were removed.

getAllRelationIdsForContentInSpace

public List<Long> getAllRelationIdsForContentInSpace(@Nonnull
                                                     String spaceKey,
                                                     @Nonnull
                                                     Collection<ConfluenceEntityObject> exclusions,
                                                     int start,
                                                     int limit)

This method returns ids of all content relation entities in space. It is used in export operations

Parameters:

spaceKey - space

exclusions - list of exclusions

start - start

limit - limit

Returns:

list of all content relation entities in space

newRelationEntity

protected User2ContentRelationEntity newRelationEntity(ConfluenceUser source,
                                                       ContentEntityObject target)

Specified by:

newRelationEntity in class HibernateRelationDao<ConfluenceUser,ContentEntityObject>