| |
| /* ==================================================================== |
| 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.*; |
| |
| /** |
| * Describes a linked data record. This record referes to the series data or text. |
| * NOTE: This source is automatically generated please do not modify this file. Either subclass or |
| * remove the record in src/records/definitions. |
| |
| * @author Glen Stampoultzis (glens at apache.org) |
| */ |
| public class LinkedDataRecord |
| extends Record |
| { |
| public final static short sid = 0x1051; |
| private byte field_1_linkType; |
| public final static byte LINK_TYPE_TITLE_OR_TEXT = 0; |
| public final static byte LINK_TYPE_VALUES = 1; |
| public final static byte LINK_TYPE_CATEGORIES = 2; |
| private byte field_2_referenceType; |
| public final static byte REFERENCE_TYPE_DEFAULT_CATEGORIES = 0; |
| public final static byte REFERENCE_TYPE_DIRECT = 1; |
| public final static byte REFERENCE_TYPE_WORKSHEET = 2; |
| public final static byte REFERENCE_TYPE_NOT_USED = 3; |
| public final static byte REFERENCE_TYPE_ERROR_REPORTED = 4; |
| private short field_3_options; |
| private BitField customNumberFormat = BitFieldFactory.getInstance(0x1); |
| private short field_4_indexNumberFmtRecord; |
| private LinkedDataFormulaField field_5_formulaOfLink; |
| |
| |
| public LinkedDataRecord() |
| { |
| |
| } |
| |
| /** |
| * Constructs a LinkedData record and sets its fields appropriately. |
| * |
| * @param in the RecordInputstream to read the record from |
| */ |
| |
| public LinkedDataRecord(RecordInputStream in) |
| { |
| super(in); |
| |
| } |
| |
| /** |
| * Checks the sid matches the expected side for this record |
| * |
| * @param id the expected sid. |
| */ |
| protected void validateSid(short id) |
| { |
| if (id != sid) |
| { |
| throw new RecordFormatException("Not a LinkedData record"); |
| } |
| } |
| |
| protected void fillFields(RecordInputStream in) |
| { |
| field_1_linkType = in.readByte(); |
| field_2_referenceType = in.readByte(); |
| field_3_options = in.readShort(); |
| field_4_indexNumberFmtRecord = in.readShort(); |
| field_5_formulaOfLink = new org.apache.poi.hssf.record.LinkedDataFormulaField(); |
| field_5_formulaOfLink.fillField(in); |
| } |
| |
| public String toString() |
| { |
| StringBuffer buffer = new StringBuffer(); |
| |
| buffer.append("[AI]\n"); |
| buffer.append(" .linkType = ") |
| .append("0x").append(HexDump.toHex( getLinkType ())) |
| .append(" (").append( getLinkType() ).append(" )"); |
| buffer.append(System.getProperty("line.separator")); |
| buffer.append(" .referenceType = ") |
| .append("0x").append(HexDump.toHex( getReferenceType ())) |
| .append(" (").append( getReferenceType() ).append(" )"); |
| buffer.append(System.getProperty("line.separator")); |
| buffer.append(" .options = ") |
| .append("0x").append(HexDump.toHex( getOptions ())) |
| .append(" (").append( getOptions() ).append(" )"); |
| buffer.append(System.getProperty("line.separator")); |
| buffer.append(" .customNumberFormat = ").append(isCustomNumberFormat()).append('\n'); |
| buffer.append(" .indexNumberFmtRecord = ") |
| .append("0x").append(HexDump.toHex( getIndexNumberFmtRecord ())) |
| .append(" (").append( getIndexNumberFmtRecord() ).append(" )"); |
| buffer.append(System.getProperty("line.separator")); |
| buffer.append(" .formulaOfLink = ") |
| .append(" (").append( getFormulaOfLink() ).append(" )"); |
| buffer.append(System.getProperty("line.separator")); |
| |
| buffer.append("[/AI]\n"); |
| return buffer.toString(); |
| } |
| |
| public int serialize(int offset, byte[] data) |
| { |
| int pos = 0; |
| |
| LittleEndian.putShort(data, 0 + offset, sid); |
| LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); |
| |
| data[ 4 + offset + pos ] = field_1_linkType; |
| data[ 5 + offset + pos ] = field_2_referenceType; |
| LittleEndian.putShort(data, 6 + offset + pos, field_3_options); |
| LittleEndian.putShort(data, 8 + offset + pos, field_4_indexNumberFmtRecord); |
| pos += field_5_formulaOfLink.serializeField( pos + 10 + offset, data ); |
| |
| return getRecordSize(); |
| } |
| |
| /** |
| * Size of record (exluding 4 byte header) |
| */ |
| public int getRecordSize() |
| { |
| return 4 + 1 + 1 + 2 + 2 + field_5_formulaOfLink.getSize(); |
| } |
| |
| public short getSid() |
| { |
| return sid; |
| } |
| |
| public Object clone() { |
| LinkedDataRecord rec = new LinkedDataRecord(); |
| |
| rec.field_1_linkType = field_1_linkType; |
| rec.field_2_referenceType = field_2_referenceType; |
| rec.field_3_options = field_3_options; |
| rec.field_4_indexNumberFmtRecord = field_4_indexNumberFmtRecord; |
| rec.field_5_formulaOfLink = ((org.apache.poi.hssf.record.LinkedDataFormulaField)field_5_formulaOfLink.clone());; |
| return rec; |
| } |
| |
| |
| |
| |
| /** |
| * Get the link type field for the LinkedData record. |
| * |
| * @return One of |
| * LINK_TYPE_TITLE_OR_TEXT |
| * LINK_TYPE_VALUES |
| * LINK_TYPE_CATEGORIES |
| */ |
| public byte getLinkType() |
| { |
| return field_1_linkType; |
| } |
| |
| /** |
| * Set the link type field for the LinkedData record. |
| * |
| * @param field_1_linkType |
| * One of |
| * LINK_TYPE_TITLE_OR_TEXT |
| * LINK_TYPE_VALUES |
| * LINK_TYPE_CATEGORIES |
| */ |
| public void setLinkType(byte field_1_linkType) |
| { |
| this.field_1_linkType = field_1_linkType; |
| } |
| |
| /** |
| * Get the reference type field for the LinkedData record. |
| * |
| * @return One of |
| * REFERENCE_TYPE_DEFAULT_CATEGORIES |
| * REFERENCE_TYPE_DIRECT |
| * REFERENCE_TYPE_WORKSHEET |
| * REFERENCE_TYPE_NOT_USED |
| * REFERENCE_TYPE_ERROR_REPORTED |
| */ |
| public byte getReferenceType() |
| { |
| return field_2_referenceType; |
| } |
| |
| /** |
| * Set the reference type field for the LinkedData record. |
| * |
| * @param field_2_referenceType |
| * One of |
| * REFERENCE_TYPE_DEFAULT_CATEGORIES |
| * REFERENCE_TYPE_DIRECT |
| * REFERENCE_TYPE_WORKSHEET |
| * REFERENCE_TYPE_NOT_USED |
| * REFERENCE_TYPE_ERROR_REPORTED |
| */ |
| public void setReferenceType(byte field_2_referenceType) |
| { |
| this.field_2_referenceType = field_2_referenceType; |
| } |
| |
| /** |
| * Get the options field for the LinkedData record. |
| */ |
| public short getOptions() |
| { |
| return field_3_options; |
| } |
| |
| /** |
| * Set the options field for the LinkedData record. |
| */ |
| public void setOptions(short field_3_options) |
| { |
| this.field_3_options = field_3_options; |
| } |
| |
| /** |
| * Get the index number fmt record field for the LinkedData record. |
| */ |
| public short getIndexNumberFmtRecord() |
| { |
| return field_4_indexNumberFmtRecord; |
| } |
| |
| /** |
| * Set the index number fmt record field for the LinkedData record. |
| */ |
| public void setIndexNumberFmtRecord(short field_4_indexNumberFmtRecord) |
| { |
| this.field_4_indexNumberFmtRecord = field_4_indexNumberFmtRecord; |
| } |
| |
| /** |
| * Get the formula of link field for the LinkedData record. |
| */ |
| public LinkedDataFormulaField getFormulaOfLink() |
| { |
| return field_5_formulaOfLink; |
| } |
| |
| /** |
| * Set the formula of link field for the LinkedData record. |
| */ |
| public void setFormulaOfLink(LinkedDataFormulaField field_5_formulaOfLink) |
| { |
| this.field_5_formulaOfLink = field_5_formulaOfLink; |
| } |
| |
| /** |
| * Sets the custom number format field value. |
| * true if this object has a custom number format |
| */ |
| public void setCustomNumberFormat(boolean value) |
| { |
| field_3_options = customNumberFormat.setShortBoolean(field_3_options, value); |
| } |
| |
| /** |
| * true if this object has a custom number format |
| * @return the custom number format field value. |
| */ |
| public boolean isCustomNumberFormat() |
| { |
| return customNumberFormat.isSet(field_3_options); |
| } |
| |
| |
| } // END OF CLASS |
| |
| |
| |
| |