acoliver    02/05/18 09:22:10

  Added:       src/java/org/apache/poi/hssf/record ObjectLinkRecord.java
  Log:
  new object link record (graphing)
  
  Revision  Changes    Path
  1.1                  
jakarta-poi/src/java/org/apache/poi/hssf/record/ObjectLinkRecord.java
  
  Index: ObjectLinkRecord.java
  ===================================================================
  
  /* ====================================================================
   * 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 [EMAIL PROTECTED]
   *
   * 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.*;
  
  /**
   * Links text to an object on the chart or identifies it as the title.
   * NOTE: This source is automatically generated please do not modify this file.  
Either subclass or
   *       remove the record in src/records/definitions.
  
   * @author Andrew C. Oliver (acoliver at apache.org)
   */
  public class ObjectLinkRecord
      extends Record
  {
      public final static short      sid                             = 0x1027;
      private  short      field_1_anchorId;
      public final static short       ANCHOR_ID_CHART_TITLE          = 1;
      public final static short       ANCHOR_ID_Y_AXIS               = 2;
      public final static short       ANCHOR_ID_X_AXIS               = 3;
      public final static short       ANCHOR_ID_SERIES_OR_POINT      = 4;
      public final static short       ANCHOR_ID_Z_AXIS               = 7;
      private  short      field_2_link1;
      private  short      field_3_link2;
  
  
      public ObjectLinkRecord()
      {
  
      }
  
      /**
       * Constructs a ObjectLink record and sets its fields appropriately.
       *
       * @param id    id must be 0x1027 or an exception
       *              will be throw upon validation
       * @param size  size the size of the data area of the record
       * @param data  data of the record (should not contain sid/len)
       */
  
      public ObjectLinkRecord(short id, short size, byte [] data)
      {
          super(id, size, data);
      }
  
      /**
       * Constructs a ObjectLink record and sets its fields appropriately.
       *
       * @param id    id must be 0x1027 or an exception
       *              will be throw upon validation
       * @param size  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 ObjectLinkRecord(short id, short size, byte [] data, int offset)
      {
          super(id, size, data, offset);
      }
  
      /**
       * 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 ObjectLink record");
          }
      }
  
      protected void fillFields(byte [] data, short size, int offset)
      {
          field_1_anchorId                = LittleEndian.getShort(data, 0x0 + offset);
          field_2_link1                   = LittleEndian.getShort(data, 0x2 + offset);
          field_3_link2                   = LittleEndian.getShort(data, 0x4 + offset);
  
      }
  
      public String toString()
      {
          StringBuffer buffer = new StringBuffer();
  
          buffer.append("[ObjectLink]\n");
  
          buffer.append("    .anchorId             = ")
              .append("0x")
              .append(HexDump.toHex((short)getAnchorId()))
              .append(" (").append(getAnchorId()).append(" )\n");
  
          buffer.append("    .link1                = ")
              .append("0x")
              .append(HexDump.toHex((short)getLink1()))
              .append(" (").append(getLink1()).append(" )\n");
  
          buffer.append("    .link2                = ")
              .append("0x")
              .append(HexDump.toHex((short)getLink2()))
              .append(" (").append(getLink2()).append(" )\n");
  
          buffer.append("[/ObjectLink]\n");
          return buffer.toString();
      }
  
      public int serialize(int offset, byte[] data)
      {
          LittleEndian.putShort(data, 0 + offset, sid);
          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
  
          LittleEndian.putShort(data, 4 + offset, field_1_anchorId);
          LittleEndian.putShort(data, 6 + offset, field_2_link1);
          LittleEndian.putShort(data, 8 + offset, field_3_link2);
  
          return getRecordSize();
      }
  
      /**
       * Size of record (exluding 4 byte header)
       */
      public int getRecordSize()
      {
          return 4 + 2 + 2 + 2;
      }
  
      public short getSid()
      {
          return this.sid;
      }
  
  
      /**
       * Get the anchor id field for the ObjectLink record.
       *
       * @return  One of 
       *        ANCHOR_ID_CHART_TITLE
       *        ANCHOR_ID_Y_AXIS
       *        ANCHOR_ID_X_AXIS
       *        ANCHOR_ID_SERIES_OR_POINT
       *        ANCHOR_ID_Z_AXIS
       */
      public short getAnchorId()
      {
          return field_1_anchorId;
      }
  
      /**
       * Set the anchor id field for the ObjectLink record.
       *
       * @param field_1_anchorId
       *        One of 
       *        ANCHOR_ID_CHART_TITLE
       *        ANCHOR_ID_Y_AXIS
       *        ANCHOR_ID_X_AXIS
       *        ANCHOR_ID_SERIES_OR_POINT
       *        ANCHOR_ID_Z_AXIS
       */
      public void setAnchorId(short field_1_anchorId)
      {
          this.field_1_anchorId = field_1_anchorId;
      }
  
      /**
       * Get the link 1 field for the ObjectLink record.
       */
      public short getLink1()
      {
          return field_2_link1;
      }
  
      /**
       * Set the link 1 field for the ObjectLink record.
       */
      public void setLink1(short field_2_link1)
      {
          this.field_2_link1 = field_2_link1;
      }
  
      /**
       * Get the link 2 field for the ObjectLink record.
       */
      public short getLink2()
      {
          return field_3_link2;
      }
  
      /**
       * Set the link 2 field for the ObjectLink record.
       */
      public void setLink2(short field_3_link2)
      {
          this.field_3_link2 = field_3_link2;
      }
  
  
  }  // END OF CLASS
  
  
  
  
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to