/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache POI" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache POI", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.poi.hssf.record;

import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.StringUtil;

/**
 * Title:        Footer Record <P>
 * Description:  Specifies the footer for a sheet<P>
 * REFERENCE:  PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
 * @author Andrew C. Oliver (acoliver at apache dot org)
 * @author Shawn Laubach (laubach@acm.org) Modified 3/14/02
 * @author Jason Height (jheight at chariot dot net dot au)
 * @version 2.0-pre
 */

public class FooterRecord extends Record {
	public final static short sid = 0x15;
	private byte field_1_footer_len;
	private String field_2_footer;
	private byte unicode_flag;

	public FooterRecord() {
	}

	/**
	 * Constructs a FooterRecord record and sets its fields appropriately.
	 *
	 * @param id     id must be 0x15 or an exception will be throw upon validation
	 * @param size  the size of the data area of the record
	 * @param data  data of the record (should not contain sid/len)
	 */

	public FooterRecord(short id, short size, byte[] data) {
		super(id, size, data);
	}

	/**
	 * Constructs a FooterRecord record and sets its fields appropriately.
	 *
	 * @param id     id must be 0x15 or an exception will be throw upon validation
	 * @param size  the size of the data area of the record
	 * @param data  data of the record (should not contain sid/len)
	 * @param offset of the record's data
	 */

	public FooterRecord(short id, short size, byte[] data, int offset) {
		super(id, size, data, offset);
	}

	protected void validateSid(short id) {
		if (id != sid) {
			throw new RecordFormatException("NOT A FooterRECORD");
		}
	}

	protected void fillFields(byte[] data, short size, int offset) {
		if (size > 0) {
			field_1_footer_len = data[0 + offset];
			unicode_flag = data[2 + offset];
			if (isMultibyte()) {
				field_2_footer =
					StringUtil.getFromUnicodeHigh(
						data,
						3 + offset,
						LittleEndian.ubyteToInt(field_1_footer_len));
			} else {
				field_2_footer =
					new String(data,
						3 + offset,// [Shawn] Changed 1 to 3 for offset of string
						LittleEndian.ubyteToInt(field_1_footer_len));
			}
		}
	}

	public boolean isMultibyte() {
		return ((unicode_flag & 0xFF) == 1);
	}
	public void setMultibyte(boolean ismulti) {
		unicode_flag = (byte) (ismulti ? 1 : 0);
	}

	/**
	 * set the length of the footer string
	 *
	 * @param len  length of the footer string
	 * @see #setFooter(String)
	 */

	public void setFooterLength(byte len) {
		field_1_footer_len = len;
	}

	/**
	 * set the footer string
	 *
	 * @param footer string to display
	 * @see #setFooterLength(byte)
	 */

	public void setFooter(String footer) {
		field_2_footer = footer;
		setMultibyte(true);
	}

	/**
	 * get the length of the footer string
	 *
	 * @return length of the footer string
	 * @see #getFooter()
	 */

	public short getFooterLength() {
		return (short) (0xFF & field_1_footer_len);
		// [Shawn] Fixed needing unsigned byte
	}

	/**
	 * get the footer string
	 *
	 * @return footer string to display
	 * @see #getFooterLength()
	 */

	public String getFooter() {
		return field_2_footer;
	}

	public String toString() {
		StringBuffer buffer = new StringBuffer();

		buffer.append("[FOOTER]\n");
		buffer
			.append("    .footerlen      = ")
			.append(Integer.toHexString(getFooterLength()))
			.append("\n");
		buffer.append("    .footer         = ").append(getFooter()).append(
			"\n");
		buffer.append("[/FOOTER]\n");
		return buffer.toString();
	}

	public int serialize(int offset, byte[] data) {
		int len = 4;

		if (getFooterLength() > 0) {
			len += 3; // [Shawn] Fixed for two null bytes in the length
		}
		short bytelen = (short)(isMultibyte()?getFooterLength()*2:getFooterLength());
		LittleEndian.putShort(data, 0 + offset, sid);
		LittleEndian.putShort(
			data,
			2 + offset,
			(short) ((len - 4) + bytelen));
		if (getFooterLength() > 0) {
			data[4 + offset] = (byte) getFooterLength();
			data[6 + offset] = unicode_flag;
			if(isMultibyte())
				StringUtil.putUncompressedUnicode(getFooter(), data, 7 + offset);
			else
				StringUtil.putCompressedUnicode(getFooter(), data, 7 + offset);
			// [Shawn] Place the string in the correct offset
		}
		return getRecordSize();
	}

	public int getRecordSize() {
		int retval = 4;

		if (getFooterLength() > 0) {
			retval += 3; // [Shawn] Fixed for two null bytes in the length
		}
		return (isMultibyte() ? 
			(retval + getFooterLength()*2) : (retval + getFooterLength()));
	}

	public short getSid() {
		return this.sid;
	}

	public Object clone() {
		FooterRecord rec = new FooterRecord();
		rec.field_1_footer_len = field_1_footer_len;
		rec.field_2_footer = field_2_footer;
		rec.unicode_flag = unicode_flag;
		return rec;
	}
}