com.endeca.portal.data

Class CollectionBindingManager

java.lang.Object

com.endeca.portal.data.CollectionBindingManager

public class CollectionBindingManager
extends java.lang.Object

This class manages the bindings from an in-project collection (identified by the projectId and a stable collection name/logical name) to its corresponding native collection and database. About how this binding information is stored and how/when it should be updated, please refer to the wiki page at: http://wiki-edca.us.oracle.com/display/Eng/Studio+support+for+databases

Constructor Summary

Constructors

Constructor and Description
CollectionBindingManager()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	addDataSet(long projectId, java.lang.String databaseName, java.lang.String nativeCollectionName, RequestIds requestIds, boolean isNewProject) Add a data set into a project.
static void	cleanupProjectBindings(long projectId) Clean up bindings after a project is removed.
static java.util.List<CollectionBinding>	getAllCollectionBindings() Get all the collection bindings.
static java.lang.String	getLogicalName(long projectId, java.lang.String stableCollectionName)
static void	removeDataSet(long projectId, java.lang.String stableCollectionName, RequestIds requestIds) Remove a dataset from a project
static void	switchCollection(long projectId, java.lang.String stableCollectionName, java.lang.String newDatabaseName, java.lang.String newCollectionName, RequestIds requestIds) Switch a stable collection name (logical name) in a project to another native collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionBindingManager

public CollectionBindingManager()

Method Detail

addDataSet

public static java.lang.String addDataSet(long projectId,
                          java.lang.String databaseName,
                          java.lang.String nativeCollectionName,
                          RequestIds requestIds,
                          boolean isNewProject)
                                   throws com.liferay.portal.SystemException

Add a data set into a project. The initial stable collection name (logic name) will be generated based on the display name of the data set.

Parameters:

projectId -

databaseName -

collectionName -

Returns:

Throws:

com.liferay.portal.SystemException

removeDataSet

public static void removeDataSet(long projectId,
                 java.lang.String stableCollectionName,
                 RequestIds requestIds)
                          throws com.liferay.portal.SystemException

Remove a dataset from a project

Parameters:

projectId -

stableCollectionName -

request -

Throws:

com.liferay.portal.SystemException

cleanupProjectBindings

public static void cleanupProjectBindings(long projectId)
                                   throws com.liferay.portal.SystemException

Clean up bindings after a project is removed.

Parameters:

projectId -

Throws:

com.liferay.portal.SystemException

switchCollection

public static void switchCollection(long projectId,
                    java.lang.String stableCollectionName,
                    java.lang.String newDatabaseName,
                    java.lang.String newCollectionName,
                    RequestIds requestIds)
                             throws com.liferay.portal.SystemException

Switch a stable collection name (logical name) in a project to another native collection. Essentially this moves a binding from one DSI record to another. This is called in cases such as Transform, Load Full Data Set.

Parameters:

projectId -

stableCollectionName -

newDatabaseName -

newCollectionName -

Throws:

com.liferay.portal.SystemException

getAllCollectionBindings

public static java.util.List<CollectionBinding> getAllCollectionBindings()
                                                                  throws DataSourceException

Get all the collection bindings.

Returns:

Throws:

DataSourceException

getLogicalName

public static java.lang.String getLogicalName(long projectId,
                              java.lang.String stableCollectionName)