public interface MetadataCache
Only a single, default metadata cache is available for a given server connection, which
you can access by calling getDefaultInstance()
on the Factory.MetadataCache
class. This cache is also used internally. Metadata caching is enabled by default; to disable it, set
the ConfigurationParameter.CLIENT_METADATA_CACHE
instance to Boolean.FALSE
.
ConfigurationParameter
Modifier and Type | Method and Description |
---|---|
void |
clear()
Removes all entries currently resident in the metadata cache.
|
void |
clear(Connection conn)
Removes all entries currently resident in the metadata cache.
|
boolean |
describedIsOfClass(ClassDescription cd,
java.lang.String classIdent)
Returns whether a class description describes the class or subclass identified by a
given class name or GUID string (
true ) or not (false ). |
ClassDescription |
getClassDescription(EngineObject eo)
Returns the class description for a given object.
|
ClassDescription |
getClassDescription(InstantiatingScope scope,
java.lang.String classIdent)
Returns the class description for a given class and scope.
|
ClassDescription[] |
getClassDescriptions(InstantiatingScope scope,
java.lang.String[] classIdents)
Returns zero or more class descriptions for a given scope and the classes specified by
a class identities array, which can contain both class names and GUID strings.
|
boolean |
isEnabled()
The
MetadataCache is enabled by default for Content Engine clients and disabled
by default for the Content Engine server. |
boolean |
objectIsOfClass(EngineObject eo,
java.lang.String classIdent)
Returns whether an object is instantiated from a class or subclass identified by a
given class name or GUID string (
true ) or not (false ). |
ClassDescription getClassDescription(InstantiatingScope scope, java.lang.String classIdent)
scope
- An InstantiatingScope
object specifying the scope of the
class description.classIdent
- A String
specifying the name or GUID string of the class.ClassDescription
object.ClassDescription[] getClassDescriptions(InstantiatingScope scope, java.lang.String[] classIdents)
null
and its members are always valid class
descriptions. Potentially, this operation is much more efficient than retrieving
individual class descriptions because any non-resident class descriptions are fetched
from the server in a single batch operation.scope
- An InstantiatingScope
object specifying the scope of the
class descriptions.classIdents
- A String
array specifying the class names or GUID strings
of the class descriptions.ClassDescription
objects.ClassDescription getClassDescription(EngineObject eo)
eo
- An EngineObject
object.ClassDescription
object.boolean objectIsOfClass(EngineObject eo, java.lang.String classIdent)
true
) or not (false
). Class
descriptions are fetched from the server and added to the metadata cache as needed.eo
- An EngineObject
object.classIdent
- A String
specifying the name or GUID string of the class.true
if the object specified by eo
is instantiated
from the class specified by classIdent
; otherwise, returns false
.boolean describedIsOfClass(ClassDescription cd, java.lang.String classIdent)
true
) or not (false
). Class
descriptions are fetched from the server and added to the metadata cache as needed.cd
- A ClassDescription
object.classIdent
- A String
specifying the name or GUID string of the class.true
if the class description specified by cd
describes the
class or subclass identified by classIdent
; otherwise, returns false
.void clear()
void clear(Connection conn)
conn
- A Connection> object.
boolean isEnabled()
MetadataCache
is enabled by default for Content Engine clients and disabled
by default for the Content Engine server. This method provides a simple way for
applications to detect whether the MetadataCache
is enabled at any point in time.true
if the MetadataCache
is enabled; otherwise, returns false
.© Copyright IBM Corporation 2006, 2015. All rights reserved.