|
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.applicationblocks.com.CfgBase
public abstract class CfgBase
The parent class for all configuration objects categories including configuration objects child structures and classes.
Constructor Summary | |
---|---|
protected |
CfgBase(IConfService confService,
ConfObjectBase confObjectData,
boolean isSaved,
ICfgObject parent)
This constructor is used from particular wrapping objects and structures for data initialization from external DOM structure. |
Method Summary | |
---|---|
CfgBase |
clone()
|
protected void |
ensureDataBackup()
This internal method is designed for "lazy initialization" of DOM data backup. |
boolean |
equals(java.lang.Object obj)
|
protected void |
flushChildrenContent()
|
IConfService |
getConfigurationService()
Used to access the configuration cfgService that this object was created with. |
org.w3c.dom.Node |
getData()
Deprecated. |
Endpoint |
getEndpoint()
Provides the location of the server to which this object belongs. |
java.util.Collection<java.lang.Integer> |
getLinkListCollection(java.lang.String propertyName)
|
protected java.lang.Integer |
getLinkValue(java.lang.String propertyName)
|
protected ILogger |
getLogger()
|
CfgDescriptionClass |
getMetaData()
Internal method to provide XML data manipulation functions with information about objects' properties. |
protected ICfgObject |
getParent()
Used to retrieve reference to the parent of the current configuration object structure. |
protected java.lang.Object |
getProperty(java.lang.Class<?> retClass,
java.lang.String propertyName)
This method is used to get any configuration object's property using its string name. |
protected java.lang.Object |
getProperty(java.lang.Class<?> retClass,
java.lang.String propertyName,
boolean resolveLinks)
This method is used to get any configuration object's property using its string name. |
java.lang.Object |
getProperty(java.lang.String propertyName)
This method is used to get any configuration object's property using its string name. |
ConfObjectBase |
getRawObjectData()
Returns reference to the underlying configuration protocol object structure. |
int |
hashCode()
|
protected void |
initStruct(ConfObjectBase confObjectData,
ICfgObject parent)
|
boolean |
isSaved()
Positive object saved state means that the object is read from the server or it is locally created and then successfully saved. |
protected java.util.concurrent.locks.ReadWriteLock |
lockObject()
|
protected void |
reloadObjectWithNewData(ConfObject newObject)
|
protected ICfgObject |
resolveLink(CfgObjectType objectType,
int dbid)
|
void |
setProperty(java.lang.String propertyName,
java.lang.Object value)
This method is used to set any configuration object's property using its string name. |
java.lang.String |
toString()
Returns a string representation of the configuration information. |
protected java.lang.StringBuilder |
toStringProperties()
|
org.w3c.dom.Node |
toXml()
Used to represent configuration object or structure to XML. |
protected void |
updateChildrenSavedState()
|
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected CfgBase(IConfService confService, ConfObjectBase confObjectData, boolean isSaved, ICfgObject parent)
confService
- a reference to Configuration ServiceconfObjectData
- tree with configuration object dataisSaved
- saved object state flagparent
- for a structure, a reference to its parentMethod Detail |
---|
protected void initStruct(ConfObjectBase confObjectData, ICfgObject parent)
protected final ILogger getLogger()
protected final java.util.concurrent.locks.ReadWriteLock lockObject()
public final IConfService getConfigurationService()
public final Endpoint getEndpoint()
getEndpoint
in interface ICfgBase
public org.w3c.dom.Node toXml()
Node newNode = cfgObject.toXml();
doc.adoptNode(newNode);
doc.appendChild(newNode);
toXml
in interface ICfgBase
protected ICfgObject getParent()
public final boolean isSaved()
@Deprecated public final org.w3c.dom.Node getData()
toXml()
public ConfObjectBase getRawObjectData()
getRawObjectData
in interface ICfgBase
protected void reloadObjectWithNewData(ConfObject newObject)
protected void flushChildrenContent()
public final CfgDescriptionClass getMetaData()
protected java.lang.Integer getLinkValue(java.lang.String propertyName)
public java.util.Collection<java.lang.Integer> getLinkListCollection(java.lang.String propertyName)
public java.lang.Object getProperty(java.lang.String propertyName)
getProperty
in interface ICfgBase
propertyName
- The name of the property
protected java.lang.Object getProperty(java.lang.Class<?> retClass, java.lang.String propertyName)
retClass
- class of return object - used to handle configuration
protocol enumeration types Conf* (extending GEnum)propertyName
- The name of the property
protected java.lang.Object getProperty(java.lang.Class<?> retClass, java.lang.String propertyName, boolean resolveLinks)
retClass
- class of return object - used to handle configuration
protocol enumeration types Conf* (extending GEnum)propertyName
- The name of the property
public void setProperty(java.lang.String propertyName, java.lang.Object value)
setProperty
in interface ICfgBase
propertyName
- The name of the propertyvalue
- New property value
java.lang.NullPointerException
- if property new value is null.
ConfigRuntimeException
- if there is some problem with the attribute or value for it
(see message or inner exception for details).protected ICfgObject resolveLink(CfgObjectType objectType, int dbid) throws ConfigException
ConfigException
protected void ensureDataBackup()
protected void updateChildrenSavedState()
public java.lang.String toString()
toString
in class java.lang.Object
protected java.lang.StringBuilder toStringProperties()
public CfgBase clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
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 |