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.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Set<java.lang.String>	getAllInventoriedCollectionNames()
static java.lang.String	lookupInventoriedCollectionName(java.lang.String collectionName) Looks through the cached list of inventoried collection names in search of one that "matches" the specified collection name.
static void	refreshIfNecessary() Refreshes the cache if its data version if out of date
static void	refreshIfNecessary(boolean forceRefresh) 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

refreshIfNecessary

public static void refreshIfNecessary(boolean forceRefresh)

Refreshes the cache if its data version if out of date

Parameters:

forceRefresh - - Fetch the latest dataVersion and not use the cached one.

lookupInventoriedCollectionName

public static java.lang.String lookupInventoriedCollectionName(java.lang.String collectionName)
                                                        throws KeyNotFoundException

Looks through the cached list of inventoried collection names in search of one that "matches" the specified collection name. "Matches" here means the specified collection name starts with the inventoried collection name. For instance:

• wine matches wine_10110
• wine matches wine
• wine matches wine_devUser_10110
• default_edp_2ea7941a-70c1-4b20-97fb-cf4a391bfc27 matches default_edp_2ea7941a-70c1-4b20-97fb-cf4a391bfc27_namespacePrefix_10601

Parameters:

collectionName - a collection name string, which could be an inventoried collection or a project-specific collection name

Returns:

matching inventoried collection name

Throws:

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

getAllInventoriedCollectionNames

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