|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataCache
Represents a client cache of the immutable metadata (class descriptions and their associated property descriptions) for all metadata objects accessed during the life of a given server connection. Using a local metadata cache decreases the time needed to access an object's immutable metadata, therefore improving the performance of client applications. Note that any independent objects that are referenced by a class description, such as choice lists, are not cached.
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
Method Summary | |
---|---|
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 |
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 ). |
Method Detail |
---|
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
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |