Package com.datalogics.PDFL

Class Collection

java.lang.Object
com.datalogics.PDFL.Collection
public class Collection extends Object
Allows for manipulation of PDF collections, or portfolios. The class illustrates how to process a collection's schema. It also describes sorting of a portfolio.

  • Method Details

    • delete

      public void delete()

    • getSchema

      public CollectionSchema getSchema()
      GetSchema allows to obtain Schema object for current Collection. The Schema object does not have constructor. Only Collection is able to create Schema.

      Returns:
      Schema object.

    • changeCollectionViewMode

      public void changeCollectionViewMode(CollectionViewType view, CollectionSplitType split)
      SetCollectionView sets view mode value to the Collection.
      Parameters:
      view - one of the members of CollectionViewMode enum.
      split - enum of split mode (selector)

    • getSort

      public List<CollectionSortItem> getSort()
      GetSort gets sort parameters for the Collection.
      Returns:
      the list of CollectionSortItem, which contains field/fields name to sort Collection by and sort order.

    • setSort

      public void setSort(List<CollectionSortItem> sort)
      SetSort allows to set field/fields to sort by as well as sort order (ascending or descending).
      Parameters:
      sort - the list of CollectionSortItem.