Package com.microstrategy.web.objects

Class WebProjectLookup

java.lang.Object

com.microstrategy.web.objects.WebProjectLookup

public class WebProjectLookup
extends java.lang.Object

Class facilitates quick cached lookup of project names from their DSS IDs and vice-versa. It also provides a cache lookup of project instances, and their respective localizations, if any are defined.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebProjectLookup.LocalizationType

Constructor Summary

Constructors

Constructor	Description
WebProjectLookup()

Method Summary

Modifier and Type	Method	Description
void	flush(java.lang.String serverName)	Flushes the WebIServerSession#getServerName() entry from the lookup cache.
void	flushAvailableLocalesCache(CacheHint session)
static WebProjectLookup	getInstance()
WebProjectInstance	getProject(WebIServerSession session)
java.lang.String	getProjectID(WebIServerSession session)
java.lang.String	getProjectID(WebIServerSession session, java.lang.String projectName)
WebProjectLookup.LocalizationType	getProjectLocalizationType(WebIServerSession session)
java.util.Locale[]	getProjectMessagesLocales(WebIServerSession session)
java.util.Locale[]	getProjectMetadataLocales(WebIServerSession session)
java.lang.Integer[]	getProjectMetadataLocalesLCID(WebIServerSession session)
java.lang.String	getProjectName(WebIServerSession session, java.lang.String projectDSSID)	Returns a project name from its DSS ID.
int	getProjectPrimaryDataLocaleLCID(WebIServerSession session)
int	getProjectPrimaryMetadataLocaleLCID(WebIServerSession session)
java.util.Locale[]	getProjectWarehouseDataLocales(WebIServerSession session)
java.lang.Integer[]	getProjectWarehouseDataLocalesLCID(WebIServerSession session)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebProjectLookup

public WebProjectLookup()

Method Detail

getInstance

public static WebProjectLookup getInstance()

getProjectLocalizationType

public WebProjectLookup.LocalizationType getProjectLocalizationType(WebIServerSession session)
                                                             throws WebObjectsException

Throws:

WebObjectsException

getProjectPrimaryMetadataLocaleLCID

public int getProjectPrimaryMetadataLocaleLCID(WebIServerSession session)
                                        throws WebObjectsException

Throws:

WebObjectsException

getProjectPrimaryDataLocaleLCID

public int getProjectPrimaryDataLocaleLCID(WebIServerSession session)
                                    throws WebObjectsException

Throws:

WebObjectsException

flushAvailableLocalesCache

public void flushAvailableLocalesCache(CacheHint session)

getProjectMetadataLocales

public java.util.Locale[] getProjectMetadataLocales(WebIServerSession session)
                                             throws WebObjectsException

Throws:

WebObjectsException

getProjectMetadataLocalesLCID

public java.lang.Integer[] getProjectMetadataLocalesLCID(WebIServerSession session)
                                                  throws WebObjectsException

Throws:

WebObjectsException

getProjectWarehouseDataLocales

public java.util.Locale[] getProjectWarehouseDataLocales(WebIServerSession session)
                                                  throws WebObjectsException

Throws:

WebObjectsException

getProjectWarehouseDataLocalesLCID

public java.lang.Integer[] getProjectWarehouseDataLocalesLCID(WebIServerSession session)
                                                       throws WebObjectsException

Throws:

WebObjectsException

getProjectMessagesLocales

public java.util.Locale[] getProjectMessagesLocales(WebIServerSession session)
                                             throws WebObjectsException

Throws:

WebObjectsException

getProjectID

public java.lang.String getProjectID(WebIServerSession session,
                                     java.lang.String projectName)
                              throws WebObjectsException

Parameters:

session - session to inquire project

projectName - name of the project

Returns:

project DSS ID

Throws:

MSTRUncheckedException - thrown if there is a problem obtaining the project ID

WebObjectsException

getProjectID

public java.lang.String getProjectID(WebIServerSession session)
                              throws WebObjectsException

Throws:

WebObjectsException

getProjectName

public java.lang.String getProjectName(WebIServerSession session,
                                       java.lang.String projectDSSID)
                                throws WebObjectsException

Returns a project name from its DSS ID. The name is localized according to the session metadata locale. WebObjectsException is thrown if no project is found.

Parameters:

session -

projectDSSID -

Returns:

a localized project name

Throws:

WebObjectsException - thrown if a problem is encountered

flush

public void flush(java.lang.String serverName)

Flushes the WebIServerSession#getServerName() entry from the lookup cache. Subsequent project lookups to this server will repopulate the cache from the Intelligence Server. If no serverName is specified, then the entire cache is flushed.

getProject

public WebProjectInstance getProject(WebIServerSession session)
                              throws WebObjectsException

Throws:

WebObjectsException