1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id$ */
package org.apache.fop.render.afp.modca;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
/**
* A page group is used in the data stream to define a named, logical grouping
* of sequential pages. Page groups are delimited by begin-end structured fields
* that carry the name of the page group. Page groups are defined so that the
* pages that comprise the group can be referenced or processed as a single
* entity. Page groups are often processed in stand-alone fashion; that is, they
* are indexed, retrieved, and presented outside the context of the containing
* document.
*
* @author <a href="mailto:pete@townsend.uk.com">Pete Townsend </a>
*/
public class PageGroup extends AbstractNamedAFPObject {
/**
* The pages contained within this group
*/
private List objects = new ArrayList();
/**
* The tag logical elements contained within this group
*/
private List tagLogicalElements = new ArrayList();
/**
* The page state
*/
private boolean complete = false;
/**
* Constructor for the PageGroup.
*
* @param name
* the name of the page group
*/
public PageGroup(String name) {
super(name);
}
/**
* Adds a page object to the group.
*
* @param page
* the page object to add
*/
public void addPage(PageObject page) {
if (!objects.contains(page)) {
objects.add(page);
}
}
/**
* @return the name of the page group
*/
public String getName() {
return name;
}
/**
* Creates a TagLogicalElement on the page.
*
* @param name
* the name of the tag
* @param value
* the value of the tag
*/
public void createTagLogicalElement(String name, String value) {
TagLogicalElement tle = new TagLogicalElement(name, value);
tagLogicalElements.add(tle);
}
/**
* Creates an InvokeMediaMap on the page.
*
* @param name
* the name of the media map
*/
public void createInvokeMediumMap(String name) {
InvokeMediumMap imm = new InvokeMediumMap(name);
objects.add(imm);
}
/**
* Method to mark the end of the page group.
*/
public void endPageGroup() {
complete = true;
}
/**
* Returns an indication if the page group is complete
* @return whether or not this page group is complete or not
*/
public boolean isComplete() {
return complete;
}
/**
* Accessor method to write the AFP datastream for the page group.
* @param os The stream to write to
* @throws java.io.IOException thrown if an I/O exception of some sort has occurred
*/
public void writeDataStream(OutputStream os)
throws IOException {
writeStart(os);
writeObjectList(tagLogicalElements, os);
writeObjectList(objects, os);
writeEnd(os);
}
/**
* Helper method to write the start of the page group.
* @param os The stream to write to
*/
private void writeStart(OutputStream os)
throws IOException {
byte[] data = new byte[17];
data[0] = 0x5A; // Structured field identifier
data[1] = 0x00; // Length byte 1
data[2] = 0x10; // Length byte 2
data[3] = (byte) 0xD3; // Structured field id byte 1
data[4] = (byte) 0xA8; // Structured field id byte 2
data[5] = (byte) 0xAD; // Structured field id byte 3
data[6] = 0x00; // Flags
data[7] = 0x00; // Reserved
data[8] = 0x00; // Reserved
for (int i = 0; i < nameBytes.length; i++) {
data[9 + i] = nameBytes[i];
}
os.write(data);
}
/**
* Helper method to write the end of the page group.
* @param os The stream to write to
*/
private void writeEnd(OutputStream os)
throws IOException {
byte[] data = new byte[17];
data[0] = 0x5A; // Structured field identifier
data[1] = 0x00; // Length byte 1
data[2] = 0x10; // Length byte 2
data[3] = (byte) 0xD3; // Structured field id byte 1
data[4] = (byte) 0xA9; // Structured field id byte 2
data[5] = (byte) 0xAD; // Structured field id byte 3
data[6] = 0x00; // Flags
data[7] = 0x00; // Reserved
data[8] = 0x00; // Reserved
for (int i = 0; i < nameBytes.length; i++) {
data[9 + i] = nameBytes[i];
}
os.write(data);
}
}
|
