Class NoteRecord

java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.NoteRecord

public class NoteRecord extends Record
NOTE: Comment Associated with a Cell (1Ch)
Author:
Yegor Kozlov
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    Flag indicating that the comment is hidden (default)
    static final short
    Flag indicating that the comment is visible
    static final short
     
  • Constructor Summary

    Constructors
    Constructor
    Description
    Construct a new NoteRecord and fill its data with the default values
    Constructs a NoteRecord and fills its fields from the supplied RecordInputStream.
  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    Read the record data from the supplied RecordInputStream
    Name of the original comment author
    short
    Return the column that contains the comment
    short
    Options flags.
    int
    Size of record
    short
    Return the row that contains the comment
    short
    Object id for OBJ record that contains the comment
    short
    return the non static version of the id for this record.
    int
    serialize(int offset, byte[] data)
    Serialize the record data into the supplied array of bytes
    void
    setAuthor(String author)
    Name of the original comment author
    void
    setColumn(short col)
    Specify the column that contains the comment
    void
    setFlags(short flags)
    Options flag
    void
    setRow(short row)
    Specify the row that contains the comment
    void
    setShapeId(short id)
    Object id for OBJ record that contains the comment
    Convert this record to string.
    protected void
    validateSid(short id)
    Checks the sid matches the expected side for this record

    Methods inherited from class loci.poi.hssf.record.Record

    clone, isInValueSection, isValue, serialize

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • sid

      public static final short sid
      See Also:
    • NOTE_HIDDEN

      public static final short NOTE_HIDDEN
      Flag indicating that the comment is hidden (default)
      See Also:
    • NOTE_VISIBLE

      public static final short NOTE_VISIBLE
      Flag indicating that the comment is visible
      See Also:
  • Constructor Details

    • NoteRecord

      public NoteRecord()
      Construct a new NoteRecord and fill its data with the default values
    • NoteRecord

      public NoteRecord(RecordInputStream in)
      Constructs a NoteRecord and fills its fields from the supplied RecordInputStream.
      Parameters:
      in - the stream to read from
  • Method Details

    • getSid

      public short getSid()
      Description copied from class: Record
      return the non static version of the id for this record.
      Specified by:
      getSid in class Record
      Returns:
      id of this record.
    • validateSid

      protected void validateSid(short id)
      Checks the sid matches the expected side for this record
      Specified by:
      validateSid in class Record
      Parameters:
      id - the expected sid.
    • fillFields

      protected void fillFields(RecordInputStream in)
      Read the record data from the supplied RecordInputStream
      Specified by:
      fillFields in class Record
      Parameters:
      in - the RecordInputstream to read the record from
    • serialize

      public int serialize(int offset, byte[] data)
      Serialize the record data into the supplied array of bytes
      Specified by:
      serialize in class Record
      Parameters:
      offset - offset in the data
      data - the data to serialize into
      Returns:
      size of the record
    • getRecordSize

      public int getRecordSize()
      Size of record
      Overrides:
      getRecordSize in class Record
    • toString

      public String toString()
      Convert this record to string. Used by BiffViewer and other utulities.
      Overrides:
      toString in class Record
    • getRow

      public short getRow()
      Return the row that contains the comment
      Returns:
      the row that contains the comment
    • setRow

      public void setRow(short row)
      Specify the row that contains the comment
      Parameters:
      row - the row that contains the comment
    • getColumn

      public short getColumn()
      Return the column that contains the comment
      Returns:
      the column that contains the comment
    • setColumn

      public void setColumn(short col)
      Specify the column that contains the comment
      Parameters:
      col - the column that contains the comment
    • getFlags

      public short getFlags()
      Options flags.
      Returns:
      the options flag
      See Also:
    • setFlags

      public void setFlags(short flags)
      Options flag
      Parameters:
      flags - the options flag
      See Also:
    • getShapeId

      public short getShapeId()
      Object id for OBJ record that contains the comment
    • setShapeId

      public void setShapeId(short id)
      Object id for OBJ record that contains the comment
    • getAuthor

      public String getAuthor()
      Name of the original comment author
      Returns:
      the name of the original author of the comment
    • setAuthor

      public void setAuthor(String author)
      Name of the original comment author
      Parameters:
      author - the name of the original author of the comment