Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.metadata
Class CfgMetadata

java.lang.Object
  extended by com.genesyslab.platform.configuration.protocol.metadata.CfgMetadata

public final class CfgMetadata
extends java.lang.Object

CfgMetadata final class is the source of and entry point to all configuration object descriptive data. The metadata functionality is intended to enhance Configuration Protocol Sdk by providing for user applications means for programmatical analyzing and processing of Configuration Objects Data.

All the various descriptive data contained in the metadata is to be used as a read-only set of descriptive objects providing descriptive information about configuration objects.


Field Summary
static int CfgRoleProtocolVersion
           
static java.lang.String ClientProtocolVersion
           
static int MaxProtocolVersion
           
static int MinProtocolVersion
           
static java.lang.String RootLocalName
           
static boolean useConfDataNs
          Deprecated.  
static boolean useLocalization
          Deprecated.  
static java.lang.String ValueAttributeName
           
 
Constructor Summary
CfgMetadata()
           
 
Method Summary
static CfgBaseComparer getBaseComparer()
           
<T extends CfgDescriptionClass,E>
T
getCfgClass(java.lang.Class<T> clazz, E cfgEnum)
          Gets a descriptive class using enum value as the criteria.
<T extends CfgDescriptionClass>
T
getCfgClass(java.lang.String value)
          Gets a descriptive class using name as the criteria.
 CfgDescriptionObject getClassById(java.lang.Integer id)
          Gets a configuration object's descriptive class.
 java.util.Collection<CfgDescriptionClass> getClasses()
          Gets the full set of class descriptions.
<T extends CfgDescriptionClass>
java.util.Collection<T>
getClasses(java.lang.Class<T> clazz)
          Gets set of descriptive classes.
<E extends GEnum>
CfgDescriptionEnum<E>
getEnum(CfgEnumType enumType)
          Gets an enum descriptive class using enum value from CfgEnumType as the criteria.
<E extends GEnum>
CfgDescriptionEnum<E>
getEnum(java.lang.String name)
          Gets an enum descriptive class using name as the criteria.
 java.util.Collection<CfgDescription> getEnums()
          Gets the set of enum descriptions.
static CfgKvKeysComparer getKvKeysComparer()
           
 java.lang.Integer getLocalizationID()
          Returns Localization ID of initialized localization data on this Metadata instance or null.
static CfgNameComparer getNameComparer()
           
static CfgNodeEqualityComparer getNodeEqualityComparer()
           
static java.lang.String getNs()
          Deprecated.  
<T extends CfgDescriptionObject>
T
getObject(java.lang.Class<T> clazz, CfgObjectType objectType)
          Gets a descriptive class for either configuration object or delta object (depending on value of generic parameter T) using enum value as the criteria.
 org.w3c.dom.Element getObjectSchema()
          Returns configuration server schema data.
 int getProtocolVersion()
          Gets protocol version the metadata is reflecting.
 Cfglibschema getSchema()
          Returns bound structure with configuration server schema information.
<T extends CfgDescriptionStructure>
T
getStructure(java.lang.Class<T> clazz, CfgStructureType structType)
          Gets a descriptive class for either configuration structure or delta structure (depending on value of generic parameter T) using enum value as the criteria.
static CfgValueComparer getValueComparer()
           
 void loadLocalization(java.lang.Integer lcid, ConfStructure localization)
          Initializes configuration Metadata descriptions with localization data.
 void parseObjectSchema(java.lang.String schema)
          Deprecated.  
 java.lang.String toString()
           
 void update(int protocolVersion)
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ClientProtocolVersion

public static final java.lang.String ClientProtocolVersion
See Also:
Constant Field Values

MaxProtocolVersion

public static final int MaxProtocolVersion
See Also:
Constant Field Values

MinProtocolVersion

public static final int MinProtocolVersion
See Also:
Constant Field Values

CfgRoleProtocolVersion

public static final int CfgRoleProtocolVersion
See Also:
Constant Field Values

RootLocalName

public static final java.lang.String RootLocalName
See Also:
Constant Field Values

ValueAttributeName

public static final java.lang.String ValueAttributeName
See Also:
Constant Field Values

useConfDataNs

@Deprecated
public static volatile boolean useConfDataNs
Deprecated. 

useLocalization

@Deprecated
public static volatile boolean useLocalization
Deprecated. 
Constructor Detail

CfgMetadata

public CfgMetadata()
            throws ProtocolException
Throws:
ProtocolException
Method Detail

getProtocolVersion

public int getProtocolVersion()
Gets protocol version the metadata is reflecting.


getLocalizationID

public java.lang.Integer getLocalizationID()
Returns Localization ID of initialized localization data on this Metadata instance or null.

Returns:
LCID of localization initialized, or null.
See Also:
CfgLanguageLCID

getSchema

public Cfglibschema getSchema()
                       throws ProtocolException
Returns bound structure with configuration server schema information.

Note: This method is for internal use only.

Returns:
configuration schema
Throws:
ProtocolException

getObjectSchema

public org.w3c.dom.Element getObjectSchema()
Returns configuration server schema data.

Note: This method is for internal use only.

Returns:
configuration schema

parseObjectSchema

@Deprecated
public void parseObjectSchema(java.lang.String schema)
Deprecated. 

This method is for internal use only.


getEnums

public java.util.Collection<CfgDescription> getEnums()
Gets the set of enum descriptions.

Returns:
Returns set of enum descriptive classes
See Also:
CfgDescriptionEnum

getClasses

public java.util.Collection<CfgDescriptionClass> getClasses()
Gets the full set of class descriptions.

Returns:
Returns set of class' descriptive classes

getClasses

public <T extends CfgDescriptionClass> java.util.Collection<T> getClasses(java.lang.Class<T> clazz)
Gets set of descriptive classes.

Returns:
Returns set of descriptive classes where T may be of type CfgDescriptionClass or any of its descendants

getCfgClass

public <T extends CfgDescriptionClass> T getCfgClass(java.lang.String value)
Gets a descriptive class using name as the criteria.

Returns:
Returns a descriptive class as <T>, or null if such a class was not found, where T may be of type CfgDescriptionClass or any of its descendants

getCfgClass

public <T extends CfgDescriptionClass,E> T getCfgClass(java.lang.Class<T> clazz,
                                                       E cfgEnum)
Gets a descriptive class using enum value as the criteria.

Returns:
Returns a descriptive class as <T> or null if such a class was not found. Where T may be of type CfgDescriptionClass or any of its descendants.

getObject

public <T extends CfgDescriptionObject> T getObject(java.lang.Class<T> clazz,
                                                    CfgObjectType objectType)
Gets a descriptive class for either configuration object or delta object (depending on value of generic parameter T) using enum value as the criteria.

Returns:
a descriptive class for an object or delta object as <T> or null if such a class was not found. where T may be of type CfgDescriptionObject or CfgDescriptionObjectDelta.

getStructure

public <T extends CfgDescriptionStructure> T getStructure(java.lang.Class<T> clazz,
                                                          CfgStructureType structType)
Gets a descriptive class for either configuration structure or delta structure (depending on value of generic parameter T) using enum value as the criteria.

Returns:
a descriptive class for a structure or delta structure as <T> or null if such a class was not found. where T may be of type CfgDescriptionStructure or CfgDescriptionStructureDelta.

getEnum

public <E extends GEnum> CfgDescriptionEnum<E> getEnum(java.lang.String name)
Gets an enum descriptive class using name as the criteria.

Returns:
Returns an enum descriptive class as <E> or null if such a class was not found. where E may be one of enum types listed in the CfgEnumType enumeration.

getEnum

public <E extends GEnum> CfgDescriptionEnum<E> getEnum(CfgEnumType enumType)
Gets an enum descriptive class using enum value from CfgEnumType as the criteria.

Returns:
Returns an enum descriptive class as <E> or null if such a class was not found. where E may be one of enum types listed in the CfgEnumType enumeration.

getClassById

public CfgDescriptionObject getClassById(java.lang.Integer id)
Gets a configuration object's descriptive class.

Parameters:
id - Used to indicate integer id of an configuration object
Returns:
Returns the configuration object's descriptive class as CfgDescriptionObject, or null if the attribute is not found.

getKvKeysComparer

public static CfgKvKeysComparer getKvKeysComparer()

getValueComparer

public static CfgValueComparer getValueComparer()

getNameComparer

public static CfgNameComparer getNameComparer()

getNodeEqualityComparer

public static CfgNodeEqualityComparer getNodeEqualityComparer()

getBaseComparer

public static CfgBaseComparer getBaseComparer()

update

@Deprecated
public void update(int protocolVersion)
Deprecated. 

Updates metadata to be adjusted to a particular protocol version.

Note: This method is for internal use only.

Parameters:
protocolVersion - Used to indicate particular protocol version the metadata to be adjusted to

getNs

@Deprecated
public static java.lang.String getNs()
Deprecated. 

Returns:
configuration server protocol namespace.

loadLocalization

public void loadLocalization(java.lang.Integer lcid,
                             ConfStructure localization)
                      throws ProtocolException
Initializes configuration Metadata descriptions with localization data.

Note: This method is for internal use only.

Throws:
ProtocolException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.