aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/render/afp/modca/ResourceObject.java
blob: e0ba1b4b7767b6584d8c598762aaed4e934643f9 (plain)
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/*
 * 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 org.apache.fop.render.afp.DataObjectInfo;
import org.apache.fop.render.afp.modca.triplets.FullyQualifiedNameTriplet;
import org.apache.fop.render.afp.modca.triplets.ObjectClassificationTriplet;
import org.apache.fop.render.afp.modca.triplets.Triplet;
import org.apache.fop.render.afp.tools.BinaryUtils;

/**
 * This resource structured field begins an envelope that is used to carry
 * resource objects in print-file-level (external) resource groups. 
 */
public class ResourceObject extends AbstractPreparedAFPObject implements DataObjectAccessor {
    
    /**
     * the object container of this resource object
     */
    private AbstractNamedAFPObject namedObject;
        
    /**
     * the data object info
     */
    private DataObjectInfo dataObjectInfo;

    /**
     * Default constructor
     * 
     * @param name the name of this resource (reference id)
     */
    public ResourceObject(String name) {
        super(name);
    }

    /**
     * Sets the data object referenced by this resource object
     * @param obj the named data object
     */
    public void setDataObject(AbstractNamedAFPObject obj) {
        this.namedObject = obj; 
        
        String fqn = obj.getFullyQualifiedName();
        if (fqn != null) {
            super.setFullyQualifiedName(
                FullyQualifiedNameTriplet.TYPE_REPLACE_FIRST_GID_NAME,
                FullyQualifiedNameTriplet.FORMAT_CHARSTR,
                fqn);
        }
        
        byte type;
        if (obj instanceof ObjectContainer) {
            type = ResourceObjectTypeTriplet.OBJECT_CONTAINER;
        } else if (obj instanceof ImageObject) {
            type = ResourceObjectTypeTriplet.IMAGE_OBJECT;
        } else if (obj instanceof GraphicsObject) {
            type = ResourceObjectTypeTriplet.GRAPHICS_OBJECT;
        } else if (obj instanceof Document) {
            type = ResourceObjectTypeTriplet.DOCUMENT_OBJECT;
        } else if (obj instanceof PageSegment) {
            type = ResourceObjectTypeTriplet.PAGE_SEGMENT_OBJECT;
        } else if (obj instanceof Overlay) {
            type = ResourceObjectTypeTriplet.OVERLAY_OBJECT;
        } else {
            throw new UnsupportedOperationException(
                    "Unsupported resource object type " + obj);
        }
        getTriplets().add(new ResourceObjectTypeTriplet(type));
    }

    /**
     * {@inheritDoc}
     */
    public AbstractNamedAFPObject getDataObject() {
        return namedObject;
    }

    /**
     * {@inheritDoc}
     */
    public DataObjectInfo getDataObjectInfo() {
        return this.dataObjectInfo;
    }
    
    /**
     * {@inheritDoc}
     */
    public void setDataObjectInfo(DataObjectInfo dataObjectInfo) {
        this.dataObjectInfo = dataObjectInfo;
        
        if (namedObject instanceof ObjectContainer) {
            Registry.ObjectType objectType = dataObjectInfo.getObjectType();
            super.setObjectClassification(
                    ObjectClassificationTriplet.CLASS_TIME_INVARIANT_PAGINATED_PRESENTATION_OBJECT,
                    objectType);
        }
    }
        
    /**
     * {@inheritDoc}
     */
    protected void writeStart(OutputStream os) throws IOException {
        super.writeStart(os);
        
        // Set the total record length
        byte[] len = BinaryUtils.convert(18 + getTripletDataLength(), 2);
        byte[] data = new byte[] {
            0x5A, // Structured field identifier
            len[0], // Length byte 1
            len[1], // Length byte 2
            (byte)0xD3, // Structured field id byte 1
            (byte)0xA8, // Structured field id byte 2
            (byte)0xCE, // Structured field id byte 3
            0x00, // Flags
            0x00, // Reserved
            0x00, // Reserved
            nameBytes[0],            
            nameBytes[1],
            nameBytes[2],
            nameBytes[3],
            nameBytes[4],
            nameBytes[5],
            nameBytes[6],
            nameBytes[7],
            0x00, // Reserved
            0x00, // Reserved
        };
        os.write(data);
    }

    /**
     * {@inheritDoc}
     */
    protected void writeContent(OutputStream os) throws IOException {
        super.writeContent(os); // write triplets
        if (namedObject != null) {
            namedObject.write(os);
        }
    }

    /**
     * {@inheritDoc}
     */
    protected void writeEnd(OutputStream os) throws IOException {
        byte[] data = new byte[] {
           0x5A, // Structured field identifier
           0x00, // Length byte 1
           0x10, // Length byte 2
           (byte)0xD3, // Structured field id byte 1
           (byte)0xA9, // Structured field id byte 2
           (byte)0xCE, // Structured field id byte 3
           0x00, // Flags
           0x00, // Reserved
           0x00, // Reserved
           nameBytes[0],            
           nameBytes[1],
           nameBytes[2],
           nameBytes[3],
           nameBytes[4],
           nameBytes[5],
           nameBytes[6],
           nameBytes[7],
        };
        os.write(data);
    }
    
    /**
     * {@inheritDoc}
     */
    public String toString() {
        return this.getName();
    }
    
    private class ResourceObjectTypeTriplet extends Triplet {

        private static final byte RESOURCE_OBJECT = 0x21;

        /**
         * Resource object types
         */
        private static final byte GRAPHICS_OBJECT = 0x03;
//        private static final byte BARCODE_OBJECT = 0x05;
        private static final byte IMAGE_OBJECT = 0x06;
//        private static final byte FONT_CHARACTER_SET_OBJECT = 0x40;
//        private static final byte CODE_PAGE_OBJECT = 0x41;
//        private static final byte CODED_FONT_OBJECT = 0x42;
        private static final byte OBJECT_CONTAINER = (byte) 0x92;
        private static final byte DOCUMENT_OBJECT = (byte) 0xA8;
        private static final byte PAGE_SEGMENT_OBJECT = (byte) 0xFB;
        private static final byte OVERLAY_OBJECT = (byte) 0xFC;
//        private static final byte PAGEDEF_OBJECT = (byte) 0xFD;
//        private static final byte FORMDEF_OBJECT = (byte) 0xFE;

        /**
         * Main constructor
         * 
         * @param type
         *            the resource type
         */
        public ResourceObjectTypeTriplet(byte type) {
            super(RESOURCE_OBJECT,
                new byte[] {
                    type,
                    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 // Constant Data
                }
            );
        }
    }
}