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 up the inventoried collection name corresponding to the specified collection name using the cached map.
static java.lang.String	lookupInventoriedOriginalCollectionName(java.lang.String collectionName) Similar to lookupInventoriedCollectionName(String), except it looks up the original collection corresponding to 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 up the inventoried collection name corresponding to the specified collection name using the cached map.

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

lookupInventoriedOriginalCollectionName

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

Similar to lookupInventoriedCollectionName(String), except it looks up the original collection corresponding to the specified collection name. For example, let's say we are given a project-specific collection name "wine_copy_11011" that corresponds to a private collection copy of the original cataloged collection named "wine". This method will return "wine" because it's the parent collection of inventoried collection, wine_copy. This method not only dereferences the specified collectionName back to a key found in the data set inventory, it also returns the key of the original collection corresponding to the potentially project-private specified collectionName.

Parameters:

collectionName -

Returns:

matching original inventoried collection name

Throws:

KeyNotFoundException - if no such original collection can be found, likely because collectionName is not known

getAllInventoriedCollectionNames

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