org.nuxeo.directory.mongodb

Class MongoDBReference

java.lang.Object

org.nuxeo.ecm.directory.AbstractReference

org.nuxeo.directory.mongodb.MongoDBReference

All Implemented Interfaces:

Reference

public class MongoDBReference
extends AbstractReference

MongoDB implementation of a Reference

Since:

9.1

Field Summary

Fields

Modifier and Type	Field and Description
protected String	collection
protected String	dataFileName
protected String	sourceField
protected String	targetField

Fields inherited from class org.nuxeo.ecm.directory.AbstractReference

fieldName, sourceDirectory, sourceDirectoryName, targetDirectory, targetDirectoryName

Constructor Summary

Constructors

Constructor and Description
MongoDBReference(MongoDBReferenceDescriptor descriptor)
MongoDBReference(ReferenceDescriptor descriptor)
MongoDBReference(String field, String directory, String collection, String sourceField, String targetField, String dataFileName)

Method Summary

Modifier and Type	Method and Description
void	addLinks(List<String> sourceIds, String targetId)
void	addLinks(List<String> sourceIds, String targetId, Session session) Adds the links between the source ids and the target id
void	addLinks(String sourceId, List<String> targetIds)
void	addLinks(String sourceId, List<String> targetIds, Session session) Adds the links between the source id and the target ids
protected MongoDBSession	getMongoDBSession()
List<String>	getSourceIdsForTarget(String targetId)
List<String>	getTargetIdsForSource(String sourceId)
List<String>	getTargetIdsForSource(String sourceId, MongoDBSession session) Retrieves all target ids associated to the given source id
protected void	initializeSession(MongoDBSession session)
void	removeLinksForSource(String sourceId)
void	removeLinksForSource(String sourceId, Session session) Removes all the links for a given source id
void	removeLinksForTarget(String targetId)
void	removeLinksForTarget(String targetId, Session session) Removes all the links for a given target id
void	setSourceIdsForTarget(String targetId, List<String> sourceIds)
void	setSourceIdsForTarget(String targetId, List<String> sourceIds, Session session) Sets all source ids to be associated to the given target id
void	setTargetIdsForSource(String sourceId, List<String> targetIds)
void	setTargetIdsForSource(String sourceId, List<String> targetIds, Session session) Sets all target ids to be associated to the given source id

Methods inherited from class org.nuxeo.ecm.directory.AbstractReference

getFieldName, getSourceDirectory, getTargetDirectory, setSourceDirectoryName, setTargetDirectoryName

Methods inherited from class java.lang.Object

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

Field Detail

collection

protected String collection

sourceField

protected String sourceField

targetField

protected String targetField

dataFileName

protected String dataFileName

Constructor Detail

MongoDBReference

public MongoDBReference(String field,
                        String directory,
                        String collection,
                        String sourceField,
                        String targetField,
                        String dataFileName)

Since:

9.2

MongoDBReference

public MongoDBReference(MongoDBReferenceDescriptor descriptor)

Since:

9.2

MongoDBReference

public MongoDBReference(ReferenceDescriptor descriptor)

Since:

9.2

Method Detail

addLinks

public void addLinks(String sourceId,
                     List<String> targetIds)
              throws DirectoryException

Throws:

DirectoryException

addLinks

public void addLinks(String sourceId,
                     List<String> targetIds,
                     Session session)
              throws DirectoryException

Description copied from interface: Reference

Adds the links between the source id and the target ids

Parameters:

sourceId - the source id

targetIds - the target ids

session - the session

Throws:

DirectoryException

addLinks

public void addLinks(List<String> sourceIds,
                     String targetId,
                     Session session)
              throws DirectoryException

Description copied from interface: Reference

Adds the links between the source ids and the target id

Parameters:

sourceIds - the source ids

targetId - the target id

session - the session

Throws:

DirectoryException

addLinks

public void addLinks(List<String> sourceIds,
                     String targetId)
              throws DirectoryException

Throws:

DirectoryException

removeLinksForSource

public void removeLinksForSource(String sourceId)
                          throws DirectoryException

Throws:

DirectoryException

removeLinksForSource

public void removeLinksForSource(String sourceId,
                                 Session session)

Description copied from interface: Reference

Removes all the links for a given source id

Parameters:

sourceId - the source id

session - the session

removeLinksForTarget

public void removeLinksForTarget(String targetId)
                          throws DirectoryException

Throws:

DirectoryException

removeLinksForTarget

public void removeLinksForTarget(String targetId,
                                 Session session)
                          throws DirectoryException

Description copied from interface: Reference

Removes all the links for a given target id

Parameters:

targetId - the target id

session - the session

Throws:

DirectoryException

getTargetIdsForSource

public List<String> getTargetIdsForSource(String sourceId)
                                   throws DirectoryException

Throws:

DirectoryException

getTargetIdsForSource

public List<String> getTargetIdsForSource(String sourceId,
                                          MongoDBSession session)
                                   throws DirectoryException

Retrieves all target ids associated to the given source id

Parameters:

sourceId - the source id

session - the mongoDB session

Returns:

the list of target ids

Throws:

DirectoryException

getSourceIdsForTarget

public List<String> getSourceIdsForTarget(String targetId)
                                   throws DirectoryException

Throws:

DirectoryException

setTargetIdsForSource

public void setTargetIdsForSource(String sourceId,
                                  List<String> targetIds)
                           throws DirectoryException

Throws:

DirectoryException

setTargetIdsForSource

public void setTargetIdsForSource(String sourceId,
                                  List<String> targetIds,
                                  Session session)
                           throws DirectoryException

Description copied from interface: Reference

Sets all target ids to be associated to the given source id

Parameters:

sourceId - the source id

targetIds - the target ids

session - the session

Throws:

DirectoryException

setSourceIdsForTarget

public void setSourceIdsForTarget(String targetId,
                                  List<String> sourceIds)
                           throws DirectoryException

Throws:

DirectoryException

setSourceIdsForTarget

public void setSourceIdsForTarget(String targetId,
                                  List<String> sourceIds,
                                  Session session)
                           throws DirectoryException

Description copied from interface: Reference

Sets all source ids to be associated to the given target id

Parameters:

targetId - the target id

sourceIds - the source ids

session - the session

Throws:

DirectoryException

initializeSession

protected void initializeSession(MongoDBSession session)

getMongoDBSession

protected MongoDBSession getMongoDBSession()
                                    throws DirectoryException

Throws:

DirectoryException