CollectionSchema Class Documentation

classCollectionSchema

Namespace:com::datalogics::PDFL

Detailed Description

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

Referenced by

Collection

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

addField

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.

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getField

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.

getField

CollectionSchemaFieldgetField(Stringname)

Parameters

name: String

textual field name.

Returns:

CollectionSchemaField object if found or NULL otherwise.

GetField allows to obtain CollectionSchemaField by name.

getFieldsNumber

intgetFieldsNumber()

Returns:

the fields number.

GetFieldsNumber allows to obtain fields number in the schema.

removeField

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.