|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is the registry holding all XML dialect implementations (Data-Model modules) loaded for an XO environment. It initializes core DM modules and provides many methods to access data useful in creating and handling DM instances.
Method Summary | |
XoObject |
createXoObject(java.lang.String nsref,
java.lang.String element)
Creates a new instance of XO object giving its namespace nsref for param element .
|
XoCustomizerInfos[] |
getCustomizers(XoObject xo)
return specific customizers usable to edit XO object xo . |
XoDMInstance |
getDataModelDocument(java.lang.String nsref)
Returns the DMDL document describing Data-Model for namespace nsref |
XoDMInstance[] |
getDataModelDocuments()
Returns the DMDL document list of all loaded DM modules |
java.net.URL |
getDMLocation(java.lang.String nsref)
Gets the location URL of either a DMDL document describing a DM module or a jar containing the module loaded for namespace nsref |
XdtBidiMap |
getEntityCatalog(java.lang.String nsref)
Returns the entities defined in namespace nsref |
XoEnvironment |
getEnvironment()
Returns the XO environment owner of this registry. |
java.lang.String |
getIdName(XoObject xo)
Returns the ID property name of param xo . |
XoProperty[] |
getProperties(XoObject xo)
Returns the list of property wrappers defined for param xo . |
XoProperty |
getProperty(XoObject xo,
java.lang.String pName)
Returns the wrapper of property named pName for param xo . |
XoProperty |
getPropertyByXml(XoObject xo,
java.lang.String xmlName)
Returns the wrapper of property whose XML attribute equivalent is named xmlName
for param xo . |
int |
getPropertyCount(XoObject xo)
Returns the number of properties defined for param xo . |
java.lang.String |
getType(XoObject xo)
returns the element type of param xo . |
boolean |
hasDataModel(java.lang.String nsref)
Checks whether a data-model module is loaded for namespace nsref . |
java.lang.String |
loadDataModel(java.net.URL jarUrl)
Loads the dialect implementation (DM module) in jar format located in URL param jarUrl . |
java.lang.String |
loadDataModel(XoDMInstance dm)
Loads the DM module described in param dm in DMDL format. |
void |
unloadDataModel(java.lang.String nsref)
Unloads DM module identified by nsref . |
Method Detail |
public XoEnvironment getEnvironment()
public boolean hasDataModel(java.lang.String nsref)
nsref
.
nsref
public XdtBidiMap getEntityCatalog(java.lang.String nsref) throws XoException
nsref
XoException
- if no module was loaded for namespace nsref
public java.lang.String getType(XoObject xo) throws XoException
xo
. This string permits to distinguish
an implementation from several ones of a single element
XoException
public XoCustomizerInfos[] getCustomizers(XoObject xo) throws XoException
xo
. In Xotics API,
an XO object, as a JavaBean, can have several java.beans.Customizer
classes.
xo
- XO object whose specific customizers are requested
XoCustomizerInfos
objects which contains customizer class
and associated display label.
array is empty if no customizer was specified
XoException
public java.lang.String loadDataModel(java.net.URL jarUrl) throws XoException
jarUrl
.
XoException
- if any error occurred during module loadingpublic java.lang.String loadDataModel(XoDMInstance dm) throws XoException
dm
in DMDL format. It is supposed that
all classes defined in DMDL document are already accessible by Xotics Environment class loader (XoEnvironment.getClassLoader()
).
XoException
- if any error occurred during module loading, including a DM instance which is
not in DMDL format.public void unloadDataModel(java.lang.String nsref) throws XoException
nsref
.
nsref
- the namespace of dialect implementation to unload.
XoException
- if no DM module corresponds to nsref
or if Data-Model is not allowed to be unloaded.public XoObject createXoObject(java.lang.String nsref, java.lang.String element) throws XoException
nsref
for param element
.
This method is not mandatory to create a new XO object, but it handles XoPolymorphWrapper
for multi-implemented XML elements.
XoException
- if an error occurred during object loading, or if such object doesn't existpublic XoDMInstance getDataModelDocument(java.lang.String nsref) throws XoException
nsref
XoDMInstance
object containing the DMDL document
XoException
- if no module was loaded for namespace nsref
public XoDMInstance[] getDataModelDocuments()
XoDMInstance
public java.net.URL getDMLocation(java.lang.String nsref) throws XoException
nsref
nsref
XoException
public XoProperty[] getProperties(XoObject xo) throws XoException
xo
.
xo
XoException
- if xo
is null or a polymorph wrapper,
or if no module was found for namespace provided by xo
public int getPropertyCount(XoObject xo) throws XoException
xo
.
xo
XoException
- if xo
is null or a polymorph wrapper,
or if no module was found for namespace provided by xo
public XoProperty getProperty(XoObject xo, java.lang.String pName) throws XoException
pName
for param xo
.
XoException
- if xo
is null or a polymorph wrapper,
or if no module was found for namespace provided by xo
public java.lang.String getIdName(XoObject xo)
xo
.
public XoProperty getPropertyByXml(XoObject xo, java.lang.String xmlName) throws XoException
xmlName
for param xo
.
XoException
- if xo
is null or a polymorph wrapper,
or if no module was found for namespace provided by xo
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |