CollectionSchema Class Documentation
class CollectionSchema : SystemIDisposableNamespace:Datalogics::PDFL
- Inherits from:
SystemIDisposable
Detailed Description
Provides for adding/removing/retrieving schema fields in a collection.
Referenced by
Uses types
Property Documentation
FieldsNumber
int FieldsNumber[get]GetFieldsNumber allows to obtain fields number in the schema.
Member Function Documentation
AddField
void AddField(CollectionSchemaField field)Parameters
field: CollectionSchemaFieldCollectionSchemaField object which will be added to the schema.
Returns:
voidAddField allows to set new field to the CollectionSchema object. If the target field exists, it is overwritten.
The schema fields contain all information required to organize Collection in a certain way.
Dispose
void Dispose()Returns:
voidGetField
CollectionSchemaField GetField(int idx)Parameters
idx: intindex of the object to find.
Returns:
CollectionSchemaFieldCollectionSchemaField object if found or NULL otherwise.
GetField allows to obtain CollectionSchemaField object by its index.
GetField
CollectionSchemaField GetField(string name)Parameters
name: stringtextual field name.
Returns:
CollectionSchemaFieldCollectionSchemaField object if found or NULL otherwise.
GetField allows to obtain CollectionSchemaField by name.
RemoveField
void RemoveField(CollectionSchemaField field)Parameters
field: CollectionSchemaFieldCollectionSchemaField which will be removed from the schema.
Returns:
voidRemoveField allows to remove specified field from the schema.
NOTE: to distinguish whether specified object belongs to the schema this uses CollectionSchemaField's name.