DAInternalFieldDefinition
Overview
This class represents internal hidden fields, for example fields that handle cached value and its version for cached calculated fields
Location
- Reference: DAInternalFieldDefinition.h
- Namespace: DataAbstract
- Ancestry: NSObject | DAFieldDefinition | DAInternalFieldDefinition
attributeType (declared in DAFieldDefinition)
- (NSAttributeType) attributeType
autoIncrement (declared in DAFieldDefinition)
- (BOOL) autoIncrement
dataType (declared in DAFieldDefinition)
Specifies the Data Type for the field.
@property (readonly) enum DADataType dataType
dataTypeName (declared in DAFieldDefinition)
Returns the readable name of the fields data type, as defined by the dataType
property.
@property (readonly) NSString *dataTypeName
initWithTable: (declared in DAFieldDefinition)
- (InstanceType) initWithTable:(DADataTable *)ownerTable
Parameters:
- ownerTable:
initWithTable:andSchema: (declared in DAFieldDefinition)
- (InstanceType) initWithTable:(DADataTable *)ownerTable andSchema:(DASchemaDataTableField *)schemaField
Parameters:
- ownerTable:
- schemaField:
initWithTable:name: (declared in DAFieldDefinition)
- (InstanceType) initWithTable:(DADataTable *)ownerTable name:(NSString *)fieldName
Parameters:
- ownerTable:
- fieldName:
name (declared in DAFieldDefinition)
Specifies the uniqe name of the field within the data table. The field can be queried by this name using KVC's valueForKey:
and setValue:forKey:
methods on the individual DADataTableRows.
@property (readonly) NSString *name
position (declared in DAFieldDefinition)
Returns the position or index of the field within the data table. This is mainly for internal use; regular field access should use the name
and not rely on position
.
@property (readonly) NSInteger position
predicateEditorRowTemplateForName:type: (declared in DAFieldDefinition)
+ (NSPredicateEditorRowTemplate *) predicateEditorRowTemplateForName:(NSString *)name type:(NSAttributeType)type
Parameters:
- name:
- type:
predicateEditorRowTemplates (declared in DAFieldDefinition)
Returns an array with one or more NSPredicateEditorRowTemplates that match the field definition, for use in an NSPredicateEditor. Usually, you will not call 'send this message' to an individual field, but use the DADataTable's defaultPredicateEditorRowTemplates
method. See also Working with NSPredicateEditor (Xcode).
- (NSArray *) predicateEditorRowTemplates
predicateEditorRowTemplateStandardOperators (declared in DAFieldDefinition)
+ (NSArray *) predicateEditorRowTemplateStandardOperators
properties (declared in DAFieldDefinition)
Provides access to various properties of the field as defined in the server's Schema.
@property (readonly) NSDictionary *properties
setDataType: (declared in DAFieldDefinition)
- (void) setDataType:(enum DADataType)aType
Parameters:
- aType:
setPosition: (declared in DAFieldDefinition)
- (void) setPosition:(NSInteger)aPosition
Parameters:
- aPosition:
setProperty:toValue: (declared in DAFieldDefinition)
Updates a property stored in the properties
list.
- (void) setProperty:(NSString *)propertyName toValue:(NSString *)propertyValue
Parameters:
- propertyName: name of the property for which we want to set new value
- propertyValue: new value we want to set.
table (declared in DAFieldDefinition)
Returns a reference to the DADataTable that contains this field.
@property (readonly) DADataTable *table
valueForRow: (declared in DAFieldDefinition)
- (id) valueForRow:(DADataTableRow *)row
Parameters:
- row:
visible assign (declared in DAFieldDefinition)
Specifies whether this field should be visible in user interfaces. This property is not used directly by the Data Abstract framework, but can be queried by user interface code to determine whether to see the field (for example in a table view or a field picker) or not. visible
will be initialized based on the value set in the Schema, server-side, but can be changed within the client, if necessary.
@property (assign) BOOL visible
dataType (declared in DAFieldDefinition)
Specifies the Data Type for the field.
@property (readonly) enum DADataType dataType
dataTypeName (declared in DAFieldDefinition)
Returns the readable name of the fields data type, as defined by the dataType
property.
@property (readonly) NSString *dataTypeName
name (declared in DAFieldDefinition)
Specifies the uniqe name of the field within the data table. The field can be queried by this name using KVC's valueForKey:
and setValue:forKey:
methods on the individual DADataTableRows.
@property (readonly) NSString *name
position (declared in DAFieldDefinition)
Returns the position or index of the field within the data table. This is mainly for internal use; regular field access should use the name
and not rely on position
.
@property (readonly) NSInteger position
properties (declared in DAFieldDefinition)
Provides access to various properties of the field as defined in the server's Schema.
@property (readonly) NSDictionary *properties
table (declared in DAFieldDefinition)
Returns a reference to the DADataTable that contains this field.
@property (readonly) DADataTable *table
visible assign (declared in DAFieldDefinition)
Specifies whether this field should be visible in user interfaces. This property is not used directly by the Data Abstract framework, but can be queried by user interface code to determine whether to see the field (for example in a table view or a field picker) or not. visible
will be initialized based on the value set in the Schema, server-side, but can be changed within the client, if necessary.
@property (assign) BOOL visible
predicateEditorRowTemplateForName:type: (declared in DAFieldDefinition)
+ (NSPredicateEditorRowTemplate *) predicateEditorRowTemplateForName:(NSString *)name type:(NSAttributeType)type
Parameters:
- name:
- type:
predicateEditorRowTemplateStandardOperators (declared in DAFieldDefinition)
+ (NSArray *) predicateEditorRowTemplateStandardOperators
attributeType (declared in DAFieldDefinition)
- (NSAttributeType) attributeType
autoIncrement (declared in DAFieldDefinition)
- (BOOL) autoIncrement
initWithTable: (declared in DAFieldDefinition)
- (InstanceType) initWithTable:(DADataTable *)ownerTable
Parameters:
- ownerTable:
initWithTable:andSchema: (declared in DAFieldDefinition)
- (InstanceType) initWithTable:(DADataTable *)ownerTable andSchema:(DASchemaDataTableField *)schemaField
Parameters:
- ownerTable:
- schemaField:
initWithTable:name: (declared in DAFieldDefinition)
- (InstanceType) initWithTable:(DADataTable *)ownerTable name:(NSString *)fieldName
Parameters:
- ownerTable:
- fieldName:
predicateEditorRowTemplates (declared in DAFieldDefinition)
Returns an array with one or more NSPredicateEditorRowTemplates that match the field definition, for use in an NSPredicateEditor. Usually, you will not call 'send this message' to an individual field, but use the DADataTable's defaultPredicateEditorRowTemplates
method. See also Working with NSPredicateEditor (Xcode).
- (NSArray *) predicateEditorRowTemplates
setDataType: (declared in DAFieldDefinition)
- (void) setDataType:(enum DADataType)aType
Parameters:
- aType:
setPosition: (declared in DAFieldDefinition)
- (void) setPosition:(NSInteger)aPosition
Parameters:
- aPosition:
setProperty:toValue: (declared in DAFieldDefinition)
Updates a property stored in the properties
list.
- (void) setProperty:(NSString *)propertyName toValue:(NSString *)propertyValue
Parameters:
- propertyName: name of the property for which we want to set new value
- propertyValue: new value we want to set.
valueForRow: (declared in DAFieldDefinition)
- (id) valueForRow:(DADataTableRow *)row
Parameters:
- row: