DASchema

Overview

The DASchema class represents the complete or partial data model for your server application, including the data tables and relationships between them, commands, Update Rules and other elements.

DASchema usually is serialized into .daSchema Files which can be edited by Schema Modeler application.

Location

 

alignmentTypeForName:

+ (enum DASchemaFieldValueAlignmentType) alignmentTypeForName:(NSString *)name

Parameters:

  • name:

alignmentTypes

+ (NSArray *) alignmentTypes

appendScript:

method appends given JavaScript to the Schema scripts collection

- (void) appendScript:(NSString *)script

Parameters:

  • script: JavaScript as string

blobTypeForName:

+ (enum DASchemaBlobType) blobTypeForName:(NSString *)name

Parameters:

  • name:

businessRuleScript  retain

read/write property which returns business rule script from the schema level

@property (retain) DASchemaServerBusinessRuleScript *businessRuleScript

commandByName:

Returns DASchemaCommand by given name. Command name is case sencetive. If DASchema does not have command with given name then returns nil.

- (DASchemaCommand *) commandByName:(NSString *)commandName

Parameters:

  • commandName: Name of the command we need to retrieve.

commands  retain

Represents collection of the DASchemaCommand

@property (retain) NSMutableArray *commands

customAttributes  retain

Represents custom attibutes that user can apply to given DASchema and use it later for its own purposes.

@property (retain) NSString *customAttributes

dataTypeForName:

+ (enum DADataType) dataTypeForName:(NSString *)name

Parameters:

  • name:

dataTypes

+ (NSArray *) dataTypes

failureBehaviourForName:

+ (enum DAFailureBehavior) failureBehaviourForName:(NSString *)name

Parameters:

  • name:

failureBehaviours

+ (NSArray *) failureBehaviours

initWithData:

- (InstanceType) initWithData:(NSData *)data

Parameters:

  • data:

initWithName:    (declared in DASchemaBaseObject)

- (InstanceType) initWithName:(NSString *)aName

Parameters:

  • aName:

initWithXml:    (declared in DASchemaBaseObject)

- (InstanceType) initWithXml:(NSString *)anXml

Parameters:

  • anXml:

joins  retain

Represents collection of the DASchemaJoins. Not implemented at the moment.

@property (retain) NSMutableArray *joins

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

nameOfAlignmentType:

+ (NSString *) nameOfAlignmentType:(enum DASchemaFieldValueAlignmentType)value

Parameters:

  • value:

nameOfBlobType:

+ (NSString *) nameOfBlobType:(enum DASchemaBlobType)value

Parameters:

  • value:

nameOfDataType:

+ (NSString *) nameOfDataType:(enum DADataType)value

Parameters:

  • value:

nameOfFailureBehaviour:

+ (NSString *) nameOfFailureBehaviour:(enum DAFailureBehavior)failureBehaviour

Parameters:

  • failureBehaviour:

nameOfParamType:

+ (NSString *) nameOfParamType:(enum DASchemaParamType)value

Parameters:

  • value:

nameOfRelationType:

+ (NSString *) nameOfRelationType:(enum DASchemaRelationType)value

Parameters:

  • value:

nameOfStatementType:

+ (NSString *) nameOfStatementType:(enum DASchemaStatementType)value

Parameters:

  • value:

note  retain    (declared in DASchemaBaseObject)

Description for schema object

@property (retain) NSString *note

paramTypeForName:

+ (enum DASchemaParamType) paramTypeForName:(NSString *)name

Parameters:

  • name:

paramTypes

+ (NSArray *) paramTypes

relations  retain

Represents collection of the DASchemaRelations

@property (retain) NSMutableArray *relations

relationTypeForName:

+ (enum DASchemaRelationType) relationTypeForName:(NSString *)name

Parameters:

  • name:

schemaWithData:

+ (InstanceType) schemaWithData:(NSData *)data

Parameters:

  • data:

schemaWithXml:

+ (InstanceType) schemaWithXml:(NSString *)anXml

Parameters:

  • anXml:

setTables:

- (void) setTables:(NSArray *)value

Parameters:

  • value:

statementTypeForName:

+ (enum DASchemaStatementType) statementTypeForName:(NSString *)name

Parameters:

  • name:

tableByName:

Returns DASchemaTable by given name. Table name is case sencetive. If DASchema does not have table with given name then returns nil.

- (DASchemaDataTable *) tableByName:(NSString *)tableName

Parameters:

  • tableName: Name of the table we want to retrieve

tables  retain

Represents collection of the DASchemaTables

@property (retain) NSMutableArray *tables

unions  retain

Represents collection of the DASchemaUnions

@property (retain) NSMutableArray *unions

updateRules  retain

Represents collection of the DASchemaUpdateRules

@property (retain) NSMutableArray *updateRules

version  assign

Schema version

@property (assign) int version

xmlAsData

Returns content of the DASchema as XML data stream

- (NSData *) xmlAsData

xmlAsString

Returns content of the DASchema as XML string

- (NSString *) xmlAsString

 

businessRuleScript  retain

read/write property which returns business rule script from the schema level

@property (retain) DASchemaServerBusinessRuleScript *businessRuleScript

commands  retain

Represents collection of the DASchemaCommand

@property (retain) NSMutableArray *commands

customAttributes  retain

Represents custom attibutes that user can apply to given DASchema and use it later for its own purposes.

@property (retain) NSString *customAttributes

joins  retain

Represents collection of the DASchemaJoins. Not implemented at the moment.

@property (retain) NSMutableArray *joins

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

relations  retain

Represents collection of the DASchemaRelations

@property (retain) NSMutableArray *relations

tables  retain

Represents collection of the DASchemaTables

@property (retain) NSMutableArray *tables

unions  retain

Represents collection of the DASchemaUnions

@property (retain) NSMutableArray *unions

updateRules  retain

Represents collection of the DASchemaUpdateRules

@property (retain) NSMutableArray *updateRules

version  assign

Schema version

@property (assign) int version

 

alignmentTypeForName:

+ (enum DASchemaFieldValueAlignmentType) alignmentTypeForName:(NSString *)name

Parameters:

  • name:

alignmentTypes

+ (NSArray *) alignmentTypes

blobTypeForName:

+ (enum DASchemaBlobType) blobTypeForName:(NSString *)name

Parameters:

  • name:

dataTypeForName:

+ (enum DADataType) dataTypeForName:(NSString *)name

Parameters:

  • name:

dataTypes

+ (NSArray *) dataTypes

failureBehaviourForName:

+ (enum DAFailureBehavior) failureBehaviourForName:(NSString *)name

Parameters:

  • name:

failureBehaviours

+ (NSArray *) failureBehaviours

nameOfAlignmentType:

+ (NSString *) nameOfAlignmentType:(enum DASchemaFieldValueAlignmentType)value

Parameters:

  • value:

nameOfBlobType:

+ (NSString *) nameOfBlobType:(enum DASchemaBlobType)value

Parameters:

  • value:

nameOfDataType:

+ (NSString *) nameOfDataType:(enum DADataType)value

Parameters:

  • value:

nameOfFailureBehaviour:

+ (NSString *) nameOfFailureBehaviour:(enum DAFailureBehavior)failureBehaviour

Parameters:

  • failureBehaviour:

nameOfParamType:

+ (NSString *) nameOfParamType:(enum DASchemaParamType)value

Parameters:

  • value:

nameOfRelationType:

+ (NSString *) nameOfRelationType:(enum DASchemaRelationType)value

Parameters:

  • value:

nameOfStatementType:

+ (NSString *) nameOfStatementType:(enum DASchemaStatementType)value

Parameters:

  • value:

paramTypeForName:

+ (enum DASchemaParamType) paramTypeForName:(NSString *)name

Parameters:

  • name:

paramTypes

+ (NSArray *) paramTypes

relationTypeForName:

+ (enum DASchemaRelationType) relationTypeForName:(NSString *)name

Parameters:

  • name:

schemaWithData:

+ (InstanceType) schemaWithData:(NSData *)data

Parameters:

  • data:

schemaWithXml:

+ (InstanceType) schemaWithXml:(NSString *)anXml

Parameters:

  • anXml:

statementTypeForName:

+ (enum DASchemaStatementType) statementTypeForName:(NSString *)name

Parameters:

  • name:

 

appendScript:

method appends given JavaScript to the Schema scripts collection

- (void) appendScript:(NSString *)script

Parameters:

  • script: JavaScript as string

commandByName:

Returns DASchemaCommand by given name. Command name is case sencetive. If DASchema does not have command with given name then returns nil.

- (DASchemaCommand *) commandByName:(NSString *)commandName

Parameters:

  • commandName: Name of the command we need to retrieve.

initWithData:

- (InstanceType) initWithData:(NSData *)data

Parameters:

  • data:

initWithName:    (declared in DASchemaBaseObject)

- (InstanceType) initWithName:(NSString *)aName

Parameters:

  • aName:

initWithXml:    (declared in DASchemaBaseObject)

- (InstanceType) initWithXml:(NSString *)anXml

Parameters:

  • anXml:

setTables:

- (void) setTables:(NSArray *)value

Parameters:

  • value:

tableByName:

Returns DASchemaTable by given name. Table name is case sencetive. If DASchema does not have table with given name then returns nil.

- (DASchemaDataTable *) tableByName:(NSString *)tableName

Parameters:

  • tableName: Name of the table we want to retrieve

xmlAsData

Returns content of the DASchema as XML data stream

- (NSData *) xmlAsData

xmlAsString

Returns content of the DASchema as XML string

- (NSString *) xmlAsString