src/java/org/apache/poi/hssf/record/SeriesToChartGroupRecord.java

   1
   2 /* ====================================================================
   3    Licensed to the Apache Software Foundation (ASF) under one or more
   4    contributor license agreements.  See the NOTICE file distributed with
   5    this work for additional information regarding copyright ownership.
   6    The ASF licenses this file to You under the Apache License, Version 2.0
   7    (the "License"); you may not use this file except in compliance with
   8    the License.  You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================== */
  18
  19
  20 package org.apache.poi.hssf.record;
  21
  22
  23
  24 import org.apache.poi.util.*;
  25
  26 /**
  27  * Indicates the chart-group index for a series.  The order probably defines the mapping.  So the 0th record probably means the 0th series.  The only field in this of course defines which chart group the 0th series (for instance) would map to.  Confusing?  Well thats because it is.  (p 522 BCG)
  28  * NOTE: This source is automatically generated please do not modify this file.  Either subclass or
  29  *       remove the record in src/records/definitions.
  30
  31  * @author Andrew C. Oliver (acoliver at apache.org)
  32  */
  33 public class SeriesToChartGroupRecord
  34     extends Record
  35 {
  36     public final static short      sid                             = 0x1045;
  37     private  short      field_1_chartGroupIndex;
  38
  39
  40     public SeriesToChartGroupRecord()
  41     {
  42
  43     }
  44
  45     /**
  46      * Constructs a SeriesToChartGroup record and sets its fields appropriately.
  47      *
  48      * @param in the RecordInputstream to read the record from
  49      */
  50
  51     public SeriesToChartGroupRecord(RecordInputStream in)
  52     {
  53         super(in);
  54
  55     }
  56
  57     /**
  58      * Checks the sid matches the expected side for this record
  59      *
  60      * @param id   the expected sid.
  61      */
  62     protected void validateSid(short id)
  63     {
  64         if (id != sid)
  65         {
  66             throw new RecordFormatException("Not a SeriesToChartGroup record");
  67         }
  68     }
  69
  70     protected void fillFields(RecordInputStream in)
  71     {
  72         field_1_chartGroupIndex        = in.readShort();
  73     }
  74
  75     public String toString()
  76     {
  77         StringBuffer buffer = new StringBuffer();
  78
  79         buffer.append("[SeriesToChartGroup]\n");
  80         buffer.append("    .chartGroupIndex      = ")
  81             .append("0x").append(HexDump.toHex(  getChartGroupIndex ()))
  82             .append(" (").append( getChartGroupIndex() ).append(" )");
  83         buffer.append(System.getProperty("line.separator"));
  84
  85         buffer.append("[/SeriesToChartGroup]\n");
  86         return buffer.toString();
  87     }
  88
  89     public int serialize(int offset, byte[] data)
  90     {
  91         int pos = 0;
  92
  93         LittleEndian.putShort(data, 0 + offset, sid);
  94         LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
  95
  96         LittleEndian.putShort(data, 4 + offset + pos, field_1_chartGroupIndex);
  97
  98         return getRecordSize();
  99     }
 100
 101     /**
 102      * Size of record (exluding 4 byte header)
 103      */
 104     public int getRecordSize()
 105     {
 106         return 4  + 2;
 107     }
 108
 109     public short getSid()
 110     {
 111         return sid;
 112     }
 113
 114     public Object clone() {
 115         SeriesToChartGroupRecord rec = new SeriesToChartGroupRecord();
 116
 117         rec.field_1_chartGroupIndex = field_1_chartGroupIndex;
 118         return rec;
 119     }
 120
 121
 122
 123
 124     /**
 125      * Get the chart group index field for the SeriesToChartGroup record.
 126      */
 127     public short getChartGroupIndex()
 128     {
 129         return field_1_chartGroupIndex;
 130     }
 131
 132     /**
 133      * Set the chart group index field for the SeriesToChartGroup record.
 134      */
 135     public void setChartGroupIndex(short field_1_chartGroupIndex)
 136     {
 137         this.field_1_chartGroupIndex = field_1_chartGroupIndex;
 138     }
 139
 140
 141 }  // END OF CLASS
 142
 143
 144
 145