+ * Briefly, MultipleDocumentHandling determines the relationship between the + * multiple input (electronic) documents fed into a multidoc print job and the + * output (physical) document or documents produced by the multidoc print job. + * There are two possibilities: + *
+ * In the detailed explanations below, if "a" represents an
+ * instance of document data, then the result of processing the data in
+ * document "a" is a sequence of media sheets represented by
+ * "a(*)".
+ *
+ * The standard MultipleDocumentHandling values are: + *
a and
+ * b -- then the result of processing all the document data
+ * (a and then b) must be treated as a single sequence
+ * of media sheets for finishing operations; that is, finishing would be
+ * performed on the concatenation of the sequences a(*),b(*). The
+ * printer must not force the data in each document instance to be formatted
+ * onto a new print-stream page, nor to start a new impression on a new media
+ * sheet. If more than one copy is made, the ordering of the sets of media
+ * sheets resulting from processing the document data must be
+ * a(*),b(*),a(*),b(*),..., and the printer object must force
+ * each copy (a(*),b(*)) to start on a new media sheet.
+ *
+ * a and
+ * b -- then the result of processing the data in each document
+ * instance must be treated as a single sequence of media sheets for finishing
+ * operations; that is, the sets a(*) and b(*) would
+ * each be finished separately. The printer must force each copy of the result
+ * of processing the data in a single document to start on a new media sheet.
+ * If more than one copy is made, the ordering of the sets of media sheets
+ * resulting from processing the document data must be
+ * a(*),a(*),...,b(*),b(*)....
+ *
+ * a and
+ * b -- then the result of processing the data in each document
+ * instance must be treated as a single sequence of media sheets for finishing
+ * operations; that is, the sets a(*) and b(*) would
+ * each be finished separately. The printer must force each copy of the result
+ * of processing the data in a single document to start on a new media sheet.
+ * If more than one copy is made, the ordering of the sets of media sheets
+ * resulting from processing the document data must be
+ * a(*),b(*),a(*),b(*),....
+ *
+ * + * SINGLE_DOCUMENT is the same as SEPARATE_DOCUMENTS_COLLATED_COPIES with + * respect to ordering of print-stream pages, but not media sheet generation, + * since SINGLE_DOCUMENT will put the first page of the next document on the + * back side of a sheet if an odd number of pages have been produced so far + * for the job, while SEPARATE_DOCUMENTS_COLLATED_COPIES always forces the + * next document or document copy on to a new sheet. + *
+ * In addition, if a {@link Finishings Finishings} attribute of + * {@link Finishings#STAPLE STAPLE} is specified, then: + *
a and b are
+ * stapled together as a single document with no regard to new sheets.
+ *
+ * a and b
+ * are stapled together as a single document, but document b
+ * starts on a new sheet.
+ *
+ * a and
+ * b are stapled separately.
+ * + * Note: None of these values provide means to produce uncollated + * sheets within a document, i.e., where multiple copies of sheet n + * are produced before sheet n+1 of the same document. + * To specify that, see the {@link SheetCollate SheetCollate} attribute. + *
+ * IPP Compatibility: The category name returned by
+ * getName() is the IPP attribute name. The enumeration's
+ * integer value is the IPP enum value. The toString() method
+ * returns the IPP string representation of the attribute value.
+ *
+ * + * @see Copies + * @see Finishings + * @see NumberUp + * @see PageRanges + * @see SheetCollate + * @see Sides + * + * @author David Mendenhall + * @author Alan Kaminsky + */ +public class MultipleDocumentHandling extends EnumSyntax + implements PrintRequestAttribute, PrintJobAttribute { + + private static final long serialVersionUID = 8098326460746413466L; + + + /** + * Single document -- see above for further + * information. + */ + public static final MultipleDocumentHandling + SINGLE_DOCUMENT = new MultipleDocumentHandling (0); + + /** + * Separate documents uncollated copies -- see above for + * further information. + */ + public static final MultipleDocumentHandling + SEPARATE_DOCUMENTS_UNCOLLATED_COPIES = new MultipleDocumentHandling (1); + + /** + * Separate documents collated copies -- see above for + * further information. + */ + public static final MultipleDocumentHandling + SEPARATE_DOCUMENTS_COLLATED_COPIES = new MultipleDocumentHandling (2); + + /** + * Single document new sheet -- see above for + * further information. + */ + public static final MultipleDocumentHandling + SINGLE_DOCUMENT_NEW_SHEET = new MultipleDocumentHandling (3); + + + /** + * Construct a new multiple document handling enumeration value with the + * given integer value. + * + * @param value Integer value. + */ + protected MultipleDocumentHandling(int value) { + super (value); + } + + private static final String[] myStringTable = { + "single-document", + "separate-documents-uncollated-copies", + "separate-documents-collated-copies", + "single-document-new-sheet" + }; + + private static final MultipleDocumentHandling[] myEnumValueTable = { + SINGLE_DOCUMENT, + SEPARATE_DOCUMENTS_UNCOLLATED_COPIES, + SEPARATE_DOCUMENTS_COLLATED_COPIES, + SINGLE_DOCUMENT_NEW_SHEET + }; + + /** + * Returns the string table for class MultipleDocumentHandling. + */ + protected String[] getStringTable() { + return myStringTable.clone(); + } + + /** + * Returns the enumeration value table for class MultipleDocumentHandling. + */ + protected EnumSyntax[] getEnumValueTable() { + return (EnumSyntax[])myEnumValueTable.clone(); + } + + /** + * Get the printing attribute class which is to be used as the "category" + * for this printing attribute value. + *
+ * For class MultipleDocumentHandling and any vendor-defined subclasses, + * the category is class MultipleDocumentHandling itself. + * + * @return Printing attribute class (category), an instance of class + * {@link java.lang.Class java.lang.Class}. + */ + public final Class getCategory() { + return MultipleDocumentHandling.class; + } + + /** + * Get the name of the category of which this attribute value is an + * instance. + *
+ * For class MultipleDocumentHandling and any vendor-defined subclasses,
+ * the category name is "multiple-document-handling".
+ *
+ * @return Attribute category name.
+ */
+ public final String getName() {
+ return "multiple-document-handling";
+ }
+
+}