Sirius.navigator.tools

Class MetaObjectCache

java.lang.Object

Sirius.navigator.tools.MetaObjectCache

public class MetaObjectCache
extends Object

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

therter

Method Summary

Modifier and Type	Method and Description
void	clearCache() Completely wipes the cache content.
Sirius.server.middleware.types.MetaObject[][]	clearCache(Sirius.server.middleware.types.MetaClass metaClass) DOCUMENT ME!
Sirius.server.middleware.types.MetaObject[]	clearCache(String query) Deprecated.
Sirius.server.middleware.types.MetaObject[]	clearCache(String query, String domain) Wipes the cache content for the given query and returns the cache's original content.
static MetaObjectCache	getInstance() DOCUMENT ME!
Sirius.server.middleware.types.MetaObject[]	getMetaObjectsByQuery(String query, Sirius.server.middleware.types.MetaClass metaClass, boolean forceReload, de.cismet.connectioncontext.ConnectionContext connectionContext) Get MetaObjects by query using the very same query string as one would request them from the server.
Sirius.server.middleware.types.MetaObject[]	getMetaObjectsByQuery(String query, String domain) Deprecated.
Sirius.server.middleware.types.MetaObject[]	getMetaObjectsByQuery(String query, String domain, boolean forceReload) Deprecated.
Sirius.server.middleware.types.MetaObject[]	getMetaObjectsByQuery(String query, String domain, boolean forceReload, de.cismet.connectioncontext.ConnectionContext connectionContext) Deprecated.
Sirius.server.middleware.types.MetaObject[]	getMetaObjectsByQuery(String query, String domain, de.cismet.connectioncontext.ConnectionContext connectionContext) Get MetaObjects by query using the very same query string as one would request them from the server.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MetaObjectCache getInstance()

DOCUMENT ME!

Returns:

DOCUMENT ME!

clearCache

public void clearCache()

Completely wipes the cache content.

clearCache

public Sirius.server.middleware.types.MetaObject[][] clearCache(Sirius.server.middleware.types.MetaClass metaClass)

DOCUMENT ME!

Parameters:

metaClass - DOCUMENT ME!

Returns:

DOCUMENT ME!

clearCache

@Deprecated
public Sirius.server.middleware.types.MetaObject[] clearCache(String query)

Deprecated.

DOCUMENT ME!

Parameters:

query - DOCUMENT ME!

Returns:

DOCUMENT ME!

clearCache

public Sirius.server.middleware.types.MetaObject[] clearCache(String query,
                                                              String domain)

Wipes the cache content for the given query and returns the cache's original content.

Parameters:

query - the query for which the cache shall be cleared

domain - DOCUMENT ME!

Returns:

DOCUMENT ME!

getMetaObjectsByQuery

@Deprecated
public Sirius.server.middleware.types.MetaObject[] getMetaObjectsByQuery(String query,
                                                                                     String domain)
                                                                              throws CacheException

Deprecated.

DOCUMENT ME!

Parameters:

query - DOCUMENT ME!

domain - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

CacheException - DOCUMENT ME!

getMetaObjectsByQuery

public Sirius.server.middleware.types.MetaObject[] getMetaObjectsByQuery(String query,
                                                                         String domain,
                                                                         de.cismet.connectioncontext.ConnectionContext connectionContext)
                                                                  throws CacheException

Get MetaObjects by query using the very same query string as one would request them from the server. This operation simply calls #getMetaObjectsByQuery(java.lang.String, boolean) with the given query and false for force reload. It throws an exception to indicate any errors so that it can maintain compliance with a call to ProxyInterface.getMetaObjectByQuery(java.lang.String, int) with regards to its return value.

Parameters:

query - the query to get the MetaObjects for

domain - the domai to get the MetaObjects from

connectionContext - DOCUMENT ME!

Returns:

an array of MetaObjects as they would have been returned from ConnectionProxy#getMetaObjectByQuery(java.lang.String, int) if used directly

Throws:

CacheException - if any error occurs, e.g. the server is not reachable if the cache is empty

See Also:

#getMetaObjectsByQuery(java.lang.String, boolean)

getMetaObjectsByQuery

@Deprecated
public Sirius.server.middleware.types.MetaObject[] getMetaObjectsByQuery(String query,
                                                                                     String domain,
                                                                                     boolean forceReload)
                                                                              throws CacheException

Deprecated.

DOCUMENT ME!

Parameters:

query - DOCUMENT ME!

domain - DOCUMENT ME!

forceReload - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

CacheException - DOCUMENT ME!

getMetaObjectsByQuery

public Sirius.server.middleware.types.MetaObject[] getMetaObjectsByQuery(String query,
                                                                         Sirius.server.middleware.types.MetaClass metaClass,
                                                                         boolean forceReload,
                                                                         de.cismet.connectioncontext.ConnectionContext connectionContext)
                                                                  throws CacheException

Get MetaObjects by query using the very same query string as one would request them from the server. This operation supports forcing of a reload so that callers are assured to receive a current result as it would have been returned from ProxyInterface.getMetaObjectByQuery(java.lang.String, int). It throws an exception to indicate any errors so that it can maintain compliance with a call to ProxyInterface.getMetaObjectByQuery(java.lang.String, int) with regards to its return value.

Parameters:

query - the query to get the MetaObjects for

metaClass - DOCUMENT ME!

forceReload - force a reload of the MetaObjects if they have already been cached

connectionContext - DOCUMENT ME!

Returns:

an array of MetaObjects as they would have been returned from ProxyInterface.getMetaObjectByQuery(java.lang.String, int) if used directly

Throws:

CacheException - if any error occurs, e.g. the server is not reachable if the cache is empty or was forced to reload

See Also:

ProxyInterface.getMetaObjectByQuery(java.lang.String, int)

getMetaObjectsByQuery

@Deprecated
public Sirius.server.middleware.types.MetaObject[] getMetaObjectsByQuery(String query,
                                                                                     String domain,
                                                                                     boolean forceReload,
                                                                                     de.cismet.connectioncontext.ConnectionContext connectionContext)
                                                                              throws CacheException

Deprecated.

DOCUMENT ME!

Parameters:

query - DOCUMENT ME!

domain - DOCUMENT ME!

forceReload - DOCUMENT ME!

connectionContext - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

CacheException - DOCUMENT ME!