/*
* 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.xml.sxw.aportisdoc;
import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.util.List;
import java.util.ArrayList;
import org.openoffice.xmerge.converter.palm.Record;
/**
* This class is used by {@link
* org.openoffice.xmerge.converter.xml.sxw.DocumentSerializerImpl
* DocumentSerializerImpl} to encode the AportisDoc format.
* It does not deal with any XML tags. It only knows how to encode
* from String
.
*
* @author Herbie Ong
*/
final class DocEncoder implements DocConstants {
/** Text buffer to contain text section. */
private StringBuffer textBuffer = null;
/** Length of text section. */
private int textLen = 0;
/** Number of text records. */
private int textRecCount = 0;
/**
* Default constructor creates a header and
* a text buffer for holding all the text in
* the AportisDoc database.
*/
DocEncoder() {
textBuffer = new StringBuffer(TEXT_RECORD_SIZE);
}
/**
* This method appends text into the text section of
* the AportisDoc database.
*
* @param text String
to append.
*/
void addText(String text) {
textBuffer.append(text);
}
/**
* This method appends text into the text section of
* the AportisDoc database.
*
* @param text char
array to append.
*/
void addText(char[] text) {
textBuffer.append(text);
}
/**
* This method appends text character into the text
* section of the AportisDoc database.
*
* @param text char
to append.
*/
void addText(char text) {
textBuffer.append(text);
}
/**
* This method encodes the information given to a
* palm Record
array in the AportisDoc
* database format.
*
* @return Record
array holding AportisDoc
* contents.
*
* @throws IOException If any I/O error occurs.
*/
Record[] getRecords() throws IOException {
byte textBytes[] = processTextBuffer();
textLen = textBytes.length;
textRecCount = (short) (textBytes.length / TEXT_RECORD_SIZE);
// recBytes to hold a record of bytes at a time
byte recBytes[] = new byte[TEXT_RECORD_SIZE];
int pos = 0;
List textRecords = new ArrayList(textRecCount + 1);
// split textBytes into chunks of Record objects
// and store in textRecords object.
for (int i = 0; i < textRecCount; i++) {
System.arraycopy(textBytes, pos, recBytes, 0, recBytes.length);
pos += recBytes.length;
Record zRec = new Record(recBytes);
textRecords.add(zRec);
}
// there's more if ...
if (pos < textLen) {
textRecCount++;
recBytes = new byte[textLen - pos];
System.arraycopy(textBytes, pos, recBytes, 0, recBytes.length);
Record rec = new Record(recBytes);
textRecords.add(rec);
}
// construct the Record array and copy
// references from textRecords.
Record[] allRecords = new Record[textRecords.size() + 1];
allRecords[0] = new Record(getHeaderBytes());
for (int i = 1; i < allRecords.length; i++) {
allRecords[i] = (Record) textRecords.get(i-1);
}
return allRecords;
}
/**
* This method converts the text buffer into a byte
* array with the proper encoding of the text section of the
* AportisDoc format.
*
* TODO: do compression.
*
* @return byte[] Converted byte
array of text
* section.
*
* @throws IOException If any I/O error occurs.
*/
private byte[] processTextBuffer() throws IOException
{
String str = textBuffer.toString();
byte bytes[] = str.getBytes(ENCODING);
return bytes;
}
/**
* This method produces the byte
array for the header.
*
* @return byte
array containing header record data.
*
* @throws IOException If any I/O error occurs.
*/
private byte[] getHeaderBytes() throws IOException
{
ByteArrayOutputStream bos = new ByteArrayOutputStream();
DataOutputStream dos = new DataOutputStream(bos);
// TODO: for now, we shall use UNCOMPRESSED.
// later, we need to use COMPRESSED or a setting.
dos.writeShort(UNCOMPRESSED);
dos.writeShort(SPARE);
dos.writeInt(textLen);
dos.writeShort(textRecCount);
dos.writeShort(TEXT_RECORD_SIZE);
dos.writeInt(SPARE);
byte[] bytes = bos.toByteArray();
return bytes;
}
}