|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.configuration.protocol.metadata.CfgMetadata
public final class CfgMetadata
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()
|
|
|
getCfgClass(java.lang.Class<T> clazz,
E cfgEnum)
Gets a descriptive class using enum value as the criteria. |
|
|
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. |
|
|
getClasses(java.lang.Class<T> clazz)
Gets set of descriptive classes. |
|
|
getEnum(CfgEnumType enumType)
Gets an enum descriptive class using enum value from |
|
|
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. |
|
|
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 |
|
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. |
|
|
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 |
|
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 |
---|
public static final java.lang.String ClientProtocolVersion
public static final int MaxProtocolVersion
public static final int MinProtocolVersion
public static final int CfgRoleProtocolVersion
public static final java.lang.String RootLocalName
public static final java.lang.String ValueAttributeName
@Deprecated public static volatile boolean useConfDataNs
@Deprecated public static volatile boolean useLocalization
Constructor Detail |
---|
public CfgMetadata() throws ProtocolException
ProtocolException
Method Detail |
---|
public int getProtocolVersion()
public java.lang.Integer getLocalizationID()
CfgLanguageLCID
public Cfglibschema getSchema() throws ProtocolException
ProtocolException
public org.w3c.dom.Element getObjectSchema()
@Deprecated public void parseObjectSchema(java.lang.String schema)
public java.util.Collection<CfgDescription> getEnums()
CfgDescriptionEnum
public java.util.Collection<CfgDescriptionClass> getClasses()
public <T extends CfgDescriptionClass> java.util.Collection<T> getClasses(java.lang.Class<T> clazz)
public <T extends CfgDescriptionClass> T getCfgClass(java.lang.String value)
public <T extends CfgDescriptionClass,E> T getCfgClass(java.lang.Class<T> clazz, E cfgEnum)
T
may be of type CfgDescriptionClass
or any of its descendants.public <T extends CfgDescriptionObject> T getObject(java.lang.Class<T> clazz, CfgObjectType objectType)
public <T extends CfgDescriptionStructure> T getStructure(java.lang.Class<T> clazz, CfgStructureType structType)
public <E extends GEnum> CfgDescriptionEnum<E> getEnum(java.lang.String name)
CfgEnumType
enumeration.public <E extends GEnum> CfgDescriptionEnum<E> getEnum(CfgEnumType enumType)
public CfgDescriptionObject getClassById(java.lang.Integer id)
id
- Used to indicate integer id of an configuration object
public static CfgKvKeysComparer getKvKeysComparer()
public static CfgValueComparer getValueComparer()
public static CfgNameComparer getNameComparer()
public static CfgNodeEqualityComparer getNodeEqualityComparer()
public static CfgBaseComparer getBaseComparer()
@Deprecated public void update(int protocolVersion)
protocolVersion
- Used to indicate particular protocol version the metadata to be adjusted to@Deprecated public static java.lang.String getNs()
public void loadLocalization(java.lang.Integer lcid, ConfStructure localization) throws ProtocolException
ProtocolException
public java.lang.String toString()
toString
in class java.lang.Object
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |