org.nuxeo.ecm.directory.sql

Class TableReference

java.lang.Object

org.nuxeo.ecm.directory.AbstractReference

org.nuxeo.ecm.directory.sql.TableReference

All Implemented Interfaces:

Reference

public class TableReference
extends AbstractReference

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dataFileName
protected String	sourceColumn
protected String	tableName
protected String	targetColumn

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

fieldName, sourceDirectory, sourceDirectoryName, targetDirectory, targetDirectoryName

Constructor Summary

Constructors

Constructor and Description
TableReference(ReferenceDescriptor descriptor)
TableReference(String fieldName, String directory, String tableName, String sourceColumn, String targetColumn, String dataFileName)
TableReference(TableReferenceDescriptor descriptor)

Method Summary

Modifier and Type	Method and Description
void	addLink(String sourceId, String targetId, SQLSession session, boolean checkExisting)
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
boolean	exists(String sourceId, String targetId, SQLSession session)
String	getDataFileName()
protected List<String>	getIdsFor(String valueColumn, String filterColumn, String filterValue)
String	getSourceColumn()
List<String>	getSourceIdsForTarget(String targetId)
protected SQLSession	getSQLSession()
Table	getTable()
String	getTableName()
String	getTargetColumn()
String	getTargetDirectoryName()
List<String>	getTargetIdsForSource(String sourceId)
protected void	maybeInitialize(SQLSession sqlSession) Initialize if needed, using an existing session.
void	removeLinksFor(String column, String entryId, SQLSession 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	setIdsFor(String idsColumn, List<String> ids, String filterColumn, String filterValue, SQLSession session)
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	setSourceIdsForTarget(String targetId, List<String> sourceIds, SQLSession session)
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
void	setTargetIdsForSource(String sourceId, List<String> targetIds, SQLSession session)

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

tableName

protected String tableName

sourceColumn

protected String sourceColumn

targetColumn

protected String targetColumn

dataFileName

protected String dataFileName

Constructor Detail

TableReference

public TableReference(String fieldName,
                      String directory,
                      String tableName,
                      String sourceColumn,
                      String targetColumn,
                      String dataFileName)

Since:

9.2

TableReference

public TableReference(TableReferenceDescriptor descriptor)

Since:

9.2

TableReference

public TableReference(ReferenceDescriptor descriptor)

Since:

9.2

Method Detail

addLinks

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

Throws:

DirectoryException

addLinks

public void addLinks(List<String> sourceIds,
                     String targetId)
              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

exists

public boolean exists(String sourceId,
                      String targetId,
                      SQLSession session)
               throws DirectoryException

Throws:

DirectoryException

addLink

public void addLink(String sourceId,
                    String targetId,
                    SQLSession session,
                    boolean checkExisting)
             throws DirectoryException

Throws:

DirectoryException

getIdsFor

protected List<String> getIdsFor(String valueColumn,
                                 String filterColumn,
                                 String filterValue)
                          throws DirectoryException

Throws:

DirectoryException

getSourceIdsForTarget

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

Throws:

DirectoryException

getTargetIdsForSource

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

Throws:

DirectoryException

removeLinksFor

public void removeLinksFor(String column,
                           String entryId,
                           SQLSession session)
                    throws DirectoryException

Throws:

DirectoryException

removeLinksForSource

public void removeLinksForSource(String sourceId,
                                 Session session)
                          throws DirectoryException

Description copied from interface: Reference

Removes all the links for a given source id

Parameters:

sourceId - the source id

session - the session

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

removeLinksForSource

public void removeLinksForSource(String sourceId)
                          throws DirectoryException

Throws:

DirectoryException

removeLinksForTarget

public void removeLinksForTarget(String targetId)
                          throws DirectoryException

Throws:

DirectoryException

setIdsFor

public void setIdsFor(String idsColumn,
                      List<String> ids,
                      String filterColumn,
                      String filterValue,
                      SQLSession session)
               throws DirectoryException

Throws:

DirectoryException

setSourceIdsForTarget

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

Throws:

DirectoryException

setTargetIdsForSource

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

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

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

getSQLSession

protected SQLSession getSQLSession()
                            throws DirectoryException

Throws:

DirectoryException

maybeInitialize

protected void maybeInitialize(SQLSession sqlSession)
                        throws DirectoryException

Initialize if needed, using an existing session.

Parameters:

sqlSession -

Throws:

DirectoryException

getTable

public Table getTable()
               throws DirectoryException

Throws:

DirectoryException

getSourceColumn

public String getSourceColumn()

getTargetColumn

public String getTargetColumn()

getTargetDirectoryName

public String getTargetDirectoryName()

getTableName

public String getTableName()

getDataFileName

public String getDataFileName()