Package ch.tocco.nice2.outputcenter.api.sorting

Class JobItemSorter

java.lang.Object

ch.tocco.nice2.outputcenter.api.sorting.JobItemSorter

public final class JobItemSorter
extends Object

Method Summary

Modifier and Type	Method	Description
static Function<OutputJobMergeItem,List<SortableItem>>	mergeItemConverter()	Returns a function that converts a single OutputJobMergeItem into the list of corrresponding SortableItem.
static SortedJobs	sort(Iterable<OutputJobItem> jobItems, Function<Integer,Integer> sortings)	Sorts the given job items.
static SortedJobs	sort(Iterable<OutputJobMergeItem> jobs)	Sorts the given list of OutputJobMergeItems.
static SortedJobs	sortItems(Iterable<SortableItem> items)	Sorts the list of items.
static SortableItem	toSortableItem(OutputJobItem jitem, int sorting)	Converts a OutputJobItem with the given sorting into a SortableItem.
static List<SortableItem>	toSortableItem(OutputJobMergeItem merge)	Converts a OutputJobMergeItem into a list of SortableItems.

Methods inherited from class java.lang.Object

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

Method Details

sort

public static SortedJobs sort(Iterable<OutputJobItem> jobItems,
 Function<Integer,Integer> sortings)
                       throws PersistException

Sorts the given job items. The sortings is the user defined sorting function that returns the position for each OutputJobItem in the list. The function is applied to the index of the OutputJobItem in question. The function may return null in which case a default sorting is used. RichIterable implements the Function interface by using the function argument to lookup the element in the list. Therefore it can be used to create permutations more conveniently:

 RichIterable<Integer> f = RichIterable.list(1, 4, 2, 3); //maps 0->1, 1->4, etc
 SortedJobs sorted = sort(items, f);
 

Guava's Functions class also provides convenient shortcuts, like Functions.constant(0) that returns a constant function, or Functions.identity that can be used to preserve the sorting in the jobItems list.

Throws:

PersistException

sort

public static SortedJobs sort(Iterable<OutputJobMergeItem> jobs)

Sorts the given list of OutputJobMergeItems.

toSortableItem

public static SortableItem toSortableItem(OutputJobItem jitem,
 int sorting)
                                   throws PersistException

Converts a OutputJobItem with the given sorting into a SortableItem. The SortableItem contains the OutputJobItem as its element.

Throws:

PersistException

toSortableItem

public static List<SortableItem> toSortableItem(OutputJobMergeItem merge)
                                         throws PersistException

Converts a OutputJobMergeItem into a list of SortableItems. If the associated job item is a personalized job all its job items are added and the optional additional docuement. If the job is unpersonalized, the jobs document is added as well as the additional document if present.

If the merge item is only linked to a dms document, then this is converted into a SortableItem.

The SortableItem can contain the following elements:

 * OutputCenterInputSupplier (for each additional document)
 * OutputJobItem
 * OutputJob (only unpersonalized)
 

Throws:

PersistException

mergeItemConverter

public static Function<OutputJobMergeItem,List<SortableItem>> mergeItemConverter()

Returns a function that converts a single OutputJobMergeItem into the list of corrresponding SortableItem. This is just calling toSortableItem(OutputJobMergeItem) and may be useful when transforming collections.

sortItems

public static SortedJobs sortItems(Iterable<SortableItem> items)

Sorts the list of items. The SortedJobs return value allows to access individual parts and allows to iterate over all items.