com.endeca.portal.data

Class CollectionNameRegistry

java.lang.Object

com.endeca.portal.data.CollectionNameRegistry

public class CollectionNameRegistry
extends java.lang.Object

A singleton that stores a global cache of collection names used in the Endeca index. This cache object was created in order to provide a method to look up the "inventoried" data set key corresponding to a project-specific data set key. But it may be enhanced for future such lookup needs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionNameRegistry.ProjectStableCollectionNameInfo

Method Summary

Methods

Modifier and Type	Method and Description
static void	forceRefresh() Force refresh the collection name registry.
static java.util.Set<java.lang.String>	getAllInventoriedCollectionIds()
static java.lang.String	getCollectionDisplayName(java.lang.String nativeCollectionId)
static java.util.Map<java.lang.String,DatabaseCollectionInfo>	getCollectionInfoMap(long projectId)
static java.util.Set<java.lang.String>	getNativeCollectionIds(long projectId)
static java.util.Set<java.lang.String>	getParentCollectionIds(long projectId)
static java.util.Set<CollectionNameRegistry.ProjectStableCollectionNameInfo>	getProjectStableCollectionNames(java.lang.String nativeCollectionId)
static java.lang.String	getStableCollectionName(long projectId, java.lang.String nativeCollectionId)
static java.util.Set<java.lang.String>	getStableCollectionNames(long projectId)
static void	invalidateCache() Increase the cache version counter to invalidate the cache
static java.lang.String	lookupInventoriedCollectionId(long projectId, java.lang.String stableCollectionName) Looks up the inventoried collection name corresponding to the specified collection name using the cached map.
static void	refreshIfNecessary() Refreshes the cache if its data version if out of date

Methods inherited from class java.lang.Object

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

Method Detail

refreshIfNecessary

public static void refreshIfNecessary()

Refreshes the cache if its data version if out of date

invalidateCache

public static void invalidateCache()

Increase the cache version counter to invalidate the cache

forceRefresh

public static void forceRefresh()

Force refresh the collection name registry. Currently, the endeca server data version won't be increased after add/remove/switch collection, because we do not use multiple collection names anymore. Therefore, in those cases, we will call forceRefresh instead of refreshIfNecessary.

lookupInventoriedCollectionId

public static java.lang.String lookupInventoriedCollectionId(long projectId,
                                             java.lang.String stableCollectionName)
                                                      throws KeyNotFoundException

Looks up the inventoried collection name corresponding to the specified collection name using the cached map.

Parameters:

projectId -

stableCollectionName -

Returns:

matching inventoried collection Id

Throws:

KeyNotFoundException - if no inventoried collection Id was found that matches the specified name

getAllInventoriedCollectionIds

public static java.util.Set<java.lang.String> getAllInventoriedCollectionIds()

getStableCollectionNames

public static java.util.Set<java.lang.String> getStableCollectionNames(long projectId)

getStableCollectionName

public static java.lang.String getStableCollectionName(long projectId,
                                       java.lang.String nativeCollectionId)
                                                throws KeyNotFoundException

Throws:

KeyNotFoundException

getParentCollectionIds

public static java.util.Set<java.lang.String> getParentCollectionIds(long projectId)

getNativeCollectionIds

public static java.util.Set<java.lang.String> getNativeCollectionIds(long projectId)

getCollectionInfoMap

public static java.util.Map<java.lang.String,DatabaseCollectionInfo> getCollectionInfoMap(long projectId)

getCollectionDisplayName

public static java.lang.String getCollectionDisplayName(java.lang.String nativeCollectionId)
                                                 throws KeyNotFoundException

Throws:

KeyNotFoundException

getProjectStableCollectionNames

public static java.util.Set<CollectionNameRegistry.ProjectStableCollectionNameInfo> getProjectStableCollectionNames(java.lang.String nativeCollectionId)