Package com.datalogics.PDFL

Class CollectionSchemaField

java.lang.Object
com.datalogics.PDFL.CollectionSchemaField
public class CollectionSchemaField extends Object
Allows for the creation of collection schema field objects. Parameters that are part of a schema's field may be set.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CollectionSchemaField(String fieldID, SchemaFieldSubtype subtype)
    CCollectionSchemaField allows to create CollectionSchemaField object.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
     
    boolean
    getEditable()
    GetEditable allows to obtain information about edit mode of the current field.
    String
    getID()
    GetID allows to obtain the unique id with which schema field has been created.
    int
    getIndex()
    GetIndex allows to obtain field index.
    String
    getName()
    GetName allows to obtain field name.
    SchemaFieldSubtype
    getSubtype()
    GetSubtype allows to obtain the field subtype.
    boolean
    getVisible()
    GetVisible allows to obtain information about filed visibility.
    void
    setEditable(boolean isEditable)
    SetEditable allows to change edit mode for shema field. Its value false by default.
    void
    setIndex(int idx)
    SetIndex allows to set field index.
    void
    setName(String name)
    SetName allows to change field name.
    void
    setVisible(boolean isVisible)
    SetVisible allows to set field's default visibility. Its value true by default.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CollectionSchemaField

      public CollectionSchemaField(String fieldID, SchemaFieldSubtype subtype)
      CCollectionSchemaField allows to create CollectionSchemaField object. The constructor accepts identifier value and subtype required by the schema field.

      Parameters:
      fieldID - 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 - the schema field subtype. The subtypes are predefined. The value of this parameter must correspond to the one of the SchemaFieldSubtype enum values.

  • Method Details

    • delete

      public void delete()

    • getID

      public String getID()
      GetID allows to obtain the unique id with which schema field has been created.
      Returns:
      the unique field's id.

    • getName

      public String getName()
      GetName allows to obtain field name.
      Returns:
      the field name.

    • setName

      public void setName(String name)
      SetName allows to change field name.
      Parameters:
      name - the new field name.

    • getSubtype

      public SchemaFieldSubtype getSubtype()
      GetSubtype allows to obtain the field subtype.
      Returns:
      field subtype. One of the ShemaFieldSubtype enum values.

    • setIndex

      public void setIndex(int idx)
      SetIndex allows to set field index. NOTE: the field indexes are zero-based in ascending order without gaps.

      Parameters:
      idx - field index.

    • getIndex

      public int getIndex()
      GetIndex allows to obtain field index.
      Returns:
      the index of the field.

    • setVisible

      public void setVisible(boolean isVisible)
      SetVisible allows to set field's default visibility. Its value true by default.
      Parameters:
      isVisible - the visibility flag.

    • getVisible

      public boolean getVisible()
      GetVisible allows to obtain information about filed visibility.
      Returns:
      true if current schema field is visible, false otherwise.

    • setEditable

      public void setEditable(boolean isEditable)
      SetEditable allows to change edit mode for shema field. Its value false by default.
      Parameters:
      isEditable - pass true to allow to edit this field or false otherwise.

    • getEditable

      public boolean getEditable()
      GetEditable allows to obtain information about edit mode of the current field.
      Returns:
      whether edit mode is allowed or not.