1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   
57   package org.apache.poi.hssf.record;
58   
59   
60   
61   import org.apache.poi.util.*;
62   
63   /**
64    * Links text to an object on the chart or identifies it as the title.
65    * NOTE: This source is automatically generated please do not modify this file.  Either subclass or
66    *       remove the record in src/records/definitions.
67   
68    * @author Andrew C. Oliver (acoliver at apache.org)
69    */
70   public class ObjectLinkRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1027;
74       private  short      field_1_anchorId;
75       public final static short       ANCHOR_ID_CHART_TITLE          = 1;
76       public final static short       ANCHOR_ID_Y_AXIS               = 2;
77       public final static short       ANCHOR_ID_X_AXIS               = 3;
78       public final static short       ANCHOR_ID_SERIES_OR_POINT      = 4;
79       public final static short       ANCHOR_ID_Z_AXIS               = 7;
80       private  short      field_2_link1;
81       private  short      field_3_link2;
82   
83   
84       public ObjectLinkRecord()
85       {
86   
87       }
88   
89       /**
90        * Constructs a ObjectLink record and sets its fields appropriately.
91        *
92        * @param id    id must be 0x1027 or an exception
93        *              will be throw upon validation
94        * @param size  size the size of the data area of the record
95        * @param data  data of the record (should not contain sid/len)
96        */
97   
98       public ObjectLinkRecord(short id, short size, byte [] data)
99       {
100          super(id, size, data);
101      }
102  
103      /**
104       * Constructs a ObjectLink record and sets its fields appropriately.
105       *
106       * @param id    id must be 0x1027 or an exception
107       *              will be throw upon validation
108       * @param size  size the size of the data area of the record
109       * @param data  data of the record (should not contain sid/len)
110       * @param offset of the record's data
111       */
112  
113      public ObjectLinkRecord(short id, short size, byte [] data, int offset)
114      {
115          super(id, size, data, offset);
116      }
117  
118      /**
119       * Checks the sid matches the expected side for this record
120       *
121       * @param id   the expected sid.
122       */
123      protected void validateSid(short id)
124      {
125          if (id != sid)
126          {
127              throw new RecordFormatException("Not a ObjectLink record");
128          }
129      }
130  
131      protected void fillFields(byte [] data, short size, int offset)
132      {
133          field_1_anchorId                = LittleEndian.getShort(data, 0x0 + offset);
134          field_2_link1                   = LittleEndian.getShort(data, 0x2 + offset);
135          field_3_link2                   = LittleEndian.getShort(data, 0x4 + offset);
136  
137      }
138  
139      public String toString()
140      {
141          StringBuffer buffer = new StringBuffer();
142  
143          buffer.append("[ObjectLink]\n");
144  
145          buffer.append("    .anchorId             = ")
146              .append("0x")
147              .append(HexDump.toHex((short)getAnchorId()))
148              .append(" (").append(getAnchorId()).append(" )\n");
149  
150          buffer.append("    .link1                = ")
151              .append("0x")
152              .append(HexDump.toHex((short)getLink1()))
153              .append(" (").append(getLink1()).append(" )\n");
154  
155          buffer.append("    .link2                = ")
156              .append("0x")
157              .append(HexDump.toHex((short)getLink2()))
158              .append(" (").append(getLink2()).append(" )\n");
159  
160          buffer.append("[/ObjectLink]\n");
161          return buffer.toString();
162      }
163  
164      public int serialize(int offset, byte[] data)
165      {
166          LittleEndian.putShort(data, 0 + offset, sid);
167          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
168  
169          LittleEndian.putShort(data, 4 + offset, field_1_anchorId);
170          LittleEndian.putShort(data, 6 + offset, field_2_link1);
171          LittleEndian.putShort(data, 8 + offset, field_3_link2);
172  
173          return getRecordSize();
174      }
175  
176      /**
177       * Size of record (exluding 4 byte header)
178       */
179      public int getRecordSize()
180      {
181          return 4  + 2 + 2 + 2;
182      }
183  
184      public short getSid()
185      {
186          return this.sid;
187      }
188  
189  
190      /**
191       * Get the anchor id field for the ObjectLink record.
192       *
193       * @return  One of 
194       *        ANCHOR_ID_CHART_TITLE
195       *        ANCHOR_ID_Y_AXIS
196       *        ANCHOR_ID_X_AXIS
197       *        ANCHOR_ID_SERIES_OR_POINT
198       *        ANCHOR_ID_Z_AXIS
199       */
200      public short getAnchorId()
201      {
202          return field_1_anchorId;
203      }
204  
205      /**
206       * Set the anchor id field for the ObjectLink record.
207       *
208       * @param field_1_anchorId
209       *        One of 
210       *        ANCHOR_ID_CHART_TITLE
211       *        ANCHOR_ID_Y_AXIS
212       *        ANCHOR_ID_X_AXIS
213       *        ANCHOR_ID_SERIES_OR_POINT
214       *        ANCHOR_ID_Z_AXIS
215       */
216      public void setAnchorId(short field_1_anchorId)
217      {
218          this.field_1_anchorId = field_1_anchorId;
219      }
220  
221      /**
222       * Get the link 1 field for the ObjectLink record.
223       */
224      public short getLink1()
225      {
226          return field_2_link1;
227      }
228  
229      /**
230       * Set the link 1 field for the ObjectLink record.
231       */
232      public void setLink1(short field_2_link1)
233      {
234          this.field_2_link1 = field_2_link1;
235      }
236  
237      /**
238       * Get the link 2 field for the ObjectLink record.
239       */
240      public short getLink2()
241      {
242          return field_3_link2;
243      }
244  
245      /**
246       * Set the link 2 field for the ObjectLink record.
247       */
248      public void setLink2(short field_3_link2)
249      {
250          this.field_3_link2 = field_3_link2;
251      }
252  
253  
254  }  // END OF CLASS
255  
256  
257  
258  
259