CollectionSchemaField Class

class CollectionSchemaField

Namespace:com::datalogics::PDFL

Detailed Description

Allows for the creation of collection schema field objects. Parameters that are part of a schema's field may be set.

Referenced by

CollectionSchema FileAttachment

Constructor & Destructor Documentation

CollectionSchemaField(String fieldID, SchemaFieldSubtype subtype)

Parameters

fieldID: String: the schema field ID. The ID is used during creation and extraction of the schema field. It is the unique identifier of the schema field.
subtype: SchemaFieldSubtype: the schema field subtype. The subtypes are predefined. The value of this parameter must correspond to the one of the SchemaFieldSubtype enum values.

CCollectionSchemaField allows to create CollectionSchemaField object. The constructor accepts identifier value and subtype required by the schema field.

Member Function Documentation

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

synchronized void delete()

Returns:

synchronized void

void finalize()

Returns:

void

boolean getEditable()

Returns:

boolean

whether edit mode is allowed or not.

GetEditable allows to obtain information about edit mode of the current field.

String getID()

Returns:

String

the unique field's id.

GetID allows to obtain the unique id with which schema field has been created.

int getIndex()

Returns:

int

the index of the field.

GetIndex allows to obtain field index.

String getName()

Returns:

String

the field name.

GetName allows to obtain field name.

SchemaFieldSubtype getSubtype()

Returns:

SchemaFieldSubtype

field subtype. One of the ShemaFieldSubtype enum values.

GetSubtype allows to obtain the field subtype.

boolean getVisible()

Returns:

boolean

true if current schema field is visible, false otherwise.

GetVisible allows to obtain information about filed visibility.

void setEditable(boolean isEditable)

Parameters

isEditable: boolean: pass true to allow to edit this field or false otherwise.

Returns:

void

SetEditable allows to change edit mode for shema field.Its value false by default.

void setIndex(int idx)

Parameters

idx: int: field index.

Returns:

void

SetIndex allows to set field index. NOTE: the field indexes are zero-based in ascending order without gaps.

void setName(String name)

Parameters

name: String: the new field name.

Returns:

void

SetName allows to change field name.

void setVisible(boolean isVisible)

Parameters

isVisible: boolean: the visibility flag.

Returns:

void

SetVisible allows to set field's default visibility.Its value true by default.