View Javadoc
1   /*
2    * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  package javax.print.attribute.standard;
26  
27  import javax.print.attribute.Attribute;
28  import javax.print.attribute.EnumSyntax;
29  import javax.print.attribute.DocAttribute;
30  import javax.print.attribute.PrintRequestAttribute;
31  import javax.print.attribute.PrintJobAttribute;
32  
33  /**
34   * Class SheetCollate is a printing attribute class, an enumeration, that
35   * specifies whether or not the media sheets of each copy of each printed
36   * document in a job are to be in sequence, when multiple copies of the document
37   * are specified by the {@link Copies Copies} attribute. When SheetCollate is
38   * COLLATED, each copy of each document is printed with the print-stream sheets
39   * in sequence. When SheetCollate is UNCOLLATED, each print-stream sheet is
40   * printed a number of times equal to the value of the {@link Copies Copies}
41   * attribute in succession. For example, suppose a document produces two media
42   * sheets as output, {@link Copies Copies} is 6, and SheetCollate is UNCOLLATED;
43   * in this case six copies of the first media sheet are printed followed by
44   * six copies of the second media sheet.
45   * <P>
46   * Whether the effect of sheet collation is achieved by placing copies of a
47   * document in multiple output bins or in the same output bin with
48   * implementation defined document separation is implementation dependent.
49   * Also whether it is achieved by making multiple passes over the job or by
50   * using an output sorter is implementation dependent.
51   * <P>
52   * If a printer does not support the SheetCollate attribute (meaning the client
53   * cannot specify any particular sheet collation), the printer must behave as
54   * though SheetCollate were always set to COLLATED.
55   * <P>
56   * The SheetCollate attribute interacts with the {@link MultipleDocumentHandling
57   * MultipleDocumentHandling} attribute. The {@link MultipleDocumentHandling
58   * MultipleDocumentHandling} attribute describes the collation of entire
59   * documents, and the SheetCollate attribute describes the semantics of
60   * collating individual pages within a document.
61   * <P>
62   * The effect of a SheetCollate attribute on a multidoc print job (a job with
63   * multiple documents) depends on whether all the docs have the same sheet
64   * collation specified or whether different docs have different sheet
65   * collations specified, and on the (perhaps defaulted) value of the {@link
66   * MultipleDocumentHandling MultipleDocumentHandling} attribute.
67   * <UL>
68   * <LI>
69   * If all the docs have the same sheet collation specified, then the following
70   * combinations of SheetCollate and {@link MultipleDocumentHandling
71   * MultipleDocumentHandling} are permitted, and the printer reports an error
72   * when the job is submitted if any other combination is specified:
73   * <UL>
74   * <LI>
75   * SheetCollate = COLLATED, {@link MultipleDocumentHandling
76   * MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be
77   * combined into one output document. Multiple copies of the output document
78   * will be produced with pages in collated order, i.e. pages 1, 2, 3, . . .,
79   * 1, 2, 3, . . .
80   * <P>
81   * <LI>
82   * SheetCollate = COLLATED, {@link MultipleDocumentHandling
83   * MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs
84   * will be combined into one output document, and the first impression of each
85   * input doc will always start on a new media sheet. Multiple copies of the
86   * output document will be produced with pages in collated order, i.e. pages
87   * 1, 2, 3, . . ., 1, 2, 3, . . .
88   * <P>
89   * <LI>
90   * SheetCollate = COLLATED, {@link MultipleDocumentHandling
91   * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each
92   * input doc will remain a separate output document. Multiple copies of each
93   * output document (call them A, B, . . .) will be produced with each document's
94   * pages in collated order, but the documents themselves in uncollated order,
95   * i.e. pages A1, A2, A3, . . ., A1, A2, A3, . . ., B1, B2, B3, . . ., B1, B2,
96   * B3, . . .
97   * <P>
98   * <LI>
99   * SheetCollate = COLLATED, {@link MultipleDocumentHandling
100  * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_COLLATED_COPIES -- Each input
101  * doc will remain a separate output document. Multiple copies of each output
102  * document (call them A, B, . . .) will be produced with each document's pages
103  * in collated order, with the documents themselves also in collated order, i.e.
104  * pages A1, A2, A3, . . ., B1, B2, B3, . . ., A1, A2, A3, . . ., B1, B2, B3,
105  * . . .
106  * <P>
107  * <LI>
108  * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
109  * MultipleDocumentHandling} = SINGLE_DOCUMENT -- All the input docs will be
110  * combined into one output document. Multiple copies of the output document
111  * will be produced with pages in uncollated order, i.e. pages 1, 1, . . .,
112  * 2, 2, . . ., 3, 3, . . .
113  * <P>
114  * <LI>
115  * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
116  * MultipleDocumentHandling} = SINGLE_DOCUMENT_NEW_SHEET -- All the input docs
117  * will be combined into one output document, and the first impression of each
118  * input doc will always start on a new media sheet. Multiple copies of the
119  * output document will be produced with pages in uncollated order, i.e. pages
120  * 1, 1, . . ., 2, 2, . . ., 3, 3, . . .
121  * <P>
122  * <LI>
123  * SheetCollate = UNCOLLATED, {@link MultipleDocumentHandling
124  * MultipleDocumentHandling} = SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each
125  * input doc will remain a separate output document. Multiple copies of each
126  * output document (call them A, B, . . .) will be produced with each document's
127  * pages in uncollated order, with the documents themselves also in uncollated
128  * order, i.e. pages A1, A1, . . ., A2, A2, . . ., A3, A3, . . ., B1, B1, . . .,
129  * B2, B2, . . ., B3, B3, . . .
130  * </UL>
131  * <P>
132  * <LI>
133  * If different docs have different sheet collations specified, then only one
134  * value of {@link MultipleDocumentHandling MultipleDocumentHandling} is
135  * permitted, and the printer reports an error when the job is submitted if any
136  * other value is specified:
137  * <UL>
138  * <LI>
139  * {@link MultipleDocumentHandling MultipleDocumentHandling} =
140  * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- Each input doc will remain a separate
141  * output document. Multiple copies of each output document (call them A, B,
142  * . . .) will be produced with each document's pages in collated or uncollated
143  * order as the corresponding input doc's SheetCollate attribute specifies, and
144  * with the documents themselves in uncollated order. If document A had
145  * SheetCollate = UNCOLLATED and document B had SheetCollate = COLLATED, the
146  * following pages would be produced: A1, A1, . . ., A2, A2, . . ., A3, A3,
147  * . . ., B1, B2, B3, . . ., B1, B2, B3, . . .
148  * </UL>
149  * </UL>
150  * <P>
151  * <B>IPP Compatibility:</B> SheetCollate is not an IPP attribute at present.
152  * <P>
153  *
154  * @see  MultipleDocumentHandling
155  *
156  * @author  Alan Kaminsky
157  */
158 public final class SheetCollate extends EnumSyntax
159     implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {
160 
161     private static final long serialVersionUID = 7080587914259873003L;
162 
163     /**
164      * Sheets within a document appear in uncollated order when multiple
165      * copies are printed.
166      */
167     public static final SheetCollate UNCOLLATED = new SheetCollate(0);
168 
169     /**
170      * Sheets within a document appear in collated order when multiple copies
171      * are printed.
172      */
173     public static final SheetCollate COLLATED = new SheetCollate(1);
174 
175     /**
176      * Construct a new sheet collate enumeration value with the given integer
177      * value.
178      *
179      * @param  value  Integer value.
180      */
181     protected SheetCollate(int value) {
182         super (value);
183     }
184 
185     private static final String[] myStringTable = {
186         "uncollated",
187         "collated"
188     };
189 
190     private static final SheetCollate[] myEnumValueTable = {
191         UNCOLLATED,
192         COLLATED
193     };
194 
195     /**
196      * Returns the string table for class SheetCollate.
197      */
198     protected String[] getStringTable() {
199         return myStringTable;
200     }
201 
202     /**
203      * Returns the enumeration value table for class SheetCollate.
204      */
205     protected EnumSyntax[] getEnumValueTable() {
206         return myEnumValueTable;
207     }
208 
209     /**
210      * Get the printing attribute class which is to be used as the "category"
211      * for this printing attribute value.
212      * <P>
213      * For class SheetCollate, the category is class SheetCollate itself.
214      *
215      * @return  Printing attribute class (category), an instance of class
216      *          {@link java.lang.Class java.lang.Class}.
217      */
218     public final Class<? extends Attribute> getCategory() {
219         return SheetCollate.class;
220     }
221 
222     /**
223      * Get the name of the category of which this attribute value is an
224      * instance.
225      * <P>
226      * For class SheetCollate, the category name is <CODE>"sheet-collate"</CODE>.
227      *
228      * @return  Attribute category name.
229      */
230     public final String getName() {
231         return "sheet-collate";
232     }
233 
234 }