summaryrefslogtreecommitdiff
path: root/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbEncoder.java
blob: 0d166aac4004da0f7277297db88616132bae124b (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
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

package org.openoffice.xmerge.converter.palm;

import java.io.OutputStream;
import java.io.BufferedOutputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.util.Date;

/**
 * Provides functionality to encode a {@code PalmDB} object into a PDB
 * formatted file given a file {@code OutputStream}.
 *
 * <p>This class is only used by the {@code PalmDB} object.</p>
 *
 * <p>One needs to create one {@code PdbEncoder} object per {@code PalmDB}
 * object to be encoded. This class keeps the PDB header data and functionality
 * in the {@code PdbHeader} class.</p>
 *
 * <p>Sample usage:</p>
 * <blockquote><pre>{@code PdbEncoder encoder = new PdbEncoder(palmDB, "STRW", "data");
 * encoder.write(new FileOutputStream("sample.pdb"));}</pre></blockquote>
 *
 * @see     PalmDB
 * @see     Record
 */
public final class PdbEncoder {

    /** PDB header. */
    private final PdbHeader header;

    /** the PalmDB object. */
    private final PalmDB db;

    /** The pattern for unique_id=0x00BABE(start). */
    private final static int START_UNIQUE_ID = 0x00BABE;


    /**
     * Constructor.
     *
     * @param db The {@code PalmDB} to be encoded.
     */
    public PdbEncoder(PalmDB db) {

        header = new PdbHeader();
        header.version = db.getVersion();

        header.attribute = db.getAttribute();

        this.db = db;

        header.pdbName = db.getPDBNameBytes();
        header.creatorID = db.getCreatorID();
        header.typeID = db.getTypeID();

        // set the following dates to current date
        Date date = new Date();
        header.creationDate = (date.getTime() / 1000) + PdbUtil.TIME_DIFF;
        header.modificationDate = header.creationDate;

        header.numRecords = db.getRecordCount();
    }

    /**
     * Write out a PDB into the given {@code OutputStream}.
     *
     * <p>First, write out the header data by using the {@code PdbHeader.write}
     * method. Next, calculate the RecordList section and write it out. Lastly,
     * write out the bytes corresponding to each {@code Record}.</p>
     *
     * <p>The RecordList section contains a list of {@code Record} index info,
     * where each {@code Record} index info contains:</p>
     *
     * <ul>
     *   <li>4 bytes local offset of the {@code Record} from the top of the
     *       PDB.</li>
     *   <li>1 byte of {@code Record} attribute.</li>
     *   <li>3 bytes unique {@code Record} ID.</li>
     * </ul>
     *
     * <p>There should be a total of {@code header.numRecords} of {@code Record}
     * index info.</p>
     *
     * @param   os  {@code OutputStream} to write out PDB.
     *
     * @throws  IOException  If I/O error occurs.
     */
    public void write(OutputStream os) throws IOException {

        BufferedOutputStream bos = new BufferedOutputStream(os);
        DataOutputStream dos = new DataOutputStream(bos);

        // write out the PDB header
        header.write(dos);

        if (header.numRecords > 0) {

            // compute for recOffset[]
            int recOffset[] = new int[header.numRecords];
            byte recAttr[] = new byte[header.numRecords];

            // first recOffset will be at PdbUtil.HEADER_SIZE + all the
            // record indices (@ 8 bytes each)
            recOffset[0] = PdbUtil.HEADER_SIZE + (header.numRecords * 8);

            int lastIndex = header.numRecords - 1;
            for (int i = 0; i < lastIndex; i++) {

                Record rec = db.getRecord(i);
                int size = rec.getSize();
                recAttr[i] = rec.getAttributes();

                recOffset[i+1] = recOffset[i] + size;
            }

            // grab the last record's attribute.
            Record lastRec = db.getRecord(lastIndex);
            recAttr[lastIndex] = lastRec.getAttributes();

            int uid = START_UNIQUE_ID;
            for (int i = 0; i < header.numRecords; i++) {

                // write out each record offset
                dos.writeInt(recOffset[i]);

                // write out record attribute (recAttr) and
                // unique ID (uid) in 4 bytes (int) chunk.
                // unique ID's have to be unique, thus
                // increment each time.
                int attr = (recAttr[i] << 24 );
                attr |= uid;
                dos.writeInt(attr);
                uid++;
            }

            // write out the raw records
            for (int i = 0; i < header.numRecords; i++) {

                Record rec = db.getRecord(i);
                byte bytes[] = rec.getBytes();
                dos.write(bytes);
            }
        } else {
            // placeholder bytes if there are no records in the list.
            dos.writeShort(0);
        }

        dos.flush();
    }
}