CollectionSchema Class Documentation
class CollectionSchemaNamespace:com::datalogics::PDFL
Detailed Description
Provides for adding/removing/retrieving schema fields in a collection.
Referenced by
Uses types
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.
delete
synchronized void delete(Boolean disposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized void delete()Returns:
synchronized voidfinalize
void finalize()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.
getFieldsNumber
int getFieldsNumber()Returns:
intthe fields number.
GetFieldsNumber allows to obtain fields number in the schema.
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.