DASchemaDataTable

Overview

The DASchemaDataTable class represents an abstract and database-independent table object that forms an intermediate level of working with data between the given database and DataAbstract client. 


The DASchemaDataTable can be based on a hardcoded SQL statement that allows to incapsulate the quite complex logic of gaining data; it can be based on an auto SQL statement that will be dynamically generated when necessary.


The DASchemaDataTable contains a collection of the fields, statements and parameters(if they are specified for given schema table). 
Field names inside the schema data table can be different from real datatable fields in the database. The FieldMappings collection on each schema table will translate the schema field names into DB field names and vice versa.

There is no necessity to deal with the DASchemaDataTable class directly. You can create new and modify existing tables using the Schema Modeler application.

Location

 

appendClientScript:

Method that appends Client Script code to the DASchemaDataTable. See Business Rules Scripting

- (void) appendClientScript:(NSString *)script

Parameters:

  • script: Java Script code as string

appendServerScript:

Method that appends Client Script code to the DASchemaDataTable. See Business Rules Scripting

- (void) appendServerScript:(NSString *)script

Parameters:

  • script: Java Script code as String

businessClassId  retain

The property is used for implementing business rules logic on a dataset level. Used in DataAbstract for Delphi.

@property (retain) NSString *businessClassId

clientBusinessRuleScript  retain

Represents and manages Client-side business rule script. See Business Rules Scripting

@property (retain) DASchemaClientBusinessRuleScript *clientBusinessRuleScript

customAttributes  retain    (declared in DASchemaSqlObject)

@property (retain) NSString *customAttributes

deleteCommand  retain

Name of the Schema Command which will process all Delete changes

@property (retain) NSString *deleteCommand

dynamicWhere  retain    (declared in DASchemaSqlObject)

@property (retain) NSString *dynamicWhere

fieldByName:

Method returns DASchemaDataTableField instance with given name.
You can use it when need to find appropriate schema field in the schema table

- (DASchemaDataTableField *) fieldByName:(NSString *)fieldName

Parameters:

  • fieldName: Name of the schema field you need to find

fields  retain

Represents a read-only collection of the fields for the given table.

@property (retain) NSMutableArray *fields

initWithName:    (declared in DASchemaBaseObject)

Initializes a new instance of the class with a given name.

- (id) initWithName:(NSString *)aName

Parameters:

  • aName:

initWithXml:    (declared in DASchemaBaseObject)

Initializes a new instance of the class with a given XML string. Here, the XML string is the XML node from the Schema XML file that represents a certain schema object, for example the Schema Data Table or Schema Parameter. In most cases you will not need to invoke this method directly on the DASchemaBaseObject. This method is overridden in descendant classes (for example in the DASchemaDataTable) where it can be used for deserializing schema XML into a schema object.

- (id) initWithXml:(NSString *)anXml

Parameters:

  • anXml:

insertCommand  retain

Name of the Schema Command which will process all Insert changes

@property (retain) NSString *insertCommand

isPublic  assign    (declared in DASchemaSqlObject)

@property (assign) BOOL isPublic

isReadOnly  assign

Boolean flag shows does given schema table readonly or not. You will not be able to modify ReadOnly table.

@property (assign) BOOL isReadOnly

name  retain    (declared in DASchemaBaseObject)

Represents the name of the schema object. Name is a mandatory property and an exception will be raised if its value is nil or empty. Only alpha-numeric characters are allowed in the Name value.

@property (retain) NSString *name

note  retain    (declared in DASchemaBaseObject)

Description for schema object

@property (retain) NSString *note

parameterByName:    (declared in DASchemaSqlObject)

- (DASchemaParameter *) parameterByName:(NSString *)parameterName

Parameters:

  • parameterName:

parameters  retain    (declared in DASchemaSqlObject)

@property (retain) NSMutableArray *parameters

serverBusinessRuleScript  retain

Represents and manages Server-side business rule script. See Business Rules Scripting

@property (retain) DASchemaServerBusinessRuleScript *serverBusinessRuleScript

statementByName:    (declared in DASchemaSqlObject)

- (DASchemaStatement *) statementByName:(NSString *)statementName

Parameters:

  • statementName:

statements  retain    (declared in DASchemaSqlObject)

@property (retain) NSMutableArray *statements

updateCommand  retain

Name of the Schema Command which will process all Update changes

@property (retain) NSString *updateCommand

 

businessClassId  retain

The property is used for implementing business rules logic on a dataset level. Used in DataAbstract for Delphi.

@property (retain) NSString *businessClassId

clientBusinessRuleScript  retain

Represents and manages Client-side business rule script. See Business Rules Scripting

@property (retain) DASchemaClientBusinessRuleScript *clientBusinessRuleScript

customAttributes  retain    (declared in DASchemaSqlObject)

@property (retain) NSString *customAttributes

deleteCommand  retain

Name of the Schema Command which will process all Delete changes

@property (retain) NSString *deleteCommand

dynamicWhere  retain    (declared in DASchemaSqlObject)

@property (retain) NSString *dynamicWhere

fields  retain

Represents a read-only collection of the fields for the given table.

@property (retain) NSMutableArray *fields

insertCommand  retain

Name of the Schema Command which will process all Insert changes

@property (retain) NSString *insertCommand

isPublic  assign    (declared in DASchemaSqlObject)

@property (assign) BOOL isPublic

isReadOnly  assign

Boolean flag shows does given schema table readonly or not. You will not be able to modify ReadOnly table.

@property (assign) BOOL isReadOnly

name  retain    (declared in DASchemaBaseObject)

Represents the name of the schema object. Name is a mandatory property and an exception will be raised if its value is nil or empty. Only alpha-numeric characters are allowed in the Name value.

@property (retain) NSString *name

note  retain    (declared in DASchemaBaseObject)

Description for schema object

@property (retain) NSString *note

parameters  retain    (declared in DASchemaSqlObject)

@property (retain) NSMutableArray *parameters

serverBusinessRuleScript  retain

Represents and manages Server-side business rule script. See Business Rules Scripting

@property (retain) DASchemaServerBusinessRuleScript *serverBusinessRuleScript

statements  retain    (declared in DASchemaSqlObject)

@property (retain) NSMutableArray *statements

updateCommand  retain

Name of the Schema Command which will process all Update changes

@property (retain) NSString *updateCommand

 

appendClientScript:

Method that appends Client Script code to the DASchemaDataTable. See Business Rules Scripting

- (void) appendClientScript:(NSString *)script

Parameters:

  • script: Java Script code as string

appendServerScript:

Method that appends Client Script code to the DASchemaDataTable. See Business Rules Scripting

- (void) appendServerScript:(NSString *)script

Parameters:

  • script: Java Script code as String

fieldByName:

Method returns DASchemaDataTableField instance with given name.
You can use it when need to find appropriate schema field in the schema table

- (DASchemaDataTableField *) fieldByName:(NSString *)fieldName

Parameters:

  • fieldName: Name of the schema field you need to find

initWithName:    (declared in DASchemaBaseObject)

Initializes a new instance of the class with a given name.

- (id) initWithName:(NSString *)aName

Parameters:

  • aName:

initWithXml:    (declared in DASchemaBaseObject)

Initializes a new instance of the class with a given XML string. Here, the XML string is the XML node from the Schema XML file that represents a certain schema object, for example the Schema Data Table or Schema Parameter. In most cases you will not need to invoke this method directly on the DASchemaBaseObject. This method is overridden in descendant classes (for example in the DASchemaDataTable) where it can be used for deserializing schema XML into a schema object.

- (id) initWithXml:(NSString *)anXml

Parameters:

  • anXml:

parameterByName:    (declared in DASchemaSqlObject)

- (DASchemaParameter *) parameterByName:(NSString *)parameterName

Parameters:

  • parameterName:

statementByName:    (declared in DASchemaSqlObject)

- (DASchemaStatement *) statementByName:(NSString *)statementName

Parameters:

  • statementName:

Descendants