1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski import java.io.DataInput; 25*b1cdbd2cSJim Jagielski import java.io.DataOutput; 26*b1cdbd2cSJim Jagielski import java.io.IOException; 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski /** 29*b1cdbd2cSJim Jagielski * <p>Class used only internally by <code>PDBEncoder</code> and 30*b1cdbd2cSJim Jagielski * <code>PDBDecoder</code> to store, read and write a pdb header.</p> 31*b1cdbd2cSJim Jagielski * 32*b1cdbd2cSJim Jagielski * <p>Note that fields are intended to be accessible only at the 33*b1cdbd2cSJim Jagielski * package level.</p> 34*b1cdbd2cSJim Jagielski * 35*b1cdbd2cSJim Jagielski * <p>Some of the fields are internally represented using a 36*b1cdbd2cSJim Jagielski * larger type since Java does not have unsigned types. 37*b1cdbd2cSJim Jagielski * Some are not since they are not relevant for now. 38*b1cdbd2cSJim Jagielski * The <code>read</code> and <code>write</code> methods should 39*b1cdbd2cSJim Jagielski * handle them properly.</p> 40*b1cdbd2cSJim Jagielski * 41*b1cdbd2cSJim Jagielski * @author Herbie Ong 42*b1cdbd2cSJim Jagielski */ 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski final class PDBHeader { 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski /** name of the database. 32 bytes. */ 47*b1cdbd2cSJim Jagielski byte[] pdbName = null; 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski /** flags for the database. Palm UInt16. Unsignedness should be irrelevant. */ 50*b1cdbd2cSJim Jagielski short attribute = 0; 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** application-specific version for the database. Palm UInt16 */ 53*b1cdbd2cSJim Jagielski int version = 0; 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski /** date created. Palm UInt32 */ 56*b1cdbd2cSJim Jagielski long creationDate = 0; 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski /** date last modified. Palm UInt32 */ 59*b1cdbd2cSJim Jagielski long modificationDate = 0; 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski /** date last backup. Palm UInt32 */ 62*b1cdbd2cSJim Jagielski long lastBackupDate = 0; 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski /** 65*b1cdbd2cSJim Jagielski * incremented every time a record is 66*b1cdbd2cSJim Jagielski * added, deleted or modified. Palm UInt32. 67*b1cdbd2cSJim Jagielski */ 68*b1cdbd2cSJim Jagielski long modificationNumber = 0; 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski /** optional field. Palm UInt32. Unsignedness should be irrelevant. */ 71*b1cdbd2cSJim Jagielski int appInfoID = 0; 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski /** optional field. Palm UInt32. Unsignedness should be irrelevant. */ 74*b1cdbd2cSJim Jagielski int sortInfoID = 0; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** database type id. Palm UInt32. Unsignedness should be irrelevant. */ 77*b1cdbd2cSJim Jagielski int typeID = 0; 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski /** database creator id. Palm UInt32. Unsignedness should be irrelevant. */ 80*b1cdbd2cSJim Jagielski int creatorID = 0; 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski /** ??? */ 83*b1cdbd2cSJim Jagielski int uniqueIDSeed = 0; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski /** see numRecords. 4 bytes. */ 86*b1cdbd2cSJim Jagielski int nextRecordListID = 0; 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski /** 89*b1cdbd2cSJim Jagielski * number of records stored in the database header. 90*b1cdbd2cSJim Jagielski * If all the record entries cannot fit in the header, 91*b1cdbd2cSJim Jagielski * then nextRecordList has the local ID of a 92*b1cdbd2cSJim Jagielski * recordList that contains the next set of records. 93*b1cdbd2cSJim Jagielski * Palm UInt16. 94*b1cdbd2cSJim Jagielski */ 95*b1cdbd2cSJim Jagielski int numRecords = 0; 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski /** 98*b1cdbd2cSJim Jagielski * Read in the data for the pdb header. Need to 99*b1cdbd2cSJim Jagielski * preserve the unsigned value for some of the fields. 100*b1cdbd2cSJim Jagielski * 101*b1cdbd2cSJim Jagielski * @param di a DataInput object 102*b1cdbd2cSJim Jagielski * @throws IOException if I/O error occurs 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski read(DataInput in)105*b1cdbd2cSJim Jagielski public void read(DataInput in) throws IOException { 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski pdbName = new byte[PalmDB.NAME_LENGTH]; 108*b1cdbd2cSJim Jagielski in.readFully(pdbName); 109*b1cdbd2cSJim Jagielski attribute = in.readShort(); 110*b1cdbd2cSJim Jagielski version = in.readUnsignedShort(); 111*b1cdbd2cSJim Jagielski creationDate = ((long) in.readInt()) & 0xffffffffL; 112*b1cdbd2cSJim Jagielski modificationDate = ((long) in.readInt()) & 0xffffffffL; 113*b1cdbd2cSJim Jagielski lastBackupDate = ((long) in.readInt()) & 0xffffffffL; 114*b1cdbd2cSJim Jagielski modificationNumber = ((long) in.readInt()) & 0xffffffffL; 115*b1cdbd2cSJim Jagielski appInfoID = in.readInt(); 116*b1cdbd2cSJim Jagielski sortInfoID = in.readInt(); 117*b1cdbd2cSJim Jagielski creatorID = in.readInt(); 118*b1cdbd2cSJim Jagielski typeID = in.readInt(); 119*b1cdbd2cSJim Jagielski uniqueIDSeed = in.readInt(); 120*b1cdbd2cSJim Jagielski nextRecordListID = in.readInt(); 121*b1cdbd2cSJim Jagielski numRecords = in.readUnsignedShort(); 122*b1cdbd2cSJim Jagielski } 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski /** 125*b1cdbd2cSJim Jagielski * Write out pdb header data. 126*b1cdbd2cSJim Jagielski * 127*b1cdbd2cSJim Jagielski * @param out a DataOut object 128*b1cdbd2cSJim Jagielski * @throws IOException if I/O error occurs 129*b1cdbd2cSJim Jagielski */ 130*b1cdbd2cSJim Jagielski write(DataOutput out)131*b1cdbd2cSJim Jagielski public void write(DataOutput out) throws IOException { 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski out.write(pdbName); 134*b1cdbd2cSJim Jagielski out.writeShort(attribute); 135*b1cdbd2cSJim Jagielski out.writeShort(version); 136*b1cdbd2cSJim Jagielski out.writeInt((int) creationDate); 137*b1cdbd2cSJim Jagielski out.writeInt((int) modificationDate); 138*b1cdbd2cSJim Jagielski out.writeInt((int) lastBackupDate); 139*b1cdbd2cSJim Jagielski out.writeInt((int) modificationNumber); 140*b1cdbd2cSJim Jagielski out.writeInt(appInfoID); 141*b1cdbd2cSJim Jagielski out.writeInt(sortInfoID); 142*b1cdbd2cSJim Jagielski out.writeInt(typeID); 143*b1cdbd2cSJim Jagielski out.writeInt(creatorID); 144*b1cdbd2cSJim Jagielski out.writeInt(uniqueIDSeed); 145*b1cdbd2cSJim Jagielski out.writeInt(nextRecordListID); 146*b1cdbd2cSJim Jagielski out.writeShort(numRecords); 147*b1cdbd2cSJim Jagielski } 148*b1cdbd2cSJim Jagielski } 149*b1cdbd2cSJim Jagielski 150