org.cip4.elk.impl.queue.util
Class BaseICSQueueFilter

java.lang.Object
  org.cip4.elk.impl.queue.util.BaseICSQueueFilter

All Implemented Interfaces:

org.cip4.elk.queue.util.QueueFilter

public class BaseICSQueueFilter
extends java.lang.Object
implements org.cip4.elk.queue.util.QueueFilter

A filter that sorts queues. This implementation of QueueFilter will sort the queue entries according to the documentation of filterQueue(JDFQueue, JDFQueueFilter).

Version:

$Id: BaseICSQueueFilter.java,v 1.4 2005/09/08 23:57:09 ola.stering Exp $

Author:

Ola Stering (olst6875@student.uu.se)

See Also:

JDF Specification Release 1.2, Table 5.105 Contents of the QueueFilter Element , ICS-Base-1.0 Specification, Table 49 QueueFilter

Constructor Summary

BaseICSQueueFilter(org.cip4.elk.queue.Queue owner)
Creates a BaseICSQueueFilter.

Method Summary

org.cip4.jdflib.jmf.JDFQueue

filterQueue(org.cip4.jdflib.jmf.JDFQueue queue, org.cip4.jdflib.jmf.JDFQueueFilter filter) Filters all queue entries in a queue, modifying the input queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseICSQueueFilter

public BaseICSQueueFilter(org.cip4.elk.queue.Queue owner)

Creates a BaseICSQueueFilter.

Parameters:

owner - the Queue that owns this QueueFilter.

Method Detail

filterQueue

public org.cip4.jdflib.jmf.JDFQueue filterQueue(org.cip4.jdflib.jmf.JDFQueue queue,
                                                org.cip4.jdflib.jmf.JDFQueueFilter filter)

Filters all queue entries in a queue, modifying the input queue. This implementation of QueueFilter handles these filter attributes:

• MaxEntries, Maximum number of QueueEntries to provide in the Queue element. If not specified, fill in all matching QueueEntrys. If 0 is specified ALL entries will be returned
• QueueEntryDetails, for details see JDF 1.2.

NOTE: The Full option is no longer a valid value of Queue QueneEntryDetails.

NOTE: An incoming Queue is assumed to be sorted BEFORE it enters this filter.

Other attributes of QueueFilter are ignored.

This filter modifies the input queue.

Specified by:

filterQueue in interface org.cip4.elk.queue.util.QueueFilter

Parameters:

queue - the queue to filter

filter - the QueueFilter to be used to filter the Queue. If the filter is null it is ignored and the returned Queue will be an exact copy of the incoming Queue.

Returns:

the filtered input queue

Throws:

java.lang.NullPointerException - if the queue is null

See Also:

QueueFilter.filterQueue(org.cip4.jdflib.jmf.JDFQueue, org.cip4.jdflib.jmf.JDFQueueFilter)