CollectionSchema Class

classCollectionSchema : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

Provides for adding/removing/retrieving schema fields in a collection.

Referenced by

Collection CollectionSchema

Uses types

CollectionSchema CollectionSchemaField

Constructor & Destructor Documentation

CollectionSchema(CollectionSchemarhs, InternalConstructsignifier)

Parameters

rhs: CollectionSchema
signifier: InternalConstruct

~CollectionSchema()

Property Documentation

intFieldsNumber[get]

Member Function Documentation

voidAddField(CollectionSchemaFieldfield)

Parameters

field: CollectionSchemaField: CollectionSchemaField object which will be added to the schema.

Returns:

void

AddField 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.

static CollectionSchemaConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

CollectionSchema

voidDispose()

Returns:

void

voidDisposeChildren()

Returns:

void

CollectionSchemaFieldGetField(intidx)

Parameters

idx: int: index of the object to find.

Returns:

CollectionSchemaField object if found or NULL otherwise.

GetField allows to obtain CollectionSchemaField object by its index.

CollectionSchemaFieldGetField(stringname)

Parameters

name: string: textual field name.

Returns:

CollectionSchemaField object if found or NULL otherwise.

GetField allows to obtain CollectionSchemaField by name.

voidRemoveField(CollectionSchemaFieldfield)

Parameters

field: CollectionSchemaField: CollectionSchemaField which will be removed from the schema.

Returns:

void

RemoveField allows to remove specified field from the schema.

NOTE: to distinguish whether specified object belongs to the schema this uses CollectionSchemaField's name.