|
| IliXML (IlvDisplay *display, const IlvPoint &at, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) |
| This constructor initializes an IliXML object. More...
|
|
void | addErrorSink (IliErrorSink *sink) |
| Adds an error sink to this table gadget. More...
|
|
void | exportDefinition () |
| Called to export a definition.
|
|
virtual IlvBitmap * | getBitmap () const |
| Returns the bitmap that is displayed during the design phase in Rogue Wave Views Data Access. More...
|
|
const char * | getDataSourceName () const |
| Returns the data source name. More...
|
|
IliErrorReporter * | getErrorReporter () const |
| Returns the error reporter that is used by the reportErrors member functions. More...
|
|
IliXMLExportModel * | getExportModel () const |
| Returns the export model. More...
|
|
const char * | getExportModelName () const |
| Returns the export model name. More...
|
|
IliXMLImportModel * | getImportModel () const |
| Returns the import model. More...
|
|
const char * | getImportModelName () const |
| Returns the import model name. More...
|
|
IlInt | getModelPropertyCount (IliXMLModelType type) const |
| Returns the model property count. More...
|
|
IlInt | getModelPropertyIndex (IliXMLModelType type, const char *name) const |
| Returns a model property index. More...
|
|
const char * | getModelPropertyName (IliXMLModelType type, IlInt index) const |
| Returns a model property name. More...
|
|
const IliValue & | getModelPropertyValue (IliXMLModelType type, const char *name) const |
| Returns a model property value. More...
|
|
const IliValue & | getModelPropertyValue (IliXMLModelType type, IlInt index) const |
| Returns a model property value. More...
|
|
IliXMLStreamModel * | getStreamModel () const |
| Returns the stream model. More...
|
|
const char * | getStreamModelName () const |
| Returns the stream model name. More...
|
|
void | importDefinition () |
| Called to import a definition.
|
|
void | importNotification () |
| Called to import a notification.
|
|
IlBoolean | isAutomaticExport () const |
| Returns IlTrue if the automatic exportation of notifications is enabled. More...
|
|
void | removeErrorSink (IliErrorSink *sink) |
| Removes an error sink from this table gadget. More...
|
|
void | reportErrors (const IliErrorList &errorList) const |
| Reports the errors that are contained in a error list. More...
|
|
void | setAutomaticExport (IlBoolean flag) |
| Enables/Disables the automatic exportation of notifications. More...
|
|
void | setDataSourceName (const char *name) |
| Sets data source name. More...
|
|
void | setErrorReporter (IliErrorReporter *reporter) |
| Sets the error reporter. More...
|
|
void | setExportModelName (const char *name) |
| Sets export model name. More...
|
|
void | setImportModelName (const char *name) |
| Sets import model name. More...
|
|
void | setModelPropertyValue (IliXMLModelType type, const char *name, const IliValue &val) |
| Sets a model property value. More...
|
|
void | setModelPropertyValue (IliXMLModelType type, IlInt index, const IliValue &val) |
| Sets a model property value. More...
|
|
void | setStreamModelName (const char *name) |
| Sets stream model name. More...
|
|
IlBoolean | hasGlobalScope () const |
| Indicates the data source scope. More...
|
|
IlBoolean | isSystemUsage () const |
| Indicates the system usage flag. More...
|
|
virtual void | setGlobalScope (IlBoolean global) |
| Specifies whether the scope of the name of the data gem is local to the container in which it is located or globally visible. More...
|
|
virtual void | usedBySystem (IlBoolean usage) |
| Specifies if the object is a system object. More...
|
|
A Model class.
Library: dbgadget
The class defines a gadget which manages the communication between a data source and a XML stream. It manages the import and export of notification and of definition.
A notification, is used to indicate a modification of the data source contents.
Data Access provides some models with a DTD but you can define your model class to implement your DTD. The default DTD is:
<!ELEMENT dataSourceNotification (primaryColumn, row*)>
<!ELEMENT primaryColumn EMPTY>
<!ELEMENT row (column*)>
<!ELEMENT column (#PCDATA)>
<!ATTLIST dataSourceNotification
name CDATA #REQUIRED
>
<!ATTLIST primaryColumn
name CDATA #REQUIRED
>
<!ATTLIST row
oldId CDATA #REQUIRED
status NOTATION(insert, change, delete) 'insert'
>
<!ATTLIST column
name CDATA #REQUIRED
>
A Definition, is used to define the data source data and to change some data source column properties.
Data Access provides some models with a DTD but you can define your model class to implement your DTD. The default DTD is:
<!ELEMENT dataSource (tableDescriptor, tableContent)>
<!ELEMENT tableDescriptor (columnDescriptor*)>
<!ELEMENT columnDescriptor(columnType, columnLook?, columnMapping?)>
<!ELEMENT columnType EMPTY>
<!ELEMENT columnLook EMPTY>
<!ELEMENT columnMapping EMPTY>
<!ELEMENT tableContent (row*)>
<!ELEMENT row (column*)>
<!ELEMENT column (#PCDATA)>
<!ATTLIST dataSource
name CDATA #REQUIRED
>
<!ATTLIST columnDescriptor
name CDATA #REQUIRED
title CDATA #IMPLIED
label CDATA #IMPLIED
>
<!ATTLIST columnType
type CDATA #REQUIRED
length CDATA #IMPLIED
key NOTATION (true, false) 'false'
nullable NOTATION (true, false) 'false'
default CDATA #IMPLIED
>
<!ATTLIST columnLook
format CDATA #IMPLIED
mask CDATA #IMPLIED
align NOTATION (left, right, center) 'left'
width CDATA #IMPLIED
readonly NOTATION (true, false) 'false'
visible NOTATION (true, false) 'true'
>
<!ATTLIST columnMapping
ds CDATA #REQUIRED
value CDATA #REQUIRED
display CDATA #REQUIRED
constrained NOTATION (true, false) 'false'
completion NOTATION (true, false) 'false'
>
- See also
IliXML
, IliModel
, IliXMLDocumentModel
.