org.eclipse.emf.cdo.util
Class CDOUtil

java.lang.Object
  extended by org.eclipse.emf.cdo.util.CDOUtil

public final class CDOUtil
extends Object

Various static methods that may help in CDO client applications.


Method Summary
static void cleanStaleReference(EObject eObject, EStructuralFeature eFeature)
           
static void cleanStaleReference(EObject eObject, EStructuralFeature eFeature, int index)
           
static CDOCollectionLoadingPolicy createCollectionLoadingPolicy(int initialChunkSize, int resolveChunkSize)
           
static CDOFeatureAnalyzer createModelBasedFeatureAnalyzer()
           
static CDORevisionPrefetchingPolicy createRevisionPrefetchingPolicy(int chunkSize)
           
static CDOFetchRuleManager createThreadLocalFetchRuleManager()
           
static CDOFeatureAnalyzer createUIFeatureAnalyzer()
           
static CDOFeatureAnalyzer createUIFeatureAnalyzer(long maxTimeBetweenOperation)
           
static CDOXATransaction createXATransaction(Notifier... notifiers)
           
static CDOObject getCDOObject(EObject object)
           
static EObject getEObject(EObject object)
           
 Map<String,EObject> getIntrinsicIDToEObjectMap(CDOResource resource)
          Returns the map used to cache the EObject that is identified by the value of its ID feature.
static EList<Resource> getResources(ResourceSet resourceSet)
           
static CDORevision getRevisionByVersion(CDOObject object, CDOBranch branch, int version)
           
static CDORevision getRevisionByVersion(CDOObject object, int version)
           
static CDOSession getSession(Object object)
           
static CDOViewSet getViewSet(Notifier notifier)
           
static CDOXATransaction getXATransaction(CDOViewSet viewSet)
           
static boolean isInvalidationRunnerActive()
          Deprecated. As of 4.0 use CDOView.isInvalidationRunnerActive()
static boolean isLegacyModeDefault()
          Deprecated. As of 4.2 the legacy mode is always enabled.
static boolean isLegacyObject(EObject object)
           
static boolean isSessionDirty(CDOSession session)
          Returns true if the given session contains a dirty transaction, false otherwise.
static boolean isStaleObject(Object object)
           
static void load(EObject eObject, CDOView view)
           
static boolean prepareDynamicEPackage(EPackage startPackage)
           
static boolean registerResourceFactory(Resource.Factory.Registry registry)
           
static void setCredentialsProvider(URI uri, IPasswordCredentialsProvider provider)
           
 void setIntrinsicIDToEObjectMap(CDOResource resource, Map<String,EObject> intrinsicIDToEObjectMap)
          Sets the map used to cache the EObject identified by the value of its ID feature.
static void setLegacyModeDefault(boolean on)
          Deprecated. As of 4.2 the legacy mode is always enabled.
static CDOObject wrapExternalObject(EObject object, CDOView view)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

registerResourceFactory

public static boolean registerResourceFactory(Resource.Factory.Registry registry)
Since:
4.0

getIntrinsicIDToEObjectMap

public Map<String,EObject> getIntrinsicIDToEObjectMap(CDOResource resource)
Returns the map used to cache the EObject that is identified by the value of its ID feature.

Returns:
the map used to cache the EObject that is identified by the value of its ID feature.
Since:
4.2
See Also:
setIntrinsicIDToEObjectMap(org.eclipse.emf.cdo.eresource.CDOResource, java.util.Map)

setIntrinsicIDToEObjectMap

public void setIntrinsicIDToEObjectMap(CDOResource resource,
                                       Map<String,EObject> intrinsicIDToEObjectMap)
Sets the map used to cache the EObject identified by the value of its ID feature. This cache is only activated if the map is not null. The map will be lazily loaded by the getEObjectByID method. It is up to the client to clear the cache when it becomes invalid, e.g., when the ID of a previously mapped EObject is changed.

Parameters:
intrinsicIDToEObjectMap - the new map or null.
Since:
4.2
See Also:
getIntrinsicIDToEObjectMap(org.eclipse.emf.cdo.eresource.CDOResource)

getSession

public static CDOSession getSession(Object object)
Since:
3.0

prepareDynamicEPackage

public static boolean prepareDynamicEPackage(EPackage startPackage)
Since:
2.0

createCollectionLoadingPolicy

public static CDOCollectionLoadingPolicy createCollectionLoadingPolicy(int initialChunkSize,
                                                                       int resolveChunkSize)
Since:
2.0

createRevisionPrefetchingPolicy

public static CDORevisionPrefetchingPolicy createRevisionPrefetchingPolicy(int chunkSize)
Since:
2.0

createThreadLocalFetchRuleManager

public static CDOFetchRuleManager createThreadLocalFetchRuleManager()
Since:
4.1

createModelBasedFeatureAnalyzer

public static CDOFeatureAnalyzer createModelBasedFeatureAnalyzer()
Since:
4.1

createUIFeatureAnalyzer

public static CDOFeatureAnalyzer createUIFeatureAnalyzer()
Since:
4.1

createUIFeatureAnalyzer

public static CDOFeatureAnalyzer createUIFeatureAnalyzer(long maxTimeBetweenOperation)
Since:
4.1

createXATransaction

public static CDOXATransaction createXATransaction(Notifier... notifiers)
Since:
4.0

getXATransaction

public static CDOXATransaction getXATransaction(CDOViewSet viewSet)
Since:
2.0

getViewSet

public static CDOViewSet getViewSet(Notifier notifier)
Since:
4.0

isStaleObject

public static boolean isStaleObject(Object object)
Since:
3.0

cleanStaleReference

public static void cleanStaleReference(EObject eObject,
                                       EStructuralFeature eFeature)
Since:
3.0

cleanStaleReference

public static void cleanStaleReference(EObject eObject,
                                       EStructuralFeature eFeature,
                                       int index)
Since:
3.0

load

public static void load(EObject eObject,
                        CDOView view)
Since:
2.0

wrapExternalObject

public static CDOObject wrapExternalObject(EObject object,
                                           CDOView view)
Since:
4.2

getEObject

public static EObject getEObject(EObject object)
Since:
2.0

getCDOObject

public static CDOObject getCDOObject(EObject object)
Since:
2.0

getRevisionByVersion

public static CDORevision getRevisionByVersion(CDOObject object,
                                               int version)
Since:
2.0

getRevisionByVersion

public static CDORevision getRevisionByVersion(CDOObject object,
                                               CDOBranch branch,
                                               int version)
Since:
3.0

getResources

public static EList<Resource> getResources(ResourceSet resourceSet)
Since:
2.0

isSessionDirty

public static boolean isSessionDirty(CDOSession session)
Returns true if the given session contains a dirty transaction, false otherwise.

Since:
2.0
See Also:
CDOTransaction

isInvalidationRunnerActive

@Deprecated
public static boolean isInvalidationRunnerActive()
Deprecated. As of 4.0 use CDOView.isInvalidationRunnerActive()

Since:
3.0

isLegacyObject

public static boolean isLegacyObject(EObject object)
Since:
3.0

isLegacyModeDefault

@Deprecated
public static boolean isLegacyModeDefault()
Deprecated. As of 4.2 the legacy mode is always enabled.

Since:
3.0

setLegacyModeDefault

@Deprecated
public static void setLegacyModeDefault(boolean on)
Deprecated. As of 4.2 the legacy mode is always enabled.

Since:
3.0

setCredentialsProvider

public static void setCredentialsProvider(URI uri,
                                          IPasswordCredentialsProvider provider)
Since:
4.0


Copyright (c) 2011, 2012 Eike Stepper (Berlin, Germany) and others.