| |
| /* ==================================================================== |
| 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. |
| ==================================================================== */ |
| |
| |
| package org.apache.poi.hssf.record; |
| |
| import org.apache.poi.util.BitField; |
| import org.apache.poi.util.BitFieldFactory; |
| import org.apache.poi.util.LittleEndian; |
| |
| /** |
| * Title: Row Record<P> |
| * Description: stores the row information for the sheet. <P> |
| * REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> |
| * @author Andrew C. Oliver (acoliver at apache dot org) |
| * @author Jason Height (jheight at chariot dot net dot au) |
| * @version 2.0-pre |
| */ |
| |
| public class RowRecord |
| extends Record |
| implements Comparable |
| { |
| public final static short sid = 0x208; |
| |
| /** The maximum row number that excel can handle (zero bazed) ie 65536 rows is |
| * max number of rows. |
| */ |
| public final static int MAX_ROW_NUMBER = 65535; |
| |
| //private short field_1_row_number; |
| private int field_1_row_number; |
| private short field_2_first_col; |
| private short field_3_last_col; // plus 1 |
| private short field_4_height; |
| private short field_5_optimize; // hint field for gui, can/should be set to zero |
| |
| // for generated sheets. |
| private short field_6_reserved; |
| private short field_7_option_flags; |
| private static final BitField outlineLevel = BitFieldFactory.getInstance(0x07); |
| |
| // bit 3 reserved |
| private static final BitField colapsed = BitFieldFactory.getInstance(0x10); |
| private static final BitField zeroHeight = BitFieldFactory.getInstance(0x20); |
| private static final BitField badFontHeight = BitFieldFactory.getInstance(0x40); |
| private static final BitField formatted = BitFieldFactory.getInstance(0x80); |
| private short field_8_xf_index; // only if isFormatted |
| |
| public RowRecord() |
| { |
| } |
| |
| /** |
| * Constructs a Row record and sets its fields appropriately. |
| * @param in the RecordInputstream to read the record from |
| */ |
| |
| public RowRecord(RecordInputStream in) |
| { |
| super(in); |
| } |
| |
| protected void validateSid(short id) |
| { |
| if (id != sid) |
| { |
| throw new RecordFormatException("NOT A valid ROW RECORD"); |
| } |
| } |
| |
| protected void fillFields(RecordInputStream in) |
| { |
| //field_1_row_number = LittleEndian.getShort(data, 0 + offset); |
| field_1_row_number = in.readUShort(); |
| field_2_first_col = in.readShort(); |
| field_3_last_col = in.readShort(); |
| field_4_height = in.readShort(); |
| field_5_optimize = in.readShort(); |
| field_6_reserved = in.readShort(); |
| field_7_option_flags = in.readShort(); |
| field_8_xf_index = in.readShort(); |
| } |
| |
| /** |
| * set the logical row number for this row (0 based index) |
| * @param row - the row number |
| */ |
| |
| //public void setRowNumber(short row) |
| public void setRowNumber(int row) |
| { |
| field_1_row_number = row; |
| } |
| |
| /** |
| * set the logical col number for the first cell this row (0 based index) |
| * @param col - the col number |
| */ |
| |
| public void setFirstCol(short col) |
| { |
| field_2_first_col = col; |
| } |
| |
| /** |
| * set the logical col number for the last cell this row (0 based index) |
| * @param col - the col number |
| */ |
| |
| public void setLastCol(short col) |
| { |
| field_3_last_col = col; |
| } |
| |
| /** |
| * set the height of the row |
| * @param height of the row |
| */ |
| |
| public void setHeight(short height) |
| { |
| field_4_height = height; |
| } |
| |
| /** |
| * set whether to optimize or not (set to 0) |
| * @param optimize (set to 0) |
| */ |
| |
| public void setOptimize(short optimize) |
| { |
| field_5_optimize = optimize; |
| } |
| |
| /** |
| * sets the option bitmask. (use the individual bit setters that refer to this |
| * method) |
| * @param options - the bitmask |
| */ |
| |
| public void setOptionFlags(short options) |
| { |
| field_7_option_flags = options; |
| } |
| |
| // option bitfields |
| |
| /** |
| * set the outline level of this row |
| * @param ol - the outline level |
| * @see #setOptionFlags(short) |
| */ |
| |
| public void setOutlineLevel(short ol) |
| { |
| field_7_option_flags = |
| outlineLevel.setShortValue(field_7_option_flags, ol); |
| } |
| |
| /** |
| * set whether or not to colapse this row |
| * @param c - colapse or not |
| * @see #setOptionFlags(short) |
| */ |
| |
| public void setColapsed(boolean c) |
| { |
| field_7_option_flags = colapsed.setShortBoolean(field_7_option_flags, |
| c); |
| } |
| |
| /** |
| * set whether or not to display this row with 0 height |
| * @param z height is zero or not. |
| * @see #setOptionFlags(short) |
| */ |
| |
| public void setZeroHeight(boolean z) |
| { |
| field_7_option_flags = |
| zeroHeight.setShortBoolean(field_7_option_flags, z); |
| } |
| |
| /** |
| * set whether the font and row height are not compatible |
| * @param f true if they aren't compatible (damn not logic) |
| * @see #setOptionFlags(short) |
| */ |
| |
| public void setBadFontHeight(boolean f) |
| { |
| field_7_option_flags = |
| badFontHeight.setShortBoolean(field_7_option_flags, f); |
| } |
| |
| /** |
| * set whether the row has been formatted (even if its got all blank cells) |
| * @param f formatted or not |
| * @see #setOptionFlags(short) |
| */ |
| |
| public void setFormatted(boolean f) |
| { |
| field_7_option_flags = formatted.setShortBoolean(field_7_option_flags, |
| f); |
| } |
| |
| // end bitfields |
| |
| /** |
| * if the row is formatted then this is the index to the extended format record |
| * @see org.apache.poi.hssf.record.ExtendedFormatRecord |
| * @param index to the XF record |
| */ |
| |
| public void setXFIndex(short index) |
| { |
| field_8_xf_index = index; |
| } |
| |
| /** |
| * get the logical row number for this row (0 based index) |
| * @return row - the row number |
| */ |
| |
| //public short getRowNumber() |
| public int getRowNumber() |
| { |
| return field_1_row_number; |
| } |
| |
| /** |
| * get the logical col number for the first cell this row (0 based index) |
| * @return col - the col number |
| */ |
| |
| public short getFirstCol() |
| { |
| return field_2_first_col; |
| } |
| |
| /** |
| * get the logical col number for the last cell this row plus one (0 based index) |
| * @return col - the last col number + 1 |
| */ |
| |
| public short getLastCol() |
| { |
| return field_3_last_col; |
| } |
| |
| /** |
| * get the height of the row |
| * @return height of the row |
| */ |
| |
| public short getHeight() |
| { |
| return field_4_height; |
| } |
| |
| /** |
| * get whether to optimize or not (set to 0) |
| * @return optimize (set to 0) |
| */ |
| |
| public short getOptimize() |
| { |
| return field_5_optimize; |
| } |
| |
| /** |
| * gets the option bitmask. (use the individual bit setters that refer to this |
| * method) |
| * @return options - the bitmask |
| */ |
| |
| public short getOptionFlags() |
| { |
| return field_7_option_flags; |
| } |
| |
| // option bitfields |
| |
| /** |
| * get the outline level of this row |
| * @return ol - the outline level |
| * @see #getOptionFlags() |
| */ |
| |
| public short getOutlineLevel() |
| { |
| return outlineLevel.getShortValue(field_7_option_flags); |
| } |
| |
| /** |
| * get whether or not to colapse this row |
| * @return c - colapse or not |
| * @see #getOptionFlags() |
| */ |
| |
| public boolean getColapsed() |
| { |
| return (colapsed.isSet(field_7_option_flags)); |
| } |
| |
| /** |
| * get whether or not to display this row with 0 height |
| * @return - z height is zero or not. |
| * @see #getOptionFlags() |
| */ |
| |
| public boolean getZeroHeight() |
| { |
| return zeroHeight.isSet(field_7_option_flags); |
| } |
| |
| /** |
| * get whether the font and row height are not compatible |
| * @return - f -true if they aren't compatible (damn not logic) |
| * @see #getOptionFlags() |
| */ |
| |
| public boolean getBadFontHeight() |
| { |
| return badFontHeight.isSet(field_7_option_flags); |
| } |
| |
| /** |
| * get whether the row has been formatted (even if its got all blank cells) |
| * @return formatted or not |
| * @see #getOptionFlags() |
| */ |
| |
| public boolean getFormatted() |
| { |
| return formatted.isSet(field_7_option_flags); |
| } |
| |
| // end bitfields |
| |
| /** |
| * if the row is formatted then this is the index to the extended format record |
| * @see org.apache.poi.hssf.record.ExtendedFormatRecord |
| * @return index to the XF record or bogus value (undefined) if isn't formatted |
| */ |
| |
| public short getXFIndex() |
| { |
| return field_8_xf_index; |
| } |
| |
| public boolean isInValueSection() |
| { |
| return true; |
| } |
| |
| public String toString() |
| { |
| StringBuffer buffer = new StringBuffer(); |
| |
| buffer.append("[ROW]\n"); |
| buffer.append(" .rownumber = ") |
| .append(Integer.toHexString(getRowNumber())).append("\n"); |
| buffer.append(" .firstcol = ") |
| .append(Integer.toHexString(getFirstCol())).append("\n"); |
| buffer.append(" .lastcol = ") |
| .append(Integer.toHexString(getLastCol())).append("\n"); |
| buffer.append(" .height = ") |
| .append(Integer.toHexString(getHeight())).append("\n"); |
| buffer.append(" .optimize = ") |
| .append(Integer.toHexString(getOptimize())).append("\n"); |
| buffer.append(" .reserved = ") |
| .append(Integer.toHexString(field_6_reserved)).append("\n"); |
| buffer.append(" .optionflags = ") |
| .append(Integer.toHexString(getOptionFlags())).append("\n"); |
| buffer.append(" .outlinelvl = ") |
| .append(Integer.toHexString(getOutlineLevel())).append("\n"); |
| buffer.append(" .colapsed = ").append(getColapsed()) |
| .append("\n"); |
| buffer.append(" .zeroheight = ").append(getZeroHeight()) |
| .append("\n"); |
| buffer.append(" .badfontheig= ").append(getBadFontHeight()) |
| .append("\n"); |
| buffer.append(" .formatted = ").append(getFormatted()) |
| .append("\n"); |
| buffer.append(" .xfindex = ") |
| .append(Integer.toHexString(getXFIndex())).append("\n"); |
| buffer.append("[/ROW]\n"); |
| return buffer.toString(); |
| } |
| |
| public int serialize(int offset, byte [] data) |
| { |
| LittleEndian.putShort(data, 0 + offset, sid); |
| LittleEndian.putShort(data, 2 + offset, ( short ) 16); |
| //LittleEndian.putShort(data, 4 + offset, getRowNumber()); |
| LittleEndian.putShort(data, 4 + offset, ( short ) getRowNumber()); |
| LittleEndian.putShort(data, 6 + offset, getFirstCol() == -1 ? (short)0 : getFirstCol()); |
| LittleEndian.putShort(data, 8 + offset, getLastCol() == -1 ? (short)0 : getLastCol()); |
| LittleEndian.putShort(data, 10 + offset, getHeight()); |
| LittleEndian.putShort(data, 12 + offset, getOptimize()); |
| LittleEndian.putShort(data, 14 + offset, field_6_reserved); |
| LittleEndian.putShort(data, 16 + offset, getOptionFlags()); |
| |
| // LittleEndian.putShort(data,18,getOutlineLevel()); |
| LittleEndian.putShort(data, 18 + offset, getXFIndex()); |
| return getRecordSize(); |
| } |
| |
| public int getRecordSize() |
| { |
| return 20; |
| } |
| |
| public short getSid() |
| { |
| return sid; |
| } |
| |
| public int compareTo(Object obj) |
| { |
| RowRecord loc = ( RowRecord ) obj; |
| |
| if (this.getRowNumber() == loc.getRowNumber()) |
| { |
| return 0; |
| } |
| if (this.getRowNumber() < loc.getRowNumber()) |
| { |
| return -1; |
| } |
| if (this.getRowNumber() > loc.getRowNumber()) |
| { |
| return 1; |
| } |
| return -1; |
| } |
| |
| public boolean equals(Object obj) |
| { |
| if (!(obj instanceof RowRecord)) |
| { |
| return false; |
| } |
| RowRecord loc = ( RowRecord ) obj; |
| |
| if (this.getRowNumber() == loc.getRowNumber()) |
| { |
| return true; |
| } |
| return false; |
| } |
| |
| public Object clone() { |
| RowRecord rec = new RowRecord(); |
| rec.field_1_row_number = field_1_row_number; |
| rec.field_2_first_col = field_2_first_col; |
| rec.field_3_last_col = field_3_last_col; |
| rec.field_4_height = field_4_height; |
| rec.field_5_optimize = field_5_optimize; |
| rec.field_6_reserved = field_6_reserved; |
| rec.field_7_option_flags = field_7_option_flags; |
| rec.field_8_xf_index = field_8_xf_index; |
| return rec; |
| } |
| } |