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

Class User2UserHibernateRelationDao

java.lang.Object

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

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

All Implemented Interfaces:

RelationDao<ConfluenceUser,ConfluenceUser>

public class User2UserHibernateRelationDao
extends HibernateRelationDao<ConfluenceUser,ConfluenceUser>

Since:

5.9

Field Summary

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

hibernate, RELATION_PARAM_NAME, sessionFactory, SOURCE_PARAM_NAME, TARGET_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
User2UserHibernateRelationDao(org.hibernate.SessionFactory sessionFactory)

Method Summary

Modifier and Type	Method and Description
User2UserRelationEntity	getRelationEntity(ConfluenceUser source, ConfluenceUser target, RelationDescriptor relationDescriptor) Get relation for given content, type and name.
int	getRelationsCount(ConfluenceUser source, ConfluenceUser target, RelationDescriptor relationDescriptor) Get total number of relations for given content, type and name.
List<ConfluenceUser>	getSources(RelationQuery<ConfluenceUser> request, int start, int limit) Fetch all related sources for the entity.
int	getSourcesCount(RelationQuery<ConfluenceUser> request) Count of all related sources for the entity.
List<ConfluenceUser>	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 User2UserRelationEntity	newRelationEntity(ConfluenceUser source, ConfluenceUser target)
int	removeAllRelations(RelatableEntity relatableEntity) This method removes all relations (across all names and types), where given entity participates.
int	removeAllRelationsFromCurrentAndHistoricalEntities(RelatableEntity relatableEntity) This method removes all relations (across all names and types), where given entity participates.
int	removeAllRelationsFromEntityWithName(String relationName, RelatableEntity relatableEntity) This method remove all relations with the given name, where the given entity participates

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

constructRelationEntity, createRelationEntity, getRelationEntities, removeRelationEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

User2UserHibernateRelationDao

public User2UserHibernateRelationDao(org.hibernate.SessionFactory sessionFactory)

Method Detail

getRelationsCount

public int getRelationsCount(ConfluenceUser source,
                             ConfluenceUser 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 User2UserRelationEntity getRelationEntity(ConfluenceUser source,
                                                           ConfluenceUser 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<ConfluenceUser> 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<ConfluenceUser> 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<ConfluenceUser> 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.

removeAllRelationsFromEntityWithName

public int removeAllRelationsFromEntityWithName(String relationName,
                                                RelatableEntity relatableEntity)

Description copied from interface: RelationDao

This method remove all relations with the given name, where the given entity participates

Returns:

number of relations which were removed

removeAllRelationsFromCurrentAndHistoricalEntities

public int removeAllRelationsFromCurrentAndHistoricalEntities(RelatableEntity relatableEntity)

Description copied from interface: RelationDao

This method removes all relations (across all names and types), where given entity participates. It also removes all relations from the historical versions of the given entity if the entity is the most current version of content

Returns:

number of relations which were removed.

newRelationEntity

protected User2UserRelationEntity newRelationEntity(ConfluenceUser source,
                                                    ConfluenceUser target)

Specified by:

newRelationEntity in class HibernateRelationDao<ConfluenceUser,ConfluenceUser>