Collection Class

class Collection

Namespace:com::datalogics::PDFL

Detailed Description

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.

Referenced by

Document

Uses types

CollectionSchema CollectionSortItem

Member Function Documentation

void changeCollectionViewMode(CollectionViewType view, CollectionSplitType split)

Parameters

view: CollectionViewType: one of the members of CollectionViewMode enum.
split: CollectionSplitType: enum of split mode (selector)

Returns:

void

SetCollectionView sets view mode value to the Collection.

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

synchronized void delete()

Returns:

synchronized void

void finalize()

Returns:

void

CollectionSchema getSchema()

Returns:

CollectionSchema

Schema object.

GetSchema allows to obtain Schema object for current Collection. The Schema object does not have constructor. Only Collection is able to create Schema.

java.util.List< CollectionSortItem > getSort()

Returns:

java.util.List< CollectionSortItem >

the list of CollectionSortItem, which contains field/fields name to sort Collection by and sort order.

GetSort gets sort parameters for the Collection.

void setSort(java.util.List< CollectionSortItem > sort)

Parameters

sort: java.util.List< CollectionSortItem >: the list of CollectionSortItem.

Returns:

void

SetSort allows to set field/fields to sort by as well as sort order (ascending or descending).