poi/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java

/* ====================================================================
   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.formula;

import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.util.CellReference;
import org.apache.poi.hssf.util.AreaReference;
import org.apache.poi.hssf.record.RecordInputStream;
import org.apache.poi.util.BitField;
import org.apache.poi.util.BitFieldFactory;
import org.apache.poi.util.LittleEndian;


/**
 * Title:        Area 3D Ptg - 3D reference (Sheet + Area)<P>
 * Description:  Defined a area in Extern Sheet. <P>
 * REFERENCE:  <P>
 * @author Libin Roman (Vista Portal LDT. Developer)
 * @author avik
 * @author Jason Height (jheight at chariot dot net dot au)
 * @version 1.0-pre
 */
public final class Area3DPtg extends OperandPtg implements AreaI {
	public final static byte sid = 0x3b;
	private final static int SIZE = 11; // 10 + 1 for Ptg
	private short field_1_index_extern_sheet;
	private int field_2_first_row;
	private int field_3_last_row;
	private int field_4_first_column;
	private int field_5_last_column;

	private BitField rowRelative = BitFieldFactory.getInstance( 0x8000 );
	private BitField colRelative = BitFieldFactory.getInstance( 0x4000 );

	/** Creates new AreaPtg */
	public Area3DPtg()
	{
	}

	public Area3DPtg( String arearef, short externIdx )
	{
		setArea(arearef);
		setExternSheetIndex( externIdx );

	}

	public Area3DPtg(RecordInputStream in)
	{
		field_1_index_extern_sheet = in.readShort();
		field_2_first_row = in.readUShort();
		field_3_last_row = in.readUShort();
		field_4_first_column = in.readUShort();
		field_5_last_column = in.readUShort();
	}

	public Area3DPtg(short firstRow, short lastRow, short firstColumn, short lastColumn,
			boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative,
			short externalSheetIndex) {
		  setFirstRow(firstRow);
		  setLastRow(lastRow);
		  setFirstColumn(firstColumn);
		  setLastColumn(lastColumn);
		  setFirstRowRelative(firstRowRelative);
		  setLastRowRelative(lastRowRelative);
		  setFirstColRelative(firstColRelative);
		  setLastColRelative(lastColRelative);
		  setExternSheetIndex(externalSheetIndex);
	}

	public String toString() {
		StringBuffer sb = new StringBuffer();
		sb.append(getClass().getName());
		sb.append(" [");
		sb.append("sheetIx=").append(getExternSheetIndex());
		sb.append(" ! ");
		sb.append(AreaReference.formatAsString(this));
		sb.append("]");
		return sb.toString();
	}

	public void writeBytes( byte[] array, int offset )
	{
		array[0 + offset] = (byte) ( sid + getPtgClass() );
		LittleEndian.putShort( array, 1 + offset, getExternSheetIndex() );
		LittleEndian.putShort( array, 3 + offset, (short)getFirstRow() );
		LittleEndian.putShort( array, 5 + offset, (short)getLastRow() );
		LittleEndian.putShort( array, 7 + offset, (short)getFirstColumnRaw() );
		LittleEndian.putShort( array, 9 + offset, (short)getLastColumnRaw() );
	}

	public int getSize()
	{
		return SIZE;
	}

	public short getExternSheetIndex()
	{
		return field_1_index_extern_sheet;
	}

	public void setExternSheetIndex( short index )
	{
		field_1_index_extern_sheet = index;
	}

	public int getFirstRow()
	{
		return field_2_first_row;
	}

	public void setFirstRow( int row )
	{
		field_2_first_row = row;
	}

	public int getLastRow()
	{
		return field_3_last_row;
	}

	public void setLastRow( int row )
	{
		field_3_last_row = row;
	}

	public int getFirstColumn()
	{
		return field_4_first_column & 0xFF;
	}

	public int getFirstColumnRaw()
	{
		return field_4_first_column;
	}

	public boolean isFirstRowRelative()
	{
		return rowRelative.isSet( field_4_first_column );
	}

	public boolean isFirstColRelative()
	{
		return colRelative.isSet( field_4_first_column );
	}

	public void setFirstColumn( short column )
	{
		field_4_first_column &= 0xFF00;
		field_4_first_column |= column & 0xFF;
	}

	public void setFirstColumnRaw( short column )
	{
		field_4_first_column = column;
	}

	public int getLastColumn()
	{
		return field_5_last_column & 0xFF;
	}

	public int getLastColumnRaw()
	{
		return field_5_last_column;
	}

	public boolean isLastRowRelative()
	{
		return rowRelative.isSet( field_5_last_column );
	}

	public boolean isLastColRelative()
	{
		return colRelative.isSet( field_5_last_column );
	}

	public void setLastColumn( short column )
	{
		field_5_last_column &= 0xFF00;
		field_5_last_column |= column & 0xFF;
	}

	public void setLastColumnRaw( short column )
	{
		field_5_last_column = column;
	}

	/**
	 * sets the first row to relative or not
	 * @param rel FIXME: Document this!
	 */
	public void setFirstRowRelative( boolean rel )
	{
		field_4_first_column = rowRelative.setBoolean( field_4_first_column, rel );
	}

	/**
	 * set whether the first column is relative
	 */
	public void setFirstColRelative( boolean rel )
	{
		field_4_first_column = colRelative.setBoolean( field_4_first_column, rel );
	}

	/**
	 * set whether the last row is relative or not
	 * @param rel FIXME: Document this!
	 */
	public void setLastRowRelative( boolean rel )
	{
		field_5_last_column = rowRelative.setBoolean( field_5_last_column, rel );
	}

	/**
	 * set whether the last column should be relative or not
	 */
	public void setLastColRelative( boolean rel )
	{
		field_5_last_column = colRelative.setBoolean( field_5_last_column, rel );
	}


	/*public String getArea(){
		RangeAddress ra = new RangeAddress( getFirstColumn(),getFirstRow() + 1, getLastColumn(), getLastRow() + 1);
		String result = ra.getAddress();

		return result;
	}*/

	public void setArea( String ref )
	{
		AreaReference ar = new AreaReference( ref );
		
		CellReference frstCell = ar.getFirstCell();
		CellReference lastCell = ar.getLastCell();

		setFirstRow(	(short) frstCell.getRow() );
		setFirstColumn(	(short) frstCell.getCol() );
		setLastRow(     (short) lastCell.getRow() );
		setLastColumn(  (short) lastCell.getCol() );
		setFirstColRelative( !frstCell.isColAbsolute() );
		setLastColRelative(  !lastCell.isColAbsolute() );
		setFirstRowRelative( !frstCell.isRowAbsolute() );
		setLastRowRelative(  !lastCell.isRowAbsolute() );
	}

	/**
	 * @return text representation of this area reference that can be used in text
	 *  formulas. The sheet name will get properly delimited if required.
	 */
	public String toFormulaString(Workbook book)
	{
		// First do the sheet name
		StringBuffer retval = new StringBuffer();
		String sheetName = Ref3DPtg.getSheetName(book, field_1_index_extern_sheet);
		if(sheetName != null) {
			if(sheetName.length() == 0) {
				// What excel does if sheet has been deleted
				sheetName = "#REF";
				retval.append(sheetName);
			} else {
				// Normal
				SheetNameFormatter.appendFormat(retval, sheetName);
			}
			retval.append( '!' );
		}
		
		// Now the normal area bit
		retval.append(AreaReference.formatAsString(this));
		
		// All done
		return retval.toString();
	}

	public byte getDefaultOperandClass() {
		return Ptg.CLASS_REF;
	}
	// TODO - one junit relies on this. remove
	public boolean equals( Object o )
	{
		if ( this == o ) return true;
		if ( !( o instanceof Area3DPtg ) ) return false;

		final Area3DPtg area3DPtg = (Area3DPtg) o;

		if ( field_1_index_extern_sheet != area3DPtg.field_1_index_extern_sheet ) return false;
		if ( field_2_first_row != area3DPtg.field_2_first_row ) return false;
		if ( field_3_last_row != area3DPtg.field_3_last_row ) return false;
		if ( field_4_first_column != area3DPtg.field_4_first_column ) return false;
		if ( field_5_last_column != area3DPtg.field_5_last_column ) return false;

		return true;
	}
}