aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/render/afp/modca/ResourceObject.java
blob: e3f8621e09570ac86fd6e449fa7860cd89c187cb (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
/*
 * 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.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 {
    
    private AbstractNamedAFPObject namedObject;
    
    /**
     * 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;
    }
        
    /** {@inheritDoc} */
    protected void writeStart(OutputStream os) throws IOException {
        super.writeStart(os);

        byte[] data = new byte[19];
        copySF(data, Type.BEGIN, Category.NAME_RESOURCE);

        // Set the total record length
        byte[] len = BinaryUtils.convert(18 + getTripletDataLength(), 2);
        data[1] = len[0]; // Length byte 1
        data[2] = len[1]; // Length byte 2
            
        // Set reserved bits
        data[17] = 0x00; // Reserved
        data[18] = 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[17];
        copySF(data, Type.END, Category.NAME_RESOURCE);
        os.write(data);
    }
    
    /** {@inheritDoc} */
    public String toString() {
        return this.getName();
    }
    
    /**
     * Sets Resource Object Type triplet
     * 
     * @param type the resource object type
     */
    public void setType(byte type) {
        getTriplets().add(new ResourceObjectTypeTriplet(type));
    }

    /** graphics object type */
    public static final byte TYPE_GRAPHIC = 0x03;
    
    /** barcode object type */
    public static final byte BARCODE = 0x05;

    /** image object type */
    public static final byte TYPE_IMAGE = 0x06;
    
//    private static final byte FONT_CHARACTER_SET = 0x40;
//    private static final byte CODE_PAGE = 0x41;
//    private static final byte CODED_FONT = 0x42;
    
    /** object container type */
    public static final byte TYPE_OBJECT_CONTAINER = (byte) 0x92;

    /** document object type */
    public static final byte TYPE_DOCUMENT = (byte) 0xA8;

    /** page segment object type */
    public static final byte TYPE_PAGE_SEGMENT = (byte) 0xFB;

    /** overlay object type */
    public static final byte TYPE_OVERLAY_OBJECT = (byte) 0xFC;
    
//    private static final byte PAGEDEF = (byte) 0xFD;
//    private static final byte FORMDEF = (byte) 0xFE;

    private class ResourceObjectTypeTriplet extends Triplet {

        private static final byte RESOURCE_OBJECT = 0x21;

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